...
URL:
| Code Block | ||
|---|---|---|
| ||
GetGET httphttps://{wf-designer-ip}:{port}/workflow-modeler?operationID={operationID}&uuid={uuid}&id={id}&displayMode={view/modify/create} |
Request:
Query Parameters:
The following attribute data transfers using Query Parameters
Name | Data Type | Required | Description |
operationID | String | Y | The new generated ID of the operation |
uuid | String |
Y | Versioned identifier of the resource model (this uuid changed for every major version of the resource) Ex.: b8ff69ca-786d-479e-9f9c-217a90ee0ebc |
id | String |
Y | Unique UUID of the workflow |
displayMode | Enum |
Y | The |
Display Mode for the workflow, Valid value as follow: view - can view only, can't modify. - OOS modify - can |
modify workflow - OOS create - can create the workflow |
Response:
Navigate to the (ZTE) WF Designer UI, load the workflow content with the given id from Catalog.
...
The following attribute data will be transfer using path Parameters
Name | Data Type | Required | Description |
uuid | String | Y | Versioned identifier of the resource model (this uuid is changed for every major version of the resource) Ex.: b8ff69ca-786d-479e-9f9c-217a90ee0ebc |
operationID | String | Y | identifier of the operation Ex.: b8ff69ca-786d-479e-9f9c-217a90ee0ebc |
artifactUUID
| String | Y | Unique UUID of the workflow (WF ID) |
Request (POST):
Request Headers
Header Name | Mandatory? | Description |
Content-Type | Y | Valid value is : application/json |
Content-MD5
| Y | The value for this header must be the MD5 checksum over the whole json body |
USERID | Y | The user ID of the SDC Designer. This user must also have a Designer role in SDC |
X-ECOMP-RequestID | N | According to the general ECOMP agreement the "X-ECOMP-RequestID" header with the transaction UUID should be published by ECOMP component calling an exposed by other ECOMP component API in order to make possible the transaction traceability across ECOMP. If it is not sent it will be automatically generated by SDC on request receipt. |
X-ECOMP-InstanceID | Y | For auditing purpose each component calling the SDC API should identify itself by sending its identity ( e.g. Instar name ...) in "X-ECOMP-InstanceID" header. If this header with non-null value is not supplied the HTTP Request will be rejected with '400 Bad Syntax’ response code. Ex.: “workflow” |
Accept | N | Determines the format of the body of the response. Valid values are: “application/octet-stream” |
|
|
|
Request Body
The body of the save request must be in a json format that specifies the metadata.
The workflow contents or artifacts. See WorkflowInfo
WorkflowInfo
Name | Data Type | Required | Description |
artifactName | String | Y | Name of the workflow |
description | String | Y | description of the workflow |
artifactType | String | Y | ‘PLAN’ |
payloadData | Object | Y | The workflow artifact or assets file |
Response:
Response Headers
Header Name | Mandatory? | Description |
Content-Type | Y | Determines the format of the response body. Valid value is: “application/json” |
Content-Length | Y | Length of the response body |
Response Body
Response body is sent as JSON object (Content-Type: application/json).
Response Example
HTTP/1.1 200 OK Content-MD5: NWQwZmZhZjFjNDc3NDFlZjkzMzBhZjcwN2YzODhjNDc= Content-Type: application/json X-ECOMP-RequestID: 3d3da579-455d-4dab-af4a-dc4ea60ff6ea Content-Length: 893 Server: Jetty(9.3.6.v20151106) { "Response code":"500", "Exception Code":"POL5000", "Reason":" The POST request failed either due to internal SDC problem." } |
|---|
Http Response Code
Response code | Exception Code | Reason /Description |
200 | N/A | component is authenticated and list of Catalog Assets Metadata is saved. |
400 | POL5001 | Missing “ID” or “UUID” from HTTP header |
404 | SVC4063 | Error: Requested resource was not found. |
405 | POL4050 | Method Not Allowed: Invalid HTTP method type used |
500 | POL5000 | The POST request failed either due to internal SDC problem. |
Get Extend BPMN Activites (from Catalog)
...