機械翻訳について

移動

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

公開済アイテムのすべてのタクソノミとカテゴリをスラグ順にリスト

get

/content/published/api/v1.1/items/.by.slug/{slug}/taxonomies

公開済アイテムのすべてのタクソノミとカテゴリをスラグでリストします。

リクエスト

パス・パラメータ

• slug: string
  パブリッシュ済アイテムのスラグ値。 slug内の特殊文字はすべてエンコードする必要があります。

問合せパラメータ

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

トップに戻る

レスポンス

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

• application/json

200レスポンス

操作の成功

本文()

ルート・スキーマ : TaxonomiesBean

型: object

Show Source

• items(optional): array items
  アイテム・タクソノミ。
• links(optional): array links
  リソース・リンク

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

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

型: array

アイテム・タクソノミ。

Show Source

• Array of: object TaxonomyItem
  TaxonomyItem

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

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

型: array

リソース・リンク

Show Source

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

{
    "type":"array",
    "description":"Resource links.",
    "items":{
        "$ref":"#/definitions/Link"
    }
}

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

型: object

TaxonomyItem

Show Source

• categories(optional): object TaxonomyCategories
  CategoriesBean
• id(optional): string
  タクソノミのId。
• links(optional): array links
• name(optional): string
  タクソノミの名前
• shortName(optional): string
  タクソノミの短縮名

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"The id of the taxonomy."
        },
        "name":{
            "type":"string",
            "description":"The name of the taxonomy"
        },
        "shortName":{
            "type":"string",
            "description":"The short name of the taxonomy"
        },
        "categories":{
            "description":"The categories of the taxonomy",
            "$ref":"#/definitions/TaxonomyCategories"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    },
    "description":"TaxonomyItem"
}

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

型: object

CategoriesBean

Show Source

• items(optional): array items
  タクソノミ・カテゴリ

{
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "description":"Taxonomy Categories",
            "items":{
                "$ref":"#/definitions/CategoryItem"
            }
        }
    },
    "description":"CategoriesBean"
}

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

型: array

Show Source

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

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

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

型: array

タクソノミ・カテゴリ

Show Source

• Array of: object CategoryItem
  CategoryItem

{
    "type":"array",
    "description":"Taxonomy Categories",
    "items":{
        "$ref":"#/definitions/CategoryItem"
    }
}

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

型: object

CategoryItem

Show Source

• apiName(optional): string
  カテゴリのapiName
• id(optional): string
  カテゴリのid。
• links(optional): array links
• name(optional): string
  カテゴリの名前
• nodes(optional): array nodes
  品目に割り当てられたカテゴリのノード。

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"The id of the category."
        },
        "name":{
            "type":"string",
            "description":"The name of the category"
        },
        "apiName":{
            "type":"string",
            "description":"The apiName of the category"
        },
        "nodes":{
            "type":"array",
            "description":"The nodes of the category assigned to the item.",
            "items":{
                "$ref":"#/definitions/CategoryNodeItem"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    },
    "description":"CategoryItem"
}

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

型: array

Show Source

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

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

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

型: array

品目に割り当てられたカテゴリのノード。

Show Source

• Array of: object CategoryNodeItem
  CategoryNodeBean

{
    "type":"array",
    "description":"The nodes of the category assigned to the item.",
    "items":{
        "$ref":"#/definitions/CategoryNodeItem"
    }
}

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

型: 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."
}

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

型: object

CategoryNodeBean

Show Source

• apiName(optional): string
  カテゴリ・ノードのapiName。
• id(optional): string
  カテゴリ・ノードのid。
• name(optional): string
  カテゴリ・ノードの名前。

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"The id of the Category node."
        },
        "name":{
            "type":"string",
            "description":"The name of the Category node."
        },
        "apiName":{
            "type":"string",
            "description":"The apiName of the Category node."
        }
    },
    "description":"CategoryNodeBean"
}

400レスポンス

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

403レスポンス

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

404レスポンス

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

500レスポンス

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

トップに戻る

例

次の例は、slugを使用して公開されたアイテムのタクソノミを読み取る方法を示しています。

curl -i -X GET -H "Accept:application/json" 'http://<hostname>/content/published/api/v1.1/items/.by.slug/{slug}/taxonomies'

例

これは、slugを使用して公開済アイテムのタクソノミを読み取ります: 1481786136832-item1_deliverytaxonomiesresource595040100700008、channelToken: 0a17fa56b37d40f1bbe31751364f765a.

/content/published/api/v1.1/items/.by.slug/1481786136832-item1_deliverytaxonomiesresource595040100700008/taxonomies?channelToken=0a17fa56b37d40f1bbe31751364f765a

レスポンス本文

{
        "items": [
          {
            "id": "5AD662150C07403FA5D76064ECA7D810",
            "name": "Test594336500988006-taxonomyCars-assetExpandDelivery",
            "shortName": "T28",
            "categories": {
              "items": [
                {
                  "id": "1666060BA6DE45F09D368C5A4DD851E3",
                  "name": "Car two doors",
                  "apiName": "t28-c-c1",
                  "nodes": [
                    {
                      "id": "AC1D8DDB67BE44FA8F7FCF7747769AC9",
                      "name": "Car intermediate",
                      "apiName": "t28-c1"
                    },
                    {
                      "id": "1666060BA6DE45F09D368C5A4DD851E3",
                      "name": "Car two doors",
                      "apiName": "t28-c-c1"
                    }
                  ],
                  "links": [
                    {
                      "href": "https://<hostname>/content/published/api/v1.1/taxonomies/5AD662150C07403FA5D76064ECA7D810/categories/1666060BA6DE45F09D368C5A4DD851E3?channelToken=0a17fa56b37d40f1bbe31751364f765a",
                      "rel": "self",
                      "method": "GET",
                      "mediaType": "application/json"
                    }
                  ]
                },
                {
                  "id": "ABF9C120EBAC4753BAE89CA89AC9F7D6",
                  "name": "car two doors",
                  "apiName": "t28-c-c",
                  "nodes": [
                    {
                      "id": "774EC8B9839B4D7392C10F005654C47D",
                      "name": "car small",
                      "apiName": "t28-c"
                    },
                    {
                      "id": "ABF9C120EBAC4753BAE89CA89AC9F7D6",
                      "name": "car two doors",
                      "apiName": "t28-c-c"
                    }
                  ],
                  "links": [
                    {
                      "href": "https://<hostname>/content/published/api/v1.1/taxonomies/5AD662150C07403FA5D76064ECA7D810/categories/ABF9C120EBAC4753BAE89CA89AC9F7D6?channelToken=0a17fa56b37d40f1bbe31751364f765a",
                      "rel": "self",
                      "method": "GET",
                      "mediaType": "application/json"
                    }
                  ]
                }
              ]
            },
            "links": [
              {
                "href": "https://<hostname>/content/published/api/v1.1/taxonomies/5AD662150C07403FA5D76064ECA7D810?channelToken=0a17fa56b37d40f1bbe31751364f765a",
                "rel": "self",
                "method": "GET",
                "mediaType": "application/json"
              }
            ]
          }
        ],
        "links": [
          {
            "href": "https://<hostname>/content/published/api/v1.1/items/.by.slug/1481786136832-item1_deliverytaxonomiesresource595040100700008/taxonomies?channelToken=0a17fa56b37d40f1bbe31751364f765a",
            "rel": "self",
            "method": "GET",
            "mediaType": "application/json"
          },
          {
            "href": "https://<hostname>/content/published/api/v1.1/items/.by.slug/1481786136832-item1_deliverytaxonomiesresource595040100700008/taxonomies?channelToken=0a17fa56b37d40f1bbe31751364f765a",
            "rel": "canonical",
            "method": "GET",
            "mediaType": "application/json"
          },
          {
            "href": "https://<hostname>/content/published/api/v1.1/metadata-catalog/items/.by.slug/1481786136832-item1_deliverytaxonomiesresource595040100700008/taxonomies?channelToken=0a17fa56b37d40f1bbe31751364f765a",
            "rel": "describedby",
            "method": "GET",
            "mediaType": "application/schema+json"
          }
        ]
      }

トップに戻る