Job Router Operations - Cancel Job

서비스:

Communication

API 버전:

2023-11-01

자유 형식 취소 이유를 제공하면서 ID별로 기존 작업을 취소하라는 요청을 제출합니다.

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

URI 매개 변수

Name	In(다음 안에)	필수	형식	Description
endpoint	path	True	string	통신 리소스의 URI
jobId	path	True	string	작업의 ID입니다.
api-version	query	True	string	이 작업에 사용할 API 버전입니다.

요청 본문

Name	형식	Description
dispositionCode	string	작업의 결과를 나타내고 이 필드를 사용자 고유의 사용자 지정 값으로 채웁습니다. 제공되지 않으면 기본값인 "Canceled"가 설정됩니다.
note	string	현재 타임스탬프가 있는 작업의 Notes 컬렉션에 추가될 메모입니다.

응답

Name	형식	Description
200 OK	object	요청이 성공했습니다.
Other Status Codes	Azure.Core.Foundations.ErrorResponse	예기치 않은 오류 응답입니다. 헤더 x-ms-error-code: string

예제

Cancels a job

Submits request to cancel an existing job

Cancels a job

샘플 요청

HTTP

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

{}

샘플 응답

상태 코드:

200

{}

Submits request to cancel an existing job

샘플 요청

HTTP

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

샘플 응답

상태 코드:

200

{}

정의

Name	Description
Azure.Core.Foundations.Error	Error 개체.
Azure.Core.Foundations.ErrorResponse	오류 세부 정보가 포함된 응답입니다.
Azure.Core.Foundations.InnerError	오류에 대한 보다 구체적인 정보를 포함하는 개체입니다. Microsoft One API 지침에 따라 - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
CancelJobOptions	작업을 취소하기 위한 페이로드를 요청합니다.

Azure.Core.Foundations.Error

Error 개체.

Name	형식	Description
code	string	서버 정의 오류 코드 집합 중 하나입니다.
details	Azure.Core.Foundations.Error[]	이 보고된 오류로 이어진 특정 오류에 대한 세부 정보 배열입니다.
innererror	Azure.Core.Foundations.InnerError	오류에 대한 현재 개체보다 더 구체적인 정보를 포함하는 개체입니다.
message	string	사람이 읽을 수 있는 오류 표현입니다.
target	string	오류의 대상입니다.

Azure.Core.Foundations.ErrorResponse

오류 세부 정보가 포함된 응답입니다.

Name	형식	Description
error	Azure.Core.Foundations.Error	Error 개체.

Azure.Core.Foundations.InnerError

오류에 대한 보다 구체적인 정보를 포함하는 개체입니다. Microsoft One API 지침에 따라 - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Name	형식	Description
code	string	서버 정의 오류 코드 집합 중 하나입니다.
innererror	Azure.Core.Foundations.InnerError	내부 오류입니다.

CancelJobOptions

작업을 취소하기 위한 페이로드를 요청합니다.

Name	형식	Description
dispositionCode	string	작업의 결과를 나타내고 이 필드를 사용자 고유의 사용자 지정 값으로 채웁습니다. 제공되지 않으면 기본값인 "Canceled"가 설정됩니다.
note	string	현재 타임스탬프가 있는 작업의 Notes 컬렉션에 추가될 메모입니다.