Skip to main content

作业端点

作业端点和参数

检索有关特定作业的详细信息

检索特定作业的消息

要详细了解对象关系以及如何在 API 中使用对象关系，请转至对象关系部分。

如需详细了解作业，请访问作业：管理员界面帮助页面。

检索有关特定作业的详细信息

要检索有关现有作业及其当前状态的详细信息，请使用 GET {baseURL}/v3/jobs/{jobId} 端点。使用各种参数筛选要显示的作业。

注意

只能使用应用程序工作流。

用户能够看到他们运行的作业以及按照通过集合共享的计划运行的作业。

参数

  • jobId (string)：必填。输入要显示其详细信息的作业 ID。

  • includeMessages (boolean)：可选。可以保留此参数但不为其提供值。您可以从以下值中选择：“true”和“false”。如果此参数设置为“false”，则将返回一个减小的对象。如果未指定，则将使用“true”值。

请求示例：cURL

curl -X 'GET' \
  'http://localhost/webapi/v3/jobs/66ebd18d3d6200007e000d8c?includeMessages=true' \
  -H 'accept: application/json' \
  -H 'authorization: Bearer BearerTokenGoesHere'

响应示例

  • 200：请求成功

    {
  "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：未授权

  • 404：未找到

检索特定作业的消息

要检索特定作业的所有消息，请使用 GET {baseURL}/v3/jobs/{jobId}/messages 端点。

注意

只有管理员才能使用此端点。

参数

  • jobId (string)：必填。输入要显示其消息的作业 ID。

请求示例：cURL

curl -X 'GET' \
  'http://localhost/webapi/v3/jobs/66ebd18d3d6200007e000d8c/messages' \
  -H 'accept: application/json' \
  -H 'authorization: Bearer BearerTokenGoesHere'

响应示例

  • 200：请求成功

    {
  "status": 0,
  "text": "string",
  "toolId": 0
}

  • 401：未授权

  • 404：未找到

对象关系

如果要获取有关特定作业的信息，则需要 jobId。要获取此 jobId，请使用 GET {baseURL}/v3/workflows/{workflowId}/jobs 端点。如需详细了解此端点，请参阅 工作流端点 帮助页面。

Postman 请求

如需详细了解有关 Postman 请求的更多信息，请访问如何使用 Postman 帮助页面。

本节内容如下: