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.

...

Get Workflow Content by WF ID
Save Workflow Content with WF ID (to Catalog)
Get Extend BPMN Activites (from Catalog)
Get Category Information of Extend BPMN Activities (from Catalog)

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'.

For a new workflow, before it be opened, the catalog should create it first. The Sequence Diagram shows as follow:

URL:

Code Block

language	bash

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

Comment


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

Yes

Y	Unique UUID of the workflow

operation

displayMode

Enum

Yes

Y

The

operation

Display Mode for the workflow, Valid value as follow:

view - can view only, can't modify. - OOS

modify - can

view and modify both.

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.

Rest APIs of Catalog

Define the rest APIs of Catalog, these APIs will be provided by Amdocs/AT&T.

Get Workflow Content by WF ID

URL:

Code Block

language	bash

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 BPMN file content of the workflow . For details to see data model 'WorkflowInfo'in the format of string.

Save Workflow Content with artifactUUID(WF ID) (to Catalog)

Save workflow content to the Catalog.

URL:

Code Block

language	bash

PUTPOST http://{sdc-ip}:{port}/api/sdc/v1/workflow-modeler/models/{id}

Request:

...

/catalog/resource/{uuid}/interfaces/{operationID}/artifacts/{artifactUUID}

Path Parameters:

The following attribute data will be transfer using path Parameters

Name

Data Type

Required

Description

CommentidStringYes

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

Body Parameters:

The workflow content, for details to see data model 'WorkflowInfo'.

Response:

(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”
~~Authorization~~	Y	The username and password are formed into one string as “username: password”. This string is then Base64 encoded to produce the encoded credential which is communicated in the header after the string “Authorization: Basic “. If the Authorization header is missing, then an HTTP “401 Unauthorized” with ‘WWW-Authenticate’ header specifying the type of required client authentication and realm token will be returned. “401” response should trigger the repeated ~~HTTP~~ request sending ~~with “Authorization” header containing the client ’s credentials.~~ If “Authorization” header is received, but the client‘s authentication fails ( due to either unknown “username” or invalid “password” ) the “403 Forbidden” response code will be returned

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

Commentid


artifactName	String	Y	Name of the workflow
description	String

Yes

Y

Unique UUID

description of the workflow

artifactType

String

Y

‘PLAN’

payloadData

String

Y

The workflow artifact or assets file.

The data of the artifact after Base64 encoding

Info

title	Base64

The resulting string is then encoded using the RFC2045-MIME variant of Base64

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)

Get the detail informtion information of the extend BPMN activities such as 'Stop Traffic', 'Stop VNF', 'Create VNF', etc.

These informations information will describe the details of the activities which can be deployed to the workflow engine finally. At the same time the activity's detail information will be used to generate the BPMN artifacts.

URL:

Code Block

language	bash

GET http://{sdc-ip}:{port}/api/sdc/v1/workflow-modeler/ext-activities

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 activities, that is ExtendActivity[]. For details to see data model 'ExtendActivity'.

Get Category Information of Extend BPMN Activities (from Catalog)

Get the category information of extend Activities. If the extend activities have category informations, the WF Designer will organize and display extend activities in categories.

URL:

Code Block

language	bash

GET http://{sdc-ip}:{port}/api/sdc/v1/workflow-modeler/ext-activity-categories

Request:

Query Parameters:

Name

Data Type

Required

Description

Comment

scene

Enum

Yes

the scene of the workflow designer. Valid value as follow:

vnf - 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

nodes

Map<String, CategoryInfo>

Yes

Category Informations of the extend activities.

key – extend activity id

value - Category Information of the extend activity

categoryData

Map<String, CategoryData>

Yes

Category Data of the group.

key - Category id

value - Category Data

CategoryInfo:

Name	Data Type	Required	Description	Comment
category	String	No	Category id of the extend activity.

CategoryData:

Name	Data Type	Required	Description	Comment
name	String	Yes	Category name.
collapse	Boolean	No	Do you collapse this category by default?

...

sample:

...

Code Block

...

language

...

xml

...

collapse

...

id

...

String

...

Unique UUID of the workflow

...

String

...

String

...

String

...

the scene of the workflow designer. Valid value as follow:

vnf - open a VNF's workflow

service - open a Service's workflow

...

Object

...

true

{
    "nodes":{
        "extend-activity-id-stop-traffic":{
            "category":"aaa"
        },
        "extend-activity-id-stop-vnf":{
            "category":"bbb"
        }
    }

Example:

Code Block

language	xml
title	A New Workflow (Empty):

{
    "id":"activity-id",
    "name":"Upgrade Image",
    "versioncategoryData":"1.0",
{
        "aaa":{
            "descriptionname":"Upgrade Image",
aaa",
            "collapse":false
        },
        "bbb":{
            "scenename":"vnfbbb",
    "data        "collapse":{
true
        }
    }
}

Data Model

ExtendActivity

Detail informtion of the extend activity.

Name	Data Type	Required	Description	Comment
id	String	Yes	id of the activity
name	String	Yes	name of the activity
description	String	No	description of the activity
icon	IConData	No	the icon to show
type	Enum	Yes	activity type, valid values as follow: serviceTask - Service(Java) Task scriptTask - Script Task restTask - Rest Task activity
content	ServiceTask\|ScriptTask\|RestTask	Yes	Related bpmn task information of the extend activity. These information will be used by the workflow engine.	ServiceTask for Service(Java) Task, ScriptTask for Script Task, RestTask for Rest Task.

IConData

Name	Data Type	Required	Description
name	String	Yes	Icon Name
width	integer	No	The width of the icon.
height	integer	No	The height of the icon.

ServiceTask

Name

Data Type

Required

Description

Comment

class

String

Yes

The implement class of the bpmn service task

inputs

Map<String, Input>

No

The input parameter definitions of the task.

key - Input parameter name

value - Input parameter definition

These parameters will dispaly on UI for designer to fullfill.

Sample:

Code Block

language	xml
collapse	true

[
    {
        "id":"extend-activity-id-stop-traffic",
        "name":"Stop Traffic",
        "description":"Stop Traffic",
        "type":"serviceTask",
        "icon":{
            "name":"stop-traffic",
            "width":56,
            "height":56
        },
        "content":{
            "class":"org.onap.activity.ext.StopTrafficServiceTask",
            "inputs":{
                "param1":{
                    "type":"string",
                    "default":"value1",
                    "required":true,
                    "constraints":[

                    ],
                    "displayName":"aaa",
                    "show":true
                },
                "param2":{
                    "type":"string",
                    "default":"value2",
                    "required":false,
                    "constraints":[

                    ]
                }
            }
        }
    }
]

ScriptTask

Name	Data Type	Required	Description	Comment
formatscriptFormat	String	Yes	The default script format, For example: javascript JavaScript, groovy
script	String	Yes	The default script content.

Sample:

Code Block

language	xml
collapse	true

[
    {
        "id":"extend-activity-id-stop-vnf",
        "name":"Stop VNF",
        "description":"Stop VNF",
        "type":"scriptTask",
        "icon":{
            "name":"stop-vnf",
            "width":56,
            "height":56
        },
        "content":{
            "scriptFormat":"groovy",
            "script":"test groovy script"
        }
    }
]

RestTask (TBD)

Name	Data Type	Required	Description	Comment
urlbaseUrl	String	No	The Base URL of the REST API exposed through the API router.	Choose between the 'url' field and ('name', 'version') filed.
nameserviceName	String	No	The microservcie name of the REST API. Only for the condition of access the REST API via MircoServiceBus.
version	String	No	The microservcie version of the REST API. Only for the condition of access the REST API via MircoServiceBus.	In the condition of access the REST API via MircoServiceBus, The workflow engine can query the URL of the REST API exposed through the MircoServiceBus by name and version.
path	String	Yes	The path of the REST API relative to the API router exposed path.
method	Enum	Yes	The method of the rest api to be called while the activity be executed on the workflow engine. Valid value as follow: get, post, put, delete
headers	Map<Strting, String>	Yes	The header paramters of the rest api associated to the rest task. Map key is the header paramter name, such as 'Accept'.Map value is the header paramter name, such as ''application/json.
inputs	Map<String, Input>	No	The input parameter definitions of the task. key - Input parameter name value - Input parameter definition

Input

Name	Data Type	Required	Description	Comment
type	EnumString	Yes	data type of the input paramter. Valid value Such as follow: string, integer, float, boolean, enum
default	any	No	the default value of the input paramter.
required	boolean	Yes	Should the input paramter be necessary? true - necessary false - not necessary
constraints
displayName	String	No	Alias of the Input paramter only for displaying use.	If there is no alias, the original name will be displayed
show	boolean	No	Is it displayed in the UI?	If false, this input parameter will be hided on the UI.

Space shortcuts

Page tree

Page History

Versions Compared

Old Version 28

New Version Current

Key

SDC Component Diagram

Sequence Diagram

Rest APIs of (ZTE) WF Designer

Open and Navigates to (ZTE) WF Designer

URL:

Request:

Query Parameters:

Response:

Rest APIs of Catalog

Get Workflow Content by WF ID

URL:

Request:

Path Parameters:

Response:

Save Workflow Content with artifactUUID(WF ID) (to Catalog)

URL:

Request:

Path Parameters:

Body Parameters:

Response:

Request (POST):

Request Headers

Request Body

WorkflowInfo

Response:

Response Headers

Response Body

Response Example

Http Response Code

Get Extend BPMN Activites (from Catalog)

URL:

Request:

Path Parameters:

Response:

Get Category Information of Extend BPMN Activities (from Catalog)

URL:

Request:

Query Parameters:

Response:

CategoryInfo:

CategoryData:

sample:

Example:

Data Model

ExtendActivity

IConData

ServiceTask

Sample:

ScriptTask

Sample:

RestTask (TBD)

Input