Recupero dei dettagli di un processo specifico
Recupero dei messaggi di un processo specifico
Per ulteriori informazioni sulle relazioni tra oggetti e su come utilizzarle nell'API, consulta la sezione Relazioni tra oggetti.
Per ulteriori informazioni sui processi, consulta la pagina di assistenza Processi: interfaccia di amministrazione.
Per recuperare i dettagli di un processo esistente e il suo stato corrente, utilizza l'endpoint GET {baseURL}/v3/jobs/{jobId}. Utilizza vari parametri per filtrare i processi che desideri visualizzare.
Nota
È possibile utilizzare solo i flussi di lavoro delle app.
Gli utenti possono visualizzare i lavori eseguiti da loro e quelli eseguiti su pianificazioni condivise tramite Raccolte.
jobId (stringa): obbligatorio. Immetti l'ID del processo di cui desideri visualizzare i dettagli.
includeMessages (booleano): opzionale. È possibile non specificare nessun valore o selezionare "true" e "false". Se il parametro è impostato su "false", viene restituito un oggetto ridotto. Se non è specificato nessun valore, viene utilizzato "true".
curl -X 'GET' \
'http://localhost/webapi/v3/jobs/66ebd18d3d6200007e000d8c?includeMessages=true' \
-H 'accept: application/json' \
-H 'authorization: Bearer BearerTokenGoesHere'200: OK
{ "id": "string", "appId": "string", "createDateTime": "2024-09-19T10:02:54.589Z", "status": "string", "disposition": "string", "outputs": [ { "id": "string", "availableFormats": [ "string" ], "fileName": "string" } ], "messages": [ { "status": 0, "text": "string", "toolId": 0 } ], "priority": "Default", "workerTag": "string", "runWithE2": true }401: Unauthorized
404: NotFound
Per recuperare tutti i messaggi su un processo specifico, utilizza l'endpoint GET {baseURL}/v3/jobs/{jobId}/messages.
Nota
Solo gli amministratori possono usare questo endpoint.
jobId (stringa): obbligatorio. Immetti l'ID del processo di cui desideri visualizzare i messaggi.
curl -X 'GET' \
'http://localhost/webapi/v3/jobs/66ebd18d3d6200007e000d8c/messages' \
-H 'accept: application/json' \
-H 'authorization: Bearer BearerTokenGoesHere'200: OK
{ "status": 0, "text": "string", "toolId": 0 }401: Unauthorized
404: NotFound
Per annullare un processo specifico, utilizza l'endpoint DELETE {baseURL}/v3/jobs/{jobId}. Il lavoro deve essere nello stato "In coda" o "In esecuzione".
Se annulli un processo in esecuzione, questo viene annullato. Se annulli un processo in coda, questo viene eliminato.
Nota
I curatori possono annullare qualsiasi processo, mentre altri ruoli possono annullare i lavori che loro stessi hanno creato, attivato o pianificato.
Altri ruoli possono annullare i processi creati, attivati o pianificati. Sono inclusi i processi condivisi con loro tramite raccolte, anche se non sono proprietari del processo.
jobId (stringa): obbligatorio. Immetti l'ID del processo che desideri annullare.
curl -X 'DELETE' \
'http://localhost/webapi/v3/jobs/678f97baa15300008c0039fc' \
-H 'accept: application/json' \
-H 'authorization: Bearer BearerTokenGoesHere'200: OK
Risposta quando annulli un processo in esecuzione:
{ "message": "Cancelled Successfully." }Risposta quando annulli un processo in coda:
{ "message": "Deleted Successfully." }
400: BadRequest
Risposta quando il processo non ha lo stato "In coda" o "In esecuzione":
{ "message": "This job is not in 'Queued' or 'Running' state." }Risposta quando l'utente che effettua la chiamata API non dispone dell'autorizzazione per annullare il processo:
{ "message": "You do not have permission to cancel this job." }
401: Unauthorized
404: NotFound
Per avere informazioni su un processo specifico, hai bisogno di un parametro jobId. Per ottenere il parametro jobId, utilizza l'endpoint GET {baseURL}/v3/workflows/{workflowId}/jobs. Per ulteriori informazioni su questo endpoint, consulta la pagina di assistenza Endpoint del flusso di lavoro.
Per ulteriori informazioni sulle richieste Postman, consulta la pagina di assistenza Come utilizzare Postman.