機械翻訳について

移動

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

公開済アイテムのHTMLレンディションを取得します。

get

/content/published/api/v1.1/items/{id}/renditions

公開済アイテムの使用可能なHTMLレンディションをすべてリストします。

リクエスト

パス・パラメータ

• id: string
  アイテムの一意の識別子(ID)。

問合せパラメータ

• links(optional): string
  クライアントが結果に必要とするrel (リレーション)リンクのコンマ区切りのリストを受け入れます。 デフォルトでは、リソース内のすべての適用可能なリンクがレスポンスに含まれます。 可能な値は次のとおりです: self, canonical, describedby。
  例: links=self,canonicalは、relプロパティselfまたはcanonicalを持つリンクのみを返します。

トップに戻る

レスポンス

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

• application/json

200レスポンス

操作の成功

本文()

ルート・スキーマ : RenditionsBean

型: object

Show Source

• items(optional): array items
  アイテム・レンディション。
• links(optional): array links

{
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "description":"Item renditions.",
            "items":{
                "$ref":"#/definitions/RenditionBean"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    }
}

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

型: array

アイテム・レンディション。

Show Source

• Array of: object RenditionBean

{
    "type":"array",
    "description":"Item renditions.",
    "items":{
        "$ref":"#/definitions/RenditionBean"
    }
}

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

型: array

Show Source

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

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

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

型: object

Show Source

• apiName(optional): string
• formats(optional): array formats
• type(optional): string

{
    "type":"object",
    "properties":{
        "apiName":{
            "type":"string"
        },
        "formats":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/RenditionFormatBean"
            }
        },
        "type":{
            "type":"string"
        }
    }
}

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

型: array

Show Source

• Array of: object RenditionFormatBean

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

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

型: object

Show Source

• format(optional): string
• links(optional): array links

{
    "type":"object",
    "properties":{
        "format":{
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    }
}

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

型: array

Show Source

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

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

ネストされたスキーマ : リンク

型: object

リソースのリンク。

Show Source

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

400レスポンス

不正リクエスト。 サーバーは、不正な構文、無効なデータまたはメッセージ・フレーミングのために、クライアント側でリクエストを処理できません。

403レスポンス

禁止。 クライアントはこのリクエストを実行する権限がありません。

404レスポンス

リクエストされたリソースは見つかりませんでした。

500レスポンス

内部サーバー・エラー システムで予期しないエラーが発生しました。

トップに戻る