Job Router Operations - Close Job

Usługa:

Communication

Wersja interfejsu API:

2023-11-01

Zamyka ukończone zadanie.

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
assignmentId	path	True	string	Identyfikator przypisania zadania.
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
closeAt	string	Jeśli nie zostanie podana, pojemność procesu roboczego zostanie zwolniona natychmiast wraz z powiadomieniem JobClosedEvent. Jeśli zostanie podana, pojemność procesu roboczego zostanie zwolniona wraz z powiadomieniem JobClosedEvent o przyszłej godzinie w formacie UTC.
dispositionCode	string	Wskazuje wynik zadania, wypełnij to pole własnymi wartościami niestandardowymi.
note	string	Uwaga, która zostanie dołączona do kolekcji Notatki zadania z bieżącym znacznikiem czasu.

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

Zabezpieczenia

AadOauth2Auth

Przepływ OAuth2 usługi Azure Active Directory

Typ: oauth2
Flow: accessCode
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/authorize
Adres URL tokenu: https://login.microsoftonline.com/common/oauth2/token

Zakresy

Nazwa	Opis
https://communication.azure.com/.default

Przykłady

Closes a completed job

Przykładowe żądanie

HTTP

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"
}

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 dotyczącymi interfejsu MICROSOFT One API — https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
CloseJobOptions	Żądanie ładunku dla zamykających zadań

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 dotyczącymi interfejsu MICROSOFT One API — 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.

CloseJobOptions

Żądanie ładunku dla zamykających zadań

Nazwa	Typ	Opis
closeAt	string	Jeśli nie zostanie podana, pojemność procesu roboczego zostanie zwolniona natychmiast wraz z powiadomieniem JobClosedEvent. Jeśli zostanie podana, pojemność procesu roboczego zostanie zwolniona wraz z powiadomieniem JobClosedEvent o przyszłej godzinie w formacie UTC.
dispositionCode	string	Wskazuje wynik zadania, wypełnij to pole własnymi wartościami niestandardowymi.
note	string	Uwaga, która zostanie dołączona do kolekcji Notatki zadania z bieżącym znacznikiem czasu.