你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Job Router Operations - Close Job

服务:

Communication

API 版本:

2023-11-01

关闭已完成的作业。

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

URI 参数

名称	在	必需	类型	说明
assignmentId	path	True	string	作业分配的 ID。
endpoint	path	True	string	通信资源的 URI
jobId	path	True	string	作业的 ID。
api-version	query	True	string	用于此操作的 API 版本。

请求正文

名称	类型	说明
closeAt	string	如果未提供，则会立即发布辅助角色容量以及 JobClosedEvent 通知。 如果提供，则辅助角色容量会在 UTC 的将来时间随 JobClosedEvent 通知一起发布。
dispositionCode	string	指示作业的结果，用自己的自定义值填充此字段。
note	string	将追加到具有当前时间戳的作业的 Notes 集合的注释。

响应

名称	类型	说明
200 OK	object	请求已成功。
Other Status Codes	Azure.Core.Foundations.ErrorResponse	意外的错误响应。 标头 x-ms-error-code: string

安全性

AadOauth2Auth

Azure Active Directory OAuth2 流

类型: oauth2
流向: accessCode
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize
令牌 URL: https://login.microsoftonline.com/common/oauth2/token

作用域

名称	说明
https://communication.azure.com/.default

示例

Closes a completed job

示例请求

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

示例响应

状态代码:

200

{}

定义

名称	说明
Azure.Core.Foundations.Error	错误对象。
Azure.Core.Foundations.ErrorResponse	包含错误详细信息的响应。
Azure.Core.Foundations.InnerError	包含有关错误的更具体信息的对象。 根据Microsoft一个 API 指南 - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses。
CloseJobOptions	关闭作业的请求有效负载

Azure.Core.Foundations.Error

错误对象。

名称	类型	说明
code	string	服务器定义的错误代码集之一。
details	Azure.Core.Foundations.Error[]	导致此报告错误的特定错误的详细信息数组。
innererror	Azure.Core.Foundations.InnerError	包含与当前对象有关错误的更具体信息的对象。
message	string	错误的人工可读表示形式。
target	string	错误的目标。

Azure.Core.Foundations.ErrorResponse

包含错误详细信息的响应。

名称	类型	说明
error	Azure.Core.Foundations.Error	错误对象。

Azure.Core.Foundations.InnerError

包含有关错误的更具体信息的对象。 根据Microsoft一个 API 指南 - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses。

名称	类型	说明
code	string	服务器定义的错误代码集之一。
innererror	Azure.Core.Foundations.InnerError	内部错误。

CloseJobOptions

关闭作业的请求有效负载

名称	类型	说明
closeAt	string	如果未提供，则会立即发布辅助角色容量以及 JobClosedEvent 通知。 如果提供，则辅助角色容量会在 UTC 的将来时间随 JobClosedEvent 通知一起发布。
dispositionCode	string	指示作业的结果，用自己的自定义值填充此字段。
note	string	将追加到具有当前时间戳的作业的 Notes 集合的注释。