INSTANCE

Service URL

https://<domain>/apigateway/se/exp/chatbot/api/instance.php

Method

POST

Input parameters

ID #

Parameter

Type

Required

Description

idProcess

QUERY

STRING

X

ID # of the process in the current revision (PMACTREV.IDPROCESS)

cdProduct

QUERY

NUMERIC

X

Code of the process automation component (39 for Workflow)

nmInstance

QUERY

STRING

X

Title of the new instance

Output parameter

{

 "success": true,

 "response": {

         "oid": "instance oid",

         "identifier": "instance ID #",

 }

}

Method

GET

Input parameters

ID #

Type

Required

Description

cdProduct

NUMERIC

X

Code of the process automation component (39 for Workflow)

cdUser

NUMERIC

X

Starter user's primary key (ADUSER.CDUSER)

fgLanguage

NUMERIC

Language code

fgStatus

NUMERIC

Process status

qtLimit

NUMERIC

Number of results

Output parameter

{

   "success": true,

   "response": {

       "total": 1,

       "results": [

           "oid": "instance oid",

           "identifier": "instance ID #",

           "title": "instance title",

           "processStatus": "process status (text)",

           "deadline": "deadline status (text)",

           "slaStatus": "SLA status (text)",

           "instanceStatus": "instance status (text)",

           "automationProductCode": "process automation code"

           "fgStatus": "process status code"

           "fgSlaStatus": "SLA status code"

           "fgDeadline": "deadline status code"

       ]

   }

}