Job Router Operations - Cancel Job

Usługa:

Communication

Wersja interfejsu API:

2023-11-01

Przesyła żądanie anulowania istniejącego zadania według identyfikatora podczas podawania przyczyny anulowania w formie bezpłatnej.

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
endpoint	path	True	string	Identyfikator URI zasobu komunikacji
jobId	path	True	string	Identyfikator zadania.
api-version	query	True	string	Wersja interfejsu API do użycia dla tej operacji.

Treść żądania

Nazwa	Typ	Opis
dispositionCode	string	Wskazuje wynik zadania, wypełnij to pole własnymi wartościami niestandardowymi. Jeśli nie zostanie podana, zostanie ustawiona domyślna wartość "Anulowane".
note	string	Uwaga, która zostanie dołączona do kolekcji Notatek zadania z bieżącą sygnaturą czasową.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	object	Żądanie zakończyło się pomyślnie.
Other Status Codes	Azure.Core.Foundations.ErrorResponse	Nieoczekiwana odpowiedź na błąd. Nagłówki x-ms-error-code: string

Przykłady

Cancels a job

Submits request to cancel an existing job

Cancels a job

Przykładowe żądanie

HTTP

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

{}

Przykładowa odpowiedź

Kod stanu:

200

{}

Submits request to cancel an existing job

Przykładowe żądanie

HTTP

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

Przykładowa odpowiedź

Kod stanu:

200

{}

Definicje

Nazwa	Opis
Azure.Core.Foundations.Error	Obiekt błędu.
Azure.Core.Foundations.ErrorResponse	Odpowiedź zawierająca szczegóły błędu.
Azure.Core.Foundations.InnerError	Obiekt zawierający bardziej szczegółowe informacje o błędzie. Zgodnie z wytycznymi interfejsu API usługi Microsoft One — https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
CancelJobOptions	Zażądaj ładunku w celu anulowania zadania.

Azure.Core.Foundations.Error

Obiekt błędu.

Nazwa	Typ	Opis
code	string	Jeden z zdefiniowanych przez serwer zestaw kodów błędów.
details	Azure.Core.Foundations.Error[]	Tablica szczegółów dotyczących określonych błędów, które doprowadziły do tego zgłoszonego błędu.
innererror	Azure.Core.Foundations.InnerError	Obiekt zawierający bardziej szczegółowe informacje niż bieżący obiekt o błędzie.
message	string	Czytelna dla człowieka reprezentacja błędu.
target	string	Element docelowy błędu.

Azure.Core.Foundations.ErrorResponse

Odpowiedź zawierająca szczegóły błędu.

Nazwa	Typ	Opis
error	Azure.Core.Foundations.Error	Obiekt błędu.

Azure.Core.Foundations.InnerError

Obiekt zawierający bardziej szczegółowe informacje o błędzie. Zgodnie z wytycznymi interfejsu API usługi Microsoft One — https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Nazwa	Typ	Opis
code	string	Jeden z zdefiniowanych przez serwer zestaw kodów błędów.
innererror	Azure.Core.Foundations.InnerError	Błąd wewnętrzny.

CancelJobOptions

Zażądaj ładunku w celu anulowania zadania.

Nazwa	Typ	Opis
dispositionCode	string	Wskazuje wynik zadania, wypełnij to pole własnymi wartościami niestandardowymi. Jeśli nie zostanie podana, zostanie ustawiona domyślna wartość "Anulowane".
note	string	Uwaga, która zostanie dołączona do kolekcji Notatek zadania z bieżącą sygnaturą czasową.