INSTANCE

Este método possibilita criar e pesquisar instâncias de workflows.

Criar uma instância

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

Parâmetros de consulta:

Query parameters	Tipo	Requerido	Descrição
idProcess	STRING	Sim	Identificador do processo na revisão vigente (PMACTREV.IDPROCESS)
cdProduct	NUMERIC	Sim	Código do componente da automação do processo (39 para Workflow)
nmInstance	STRING	Sim	Título da nova instância

Exemplo de solicitação:

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>'

Exemplo de resposta:

200 OK

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

Pesquisar uma instância

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

Parâmetros de consulta:

Identificador	Tipo	Requerido	Descrição
cdProduct	Numeric	Sim	Código do componente da automação do processo (39 para Workflow)
cdUser	Numeric	Sim	Chave primária do usuário iniciador (ADUSER.CDUSER)
fgLanguage	Numeric	Não	Código do idioma
fgStatus	Numeric	Não	Situação do processo
qtLimit	Numeric	Não	Quantidade de resultados

Exemplo de solicitação:

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>'

Exemplo de resposta:

200 OK

{
  "success": true,
  "response": {
    "total": 1,
    "results": [
      {
        "oid": "1276",
        "identifier": "000645",
        "title": "Your instance title",
        "processStatus": "Andamento",
        "deadline": "Em dia",
        "slaStatus": "Não aplicável",
        "instanceStatus": "",
        "automationProductCode": 39,
        "fgStatus": 1,
        "fgSlaStatus": null,
        "fgDeadline": 1
      }
    ]
  }
}