Listar solicitações onde sou o solicitante

Como listar instâncias acessíveis pela pessoa autenticada na API?

Para listar as instâncias acessíveis pela pessoa relacionada a API, siga os passos abaixo:

Autenticação: Primeiro obtenha um token de autenticação com permissão de realizar essa operação;
Enviar a requisição: Utilize o endpoint Listar solicitações onde sou o solicitante. Não se esqueça de substituir seu_endereco.do.zeev no exemplo pelo endereço que você utiliza para acessar o Zeev;
Paginar: Observe que a consulta à essa API retorna um número limitado de registros; para obter todos os dados, será necessário implementar um algoritmo de paginação;
Rate limit: Se for paginar os resultados, respeite os limites máximos de solicitações;
oData: opcionalmente, utilize regras oData para manipular o resultado da API. Essa API aceita $select

Como incluir a lista de tarefas pendentes e de tarefas concluídas junto as informações da solicitação?

Por padrão, essa consulta não traz a lista de tarefas pendentes e já concluídas. Para trazer essa informação, você deve instruir a chamada da API explicitamente que deseja essa informação. Para isso, são disponibilizados dois parâmetros:

showPendingInstanceTasks=true Indica que você deseja que a lista com informações das tarefas atualmente pendentes na solicitação sejam mostradas.
showFinishedInstanceTasks=true Indica que você deseja que a lista com informações das tarefas já concluídas na solicitação sejam mostradas.

Como incluir a lista das pessoas atualmente responsáveis por uma tarefa da solicitação?

Para trazer essa informação, é preciso, primeiro, que o parâmetro showPendingInstanceTasks=true seja ativado. Ele irá trazer a lista das tarefas pendentes.

Então, você deve acrescentar o parâmetro showPendingAssignees=true . Esse parâmetro indica que você quer trazer junto o nome e identificação das pessoas responsáveis por cada tarefa pendente.

Como incluir valores de campos de formulário?

Por padrão, essa API não traz os valores de campos de formulário da solicitação. Para trazer essa informação, você precisa informar explicitamente o identificador dos campos de formulário que você deseja obter, usando o parâmetro formFieldNames. Por exemplo:

formFieldNames=nomeCompleto&formFieldNames=idade&formFieldNames=endereco

Listar todas instâncias de solicitações em que a pessoa relacionada ao token é o requisitante (Auth)

get

Parâmetros de consulta

instanceIdinteger · int32Opcional

Código identificador da instância da solicitação

formFieldNamesstring[]Opcional

Campos do formulário que devem ser retornados na consulta. Para mais de um, repita o parâmetro para cada campo a ser retornado.

startDateBeginstring · date-timeOpcional

Data inicial de intervalo de data de solicitação

startDateEndstring · date-timeOpcional

Data final de intervalo de data de solicitação

isActivebooleanOpcional

Indicação se a solicitação está em andamento ou não (já foi finalizada)

showPendingInstanceTasksbooleanOpcional

Indicação se devem ser listadas as tarefas pendentes da solicitação nesse momento

showFinishedInstanceTasksbooleanOpcional

Indicação se devem ser listadas as tarefas finalizadas da solicitação nesse momento

showPendingAssigneesbooleanOpcional

Indicação se devem ser listados os responsáveis pelas tarefas pendentes da solicitação nesse momento

recordsPerPageinteger · int32Opcional

Indicação do número de registros a serem retornados

pageNumberinteger · int32Opcional

Indicação do número da página para paginação de registros

useCachebooleanOpcional

Indicação se a consulta pode vir do cache

Respostas

200

Sucesso

400

Solicitação ou dados da solicitação são inválidas

401

Pessoa não autorizada

403

Pessoa não tem permissão de executar essa operação

404

O registro não foi encontrado

429

Muitas requisições em um determinado período de tempo

500

Ocorreu algum erro interno no servidor

get

/api/2/instances

GET /api/2/instances HTTP/1.1
Host: seu_endereco.do.zeev
Accept: */*

[
  {
    "id": 1,
    "masterInstanceId": 1,
    "starterInstanceId": 1,
    "requestName": "text",
    "reportLink": "text",
    "confirmationCode": "text",
    "uid": "00000000-0000-0000-0000-000000000000",
    "simulation": true,
    "active": true,
    "flowResult": "text",
    "flowResultId": 1,
    "startDateTime": "2026-02-04T01:17:52.876Z",
    "endDateTime": "2026-02-04T01:17:52.876Z",
    "lastFinishedTaskDateTime": "2026-02-04T01:17:52.876Z",
    "leadTimeInDays": 1,
    "flow": {
      "id": 1,
      "uid": "00000000-0000-0000-0000-000000000000",
      "name": "text",
      "version": 1
    },
    "service": {
      "id": 1,
      "uid": "00000000-0000-0000-0000-000000000000",
      "name": "text"
    },
    "formFields": [
      {
        "id": 1,
        "name": "text",
        "value": "text",
        "row": 1
      }
    ],
    "requester": {
      "id": 1,
      "name": "text",
      "email": "text",
      "username": "text",
      "team": {
        "id": 1,
        "name": "text",
        "code": "text"
      },
      "position": {
        "id": 1,
        "name": "text",
        "code": "text"
      }
    },
    "instanceTasks": [
      {
        "id": 1,
        "subprocessId": 1,
        "startDateTime": "2026-02-04T01:17:52.876Z",
        "endDateTime": "2026-02-04T01:17:52.876Z",
        "expectedEndDateTime": "2026-02-04T01:17:52.876Z",
        "leadTimeInDays": 1,
        "onTime": true,
        "active": true,
        "result": "text",
        "alias": "text",
        "task": {
          "id": 1,
          "name": "text",
          "type": "text",
          "businessHours": true,
          "timeout": 1
        },
        "executor": {
          "userId": 1,
          "name": "text",
          "email": "text",
          "username": "text"
        },
        "assignees": [
          {
            "id": 1,
            "userId": 1,
            "name": "text",
            "email": "text",
            "username": "text",
            "team": {
              "id": 1,
              "name": "text",
              "code": "text"
            },
            "position": {
              "id": 1,
              "name": "text",
              "code": "text"
            }
          }
        ]
      }
    ]
  }
]

Exemplo de requisição

const myHeaders = new Headers();
myHeaders.append("Accept", "application/json");
myHeaders.append("Content-Type", "application/json");
myHeaders.append("Authorization", "Bearer TOKEN_DO_USUARIO");

const requestOptions = {
  method: "GET",
  headers: myHeaders
};

try {
  const response = await fetch("https://seu_endereco.do.zeev/api/2/instances?instanceId=1234", requestOptions);
  const result = await response.text();
  console.log(result)
} catch (error) {
  console.error(error);
};

//Confira os parâmetros disponíveis para uso nesta pagina

Links relacionados:

AnteriorCancelar ou reverter cancelamento de solicitações PróximoListar todas as solicitações do sistema

Atualizado há 1 ano

[ { "id": 1, "masterInstanceId": 1, "starterInstanceId": 1, "requestName": "text", "reportLink": "text", "confirmationCode": "text", "uid": "00000000-0000-0000-0000-000000000000", "simulation": true, "active": true, "flowResult": "text", "flowResultId": 1, "startDateTime": "2026-02-04T01:17:52.876Z", "endDateTime": "2026-02-04T01:17:52.876Z", "lastFinishedTaskDateTime": "2026-02-04T01:17:52.876Z", "leadTimeInDays": 1, "flow": { "id": 1, "uid": "00000000-0000-0000-0000-000000000000", "name": "text", "version": 1 }, "service": { "id": 1, "uid": "00000000-0000-0000-0000-000000000000", "name": "text" }, "formFields": [ { "id": 1, "name": "text", "value": "text", "row": 1 } ], "requester": { "id": 1, "name": "text", "email": "text", "username": "text", "team": { "id": 1, "name": "text", "code": "text" }, "position": { "id": 1, "name": "text", "code": "text" } }, "instanceTasks": [ { "id": 1, "subprocessId": 1, "startDateTime": "2026-02-04T01:17:52.876Z", "endDateTime": "2026-02-04T01:17:52.876Z", "expectedEndDateTime": "2026-02-04T01:17:52.876Z", "leadTimeInDays": 1, "onTime": true, "active": true, "result": "text", "alias": "text", "task": { "id": 1, "name": "text", "type": "text", "businessHours": true, "timeout": 1 }, "executor": { "userId": 1, "name": "text", "email": "text", "username": "text" }, "assignees": [ { "id": 1, "userId": 1, "name": "text", "email": "text", "username": "text", "team": { "id": 1, "name": "text", "code": "text" }, "position": { "id": 1, "name": "text", "code": "text" } } ] } ] } ]

hashtagComo listar instâncias acessíveis pela pessoa autenticada na API?

hashtagComo incluir a lista de tarefas pendentes e de tarefas concluídas junto as informações da solicitação?

hashtagComo incluir a lista das pessoas atualmente responsáveis por uma tarefa da solicitação?

hashtagComo incluir valores de campos de formulário?

hashtagListar todas instâncias de solicitações em que a pessoa relacionada ao token é o requisitante (Auth)

hashtagLinks relacionados: