Versions Compared

Key

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

...

Request:

Query Parameters:

NameData TypeRequiredDescriptionComment
sceneEnumYes

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:

NameData TypeRequiredDescriptionComment
nodesMap<String, CategoryInfo>Yes

Category Informations of the extend activities.

key – extend activity id

value - Category Informations of the extend activity


categoryDataMap<String, CategoryData>Yes

Category Data of the group.

key - Category id

value - Category Data


CategoryInfo:
NameData TypeRequiredDescriptionComment
categoryStringNo

Category id of the extend activity.


CategoryData:
NameData TypeRequiredDescriptionComment
nameStringYes

Category name.


collapseBooleanNoDo you collapse this category by default?


Data Model

WorkflowInfo

NameData TypeRequiredDescriptionComment
id
String
Yes
Unique UUID of the workflow

name
String
YesName of the workflow
version
String
Noversion of the workflow
description
String
Nodescription of the workflow
sceneEnumYes

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
YesThe workflow contentfor new workflow, the data field maybe empty.

...


ExtendActivity

Brief 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

name
description of the activity

category

String

No

Categorization to help better experience to the Designer while building the work-flow


iconIConDataNothe icon to show

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

category

String

No

Categorization to help better experience to the Designer while building the work-flow

type

Enum

Yes

activity type, valid values as follow:

java - Service(Java) Task

script - Script Task

rest - Rest Task


activityJavaTask|ScriptTask|RestTaskYes

Type related bpmn task information of the activity. These information will be used by the workflow engine.

JavaTask for Service(Java) Task, ScriptTask for Script Task, RestTask for Rest Task.

...