| Table of Contents |
|---|
SDC Component Diagram
...
Sequence Diagram
...
In this case, the Catalog plays a manager role of the workflows, it manage the designed workflows and provide the Create/Updata/Query operations of workflows for Service Designer and provide the storage of workflows.
...
The interaction between Catalog and '(ZTE) WF Designer' is as follows:
So, the rest APIs of '(ZTE) WF Designer' should be provided as follow:
- Open and Navigates to (ZTE) WF Designer
The rest APIs of Catalog should be provide by Amdocs/AT&T provided as follow:
Get Workflow Content by WF ID
Get Brief Information of Extend BPMN Activities (from Catalog)
Get Detail Information of Extend BPMN Activites (from Catalog)
Save Workflow Content with WF ID (to Catalog)
The rest APIs of '(ZTE) WF Designer' should be provided by ZTE as follow:
- 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.
Open and Navigates to (ZTE) WF Designer
...
Open the an existed workflow and navigate to the '(ZTE) WF Designer'.
...
Navigate to the (ZTE) WF Designer UI, load the workflow data content with the given id from Catalog.
...
| Name | Data Type | Required | Description | Comment |
|---|---|---|---|---|
| id | String | Yes | Unique UUID of the workflow |
Response:
Return the information content of the workflow in json format. see data information WorkflowInfo for details.
Get Brief Information of Extend BPMN Activities (from Catalog)
Get the brief Information of extend Activities such as 'Stop Traffic', 'Stop VNF', 'Create VNF', etc.
...
| Code Block | ||
|---|---|---|
| ||
GET http://{sdc-ip}:{port}/api/sdc/v1/workflow-modeler/ext-activity-activitiesbriefs |
Request:
Query Parameters:
...
| Name | Data Type | Required | Description | Comment |
|---|---|---|---|---|
activities | ExtendActivityBriefInfo[] | Yes | extend activity brief/base information list |
Get Detail Information of Extend BPMN Activites (from Catalog)
...
Get the detail informtion of the extend BPMN activities. Thes information will describe the details of the activities deployed to the workflow engine and will be used to generate the BPMN artifacts.
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. |
...
Return the detail information of the extend activityextend activities. see data information ExtendActivity for details.
...
| Name | Data Type | Required | Description | Comment |
|---|---|---|---|---|
| id | String | Yes | Unique UUID of the workflow |
Body Parameters:
The information of the workflow in json formatworkflow content, for details to see data information WorkflowInfo.
...
| Name | Data Type | Required | Description | Comment |
|---|---|---|---|---|
id | String | Yes | Unique UUID of the workflow | |
| name | String | Yes | Name of the workflow | |
| version | String | No | version of the workflow | |
| description | String | No | description of the workflow | |
| 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. |
| data | String | YesContnent | of the workflow in json formatThe workflow contnent | for new workflow, the data field maybe empty. |
...