機械翻訳について

移動

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

タクソノミのプレビュー

get

/content/preview/api/v1.1/taxonomies/{id}

指定されたチャネルに公開されている場合は、そのタクソノミのプロモート済バージョンを返します。 タクソノミはIdによって一意に識別されます。
公開された各タクソノミには、次の情報が含まれます:

1. 標準フィールド: これらはシステムによって作成されたフィールドです。
   
   • id: タクソノミのID。
   • name: タクソノミの名前。
   • description : タクソノミの説明。
   • shortName: タクソノミの短い名前。
   • customProperties: タクソノミに対して定義されたカスタム・プロパティ。
   • updatedDate : リクエストされたチャネル上のタクソノミの最終公開日。

リクエスト・ヘッダー:


必須	ヘッダー名	ヘッダー値
必須	channelToken	{有効なチャネル・トークン値}
オプショナル	Accept	application/json

リクエスト

パス・パラメータ

• id: string
  タクソノミの一意識別子(ID)。

問合せパラメータ

• channelToken(optional): string
  ターゲット・チャネルのチャネル・トークン。 チャネル・トークンは、問合せパラメータまたはリクエスト・ヘッダーのいずれかとして提供する必要があります。
• expand(optional): string
  展開パラメータは、タクソノミ・レスポンスにインラインで子リソース(参照アイテム)を取得するオプションを提供します。 フィールド名またはallのコンマ区切りリストを受け入れます。 このフィールドは現在無視されています。
• links(optional): string
  クライアントが結果に必要とするrel (リレーション)リンクのコンマ区切りのリストを受け入れます。 デフォルトでは、リソース内のすべての適用可能なリンクがレスポンスに含まれます。 可能な値は次のとおりです: self, canonical, describedby。
  例: links=self,canonicalは、relプロパティselfまたはcanonicalを持つリンクのみを返します。

トップに戻る

レスポンス

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

• application/json

200レスポンス

操作の成功

本文()

ルート・スキーマ : タクソノミ

型: object

タクソノミ

Show Source

• createdDate(optional): object date
  date
• customProperties(optional): object customProperties
  許可される追加プロパティ: additionalProperties

  タクソノミのカスタム・プロパティ。 これは、ユーザーによって定義される名前/値ペアで構成されます。
• description(optional): string
  タクソノミの説明。
• id(optional): string
  タクソノミのId。
• links(optional): array links
  リンク
• name(optional): string
  タクソノミの名前。
• shortName(optional): string
  タクソノミの短縮名。
• updatedDate(optional): object date
  date

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"The id of the taxonomy."
        },
        "name":{
            "type":"string",
            "description":"The name of the taxonomy."
        },
        "description":{
            "type":"string",
            "description":"The description of the taxonomy."
        },
        "shortName":{
            "type":"string",
            "description":"The short name of the taxonomy."
        },
        "customProperties":{
            "type":"object",
            "description":"Custom properties of the taxonomy. This consists of a name-value pairs defined by the user.",
            "additionalProperties":{
                "type":"string"
            }
        },
        "createdDate":{
            "description":"Created date of the taxonomy.",
            "$ref":"#/definitions/date"
        },
        "updatedDate":{
            "description":"Last updated date of the taxonomy.",
            "$ref":"#/definitions/date"
        },
        "links":{
            "type":"array",
            "description":"Links",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    },
    "description":"Taxonomy"
}

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

型: object

date

Show Source

• description(optional): string
• timezone(optional): string
• value(optional): string

{
    "type":"object",
    "properties":{
        "value":{
            "type":"string"
        },
        "timezone":{
            "type":"string"
        },
        "description":{
            "type":"string"
        }
    },
    "description":"date"
}

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

型: object

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

Show Source

• string

{
    "type":"object",
    "description":"Custom properties of the taxonomy. This consists of a name-value pairs defined by the user.",
    "additionalProperties":{
        "type":"string"
    }
}

タクソノミのカスタム・プロパティ。 これは、ユーザーによって定義される名前/値ペアで構成されます。

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

型: array

リンク

Show Source

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

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

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

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

304レスポンス

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

400レスポンス

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

403レスポンス

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

404レスポンス

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

500レスポンス

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

トップに戻る

例

例:

次の例は、cURLを使用してRESTリソースに対するGETリクエストを送信して、指定したチャネルに公開されたタクソノミをプレビューする方法を示しています:

curl -X GET -H 'Accept: application/json' 'https://host:port/content/preview/api/v1.1/taxonomies/1143EFDC17EC47318DFA55D04F098433?channelToken=986bc783d8c8452c813b7cf92dde0322'

このプレビューはIDの公開されたタクソノミをプレビュー : 1143EFDC17EC47318DFA55D04F098433、channelToken:986bc783d8c8452c813b7cf92dde0322。

レスポンス本文

{
        "id": "1143EFDC17EC47318DFA55D04F098433",
        "name": "allChannels-taxonomyPublished-1-Test1261401333683001",
        "description": "Taxonomy Description - 1",
        "shortName": "ALL",
        "createdDate": {
          "value": "2020-07-08T13:17:09.162Z",
          "timezone": "UTC"
        },
        "updatedDate": {
          "value": "2020-07-08T13:17:58.289Z",
          "timezone": "UTC"
        },
        "links": [
          {
            "href": "https://<hostname>/content/preview/api/v1.1/taxonomies/1143EFDC17EC47318DFA55D04F098433?channelToken=986bc783d8c8452c813b7cf92dde0322",
            "rel": "self",
            "method": "GET",
            "mediaType": "application/json"
          },
          {
            "href": "https://<hostname>/content/preview/api/v1.1/taxonomies/1143EFDC17EC47318DFA55D04F098433?channelToken=986bc783d8c8452c813b7cf92dde0322",
            "rel": "canonical",
            "method": "GET",
            "mediaType": "application/json"
          },
          {
            "href": "https://<hostname>/content/preview/api/v1.1/metadata-catalog/taxonomies/1143EFDC17EC47318DFA55D04F098433?channelToken=986bc783d8c8452c813b7cf92dde0322",
            "rel": "describedby",
            "method": "GET",
            "mediaType": "application/schema+json"
          }
        ]
      }
   

トップに戻る