作业端点
作业端点和参数
要详细了解对象关系以及如何在 API 中使用对象关系，请转至对象关系部分。
如需详细了解作业，请访问作业：管理员界面帮助页面。
检索所有作业的详细信息
要检索所有作业及其当前状态的详细信息，请使用 GET {baseURL}/v3/jobs 端点。使用各种参数筛选要显示的作业。
注意
只有管理员才能使用此端点。
参数
sortField (string)：可选。按以下允许的值对结果进行排序：
创建日期、应用程序名称、完成日期时间、优先级、状态。direction (string)：可选。按升序或降序排序。允许的值包括：
升序或降序。offset (string)：可选。输入分页偏移量。
limit (string)：可选。输入分页限制数。
priorities (string)：可选。要按作业优先级筛选，请输入以下任一或多个值：
低、中、高、关键和数值。状态（字符串）：可选。要按状态筛选，请输入以下一个或多个值：
排除、正在初始化、正在运行和完成。用户（字符串）：可选。要按用户筛选，请输入有效的
用户 ID。仅当“所有用户 = true”时才筛选。所有用户（布尔值）：可选。要包含所有用户，请选择
true。工作流名称（字符串）：可选。要按工作流名称筛选，请输入一个或多个
工作流名称。完成截止日期（字符串）：可选。返回在指定日期之前完成的作业。不包括在指定日期完成的作业。要求的格式为：年-月-日。
完成开始日期（字符串）：可选。返回在指定日期之后完成的作业。不包括在指定日期完成的作业。要求的格式为：年-月-日。
curl -X 'GET' \ 'http://localhost/webapi/v3/jobs' \ -H 'accept: application/json' \ -H 'authorization: Bearer BearerTokenGoesHere'
200: OK
{ "data": [ { "jobId": "68dd3292c97fddfcc003adcb", "status": "Completed", "workflowName": "Workflow1.yxmd", "workflowId": "68dd32922a719467662d27c7", "submittedBy": "Jane Doe", "startTime": "2025-10-01T13:54:26Z", "queueTime": "2025-10-01T13:54:26Z", "executionTime": "00:00:02", "priority": "6" }, { "jobId": "68dd3336c97fddfcc003add2", "status": "Completed", "workflowName": "Workflow1", "workflowId": "68dd32922a719467662d27c7", "submittedBy": "Jane Doe", "startTime": "2025-10-01T13:57:10Z", "queueTime": "2025-10-01T13:57:10Z", "executionTime": "00:00:02", "priority": "Low" } ], "pagination": { "currentPage": 1, "pageSize": 50, "totalItems": 3, "totalPages": 1, "hasNextPage": false, "hasPreviousPage": false } }401: Unauthorized
检索有关特定作业的详细信息
要检索有关现有作业及其当前状态的详细信息，请使用 GET {baseURL}/v3/jobs/{jobId} 端点。使用各种参数筛选要显示的作业。
注意
只能使用应用程序工作流。
用户能够看到他们运行的作业以及按照通过 Collections（集合）共享的计划运行的作业。
参数
jobId (string)：必填。输入要显示其详细信息的作业 ID。
includeMessages (boolean)：可选。可以保留此参数但不为其提供值。您可以从以下值中选择：“true”和“false”。如果此参数设置为“false”，则将返回一个减小的对象。如果未指定，则将使用“true”值。
curl -X 'GET' \ 'http://localhost/webapi/v3/jobs/66ebd18d3d6200007e000d8c?includeMessages=true' \ -H 'accept: application/json' \ -H 'authorization: Bearer BearerTokenGoesHere'
200: OK
{ "id": "string", "appId": "string", "createDateTime": "2024-09-19T10:02:54.589Z", "status": "string", "disposition": "string", "outputs": [ { "id": "string", "availableFormats": [ "string" ], "fileName": "string" } ], "messages": [ { "status": 0, "text": "string", "toolId": 0 } ], "priority": "Default", "workerTag": "string", "runWithE2": true }401: Unauthorized
404: NotFound
检索特定作业的消息
要检索特定作业的所有消息，请使用 GET {baseURL}/v3/jobs/{jobId}/messages 端点。
注意
只有管理员才能使用此端点。
参数
jobId (string)：必填。输入要显示其消息的作业 ID。
curl -X 'GET' \ 'http://localhost/webapi/v3/jobs/66ebd18d3d6200007e000d8c/messages' \ -H 'accept: application/json' \ -H 'authorization: Bearer BearerTokenGoesHere'
200: OK
{ "status": 0, "text": "string", "toolId": 0 }401: Unauthorized
404: NotFound
取消特定作业
要取消特定作业，请使用 DELETE {baseURL}/v3/jobs/{jobId} 端点。作业必须处于“已排队”或“正在运行”状态。
如果取消正在运行的作业，该作业将被取消。如果您取消排队的作业，该作业将被删除。
注意
管理员可以取消任何作业。
其他角色可以取消他们创建、触发或计划的作业。它包括通过“集合”与他们共享的作业，即使他们不是作业所有者。
参数
jobId (string)：必填。输入要取消的作业 ID。
curl -X 'DELETE' \ 'http://localhost/webapi/v3/jobs/678f97baa15300008c0039fc' \ -H 'accept: application/json' \ -H 'authorization: Bearer BearerTokenGoesHere'
200: OK
取消正在运行的作业时的响应：
{ "message": "Cancelled Successfully." }取消排队作业时的响应：
{ "message": "Deleted Successfully." }
400: BadRequest
作业未处于“已排队”或“正在运行”状态时的响应：
{ "message": "This job is not in 'Queued' or 'Running' state." }当进行 API 调用的用户无权取消作业时的响应：
{ "message": "You do not have permission to cancel this job." }
401: Unauthorized
404: NotFound
对象关系
如果要获取有关特定作业的信息，则需要 jobId。要获取此 jobId，请使用 GET {baseURL}/v3/workflows/{workflowId}/jobs 端点。如需详细了解此端点，请参阅 工作流端点 帮助页面。
Postman 请求
如需详细了解有关 Postman 请求的更多信息，请访问如何使用 Postman 帮助页面。