Job Router Operations - Cancel Job

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

Invia una richiesta di annullamento di un processo esistente in base all'ID durante la fornitura di un motivo di annullamento in formato libero.

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

Parametri dell'URI

Nome In Necessario Tipo Descrizione
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
dispositionCode

string

Indica il risultato di un processo, popolare questo campo con valori personalizzati. Se non specificato, viene impostato il valore predefinito "Cancelled".
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

Cancels a job
Submits request to cancel an existing job

Cancels a job

Esempio di richiesta

POST https://contoso.westus.communications.azure.com/routing/jobs/8780b28c-7079-4de1-9143-4d369289e958:cancel?api-version=2023-11-01

{}

Risposta di esempio

Codice di stato:
200 
{}

Submits request to cancel an existing job

Esempio di richiesta

POST https://contoso.westus.communications.azure.com/routing/jobs/8780b28c-7079-4de1-9143-4d369289e958:cancel?api-version=2023-11-01

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 dell'API Microsoft One - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
CancelJobOptions

Richiedere il payload per l'annullamento di un processo.

Azure.Core.Foundations.Error

Oggetto error.

Nome Tipo Descrizione
code

string

Uno dei set definiti dal server di codici di errore.
details

Azure.Core.Foundations.Error[]

Matrice di dettagli sugli errori specifici che hanno causato questo 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 dell'API Microsoft One - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Nome Tipo Descrizione
code

string

Uno dei set definiti dal server di codici di errore.
innererror

Azure.Core.Foundations.InnerError

Errore interno.

CancelJobOptions

Richiedere il payload per l'annullamento di un processo.

Nome Tipo Descrizione
dispositionCode

string

Indica il risultato di un processo, popolare questo campo con valori personalizzati. Se non specificato, viene impostato il valore predefinito "Cancelled".
note

string

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