機械翻訳について
  1. コンテンツ配信用のREST API
  2. タスク
  3. Item

アイテムのプレビューを取得

get

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

発行または公開の準備ができているアイテムの最新の管理バージョンをプレビューします。 アイテムはIDによって一意に識別されます。
注: このAPIでは、アイテムをプレビューするための認証が必要です。

各プレビューアイテムには次の情報があります:
  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レスポンス

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

例

次の例は、公開されたアイテムをプレビューする方法を示しています。

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

IDを持つ公開済アイテムのプレビューを読み取ります: COREC600072445DF413BB62A55AC20642196。

/content/published/api/v1.1/items/COREC600072445DF413BB62A55AC20642196/preview

レスポンス本文

{
        "id": "COREC600072445DF413BB62A55AC20642196",
        "type": "Test615486605533000",
        "name": "Test615574578944000_item1",
        "description": "Test615574579004001_item1_desc",
        "typeCategory": "ContentType",
        "slug": "1481786137057-test615574578944000_item1",
        "language": "en",
        "translatable": false,
        "createdDate": {
          "value": "2020-07-03T09:56:05.237Z",
          "timezone": "UTC"
        },
        "updatedDate": {
          "value": "2020-07-03T09:56:05.237Z",
          "timezone": "UTC"
        },
        "fields": {
          "615485847566005Float_Single": 2.3,
          "615485847886008Reference_Single": {
            "id": "CONT689B06DD7FF945EDA2C118AE6958832E",
            "type": "DigitalAsset",
            "name": "audi1_1593770161812.jpg",
            "typeCategory": "DigitalAssetType",
            "links": [
              {
                "href": "https://<hostname>/content/published/api/v1.1/items/CONT689B06DD7FF945EDA2C118AE6958832E",
                "rel": "self",
                "method": "GET",
                "mediaType": "application/json"
              }
            ]
          },
          "615485847117002String_List": [
            "sample1",
            "sample2"
          ],
          "615485848155009Reference_List": [
            {
              "id": "CORE74BAB37DCB14487DBA7C0206580C1FE1",
              "type": "Test615524669505002",
              "name": "Test615562696749006_item1",
              "typeCategory": "ContentType",
              "links": [
                {
                  "href": "https://<hostname>/content/published/api/v1.1/items/CORE74BAB37DCB14487DBA7C0206580C1FE1",
                  "rel": "self",
                  "method": "GET",
                  "mediaType": "application/json"
                }
              ]
            },
            {
              "id": "CORE58BE978F62FD47A984960B273D19FE61",
              "type": "Test615524669505002",
              "name": "Test615568776605008_item2",
              "typeCategory": "ContentType",
              "links": [
                {
                  "href": "https://<hostname>/content/published/api/v1.1/items/CORE58BE978F62FD47A984960B273D19FE61",
                  "rel": "self",
                  "method": "GET",
                  "mediaType": "application/json"
                }
              ]
            }
          ],
          "615485847348003Int_Single": 13,
          "615485747694001String_Single": "sample",
          "615485847674006Float_List": [
            1.4,
            5.4
          ],
          "615485847466004Int_List": [
            14,
            54
          ],
          "615485847774007Boolean_Single": false
        },
        "links": [
          {
            "href": "https://<hostname>/content/published/api/v1.1/items/COREC600072445DF413BB62A55AC20642196/preview",
            "rel": "self",
            "method": "GET",
            "mediaType": "application/json"
          },
          {
            "href": "https://<hostname>/content/published/api/v1.1/items/COREC600072445DF413BB62A55AC20642196/preview",
            "rel": "canonical",
            "method": "GET",
            "mediaType": "application/json"
          },
          {
            "href": "https://<hostname>/content/published/api/v1.1/metadata-catalog/items/COREC600072445DF413BB62A55AC20642196/preview",
            "rel": "describedby",
            "method": "GET",
            "mediaType": "application/schema+json"
          }
        ]
      }
トップに戻る