Job Router Operations - Close Job

  • Riferimento
Servizio:
Communication
Versione API:
2023-11-01

Chiude un processo completato.

POST {endpoint}/routing/jobs/{jobId}/assignments/{assignmentId}:close?api-version=2023-11-01

Parametri dell'URI

Nome In Necessario Tipo Descrizione
assignmentId
 path True

string

ID di un'assegnazione di processo.
endpoint
 path True

string

Uri della risorsa di comunicazione
jobId
 path True

string

ID di un processo.
api-version
 query True

string

Versione dell'API da usare per questa operazione.

Corpo della richiesta

Nome Tipo Descrizione
closeAt

string

In caso contrario, la capacità di lavoro viene rilasciata immediatamente insieme a una notifica JobClosedEvent. Se specificato, la capacità di lavoro viene rilasciata insieme a una notifica JobClosedEvent in un momento futuro in formato UTC.
dispositionCode

string

Indica il risultato di un processo, popolare questo campo con i propri valori personalizzati.
note

string

Si noti che verrà aggiunto all'insieme Notes di un processo con il timestamp corrente.

Risposte

Nome Tipo Descrizione
200 OK

object

La richiesta ha avuto esito positivo.
Other Status Codes

Azure.Core.Foundations.ErrorResponse

Risposta di errore imprevista.

Intestazioni

x-ms-error-code: string

Esempio

Closes a completed job

Esempio di richiesta

POST https://contoso.westus.communications.azure.com/routing/jobs/8780b28c-7079-4de1-9143-4d369289e958/assignments/1d5896f3-8b54-40be-82d3-910323f5e2af:close?api-version=2023-11-01

{
  "dispositionCode": "JobCompleted.",
  "note": "Closing job"
}

Risposta di esempio

Codice di stato:
200 
{}

Definizioni

Nome Descrizione
Azure.Core.Foundations.Error

Oggetto error.
Azure.Core.Foundations.ErrorResponse

Risposta contenente i dettagli dell'errore.
Azure.Core.Foundations.InnerError

Oggetto contenente informazioni più specifiche sull'errore. In base alle linee guida per l'API Microsoft One - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
CloseJobOptions

Richiedere payload per la chiusura dei processi

Azure.Core.Foundations.Error

Oggetto error.

Nome Tipo Descrizione
code

string

Uno di un set definito dal server di codici di errore.
details

Azure.Core.Foundations.Error[]

Matrice di dettagli sugli errori specifici che hanno causato l'errore segnalato.
innererror

Azure.Core.Foundations.InnerError

Oggetto contenente informazioni più specifiche dell'oggetto corrente sull'errore.
message

string

Rappresentazione leggibile dell'errore.
target

string

Destinazione dell'errore.

Azure.Core.Foundations.ErrorResponse

Risposta contenente i dettagli dell'errore.

Nome Tipo Descrizione
error

Azure.Core.Foundations.Error

Oggetto error.

Azure.Core.Foundations.InnerError

Oggetto contenente informazioni più specifiche sull'errore. In base alle linee guida per l'API Microsoft One - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Nome Tipo Descrizione
code

string

Uno di un set definito dal server di codici di errore.
innererror

Azure.Core.Foundations.InnerError

Errore interno.

CloseJobOptions

Richiedere payload per la chiusura dei processi

Nome Tipo Descrizione
closeAt

string

In caso contrario, la capacità di lavoro viene rilasciata immediatamente insieme a una notifica JobClosedEvent. Se specificato, la capacità di lavoro viene rilasciata insieme a una notifica JobClosedEvent in un momento futuro in formato UTC.
dispositionCode

string

Indica il risultato di un processo, popolare questo campo con i propri valori personalizzati.
note

string

Si noti che verrà aggiunto all'insieme Notes di un processo con il timestamp corrente.