Return the content of the workflow. see data information WorkflowInfo for details.model 'WorkflowInfo' for details.

Save Workflow Content with WF ID (to Catalog)

Save workflow content to the Catalog.

URL:

Code Block

language	bash

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 workflow content, for details to see data model 'WorkflowInfo'.

Response:

Name	Data Type	Required	Description	Comment
id	String	Yes	Unique UUID of the workflow saved

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.

URL:

Code Block

language	bash

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

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:

...

activities

...

ExtendActivityBriefInfo[]

...

Return the brief/base Information List of ExtendActivities, for details to see the 'ExtendActivityBriefInfo' data model.

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

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. see data information ExtendActivity for details.

Save Workflow Content with WF ID (to Catalog)

Save workflow content to the Catalog.

URL:

Code Block

language	bash

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

Request:

Pah Parameters:

...

Body Parameters:

The workflow content, for details to see data information WorkflowInfo.

Response:

...

model 'ExtendActivity' for details.

Data Model

WorkflowInfo

...

Data Information:

...

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	Yes	The workflow contnent	for new workflow, the data field maybe empty.

ExtendActivityBriefInfo

...

Brief 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 of the activity
category
String
No
Categorization to help better experience to the Designer while building the work-flow

svg String Yes the 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

activity JavaTask|ScriptTask|RestTask Yes
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.

JavaTask

...

Name
Data Type
Required
Description
Comment
class String Yes The implement class of the bpmn service task
inputs
Input[]
No
The input parameter definitions of the service task. These parameters will dispaly on UI for designer to fullfill.
mappingInputs MappingInput[] No The mapping input parameter definitions of the service task. These parameters will tranform to the actual input parameters of the service task which will be executed on the workflow engine. Only define the relationshipe between the actual input parameter and the UI dispalyed input parameter of the bpmn task.

ScriptTask

...

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

script
String
Yes
The default script content.

RestTask

...

Name
Data Type
Required
Description
Comment
url
String
No
The URL of the REST API exposed through the API router.
Choose between the 'url' field and ('name', 'version') filed.
name 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
Input[]
No
The input parameter definitions of the rest task. These parameters will dispaly on UI for designer to fullfill.
mappingInputs MappingInput[] No The mapping input parameter definitions of the rest task. These parameters will tranform to the actual input parameters of the rest task which will be executed on the workflow engine. Only define the relationshipe between the actual input parameter and the UI dispalyed input parameter of the bpmn task.

Input

...

Name
Data Type
Required
Description
Comment
name
String
Yes
Input paramter name

dataType
Enum
Yes
data type of the input paramter. Valid value as follow:
string, integer, float, boolean, enum

required
boolean
Yes
Should the input paramter be necessary?
true - necessary
false - not necessary

default
any
No
the default value of the input paramter.

enumValue
String[]
No
the enum value of the paramter.
only need when the dataType of the paramter is 'enum'.

MappingInput

...

Space shortcuts

Page tree

Versions Compared

Old Version 15

New Version 16

Key

Save Workflow Content with WF ID (to Catalog)

URL:

Request:

Pah Parameters:

Body Parameters:

Response:

Get Brief Information of Extend BPMN Activities (from Catalog)

URL:

Request:

Query Parameters:

Response:

Get Detail Information of Extend BPMN Activites (from Catalog)

URL:

Request:

Path Parameters:

Response:

Save Workflow Content with WF ID (to Catalog)

URL:

Request:

Pah Parameters:

Body Parameters:

Response:

Data Model

WorkflowInfo

Data Information:

ExtendActivityBriefInfo

ExtendActivity

JavaTask

ScriptTask

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

script
String
Yes
The default script content.

RestTask

Input

MappingInput

Define the relationshipe between the actual input parameter and the UI dispalyed input parameter of the bpmn task.
...

Name	Data Type	Required	Description
id	String	Yes	id of the activity
name	String	Yes	name of the activity
description	String	No	name of the activity
category	String	No	Categorization to help better experience to the Designer while building the work-flow
svg	String	Yes	the icon to show

Name	Data Type	Required	Description	Comment
class	String	Yes	The implement class of the bpmn service task
inputs	Input[]	No	The input parameter definitions of the service task. These parameters will dispaly on UI for designer to fullfill.
mappingInputs	MappingInput[]	No	The mapping input parameter definitions of the service task. These parameters will tranform to the actual input parameters of the service task which will be executed on the workflow engine.	Only define the relationshipe between the actual input parameter and the UI dispalyed input parameter of the bpmn task.

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

Name	Data Type	Required	Description	Comment
url	String	No	The URL of the REST API exposed through the API router.	Choose between the 'url' field and ('name', 'version') filed.
name	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	Input[]	No	The input parameter definitions of the rest task. These parameters will dispaly on UI for designer to fullfill.
mappingInputs	MappingInput[]	No	The mapping input parameter definitions of the rest task. These parameters will tranform to the actual input parameters of the rest task which will be executed on the workflow engine.	Only define the relationshipe between the actual input parameter and the UI dispalyed input parameter of the bpmn task.

Name	Data Type	Required	Description
name	String	Yes	Input paramter name
dataType	Enum	Yes	data type of the input paramter. Valid value as follow: string, integer, float, boolean, enum
required	boolean	Yes	Should the input paramter be necessary? true - necessary false - not necessary
default	any	No	the default value of the input paramter.
enumValue	String[]	No	the enum value of the paramter. only need when the dataType of the paramter is 'enum'.

Space shortcuts

Page tree

Page History

Versions Compared

Old Version 15

New Version 16

Key

Save Workflow Content with WF ID (to Catalog)

URL:

Request:

Pah Parameters:

Body Parameters:

Response:

Get Brief Information of Extend BPMN Activities (from Catalog)

URL:

Request:

Query Parameters:

Response:

Get Detail Information of Extend BPMN Activites (from Catalog)

URL:

Request:

Path Parameters:

Response:

Save Workflow Content with WF ID (to Catalog)

URL:

Request:

Pah Parameters:

Body Parameters:

Response:

Data Model

WorkflowInfo

Data Information:

ExtendActivityBriefInfo

ExtendActivity

JavaTask

ScriptTask

NameData TypeRequiredDescriptionCommentformatStringYesThe default script format, For example: javascript groovyscriptStringYesThe default script content.

RestTask

Input

MappingInput

Define the relationshipe between the actual input parameter and the UI dispalyed input parameter of the bpmn task....

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

script
String
Yes
The default script content.

Define the relationshipe between the actual input parameter and the UI dispalyed input parameter of the bpmn task.
...