機械翻訳について

移動先

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

タイプのすべてのレイアウト・マッピングのリスト

get

/content/management/api/v1.1/types/{name}/layoutMapping

タイプのすべてのレイアウト・マッピングをリストします。

リクエスト

パス・パラメータ

• name: string
  型名識別子は大/小文字が区別され、特殊文字はエンコードする必要があります。

問合せパラメータ

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

トップに戻る

レスポンス

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

• application/json

200レスポンス

OK。

本文()

ルート・スキーマ : TypeSubResourceListLayoutMappings

型: object

LayoutMappings

ソースを表示

• data(optional): array data
• links(optional): array links
• totalResults(optional): integer(int32)

{
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "format":"int32"
        },
        "data":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/LayoutMapping"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    },
    "description":"LayoutMappings"
}

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

型: array

ソースを表示

• Array of: object LayoutMapping
  LayoutMapping

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

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

型: array

ソースを表示

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

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

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

型: object

LayoutMapping

ソースを表示

• apiName(optional): string
  レイアウトの名前。
• formats(optional): object formats
  許可される追加のプロパティ: additionalProperties

  レイアウト形式。
• generateRendition(optional): boolean
  generateRendition.
• id(optional): integer(int64)
  レイアウト・マッピングのID。
• label(optional): string
  レイアウト・マッピングのカテゴリの名前です。

{
    "type":"object",
    "properties":{
        "label":{
            "type":"string",
            "description":"Name of the category for layout mapping."
        },
        "apiName":{
            "type":"string",
            "description":"Name of the layout."
        },
        "formats":{
            "type":"object",
            "description":"layout formats.",
            "additionalProperties":{
                "type":"string"
            }
        },
        "generateRendition":{
            "type":"boolean",
            "description":"generateRendition."
        },
        "id":{
            "type":"integer",
            "format":"int64",
            "description":"Id of the layout mapping."
        }
    },
    "description":"LayoutMapping"
}

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

型: object

使用可能なその他のプロパティ

ソースを表示

• string

{
    "type":"object",
    "description":"layout formats.",
    "additionalProperties":{
        "type":"string"
    }
}

レイアウト形式。

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

304 レスポンス

変更されていません。

400レスポンス

不正リクエスト

403レスポンス

禁止。

500レスポンス

内部サーバー・エラー

先頭に戻る