Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

NameData TypeRequiredDescriptionComment
idStringYesUnique 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 WF ID (to Catalog)

...

NameData TypeRequiredDescriptionComment
idStringYesUnique UUID of the workflow

Body Parameters:

The workflow content, for details to see data model 'WorkflowInfo'BPMN file content of the workflow in the format of string.

Response:

...

None

Get Extend BPMN Activites (from Catalog)

...

Code Block
languagexml
collapsetrue
{
    "nodes":{
        "extend-activity-id-stop-traffic":{
            "category":"aaa"
        },
        "extend-activity-id-stop-vnf":{
            "category":"bbb"
        }
    },
    "categoryData":{
        "aaa":{
            "name":"aaa",
            "collapse":false
        },
        "bbb":{
            "name":"bbb",
            "collapse":true
        }
    }
}


Data Model

WorkflowInfo

...

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

...

String

...

Sample:

...

languagexml
titleA New Workflow (Empty):

...

ExtendActivity

Detail informtion of the extend activity.

...

Name

Data Type

Required

Description

Comment

classStringYesThe 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
languagexml
collapsetrue
[
    {
        "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":[

                    ]
                }
            }
        }
    }
]

...

Name

Data Type

Required

Description

Comment

scriptFormat

String

Yes

The script format, For example: JavaScript, groovy


script

String

Yes

The script content.


Sample:

Code Block
languagexml
collapsetrue
[
    {
        "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"
        }
    }
]

...