機械翻訳について

移動先

• リクエスト
• レスポンス
• 例

公開ジョブの読取りステータス

get

/content/management/api/v1.1/taxonomies/{id}/publish/{jobTokenId}

タクソノミを公開しているジョブのステータスを読みます。

リクエスト

パス・パラメータ

• id: string
  タクソノミのId。
• jobTokenId: string
  ジョブのid。

問合せパラメータ

• links(optional): string
  このパラメータは、リンク名のカンマ区切りのリストを受け入れます。 デフォルトでは、このパラメータによって、適用可能なすべてのリンクが指定されます。 可能な値は次のとおりです: self, canonical, describedby

トップに戻る

レスポンス

サポートされているメディア・タイプ

• application/json

200レスポンス

OK。

本文()

ルート・スキーマ: Status

型: object

ステータス

ソースを表示

• completed(optional): boolean
  元のリクエストが完了しているかどうか
• completedPercentage(optional): integer(int32)
  プロセスの完了数を取得し、0から100までの数値。
• endTime(optional): object date
  date
• error(optional): object Error
  エラー
• id(optional): string
  元のリクエストのステータスid。 これはレスポンス取得の必須プロパティです。
• links(optional): array links
  ステータス・リソースのリンク
• message(optional): string
  現在の処理ステータスに関する人間が読むことができるメッセージ
• progress(optional): string
  許容値: [ "succeeded", "failed", "processing", "pending", "aborted", "paused", "blocked" ]

  元のリクエストの現在の進行状況。 これはレスポンス取得の必須プロパティです。
• requestStatus(optional): integer(int32)
  元のリクエストのHTTPステータス・コード。 これはポーリング・リクエストのステータスではありません。 値はリクエストが完了した後にのみ使用できます
• result(optional): object ResultObject
  結果
• startTime(optional): object date
  date

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"status id of the original request. It is a required property in the get response."
        },
        "startTime":{
            "description":"Time when the original request started",
            "$ref":"#/definitions/date"
        },
        "endTime":{
            "description":"Time when the original request ended",
            "$ref":"#/definitions/date"
        },
        "progress":{
            "type":"string",
            "description":"The current progress of the original request. It is a required property in the get response.",
            "enum":[
                "succeeded",
                "failed",
                "processing",
                "pending",
                "aborted",
                "paused",
                "blocked"
            ]
        },
        "completed":{
            "type":"boolean",
            "description":"Whether the original request is completed or not"
        },
        "message":{
            "type":"string",
            "description":"Human readable message about the current processing status"
        },
        "completedPercentage":{
            "type":"integer",
            "format":"int32",
            "description":"A number between 0 and 100, capturing how much of the process has been completed."
        },
        "requestStatus":{
            "type":"integer",
            "format":"int32",
            "description":"HTTP status code of the original request. This is not the polling request's status. Value is available only after the request is completed"
        },
        "result":{
            "description":"The response when the original async request finishes",
            "$ref":"#/definitions/ResultObject"
        },
        "error":{
            "description":"contains error detail of the original request. This is only available when the original request is processed and failed",
            "$ref":"#/definitions/Error"
        },
        "links":{
            "type":"array",
            "description":"links of the status resource",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    },
    "description":"Status"
}

ネストされたスキーマ : date

型: object

date

ソースを表示

• timezone(optional): string
• value(optional): string

{
    "type":"object",
    "properties":{
        "value":{
            "type":"string"
        },
        "timezone":{
            "type":"string"
        }
    },
    "description":"date"
}

ネストされたスキーマ: Error

型: object

エラー

ソースを表示

• detail(optional): string
  詳細なエラー・メッセージ
• instance(optional): string
  エラーに関する詳細を提供するリンクへのURI。
• o:errorCode(optional): string
  アプリケーション固有のエラー・コード。
• o:errorDetails(optional): object Error
  エラー
• o:errorPath(optional): string
  エラーが発生した場所を示すXPathまたはJSONのパス
• status(optional): integer(int32)
  HTTPステータス・コード。
• title(optional): string
  要約エラー・メッセージ。 これはレスポンス取得の必須プロパティです。
• type(optional): string
  HTTPエラー・コード・ページにリンクします。 これはレスポンス取得の必須プロパティです。

{
    "type":"object",
    "properties":{
        "title":{
            "type":"string",
            "description":"Summary error message. It is a required property in the get response."
        },
        "detail":{
            "type":"string",
            "description":"Detailed error message."
        },
        "status":{
            "type":"integer",
            "format":"int32",
            "description":"HTTP status code."
        },
        "type":{
            "type":"string",
            "description":"Link to HTTP error code page. It is a required property in the get response."
        },
        "o:errorCode":{
            "type":"string",
            "description":"Application specific error code."
        },
        "o:errorDetails":{
            "description":"Drill down to the details. Multiple errors can be organized in a hierarchical structure.",
            "$ref":"#/definitions/Error"
        },
        "o:errorPath":{
            "type":"string",
            "description":"XPath or JSON patch to indicate where the error occurs."
        },
        "instance":{
            "type":"string",
            "description":"URI to the link that provides more detail about the error."
        }
    },
    "description":"Error"
}

ネストされたスキーマ: links

型: array

ステータス・リソースのリンク

ソースを表示

• Array of: object Link
  リソースのリンク。

{
    "type":"array",
    "description":"links of the status resource",
    "items":{
        "$ref":"#/definitions/Link"
    }
}

ネストされたスキーマ : ResultObject

型: object

結果

ソースを表示

• body(optional): object body
  元の非同期リクエストへのレスポンスのHTTP本文
• headers(optional): array headers
  元の非同期リクエストへのレスポンスのHTTPヘッダーのリスト
• status(optional): object ResultHTTPStatus
  ResultHTTPStatus

{
    "type":"object",
    "properties":{
        "status":{
            "description":"HTTP status line of the response to the original async request",
            "$ref":"#/definitions/ResultHTTPStatus"
        },
        "headers":{
            "type":"array",
            "description":"List of the HTTP headers of the response to the original async request",
            "items":{
                "$ref":"#/definitions/ResultHTTPHeader"
            }
        },
        "body":{
            "type":"object",
            "description":"HTTP body of the response to the original async request"
        }
    },
    "description":"Result"
}

ネストされたスキーマ: Link

型: object

リソースのリンク。

ソースを表示

• href(optional): string
  ターゲット・リソースのURI それはテンプレートURIである可能性があります。 これはレスポンス取得の必須プロパティです。
• mediaType(optional): string
  メディア・タイプ。
• method(optional): string
  ターゲット・リソースへのアクセスに使用できるHTTPメソッド。
• profile(optional): string
  ターゲット・リソースを記述するメタデータにリンクします。
• rel(optional): string
  関連タイプ これはレスポンス取得の必須プロパティです。
• templated(optional): boolean
  URIがテンプレートであるかどうか。

{
    "type":"object",
    "properties":{
        "href":{
            "type":"string",
            "description":"The target resource's URI. It could be template URI. It is a required property in the get response."
        },
        "rel":{
            "type":"string",
            "description":"Relation type. It is a required property in the get response."
        },
        "templated":{
            "type":"boolean",
            "description":"Whether the URI is a template."
        },
        "method":{
            "type":"string",
            "description":"What HTTP method can be used to access the target resource."
        },
        "profile":{
            "type":"string",
            "description":"Link to the metadata that describes the target resource."
        },
        "mediaType":{
            "type":"string",
            "description":"Media type."
        }
    },
    "description":"Link of the resource."
}

ネストされたスキーマ : body

型: object

元の非同期リクエストへのレスポンスのHTTP本文

ネストされたスキーマ: headers

型: array

元の非同期リクエストへのレスポンスのHTTPヘッダーのリスト

ソースを表示

• Array of: object ResultHTTPHeader
  ResultHTTPHeader

{
    "type":"array",
    "description":"List of the HTTP headers of the response to the original async request",
    "items":{
        "$ref":"#/definitions/ResultHTTPHeader"
    }
}

ネストされたスキーマ : ResultHTTPStatus

型: object

ResultHTTPStatus

ソースを表示

• code(optional): integer(int32)
  HTTPレスポンス・ステータス・コード
• reason(optional): string
  HTTPレスポンス理由フレーズ

{
    "type":"object",
    "properties":{
        "code":{
            "type":"integer",
            "format":"int32",
            "description":"HTTP response status code"
        },
        "reason":{
            "type":"string",
            "description":"HTTP response reason phrase"
        }
    },
    "description":"ResultHTTPStatus"
}

ネストされたスキーマ : ResultHTTPHeader

型: object

ResultHTTPHeader

ソースを表示

• name(optional): string
  HTTPレスポンス・ヘッダー名
• value(optional): string
  HTTPレスポンス・ヘッダー値

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"HTTP response header name"
        },
        "value":{
            "type":"string",
            "description":"HTTP response header value"
        }
    },
    "description":"ResultHTTPHeader"
}

304 レスポンス

変更されていません。

400レスポンス

不正リクエスト

403レスポンス

禁止。

404レスポンス

ジョブが見つかりません。 リクエストされたリソースがシステムに見つかりません。

500レスポンス

内部サーバー・エラー

トップに戻る

例

次の例は、cURLを使用してGETリクエストを発行することによって、タクソノミを公開しているジョブのステータスを読み取る方法を示しています:

curl -X GET -H 'Accept: application/json' 'https://host:port/content/management/api/v1.1/taxonomies/{id}/publish/{jobTokenID}'

例:

これにより、公開ジョブのステータスが返されます。

/content/management/api/v1.1/taxonomies/D7969D6CA0D144AEA9CCA88BA6D2CF81/publish/OPC7FC2C6D7A8944689E775CCB24313DE3

レスポンス本文

{
  "id": "OPC7FC2C6D7A8944689E775CCB24313DE3",
  "startTime": {
    "value": "2019-02-06T01:11:35.304Z",
    "timezone": "UTC"
  },
  "endTime": {
    "value": "2019-02-06T01:11:35.591Z",
    "timezone": "UTC"
  },
  "progress": "succeeded",
  "completed": true,
  "message": "Job Completed Successfully",
  "completedPercentage": 100,
  "result": {
    "status": {
      "code": 200,
      "reason": ""
    },
    "headers": [],
    "body": {
      "id": "D7969D6CA0D144AEA9CCA88BA6D2CF81",
      "name": "Taxonomy for Publishing",
      "description": "Taxonomy description",
      "shortName": "T3",
      "status": "promoted",
      "version": 7,
      "isPublishable": true,
      "isForSiteManagement": false,
      "availableStates": [
        {
          "status": "promoted",
          "version": 7,
          "published": true
        },
        {
          "status": "draft",
          "published": false
        }
      ],
      "publishedChannels": [
        {
          "id": "CC59073EACA4A56A990700ADEB643CAB64E62AA2CC55",
          "name": "Channel 02"
        }
      ],
      "createdBy": "cecsusername",
      "createdDate": {
        "value": "2019-02-01T17:50:26.936Z",
        "timezone": "UTC"
      },
      "updatedBy": "cecsusername",
      "updatedDate": {
        "value": "2019-02-06T01:11:35.483Z",
        "timezone": "UTC"
      }
    }
  },
  "links": [
    {
      "href": "https://<hostname>/content/management/api/v1.1/taxonomies/D7969D6CA0D144AEA9CCA88BA6D2CF81/publish/OPC7FC2C6D7A8944689E775CCB24313DE3",
      "rel": "self",
      "method": "GET",
      "mediaType": "application/json"
    },
    {
      "href": "https://<hostname>/content/management/api/v1.1/taxonomies/D7969D6CA0D144AEA9CCA88BA6D2CF81/publish/OPC7FC2C6D7A8944689E775CCB24313DE3",
      "rel": "canonical",
      "method": "GET",
      "mediaType": "application/json"
    },
    {
      "href": "https://<hostname>/content/management/api/v1.1/metadata-catalog/taxonomies/D7969D6CA0D144AEA9CCA88BA6D2CF81/publish/OPC7FC2C6D7A8944689E775CCB24313DE3",
      "rel": "describedby",
      "method": "GET",
      "mediaType": "application/schema+json"
    }
  ]
}

先頭に戻る