機械翻訳について

移動先

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

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

get

/content/management/api/v1.1/personalization/recommendations/{id}/publish/{statusId}

推奨を公開しているジョブのステータスを読みます。

リクエスト

パス・パラメータ

• id: string
  推奨のId。
• statusId: string
  推奨公開操作のステータスId。

問合せパラメータ

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

トップに戻る

レスポンス

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

• application/json

200レスポンス

OK。

本文()

ルート・スキーマ : RecommendationPublishJobStatus

型: object

RecommendationPublishJobStatus

ソースを表示

• 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 ResultRecommendationPublishResult
  結果
• 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/ResultRecommendationPublishResult"
        },
        "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":"RecommendationPublishJobStatus"
}

ネストされたスキーマ : 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"
    }
}

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

型: object

結果

ソースを表示

• body(optional): object RecommendationPublishResult
  推奨公開結果
• 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":{
            "description":"HTTP body of the response to the original async request",
            "$ref":"#/definitions/RecommendationPublishResult"
        }
    },
    "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."
}

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

型: object

推奨公開結果

ソースを表示

• allowUnpublishFromActiveSite(optional): boolean
  アクティブなサイト・アイテムをunpublished.(defaults to false)にするかどうか。
• channels(optional): array channels
  公開取消チャネルのリスト。 チャネルが空でない場合、q内のアイテムは指定されたチャネルに対する公開が取り消されます。 チャネルが空の場合、q当たりのすべてのアイテムは、ターゲット対象の各チャネルに対して非公開になります。
• ids(optional): array ids
  詳細な未公開アイテムidのリンク。
• items(optional): array items
• links(optional): array links
  推奨公開操作のリソースのリンク。

{
    "type":"object",
    "properties":{
        "links":{
            "type":"array",
            "description":"Links of the Recommendation publish operations resource.",
            "items":{
                "$ref":"#/definitions/Link"
            }
        },
        "channels":{
            "type":"array",
            "description":"List of unpublish channels. If channels is not empty, items in the q are unpublished to the given channels. If the channels is empty, all the items as per q are unpublished to their respective targeted channels.",
            "items":{
                "$ref":"#/definitions/ChannelId"
            }
        },
        "allowUnpublishFromActiveSite":{
            "type":"boolean",
            "description":"whether to allow active site items to be unpublished.(defaults to false)"
        },
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ItemId"
            }
        },
        "ids":{
            "type":"array",
            "description":"links of the detailed unpublished item ids.",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    },
    "description":"Recommendation Publish Result"
}

ネストされたスキーマ: 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"
}

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

型: array

公開取消チャネルのリスト。 チャネルが空でない場合、q内のアイテムは指定されたチャネルに対する公開が取り消されます。 チャネルが空の場合、q当たりのすべてのアイテムは、ターゲット対象の各チャネルに対して非公開になります。

ソースを表示

• Array of: object ChannelId
  ChannelId

{
    "type":"array",
    "description":"List of unpublish channels. If channels is not empty, items in the q are unpublished to the given channels. If the channels is empty, all the items as per q are unpublished to their respective targeted channels.",
    "items":{
        "$ref":"#/definitions/ChannelId"
    }
}

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

型: array

詳細な未公開アイテムidのリンク。

ソースを表示

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

{
    "type":"array",
    "description":"links of the detailed unpublished item ids.",
    "items":{
        "$ref":"#/definitions/Link"
    }
}

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

型: array

ソースを表示

• Array of: object ItemId

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/ItemId"
    }
}

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

型: array

推奨公開操作のリソースのリンク。

ソースを表示

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

{
    "type":"array",
    "description":"Links of the Recommendation publish operations resource.",
    "items":{
        "$ref":"#/definitions/Link"
    }
}

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

型: object

ChannelId

ソースを表示

• id(optional): string
• isPrimaryChannel(optional): boolean
  チャネルがアセットのプライマリかどうかを示します。
• links(optional): array links
  リンク
• name(optional): string

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        },
        "name":{
            "type":"string"
        },
        "isPrimaryChannel":{
            "type":"boolean",
            "description":"Indicates if channel is primary for an asset."
        },
        "links":{
            "type":"array",
            "description":"Links",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    },
    "description":"ChannelId"
}

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

型: array

リンク

ソースを表示

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

{
    "type":"array",
    "description":"Links",
    "items":{
        "$ref":"#/definitions/Link"
    }
}

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

型: object

ソースを表示

• id(optional): string
  アイテムのId。
• links(optional): array links
  アイテム・リソースのリンク
• name(optional): string
  アイテムの名前。

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"id of the item."
        },
        "name":{
            "type":"string",
            "description":"name of the item."
        },
        "links":{
            "type":"array",
            "description":"links of the item resource",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    }
}

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

型: array

アイテム・リソースのリンク

ソースを表示

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

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

ネストされたスキーマ : 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レスポンス

内部サーバー・エラー

先頭に戻る