Endpoint
/api/v2/tenants/{tenant_id}/metadata/processes
Path Parameters
tenant_id
string

clientId of the tenant

activities
array

This list contains activities to perform when the process is started. The supported tasks are SERVICE_TASK and SEND_MESSAGE_TASK. For the service task, the server input and output are defined by the service. The "input map" of Service Task is about how to map process variables to the service input and "output map" is about how to map the service output to process variables.

createdBy
string

Creator of the process workflow

createdDate
string

Create date of the process workflow

description
string

Details of the purpose ofthe workflow

enabled
boolean

This indicates if the process is enabled for execution or not.

endEvents
array

Ending events process details.

endEvents.@type
endEvents.name
endEvents.uniqueId
gateways
array

This list has decision flows termed as gateways. There are two types of gateway - Exclusive gateway and Parallel gateway. Exclusive gateway is the decision point in the flow and parallel gateway creates parallel flows. Exclustive gateway has property "defaultSequenceFlow" to indicate the default outgoing flow.

gateways.@type
Type of decision flow.
gateways.defaultSequenceFlow
Default sequence flow unique identifier.
gateways.name
Name of decision flow gateway.
gateways.uniqueId
Unique idenfier of the decision gateway.
name
string

Represents the name of the created process workflow.

sequenceFlows
array

This list contains sequence flow. Sequence flow links all process elements. It has "source" and "target", and optional "conditionExpression" attribute. The condition expression is typically used along with exclusive gateway(Decision flows) to direct the outgoing flow.

sequenceFlows.@type
Sequence flow identifier
sequenceFlows.conditionExpression
Conditional expression as permited by the system.
sequenceFlows.name
Sequence flow process name.
sequenceFlows.source
From source event.
sequenceFlows.target
To Target event
sequenceFlows.uniqueId
Sequence flow process uuid.
startEvents

This list contains process start events. The process can be started by a platform event (SIGNAL) or a timer. Valid values for eventOperation is CREATED, UPDATED

updatedBy
string

last updated by

updatedDate
string

Last update on

variables
array

Associated variable details.

variables.dataType
Data Typ of the output
variables.id
Variable uuid of REST output.
variables.name
Variable name of the REST ouput.
variables.required
Required or not.
{
  "activities": [
    {
      "@type": "SendMessageTask",
      "async": false,
      "entity": "$StartEvent_1pxu3q3.alert",
      "messageRecipients": {
        "ROSTER": "",
        "USER": "buser3",
        "USERGROUP": ""
      },
      "name": "Mail event",
      "notificationPriority": "NORMAL",
      "notificationTemplateRef": "c2fa27a5-2ad7-4de6-ba44-947363b37f54",
      "uniqueId": "Task_0eogjde"
    },
    {
      "@type": "RestServiceTask",
      "async": false,
      "entity": "$StartEvent_1pxu3q3.alert",
      "integrationEventRef": "INTG-EVENT-b59c3af5-77ef-4ca2-a0a6-6f2c4cc8d3a1",
      "integrationRef": "INTG-2418f51d-f2c9-41a9-9ef1-9d4f8c74b5eb",
      "name": "Invoke integration",
      "uniqueId": "Task_0t8lier"
    },
    {
      "@type": "SendMessageTask",
      "async": false,
      "entity": "$StartEvent_1pxu3q3.alert",
      "messageRecipients": {
        "ROSTER": "",
        "USER": "buser3",
        "USERGROUP": ""
      },
      "name": "Update mail",
      "notificationPriority": "NORMAL",
      "notificationTemplateRef": "c2fa27a5-2ad7-4de6-ba44-947363b37f54",
      "uniqueId": "Task_0t1v9n2"
    }
  ],
  "createdBy": "USR0000000273",
  "createdDate": "2020-01-21T07:02:02+0000",
  "description": "",
  "enabled": false,
  "endEvents": [
    {
      "@type": "EndEvent",
      "name": "null",
      "uniqueId": "EndEvent_0im2rr5"
    },
    {
      "@type": "EndEvent",
      "name": "null",
      "uniqueId": "EndEvent_1spnb7x"
    }
  ],
  "gateways": [
    {
      "@type": "ExclusiveGateway",
      "defaultSequenceFlow": "SequenceFlow_1tycyne",
      "name": "null",
      "uniqueId": "ExclusiveGateway_1x5l54b"
    }
  ],
  "name": "Sample Workflow",
  "sequenceFlows": [
    {
      "@type": "SequenceFlow",
      "name": "null",
      "source": "Task_0t8lier",
      "target": "ExclusiveGateway_1x5l54b",
      "uniqueId": "SequenceFlow_17hco2p"
    },
    {
      "@type": "SequenceFlow",
      "name": "null",
      "source": "Task_0t1v9n2",
      "target": "EndEvent_1spnb7x",
      "uniqueId": "SequenceFlow_1rhs6kb"
    },
    {
      "@type": "SequenceFlow",
      "conditionExpression": "$Task_0t8lier.priority = \"High\"",
      "name": "1",
      "source": "ExclusiveGateway_1x5l54b",
      "target": "Task_0t1v9n2",
      "uniqueId": "SequenceFlow_08qvs1l"
    },
    {
      "@type": "SequenceFlow",
      "name": "null",
      "source": "Task_0eogjde",
      "target": "EndEvent_0im2rr5",
      "uniqueId": "SequenceFlow_1hszcv0"
    },
    {
      "@type": "SequenceFlow",
      "name": "null",
      "source": "StartEvent_1pxu3q3",
      "target": "Task_0t8lier",
      "uniqueId": "SequenceFlow_0b2ikfc"
    },
    {
      "@type": "SequenceFlow",
      "conditionExpression": "$Task_0t8lier.priority = \"Low\"",
      "name": "2",
      "source": "ExclusiveGateway_1x5l54b",
      "target": "Task_0eogjde",
      "uniqueId": "SequenceFlow_1tycyne"
    }
  ],
  "startEvents": [
    {
      "@type": "SignalStartEvent",
      "eventCondition": "$currentState = \"Critical\"",
      "eventOperation": "CREATED",
      "formName": "alert",
      "name": "null",
      "uniqueId": "StartEvent_1pxu3q3"
    }
  ],
  "updatedBy": "USR0000000007",
  "updatedDate": "2020-01-22T04:51:33+0000",
  "variables": []
}

Responses

OK

uniqueId
string

{
  "uniqueId": "PROCESS_56381b97-67f7-410e-bec1-c3eb5766bc2a"
}