機械翻訳について
  1. コンテンツ・プレビュー用のREST API
  2. タスク
  3. スラグによるアイテム

スラグによるアイテムのプレビュー

get

/content/preview/api/v1.1/items/.by.slug/{slug}

公開または公開の準備ができているスラグ値で、品目の最新の管理バージョンをプレビューします。 品目はスラグによって一意に識別されます。
各プレビュー・アイテムには次の情報があります:
  1. 標準フィールド: これらはシステムによって作成されたフィールドです。
    • id: アイテムのID。
    • type: アイテムのタイプ。
    • name: アイテムの名前。
    • typeCategory: タイプのカテゴリ。
    • description: アイテムの説明。
    • slug : 人間が読める形式のアイテムを識別するURL部分。
    • language : アイテムの言語。
    • createdDate: チャネル上のアイテムの作成日がリクエストされました。
    • updatedDate: チャネルのアイテムの更新日がリクエストされました。
  2. ユーザー定義フィールド: これらは、型が定義されたときにユーザーによって作成されるフィールドです。 すべてのユーザー・フィールドは、fieldsノードの下で使用できます。

    3. リクエスト・ヘッダー :
    必須ヘッダー名ヘッダー値
    必須channelToken{有効なチャネル・トークン値}
    オプショナルAcceptapplication/json

リクエスト

パス・パラメータ
問合せパラメータ
  • ターゲット・チャネルのチャネル・トークン。 チャネル・トークンは、問合せパラメータまたはリクエスト・ヘッダーのいずれかとして提供する必要があります。
  • Expandパラメータは、子リソース(参照アイテム)をアイテム・レスポンスとインラインで取得するオプションを提供します。 フィールド名またはallのコンマ区切りリストを受け入れます。 すべてのユーザー定義フィールド名にプレフィクスfieldsを付け、その後にピリオド(。)を付ける必要があります。 これらのフィールドが参照タイプである場合、リソースはレスポンス内でデータをインライン展開します。 フィールド名は大文字と小文字を区別します。 expandがall (小文字)として指定されると、リクエストされたアイテムの参照タイプのすべてのフィールドが展開されます。 展開が指定されていない場合、アイテム・レスポンスには参照されたアイテムへのリンクが含まれます。
    このフォームの展開は1つのレベルのみでサポートされています。参照先フィールドの最初のレベルを超えて拡張するリクエストは、HTTP 400レスポンスを生成します。     リクエストされたアイテムのタイプ定義に従って、展開に存在しないフィールドが含まれている場合、リソースはHTTP 400を生成します。
    例:
      expand=fields.field1,fields.field2
      expand=all
    ここで、field1、field2は、このアイテムが属するタイプのユーザー定義フィールドの名前です。
トップに戻る

レスポンス

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

200レスポンス

操作の成功
本文()
ルート・スキーマ : アイテム
型: object
Item
Show Source
ネストされたスキーマ : createdDate
型: object
アイテムの作成日。 Map having value, timezone, and description
ネストされたスキーマ: fields
型: object
使用可能なその他のプロパティ
Show Source
ユーザー定義フィールドのデータ。 Map
ネストされたスキーマ : itemVariations
型: array
Show Source
ネストされたスキーマ : RenditionsBean
型: object
Show Source
ネストされたスキーマ : TaxonomiesBean
型: object
Show Source
ネストされたスキーマ : updatedDate
型: object
アイテムの最終更新日。 Map having value, timezone, and description
ネストされたスキーマ : additionalProperties
型: object
ネストされたスキーマ : ItemVariation
型: object
Show Source
ネストされたスキーマ: items
型: array
アイテム・レンディション。
Show Source
ネストされたスキーマ : RenditionBean
型: object
Show Source
ネストされたスキーマ: formats
型: array
Show Source
ネストされたスキーマ : RenditionFormatBean
型: object
Show Source
ネストされたスキーマ: items
型: array
アイテム・タクソノミ。
Show Source
ネストされたスキーマ : TaxonomyItem
型: object
TaxonomyItem
Show Source
ネストされたスキーマ : TaxonomyCategories
型: object
CategoriesBean
Show Source
ネストされたスキーマ: items
型: array
タクソノミ・カテゴリ
Show Source
ネストされたスキーマ : CategoryItem
型: object
CategoryItem
Show Source
ネストされたスキーマ : nodes
型: array
品目に割り当てられたカテゴリのノード。
Show Source
ネストされたスキーマ : CategoryNodeItem
型: object
CategoryNodeBean
Show Source

304レスポンス

変更されません。 リクエストは電子タグでリクエストを受け付けます。

400レスポンス

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

403レスポンス

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

404レスポンス

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

500レスポンス

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

例

例1:

次の例は、cURLを使用してRESTリソースに対するGETリクエストを送信して、最新の管理アイテムをプレビューする方法を示しています:

curl -X GET -H 'Accept: application/json' 'https://host:port/content/preview/api/v1.1/items/.by.slug/3000000000012-c1?channelToken=37727fdc857c4d479513325888b69df0'

これは、スラグのあるアイテムのプレビューを読み取ります: 3000000000012-c1、channelToken: 37727fdc857c4d479513325888b69df0。

レスポンス本文

{
        "id": "CORE96C8FDF1883C44AB908FC56FF618D225",
        "type": "custitem",
        "typeCategory": "ContentType",
        "name": "c1",
        "description": "",
        "slug": "3000000000012-c1",
        "language": "en-US",
        "translatable": true,
        "createdDate": {
          "value": "2021-09-16T04:06:07.066Z",
          "timezone": "UTC"
        },
        "updatedDate": {
          "value": "2021-09-16T04:45:11.903Z",
          "timezone": "UTC"
        },
        "fileExtension": "contentItem",
        "fields": {
          "profession": "cricket",
          "title": "batter"
        },
        "mimeType": "contentItem",
        "fileGroup": "contentItem",
        "links": [
          {
            "href": "https://<hostname>/content/preview/api/v1.1/items/.by.slug/3000000000012-c1?channelToken=37727fdc857c4d479513325888b69df0",
            "rel": "self",
            "method": "GET",
            "mediaType": "application/json"
          },
          {
            "href": "https://<hostname>/content/preview/api/v1.1/items/.by.slug/3000000000012-c1?channelToken=37727fdc857c4d479513325888b69df0",
            "rel": "canonical",
            "method": "GET",
            "mediaType": "application/json"
          },
          {
            "href": "https://<hostname>/content/preview/api/v1.1/metadata-catalog/items/.by.slug/3000000000012-c1?channelToken=37727fdc857c4d479513325888b69df0",
            "rel": "describedby",
            "method": "GET",
            "mediaType": "application/schema+json"
          }
        ]
      }

例2:

curl -X GET -H 'Accept: application/json' 'https://host:port/content/preview/api/v1.1/items/.by.slug/cdt-digital-asset?channelToken=f573b68c764a44f9bae0627140d8b0bd'

これは、スラグのあるアイテムのプレビューを読み取ります: cdt-digital-asset, channelToken: f573b68c764a44f9bae0627140d8b0bd.

レスポンス本文

{
        "id": "CONT3E3AFF31343940768BEBE5461F97A8BC",
        "type": "DigitalAsset",
        "name": "Test522387760830005.jpg",
        "description": "",
        "slug": "cdt-digital-asset",
        "language": "en-US",
        "typeCategory": "DigitalAssetType",
        "createdDate": {
          "value": "2020-07-03T07:22:31.732Z",
          "timezone": "UTC"
        },
        "updatedDate": {
          "value": "2020-07-03T07:22:31.732Z",
          "timezone": "UTC"
        },
        "fileExtension": "jpg",
        "fields": {
          "metadata": {
            "width": "5",
            "height": "5"
          },
          "size": 631,
          "native": {
            "links": [
              {
                "href": "https://<hostname>/content/preview/assets/cdt-digital-asset/native/Test522387760830005.jpg?channelToken=f573b68c764a44f9bae0627140d8b0bd",
                "rel": "self",
                "method": "GET",
                "mediaType": "image/jpeg"
              }
            ]
          },
          "renditions": [
            {
              "name": "Thumbnail",
              "formats": [
                {
                  "format": "jpg",
                  "size": 631,
                  "mimeType": "image/jpeg",
                  "metadata": {
                    "width": "5",
                    "height": "5"
                  },
                  "links": [
                    {
                      "href": "https://<hostname>/content/preview/assets/cdt-digital-asset/Thumbnail/Test522387760830005.jpg?format=jpg&type=responsiveimage&channelToken=f573b68c764a44f9bae0627140d8b0bd",
                      "rel": "self",
                      "method": "GET",
                      "mediaType": "image/jpeg"
                    }
                  ]
                },
                {
                  "format": "webp",
                  "size": 0,
                  "mimeType": "image/webp",
                  "metadata": {
                    "width": "5",
                    "height": "5"
                  },
                  "links": [
                    {
                      "href": "https://<hostname>/content/preview/assets/cdt-digital-asset/Thumbnail/Test522387760830005.jpg?format=webp&type=responsiveimage&channelToken=f573b68c764a44f9bae0627140d8b0bd",
                      "rel": "self",
                      "method": "GET",
                      "mediaType": "image/webp"
                    }
                  ]
                }
              ],
              "type": "responsiveimage"
            },
            {
              "name": "Medium",
              "formats": [
                {
                  "format": "jpg",
                  "size": 631,
                  "mimeType": "image/jpeg",
                  "metadata": {
                    "width": "5",
                    "height": "5"
                  },
                  "links": [
                    {
                      "href": "https://<hostname>/content/preview/assets/cdt-digital-asset/Medium/Test522387760830005.jpg?format=jpg&type=responsiveimage&channelToken=f573b68c764a44f9bae0627140d8b0bd",
                      "rel": "self",
                      "method": "GET",
                      "mediaType": "image/jpeg"
                    }
                  ]
                },
                {
                  "format": "webp",
                  "size": 0,
                  "mimeType": "image/webp",
                  "metadata": {
                    "width": "5",
                    "height": "5"
                  },
                  "links": [
                    {
                      "href": "https://<hostname>/content/preview/assets/cdt-digital-asset/Medium/Test522387760830005.jpg?format=webp&type=responsiveimage&channelToken=f573b68c764a44f9bae0627140d8b0bd",
                      "rel": "self",
                      "method": "GET",
                      "mediaType": "image/webp"
                    }
                  ]
                }
              ],
              "type": "responsiveimage"
            },
            {
              "name": "Large",
              "formats": [
                {
                  "format": "jpg",
                  "size": 631,
                  "mimeType": "image/jpeg",
                  "metadata": {
                    "width": "5",
                    "height": "5"
                  },
                  "links": [
                    {
                      "href": "https://<hostname>/content/preview/assets/cdt-digital-asset/Large/Test522387760830005.jpg?format=jpg&type=responsiveimage&channelToken=f573b68c764a44f9bae0627140d8b0bd",
                      "rel": "self",
                      "method": "GET",
                      "mediaType": "image/jpeg"
                    }
                  ]
                },
                {
                  "format": "webp",
                  "size": 0,
                  "mimeType": "image/webp",
                  "metadata": {
                    "width": "5",
                    "height": "5"
                  },
                  "links": [
                    {
                      "href": "https://<hostname>/content/preview/assets/cdt-digital-asset/Large/Test522387760830005.jpg?format=webp&type=responsiveimage&channelToken=f573b68c764a44f9bae0627140d8b0bd",
                      "rel": "self",
                      "method": "GET",
                      "mediaType": "image/webp"
                    }
                  ]
                }
              ],
              "type": "responsiveimage"
            },
            {
              "name": "Small",
              "formats": [
                {
                  "format": "jpg",
                  "size": 631,
                  "mimeType": "image/jpeg",
                  "metadata": {
                    "width": "5",
                    "height": "5"
                  },
                  "links": [
                    {
                      "href": "https://<hostname>/content/preview/assets/cdt-digital-asset/Small/Test522387760830005.jpg?format=jpg&type=responsiveimage&channelToken=f573b68c764a44f9bae0627140d8b0bd",
                      "rel": "self",
                      "method": "GET",
                      "mediaType": "image/jpeg"
                    }
                  ]
                },
                {
                  "format": "webp",
                  "size": 0,
                  "mimeType": "image/webp",
                  "metadata": {
                    "width": "5",
                    "height": "5"
                  },
                  "links": [
                    {
                      "href": "https://<hostname>/content/preview/assets/cdt-digital-asset/Small/Test522387760830005.jpg?format=webp&type=responsiveimage&channelToken=f573b68c764a44f9bae0627140d8b0bd",
                      "rel": "self",
                      "method": "GET",
                      "mediaType": "image/webp"
                    }
                  ]
                }
              ],
              "type": "responsiveimage"
            }
          ],
          "mimeType": "image/jpeg",
          "fileType": "jpeg"
        },
        "links": [
          {
            "href": "https://<hostname>/content/preview/api/v1.1/items/.by.slug/cdt-digital-assetchannelToken=f573b68c764a44f9bae0627140d8b0bd",
            "rel": "self",
            "method": "GET",
            "mediaType": "application/json"
          },
          {
            "href": "https://<hostname>/content/preview/api/v1.1/items/.by.slug/cdt-digital-asset?channelToken=f573b68c764a44f9bae0627140d8b0bd",
            "rel": "canonical",
            "method": "GET",
            "mediaType": "application/json"
          },
          {
            "href": "https://<hostname>/content/preview/api/v1.1/metadata-catalog/items/.by.slug/cdt-digital-asset?channelToken=f573b68c764a44f9bae0627140d8b0bd",
            "rel": "describedby",
            "method": "GET",
            "mediaType": "application/schema+json"
          }
        ]
      }
    }
トップに戻る