Skip to main content

Endpoint dei processi

Endpoint e parametri dei processi

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.

Recupero dei dettagli di un processo specifico

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 utilizza solo i flussi di lavoro delle app.

Gli utenti possono visualizzare i lavori eseguiti da loro e quelli eseguiti su pianificazioni condivise tramite Raccolte.

Parametri

  • jobId (stringa): obbligatorio. Immetti l'ID del processo di cui desideri visualizzare i dettagli.

  • includeMessages (booleano): facoltativo. È 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".

Esempio di richiesta: cURL

curl -X 'GET' \
  'http://localhost/webapi/v3/jobs/66ebd18d3d6200007e000d8c?includeMessages=true' \
  -H 'accept: application/json' \
  -H 'authorization: Bearer BearerTokenGoesHere'

Esempio di risposta

  • 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: Autorizzazione negata

  • 404: NotFound

Recupero dei messaggi di un processo specifico

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.

Parametri

  • jobId (stringa): obbligatorio. Immetti l'ID del processo di cui desideri visualizzare i messaggi.

Esempio di richiesta: cURL

curl -X 'GET' \
  'http://localhost/webapi/v3/jobs/66ebd18d3d6200007e000d8c/messages' \
  -H 'accept: application/json' \
  -H 'authorization: Bearer BearerTokenGoesHere'

Esempio di risposta

  • 200: OK

    {
  "status": 0,
  "text": "string",
  "toolId": 0
}

  • 401: Autorizzazione negata

  • 404: NotFound

Relazioni tra oggetti

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.

Richieste Postman

Per ulteriori informazioni sulle richieste Postman, consulta la pagina di assistenza Come utilizzare Postman.

In questa sezione: