INSTANCE

This method allows creating and searching for workflow instances.

Creating an instance

POST /apigateway/se/exp/chatbot/api/instance.php

Query parameters:

Query parameters	Type	Required	Description
idProcess	STRING	Yes	ID # of the process in the current revision (PMACTREV.IDPROCESS)
cdProduct	NUMERIC	Yes	Process automation component code (39 for Workflow)
nmInstance	STRING	Yes	Title of the new instance

Example request:

curl -X POST 'https://my-domain.softexpert.com.br/apigateway/se/exp/chatbot/api/instance.php?idProcess=000.DPProcess&cdProduct=39&nmInstance=Your%20instance%20title' \
--header 'Authorization: <your_api_token>'

Example response:

200 OK

{
  "success": true,
  "response": {
    "oid": "1276",
    "identifier": "000645"
  }
}

Searching for an instance

GET /apigateway/se/exp/chatbot/api/instance.php

Query parameters:

ID #	Type	Required	Description
cdProduct	Numeric	Yes	Process automation component code (39 for Workflow)
cdUser	Numeric	Yes	Starter user's primary key (ADUSER.CDUSER)
fgLanguage	Numeric	No	Language code
fgStatus	Numeric	No	Process status
qtLimit	Numeric	No	Quantity of results

Example request:

curl -X GET 'https://john.softexpert.com.br/apigateway/se/exp/chatbot/api/instance.php?cdProduct=39&cdUser=86&qtLimit=1' \
--header 'Authorization: <your_api_token>'

Example response:

200 OK

{
  "success": true,
  "response": {
    "total": 1,
    "results": [
      {
        "oid": "1276",
        "identifier": "000645",
        "title": "Your instance title",
        "processStatus": "Progress",
        "deadline": "On time",
        "slaStatus": "Not applicable",
        "instanceStatus": "",
        "automationProductCode": 39,
        "fgStatus": 1,
        "fgSlaStatus": null,
        "fgDeadline": 1
      }
    ]
  }
}