...
- Open and Navigates to (ZTE) WF Designer
Rest APIs of (ZTE) WF
...
Designer:
Define the Rest APIs of (ZTE) WF Designer, these APIs will be provided by ZTE.
...
For a new workflow, before it be opened, the catalog (workflow manager) should create it first. The Sequence Diagram shows as follow:
...
Navigate to the (ZTE) WF Designer UI, load the workflow data with the given id from Catalog (Workflow Manager).
Generate WF ID(s) BPMN Artifact:
First, The generator call query API to retrieve the json content of the workflow from Catalog.
Secend, The generator convert the data of the workflow from json format to BPMN format.
After then, the generator call save API to save the BPMN content back to the Catalog.
The Sequence for Generate BPMN Artifacts as follow:
URL:
| Code Block | ||
|---|---|---|
| ||
POST http://{wf-designer-ip}:{port}/api/workflow-modeler/v1/generateBPMN |
Request:
Body Parameters:
...
.
Response:
...
...
Rest APIs of Catalog
...
Define the rest APIs of Catalog (Workflow Manager), these APIs will be provided by Amdocs/AT&T.
Get
...
Workflow Content by WF ID
...
URL:
| Code Block | ||
|---|---|---|
| ||
GET http://{sdc-ip}:{port}/api/sdc/v1/workflow-modeler/models/{id} |
Request:
Path Parameters:
| Name | Data Type | Required | Description | Comment |
|---|---|---|---|---|
| id | String | Yes | Unique UUID of the workflow |
Response:
Return the information of the workflow in json format. see data information WorkflowInfo for details.
Get Brief Information of Extend BPMN Activities (from Catalog)
...
Get the extend Activities such as 'Stop Traffic', 'Stop VNF', 'Create VNF', etc.
URL:
| Code Block | ||
|---|---|---|
| ||
GET http://{sdc-ip}:{port}/api/sdc/v1/workflow-modeler/ext-activities |
Request:
Query Parameters:
| Name | Data Type | Required | Description | Comment |
|---|---|---|---|---|
| scene | Enum | Yes | the scene of the workflow designer. Valid value as follow: resource - open a VNF's workflow service - open a Service's workflow | different scene may has different activities extend. |
Response:
| Name | Data Type | Required | Description | Comment |
|---|---|---|---|---|
activities | ExtendActivityBriefInfo[] | Yes | extend activity brief/base information list |
Get Detail Information of
...
Extend BPMN
...
Activites (from Catalog):
URL:
| Code Block | ||
|---|---|---|
| ||
GET http://{sdc-ip}:{port}/api/sdc/v1/workflow-modeler/ext-activities/{id} |
Request:
Path Parameters:
| Name | Data Type | Required | Description | Comment |
|---|---|---|---|---|
id | String | Yes | Uniqued id of the extend bpmn activity. |
Response:
Return the detail information of the extend activity. see data information ExtendActivity for details.
Save
...
Workflow Content with WF ID (to Catalog)
...
Save the JSON workflow content of the workflow to the Catalog.
URL:
| Code Block | ||
|---|---|---|
| ||
PUT http://{sdc-ip}:{port}/api/sdc/v1/workflow-modeler/models/{id} |
Request:
Pah Parameters:
| Name | Data Type | Required | Description | Comment |
|---|---|---|---|---|
| id | String | Yes | Unique UUID of the workflow |
Body Parameters:
The information of the workflow in json format, for details to see data information WorkflowInfo.
Response:
...
Store BPMN Artifact against WF ID:
Save the BPMN content of the workflow to the Catalog.
URL:
| Code Block | ||
|---|---|---|
| ||
PUT http://{sdc-ip}:{port}/api/sdc/v1/workflow-modeler/models/{id}/bpmn |
Request:
Path Parameters:
...
Body Parameters:
...
Response:
| Name | Data Type | Required | Description | Comment |
|---|---|---|---|---|
| id | String | Yes | Unique UUID of the workflow saved |
Data Information:
WorkflowInfo:
...