機械翻訳について

移動先

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

idで特定のカテゴリを読み取ります。

get

/content/management/api/v1.1/personalization/categories/{id}

リクエスト

パス・パラメータ

• id: string
  カテゴリのid。

問合せパラメータ

• fields(optional): string
  このパラメータは、属性カテゴリに対して返されるフィールドを制御するために使用されます。 このパラメータは、フィールド名または「すべて」のカンマ区切りリストを受け入れます。 これらのフィールドは、リスト内の各カテゴリについて返されます。 すべてのフィールド名で大文字と小文字が区別されるため、問合せには正しいフィールド名を指定する必要があります。 各推奨には、標準フィールド(id、name、descriptionおよびtype)があります。 fieldsを「すべて」 (大/小文字を区別しない)として指定すると、すべての標準フィールドおよび追加フィールドが返されます。 標準フィールドは常にレスポンスで返され、除外することはできません。 ユーザーがフィルタ処理できるのは、追加フィールドのみです。 このパラメータは問合せではオプションで、デフォルトではレスポンスの標準フィールドのみが表示されます。 問合せで指定されたフィールド名が正しくないか無効な場合は、エラーが発生します。
  
  例: ?fields=all
  この結果、すべての標準フィールドと、各カテゴリのすべての追加フィールドが返されます。
  
• links(optional): string
  このパラメータは、リンク名のカンマ区切りのリストを受け入れます。 デフォルトでは、このパラメータによって、適用可能なすべてのリンクが指定されます。 可能な値は次のとおりです: self, canonical, describedby

トップに戻る

レスポンス

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

• application/json

200レスポンス

OK。

本文()

ルート・スキーマ : AttributeCategory

型: object

AttributeCatgegory

ソースを表示

• description(optional): string
  カテゴリの説明。
• id: string
  カテゴリのId。 これは、レスポンス取得の必須プロパティであり、ポスト/putリクエストで無視されました。
• links(optional): array links
  リンク
• name: string
  カテゴリの名前。 これはレスポンス取得の必須プロパティであり、投稿/書込みリクエストで空にはできません。
• type(optional): string
  カテゴリのタイプ。 これは、標準またはカスタムに設定できます。 パラメータは、カスタム・カテゴリでのみ追加、更新および削除できます。

{
    "type":"object",
    "required":[
        "id",
        "name"
    ],
    "properties":{
        "id":{
            "type":"string",
            "description":"The id of the Category. This is a required propety in the get response and ignored in post/put requests."
        },
        "name":{
            "type":"string",
            "description":"The name of the Category. It is a required property in the get response and cannot be empty in post/put request."
        },
        "description":{
            "type":"string",
            "description":"The description of the Category."
        },
        "type":{
            "type":"string",
            "description":"The Type of the Category.  This can be set to \"standard\" or \"custom\". Parameters can be added, updated and deleted in custom categories only."
        },
        "links":{
            "type":"array",
            "description":"Links",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    },
    "description":"AttributeCatgegory"
}

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

型: array

リンク

ソースを表示

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

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

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

禁止。

404レスポンス

推奨が見つかりません。 リクエストしたリソースが見つかりません。

500レスポンス

内部サーバー・エラー

先頭に戻る