canvas_id
, você deve passar o seu application_id
.
Vá até a página do seu Workstation App e siga estes passos:
Open Connect via API
Get your app data
success
e a task criada terá o status de running
. Você tem duas opções para consumir o resultado de uma task:
completed
ou failed
. Para obter o status de uma task depois de criá-la podemos enviar um request para o endpoitn /task
da API.
webhook_url
na sua chamada de API. Desse forma o endpoit que você passou vai receber um POST
request quando a execução da task terminar.
GET
request pro endpoint /task
. Esse endpoint suporta alguns parâmetros opicionais para filtrar e paginar seus resultados:
limit
: Número de resultados por resposta (padrão: 10, intervalo: 1-100)offset
: Posição inicial dos resultados (padrão: 0)status
: Array de status de tasks (opções: “created”, “running”, “validating”, “completed”, “failed”)since
: Data inicial para filtrar as tasks (formato: timestamp ou ISO 8601)until
: Data final para filtar as tasks (formato: timestamp ou ISO 8601)approvedBy
: Email do usuário que aprovou a taskrevisionProcess
: Tipo de revisão recebida (opções: “approvedWithRevisions”, “approvedDirectly”)promptApplicationId
: ID da aplicação onde a task foi criadapromptVersionId
: ID da versão do Canvas utilizada para criar a taskids
: Array de IDs específicos de tasks para serem listadasorderBy
: Campo para ordenar por (opções: “name”, “reference”, “approvedAt”, “createdAt”, “updatedAt”, “id”, “status”, “approvedBy”, “createdBy”)order
: Sentido de ordenação (opções: “asc” or “desc”)