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

clientId of the tenant

Query Parameters
processName
string

Query processes with name

startEventType
string

Query processes that are having event type

startEventOperation
string

Query process with operation type

enabled
string

Query processes that are enabled or not enabled.

deployed
string

Query processes that are deployed or not deployed.

formName
string

Query processes that are defined against start event object.

Responses

OK

descendingOrder
boolean

nextPage
boolean

orderBy
string

pageNo
number

pageSize
number

previousPageNo
number

results
array

results.activities
results.inputs
results.name
results.outputs
results.permissions
results.startEvents
results.updatedBy
results.updatedDate
results.variables
totalPages
number

totalResults
number

{
  "descendingOrder": true,
  "nextPage": false,
  "orderBy": "createdTime",
  "pageNo": 1,
  "pageSize": 100,
  "previousPageNo": 0,
  "results": [
    {
      "name": "HandleResourceCreation",
      "startEvents": [
        {
          "@type": "SignalStartEvent",
          "eventCondition": "$location.name = \"San Jose\"",
          "eventOperation": "CREATED",
          "formName": "resource",
          "uniqueId": "m5b85078-d922-4107-b18e-7f98310145ec"
        },
        {
          "@type": "TimerStartEvent",
          "repeatRule": "F1D",
          "timeInterval": "R/2019-07-01T13:00:00Z",
          "uniqueId": "i4385078-d922-4107-b18e-7f98310138wr"
        }
      ],
      "updatedBy": "Sally Sue",
      "updatedDate": "2018-11-01T11:49:21 0000"
    }
  ],
  "totalPages": 1,
  "totalResults": 1
}
{
  "descendingOrder": true,
  "nextPage": false,
  "orderBy": "createdTime",
  "pageNo": 1,
  "pageSize": 100,
  "previousPageNo": 0,
  "results": [
    {
      "activities": [
        {
          "@type": "SendMessageTask",
          "entity": "$m5b85078-d922-4107-b18e-7f98310145ec.resource",
          "messageRecipients": {
            "Groups": "SR Approver Group, Shared Service Admins",
            "Rosters": "1st Shift Roster, Primary Escalation Contacts",
            "Users": "johnDoe, sallySue"
          },
          "notificationPriority": "NORMAL",
          "notificationTemplateRef": "...",
          "uniqueId": "l8c85078-d922-4107-b18e-7f98950145ec"
        },
        {
          "@type": "RestServiceTask",
          "entity": "$m5b85078-d922-4107-b18e-7f98310145ec.resource",
          "entityType": "RESOURCE",
          "serviceRef": "875ed563-325d-49a3-b01d-9fae0ac88ue9",
          "uniqueId": "o0j85078-d922-4107-b18e-7f98310189u1"
        },
        {
          "@type": "TimerIntermediateEvent",
          "timeOrDuration": "PT2H",
          "uniqueId": "28r85078-d922-8707-b18e-7f98950149rk"
        }
      ],
      "createdBy": "Joe Bob",
      "createdDate": "2018-10-08T11:49:21 0000",
      "enabled": true,
      "inputs": [],
      "name": "HandleResourceCreation",
      "outputs": [],
      "permissions": [
        {
          "permissionLevel": "VIEW",
          "roleId": "pepsi_cloud_role_id"
        }
      ],
      "startEvents": [
        {
          "@type": "SignalStartEvent",
          "eventCondition": "$location.name = \"San Jose\"",
          "eventOperation": "CREATED",
          "formName": "resource",
          "uniqueId": "m5b85078-d922-4107-b18e-7f98310145ec"
        },
        {
          "@type": "TimerStartEvent",
          "repeatRule": "F1D",
          "timeInterval": "R/2019-07-01T13:00:00Z",
          "uniqueId": "i4385078-d922-4107-b18e-7f98310138wr"
        }
      ],
      "uniqueId": "d7f85078-d922-4107-b18e-e698310145ec",
      "updatedBy": "Sally Sue",
      "updatedDate": "2018-11-01T11:49:21 0000",
      "variables": [
        {
          "dataType": "STRING",
          "id": "400000001",
          "name": "REST Result",
          "required": true
        }
      ]
    }
  ],
  "totalPages": 1,
  "totalResults": 1
}