サイト管理用のREST API

テンプレートで使用するアセットのリスト

get

/sites/management/api/v1/templates/{id}/assets

COLLECTION

テンプレートによって使用されるアセットをリストします。使用されたアセットの各インスタンスが返され、インスタンス識別子とそのインスタンスを含むページIDが返されます。アセットのIDを含めるには、expand=item問合せパラメータを含めてitemフィールドを展開します。アセットの数が多い可能性があるため、結果をページでリクエストできます。

リリース21.1.3で導入されました。

認可

この操作を起動するには、認証されたユーザーまたはクライアント・アプリケーションがリソースと共有され、次のいずれかの「共有」ロールを持っている必要があります:

所有者
マネージャ
貢献者
ダウンロード実行者
ビューア

制限

limit問合せパラメータが指定されていない場合、この操作では50アイテムのデフォルト制限が使用されます。指定できる最大制限は250です。制限がこの最大値を超えると、250の制限が使用されます。

パス代替識別子

「テンプレート」リソースのデフォルトの識別子は、「テンプレート識別子」です。テンプレート・リソースは代替識別子をサポートしています。

nameテンプレート名

テンプレート識別子のかわりに、テンプレート名を使用してリソース・パスでテンプレートを一意に識別できます。テンプレートのデフォルトのリソース・パス・パラメータはテンプレート識別子ですが、テンプレートでの作業時には、判読可能なテンプレート名が簡単になる場合があります。

http://api.example.com/sites/management/api/v1/templates/name:CafeSupremo/assets

リリース19.4.1.での導入。

成功したレスポンスの例

この操作は、次の成功(2xx)のレスポンスで応答します。レスポンスHTTPステータス・コードとサンプル本体の完全なリストは、この操作の「レスポンス」に関する項を参照してください。

200OK - List Assets

テンプレートで使用するアセットをリストします。レスポンスのitemフィールドには、コンテンツ管理REST APIから関係の詳細を読み取るための正規のリンクが含まれています。

リクエスト

GET https://api.example.com/sites/management/api/v1/templates/{id}/assets

レスポンス本文

{
  "totalResults": 2,
  "limit": 50,
  "count": 2,
  "hasMore": false,
  "offset": 0,
  "items": [
      {
        "pageId": 100,
        "instanceId": "a47be99b-7b63-4918-bd2d-8373c8484036",
        "version": "2.4",
        "item": {
          "links": [
              {
                "rel": "canonical",
                "href": "http://api.example.com/content/management/api/v1.1/items/CORE81C98B7935194159A2D1D3B0DBE948F5",
                "templated": false,
                "mediaType": "application/json",
                "method": "GET"
              }
          ]
        }
      },
      {
        "pageId": 120,
        "instanceId": "d952fa9d-56cc-4adf-a1f5-0f549f3c49a4",
        "version": "draft",
        "item": {
          "links": [
              {
                "rel": "canonical",
                "href": "http://api.example.com/content/management/api/v1.1/items/CONT051B2BD577E24A3F804785E1CF21B7D3",
                "templated": false,
                "mediaType": "application/json",
                "method": "GET"
              }
          ]
        }
      }
  ]
}

200 OK - アイテムIDを含むリストア・セット

テンプレートで使用されるアセットをリストし、itemフィールドを展開してアセット・アイテムIDを含めます。リンクは明確にするために除外されます。

リクエスト

GET https://api.example.com/sites/management/api/v1/templates/{id}/assets?expand=item&links=none

レスポンス本文

{
  "totalResults": 2,
  "limit": 50,
  "count": 2,
  "hasMore": false,
  "offset": 0,
  "items": [
      {
        "pageId": 100,
        "instanceId": "a47be99b-7b63-4918-bd2d-8373c8484036",
        "version": "2.4",
        "item": {
          "id": "CORE81C98B7935194159A2D1D3B0DBE948F5"
        }
      },
      {
        "pageId": 120,
        "instanceId": "d952fa9d-56cc-4adf-a1f5-0f549f3c49a4",
        "version": "draft",
        "item": {
          "id": "CONT051B2BD577E24A3F804785E1CF21B7D3"
        }
      }
  ]
}

クライアント・エラー・レスポンスの例

この操作は、レスポンス本文に例外の詳細が含まれている次のクライアント・エラー(4xx)レスポンスで応答します。レスポンスHTTPステータス・コードとサンプル本体の完全なリストは、この操作の「レスポンス」に関する項を参照してください。

404Not Found - Template Not Found

サイト・テンプレートが存在しないか、削除されたか、認証済ユーザーまたはクライアント・アプリケーションがテンプレートへのアクセス権を持っていません。

エラー・コード

OCE-SITEMGMT-009000

解決 - 識別子のチェック

テンプレート識別子が有効であることを確認してください。

解決 - メンバーシップのチェック

認証済ユーザーがテンプレートのメンバーまたはサイト管理者であることを確認してください。

例外詳細フィールド

このエラー・タイプでは、レスポンスに次のフィールド/値が含まれます:

フィールド名	説明
`template`	存在しないか、認証されたユーザーに表示されないテンプレート。

この例外の詳細タイプの詳細は、swaggerドキュメントの定義セクションのTemplateNotFoundExceptionDetailスキーマを参照してください。

レスポンス本文の例

{
  "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
  "title": "Template Not Found",
  "status": "404",
  "detail": "Template does not exist or has been deleted, or the authenticated user or client application does not have access to the template.",
  "o:errorCode": "OCE-SITEMGMT-009000",
  "template": {
    "id": "F30F08EB205D44AD20B5A48D1B1B3DD7D74F45978AB6"
  }
}

リクエスト

パス・パラメータ

id: string

テンプレートの不変識別子。

問合せパラメータ

excludeFields(optional): string

レスポンスに使用しないフィールド名のカンマ区切り文字列。フィールド名を区切るには、ドットを使用してネストされたフィールドを特定できます。フィールド名は大文字と小文字を区別します。フィールドが存在しない場合、フィールド名は無視されます。コレクションのフィールドを参照するために、フィールド名の先頭に@文字(@hasMoreなど)を付加できます。
excludeLinks(optional): string

レスポンスからexcludeへのリンク関係名のカンマ区切りリスト。
expand(optional): string

展開するフィールド名のカンマ区切りの文字列。値allを使用して、すべての関係を展開します。
expand問合せパラメータには次のフィールド名を指定できます:
フィールド名説明
item アセットのコンテンツ・アイテム。
expansionErrors(optional): string
拡張のエラーの処理方法を指定します。指定しない場合は、デフォルトで関連フィールドにエラーの詳細が含まれます。
有効な値は次のとおりです。
- ignore - エラーを無視して関係を展開しません。関連リンクはレスポンスに含まれません
- include - 展開された関係のかわりにエラー詳細を含めます。関連リンクが返されます
- fail - リクエストの拡張の失敗エラー・レスポンスでの失敗
fields(optional): string

レスポンスに必要なフィールド名のカンマ区切り文字列。フィールド名を区切るためにドットを使用して、ネストされたプロパティを特定できます。フィールド名は大文字と小文字を区別します。フィールドが存在しない場合、フィールド名は無視されます。コレクションのフィールドを参照するために、フィールド名の先頭に@文字(@hasMoreなど)を付加できます。
limit(optional): integer(int32)

レスポンスで返される最大品目数を指定する正の整数値。指定しない場合、サービスでは適切な制限が選択されます。

フィールド名	説明
`item`	アセットのコンテンツ・アイテム。

links(optional): string

レスポンス内のincludeへのリンク関係名のカンマ区切りリスト。デフォルトでは、すべてのリンクが返されます。

次のリンクは、このリソースにより提供されます:

リンク関係	説明
`parent`	親リソースが読取り可能な場所を示します。このリンクは`up`リンクに相当し、親リソース(単数形のリソースを含むコレクション・リソースなど)へのリンクを提供します。
`self`	リソースの現在の戻り表現を示します。リソース自体を表すリンクに使用されます。たとえば、リソースがコレクションの一部として戻された場合、自己リンクは個々のリソースのURLパスを提供します。
`canonical`	リクエストされたリソースの優先表現を示します。リソースの標準的な形式を表すリンクに使用されます。たとえば、リソースがコレクションの一部として返される場合、正規リンクは個々のリソースの正規の形式のURLパスを提供します。
`child`	関連リソースまたは子リソースの読取りが可能な場所を表します。子リンクは展開可能なプロパティとして返され、展開されていない関係の詳細が読み取られるロケーションを提供します。
`prev`	前のページが存在する場合、結果の前のページを説明します。コレクション・リソースとともに使用し、`offset`および`limit`問合せパラメータを指定したページ・リクエストへのレスポンスに基づいて前のパス・リンクを提供します。
`next`	次のページが存在する場合、結果の次のページについて説明します。収集リソースとともに使用し、`offset`および`limit`問合せパラメータを指定したページ・リクエストへのレスポンスに基づいて、次のページ・リンクを提供します。
`describedBy`	リソースに関するメタデータ情報を提供するスキーマ・リソースが記述されます。スキーマ・リソースがリソースを説明する場所を示すために、コレクション・リソース、単数形およびリレーション・リソースで使用されます。

offset(optional): integer(int64)

返される最初のアイテムのインデックスを指定する負でない整数値。オフセット索引はゼロから始まります。デフォルトでは、オフセットはゼロで、コレクション内の最初のアイテムから始まるアイテムが返されます。

return(optional): string

レスポンス・フィールドおよびリンクの制御に使用するリソース表現を指定します。表現が指定されない場合、fields、excludeFields、links、excludeLinksおよびexpand問合せパラメータの値に基づいて、クライアント定義の表現が戻されます。

次の表現は、return問合せパラメータでサポートされています:

表現	説明
`representation`	フル・リソース表示には、すべてのプロパティとリンクが含まれ、大部分の関係が拡張されます。
`default`	デフォルトのリソース表示には、ほとんどのプロパティとリンクが含まれます。
`basic`	基本的なリソース表現には、いくつかのプロパティといくつかのリンクが含まれます。
`minimal`	最小リソース表現。必須プロパティとリンクなしが含まれます。

トップに戻る

レスポンス

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

application/json
application/vnd.oracle.resource+json;type=collection

200レスポンス

ヘッダー

Cache-Control: string

キャッシュ・メカニズムのディレクティブ。
Content-Length: string

レスポンス本文のサイズ。
Content-Type: string

レスポンスのコンテンツ・タイプ。

ルート・スキーマ: schema

型: object

ソースを表示

items: array items

「テンプレート・ページ・アセット」要素のコレクション。
リリース21.1.3で導入されました。

{
    "type":"object",
    "allOf":[
        {
            "$ref":"#/definitions/CollectionResource"
        }
    ],
    "properties":{
        "items":{
            "description":"<p>Collection of <em>Template Page Asset</em> elements.</p><small>Introduced in release 21.1.3.</small>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic",
                "minimal"
            ],
            "type":"array",
            "items":{
                "allOf":[
                    {
                        "$ref":"#/definitions/TemplatePageAsset"
                    }
                ]
            }
        }
    },
    "required":[
        "items"
    ]
}

すべてに一致

ソースを表示

allOf CollectionResource

REST APIによって返されるすべてのコレクションは、標準のコレクション定義を拡張します。この定義では、品目の合計数、返される品目のオフセットおよび制限の詳細、品目の数、および使用可能な品目が他にもあるかどうかを示すインジケータに関する情報を提供します。

{
    "type":"object",
    "allOf":[
        {
            "$ref":"#/definitions/CollectionResource"
        }
    ],
    "properties":{
        "items":{
            "description":"<p>Collection of <em>Template Page Asset</em> elements.</p><small>Introduced in release 21.1.3.</small>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic",
                "minimal"
            ],
            "type":"array",
            "items":{
                "allOf":[
                    {
                        "$ref":"#/definitions/TemplatePageAsset"
                    }
                ]
            }
        }
    },
    "required":[
        "items"
    ]
}

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

型: array

「テンプレート・ページ・アセット」要素のコレクション。

リリース21.1.3で導入されました。

ソースを表示

Array of: items

{
    "description":"<p>Collection of <em>Template Page Asset</em> elements.</p><small>Introduced in release 21.1.3.</small>",
    "x-returnedIn":[
        "representation",
        "default",
        "basic",
        "minimal"
    ],
    "type":"array",
    "items":{
        "allOf":[
            {
                "$ref":"#/definitions/TemplatePageAsset"
            }
        ]
    }
}

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

REST APIによって返されるすべてのコレクションは、標準のコレクション定義を拡張します。この定義では、品目の合計数、返される品目のオフセットおよび制限の詳細、品目の数、および使用可能な品目が他にもあるかどうかを示すインジケータに関する情報を提供します。

すべてに一致

ソースを表示

object SingularResource

すべての単数形のリソースには、特異なリソース定義のプロパティが含まれます。単一のリソースには、他のリソースとの関係を提供するリンク、またはリソース自体をselfがリンクするリンク先のリストが含まれます。
object CollectionResource-allOf[1]

{
    "description":"<p>All collections returned by REST APIs extend the standard collection definition. The definition provides information about the total number of items, the offset and limit details for the items returned, the number of items and an indicator to whether there are more items available.</p>",
    "allOf":[
        {
            "$ref":"#/definitions/SingularResource"
        },
        {
            "properties":{
                "totalResults":{
                    "description":"<p>Total number of resources that match the request. If provided, this is the total number of available items. If not specified the total is not known, or is not viable to return. Paging limits or offsets are ignored when calculating this value. Only returned if the <code>totalResults</code> parameter is supported and is set to <code>true</code> by the client.</p>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic",
                        "minimal"
                    ],
                    "type":"integer",
                    "format":"int64"
                },
                "limit":{
                    "description":"<p>Actual response size limit used. If the request specifies too large a limit, or does not specify a limit then the response will specify the limit used.</p>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic",
                        "minimal"
                    ],
                    "type":"integer",
                    "format":"int32"
                },
                "count":{
                    "description":"<p>Total number of resources in the response.</p>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic",
                        "minimal"
                    ],
                    "type":"integer",
                    "format":"int32"
                },
                "hasMore":{
                    "description":"<p>Collection has more elements that match the request. Indicates whether there are more items to be returned when a paged request is made and the page was not big enough to return all elements.</p>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic",
                        "minimal"
                    ],
                    "type":"boolean"
                },
                "offset":{
                    "description":"<p>Actual response offset used. If the request specifies no offset then the actual offset is provided in the response.</p>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic",
                        "minimal"
                    ],
                    "type":"integer",
                    "format":"int64"
                }
            }
        }
    ]
}

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

型: object

すべての単数形のリソースには、特異なリソース定義のプロパティが含まれます。単一のリソースには、他のリソースとの関係を提供するリンク、またはリソース自体をselfがリンクするリンク先のリストが含まれます。

ソースを表示

links(optional): array links

このリソースに対する関連リソースおよびアクションへのHATEOSリンク。リソースの正規表現へのリンクを含む自己リンクを少なくとも1つ含める必要があります。

{
    "description":"<p>All singular resources include the properties of the singular resource definition. A singular resource includes a list of links that provide relationships to other resources, or in the case of the <em>self</em> link the resource itself.</p>",
    "properties":{
        "links":{
            "description":"<p>HATEOS link to related resources and actions or actions on this resource. Must include at least a 'self' link that contains a link to the canonical representation of the resource.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"array",
            "items":{
                "allOf":[
                    {
                        "$ref":"#/definitions/Link"
                    }
                ]
            }
        }
    }
}

ネストされたスキーマ : CollectionResource-allOf[1]

型: object

ソースを表示

count(optional): integer(int32)

レスポンス内のリソースの合計数。
hasMore(optional): boolean

コレクションには、リクエストに一致する多くの要素があります。ページ・リクエストを作成し、ページがすべての要素を返すのに十分な大きさでない場合に、返されるアイテムが他にもあるかどうかを示します。
limit(optional): integer(int32)

実際のレスポンス・サイズ制限。リクエストで指定されている制限値が大きすぎる場合、または制限が指定されていない場合、レスポンスでは使用される制限が指定されます。
offset(optional): integer(int64)

使用される実際のレスポンス・オフセット。リクエストでオフセットが指定されていない場合、レスポンスに実際のオフセットが指定されます。
totalResults(optional): integer(int64)

リクエストに一致するリソースの合計数。指定した場合は、使用可能なアイテムの合計数です。指定されない場合、合計が不明か、または戻り不可能です。この値を計算するとき、ページング制限またはオフセットは無視されます。 totalResultsパラメータがサポートされていて、クライアントがtrueに設定している場合にのみ返されます。

{
    "properties":{
        "totalResults":{
            "description":"<p>Total number of resources that match the request. If provided, this is the total number of available items. If not specified the total is not known, or is not viable to return. Paging limits or offsets are ignored when calculating this value. Only returned if the <code>totalResults</code> parameter is supported and is set to <code>true</code> by the client.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic",
                "minimal"
            ],
            "type":"integer",
            "format":"int64"
        },
        "limit":{
            "description":"<p>Actual response size limit used. If the request specifies too large a limit, or does not specify a limit then the response will specify the limit used.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic",
                "minimal"
            ],
            "type":"integer",
            "format":"int32"
        },
        "count":{
            "description":"<p>Total number of resources in the response.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic",
                "minimal"
            ],
            "type":"integer",
            "format":"int32"
        },
        "hasMore":{
            "description":"<p>Collection has more elements that match the request. Indicates whether there are more items to be returned when a paged request is made and the page was not big enough to return all elements.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic",
                "minimal"
            ],
            "type":"boolean"
        },
        "offset":{
            "description":"<p>Actual response offset used. If the request specifies no offset then the actual offset is provided in the response.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic",
                "minimal"
            ],
            "type":"integer",
            "format":"int64"
        }
    }
}

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

すべてに一致

ソースを表示

allOf TemplatePageAsset

サイト・ページで使用されるアセットに関する情報。
リリース21.1.3で導入されました。

{
    "allOf":[
        {
            "$ref":"#/definitions/TemplatePageAsset"
        }
    ]
}

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

サイト・ページで使用されるアセットに関する情報。

リリース21.1.3で導入されました。

すべてに一致

ソースを表示

object SingularResource

すべての単数形のリソースには、特異なリソース定義のプロパティが含まれます。単一のリソースには、他のリソースとの関係を提供するリンク、またはリソース自体をselfがリンクするリンク先のリストが含まれます。
object TemplatePageAsset-allOf[1]

{
    "description":"<p>Information about an asset that is used on a site page.</p><small>Introduced in release 21.1.3.</small>",
    "allOf":[
        {
            "$ref":"#/definitions/SingularResource"
        },
        {
            "properties":{
                "pageId":{
                    "description":"<p>Page id.</p><small>Introduced in release 21.1.3.</small>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "type":"integer",
                    "format":"int32"
                },
                "instanceId":{
                    "description":"<p>Instance id.</p><small>Introduced in release 21.1.3.</small>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "type":"string"
                },
                "version":{
                    "description":"<p>Version that is in use on this page.</p><small>Introduced in release 21.1.3.</small>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "type":"string"
                },
                "item":{
                    "description":"<p>The content item of the asset.</p><small>Introduced in release 21.1.3.</small>",
                    "x-expandable":true,
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "x-expandedIn":[
                        "representation"
                    ],
                    "allOf":[
                        {
                            "$ref":"#/definitions/ContentItem"
                        }
                    ]
                }
            }
        }
    ]
}

ネストされたスキーマ : TemplatePageAsset-allOf[1]

型: object

ソースを表示

instanceId(optional): string

インスタンスID
リリース21.1.3で導入されました。
item(optional): item

アセットのコンテンツ・アイテム。
リリース21.1.3で導入されました。
pageId(optional): integer(int32)

ページID
リリース21.1.3で導入されました。
version(optional): string

このページで使用されているバージョン。
リリース21.1.3で導入されました。

{
    "properties":{
        "pageId":{
            "description":"<p>Page id.</p><small>Introduced in release 21.1.3.</small>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"integer",
            "format":"int32"
        },
        "instanceId":{
            "description":"<p>Instance id.</p><small>Introduced in release 21.1.3.</small>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "version":{
            "description":"<p>Version that is in use on this page.</p><small>Introduced in release 21.1.3.</small>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "item":{
            "description":"<p>The content item of the asset.</p><small>Introduced in release 21.1.3.</small>",
            "x-expandable":true,
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "x-expandedIn":[
                "representation"
            ],
            "allOf":[
                {
                    "$ref":"#/definitions/ContentItem"
                }
            ]
        }
    }
}

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

型: array

このリソースに対する関連リソースおよびアクションへのHATEOSリンク。リソースの正規表現へのリンクを含む自己リンクを少なくとも1つ含める必要があります。

ソースを表示

Array of: items

{
    "description":"<p>HATEOS link to related resources and actions or actions on this resource. Must include at least a 'self' link that contains a link to the canonical representation of the resource.</p>",
    "x-returnedIn":[
        "representation",
        "default",
        "basic"
    ],
    "type":"array",
    "items":{
        "allOf":[
            {
                "$ref":"#/definitions/Link"
            }
        ]
    }
}

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

すべてに一致

ソースを表示

object 「リンク」

REST HATEOASリンクおよび関連メタデータ。レスポンスがリンクを提供する場合(リソース自体へのselfリンクなど)、提供されるリンクには、このリンク構造で定義された1つ以上のプロパティが含まれます。

{
    "allOf":[
        {
            "$ref":"#/definitions/Link"
        }
    ]
}

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

型: object

REST HATEOASリンクおよび関連メタデータ。レスポンスがリンクを提供する場合(リソース自体へのselfリンクなど)、提供されるリンクには、このリンク構造で定義された1つ以上のプロパティが含まれます。

ソースを表示

href(optional): string

ターゲット・リソースのURI URI RFC3986またはURIテンプレートRFC6570。値がURIテンプレートに設定されている場合、templatedプロパティをtrueに設定する必要があります。
mediaType(optional): string

メディア・タイプ。RFC 2046で定義され、リンク・ターゲットを記述します。
method(optional): string
リンクのターゲットをリクエストするためのHTTPメソッド。
有効な値は次のとおりです。
- OPTIONS - HTTP OPTIONS
- HEAD - HTTP HEAD
- GET - HTTP GET
- POST - HTTP POST
- PUT - HTTP PUT
- PATCH - HTTP PATCH
- DELETE - HTTP DELETE
profile(optional): string(uri)

ターゲット・リソースを参照解除するときにリソースを指定するJSONスキーマなどのリソースのメタデータへのリンク。
rel(optional): string

リンクの詳細を取得するために使用できるリンク・リレーションの名前。
templated(optional): boolean

hrefプロパティを指定するブール・フラグは、URIまたはURIテンプレートです。プロパティが存在しない場合、falseとみなすことができます。

{
    "description":"<p>REST HATEOAS link and related metadata. If responses provide links (for example, a <code>self</code> link to the resource itself) the links provided will include one or more of the properties defined on this link structure.</p>",
    "properties":{
        "rel":{
            "description":"<p>Name of the link relation that, in addition to the type property, can be used to retrieve link details.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "href":{
            "description":"<p>The target resource URI. URI <em>RFC3986</em> or URI Template <em>RFC6570</em>. If the value is set to URI Template, then the <code>templated</code> property must be set to <code>true</code>.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "templated":{
            "description":"<p>Boolean flag that specifies the <code>href</code> property is a URI or URI Template. The property can be assumed to be <code>false</code> if the property is not present.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"boolean"
        },
        "mediaType":{
            "description":"<p>Media type, as defined by RFC 2046, describing the link target.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "method":{
            "description":"<p>HTTP method for requesting the target of the link.</p><p>Valid values are:\n<ul><li> <code>OPTIONS</code> - HTTP OPTIONS</li><li> <code>HEAD</code> - HTTP HEAD</li><li> <code>GET</code> - HTTP GET</li><li> <code>POST</code> - HTTP POST</li><li> <code>PUT</code> - HTTP PUT</li><li> <code>PATCH</code> - HTTP PATCH</li><li> <code>DELETE</code> - HTTP DELETE</li></p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "profile":{
            "description":"<p>Link to the metadata of the resource, such as JSON-schema, that describes the resource expected when dereferencing the target resource.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string",
            "format":"uri"
        }
    }
}

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

アセットのコンテンツ・アイテム。

リリース21.1.3で導入されました。

すべてに一致

ソースを表示

allOf ContentItem

コンテンツ・アイテム。
リリース20.1.1で導入されました。

{
    "description":"<p>The content item of the asset.</p><small>Introduced in release 21.1.3.</small>",
    "x-expandable":true,
    "x-returnedIn":[
        "representation",
        "default",
        "basic"
    ],
    "x-expandedIn":[
        "representation"
    ],
    "allOf":[
        {
            "$ref":"#/definitions/ContentItem"
        }
    ]
}

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

コンテンツ・アイテム。

リリース20.1.1で導入されました。

すべてに一致

ソースを表示

object SingularResource

すべての単数形のリソースには、特異なリソース定義のプロパティが含まれます。単一のリソースには、他のリソースとの関係を提供するリンク、またはリソース自体をselfがリンクするリンク先のリストが含まれます。
object ContentItem-allOf[1]

{
    "description":"<p>A content item.</p><small>Introduced in release 20.1.1.</small>",
    "allOf":[
        {
            "$ref":"#/definitions/SingularResource"
        },
        {
            "properties":{
                "id":{
                    "description":"<p>Unique identifier for the item.</p><p>No assumptions should be made about the content of the field; the field should be treated as an <em>opaque</em> value.</p><small>Introduced in release 20.1.1.</small>",
                    "x-opaque":true,
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic",
                        "minimal"
                    ],
                    "type":"string"
                },
                "name":{
                    "description":"<p>Short human-readable name to identify the item.</p><small>Introduced in release 20.1.1.</small>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "type":"string"
                },
                "type":{
                    "description":"<p>Item type.</p><small>Introduced in release 20.1.1.</small>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "type":"string"
                },
                "description":{
                    "description":"<p>Description of the item.</p><small>Introduced in release 20.1.1.</small>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "type":"string"
                },
                "slug":{
                    "description":"<p>URL slug of the item.</p><small>Introduced in release 20.1.1.</small>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "type":"string"
                },
                "isPublished":{
                    "description":"<p>Is item published.</p><small>Introduced in release 20.1.1.</small>",
                    "x-queryable":true,
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "type":"boolean"
                },
                "repositoryId":{
                    "description":"<p>Repository this content item is in.</p><p>No assumptions should be made about the content of the field; the field should be treated as an <em>opaque</em> value.</p><small>Introduced in release 20.1.1.</small>",
                    "x-queryable":true,
                    "x-opaque":true,
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "type":"string"
                },
                "channels":{
                    "description":"<p>Channels this content item is in.</p><small>Introduced in release 20.1.1.</small>",
                    "x-queryable":true,
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "allOf":[
                        {
                            "$ref":"#/definitions/ContentItemChannels"
                        }
                    ]
                },
                "publishedChannels":{
                    "description":"<p>Channels this content item is currently published to.</p><small>Introduced in release 20.1.1.</small>",
                    "x-queryable":true,
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "allOf":[
                        {
                            "$ref":"#/definitions/ContentItemChannels"
                        }
                    ]
                }
            }
        }
    ]
}

ネストされたスキーマ : ContentItem-allOf[1]

型: object

ソースを表示

channels(optional): チャネル

このコンテンツ・アイテムが存在するチャネル。
リリース20.1.1で導入されました。
description(optional): string

アイテムの説明。
リリース20.1.1で導入されました。
id(optional): string

品目の一意の識別子。
フィールドの内容は想定しないでください。フィールドはopaque値として扱われる必要があります。
リリース20.1.1で導入されました。
isPublished(optional): boolean

品目は公開済です。
リリース20.1.1で導入されました。
name(optional): string

品目を識別するための、人間が読むことのできる短縮名。
リリース20.1.1で導入されました。
publishedChannels(optional): publishedChannels

このコンテンツ・アイテムが現在公開されているチャネル。
リリース20.1.1で導入されました。
repositoryId(optional): string

このコンテンツ・アイテムがあるリポジトリ。
フィールドの内容は想定しないでください。フィールドはopaque値として扱われる必要があります。
リリース20.1.1で導入されました。
slug(optional): string

アイテムのURLスラグ。
リリース20.1.1で導入されました。
type(optional): string

アイテム・タイプ
リリース20.1.1で導入されました。

{
    "properties":{
        "id":{
            "description":"<p>Unique identifier for the item.</p><p>No assumptions should be made about the content of the field; the field should be treated as an <em>opaque</em> value.</p><small>Introduced in release 20.1.1.</small>",
            "x-opaque":true,
            "x-returnedIn":[
                "representation",
                "default",
                "basic",
                "minimal"
            ],
            "type":"string"
        },
        "name":{
            "description":"<p>Short human-readable name to identify the item.</p><small>Introduced in release 20.1.1.</small>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "type":{
            "description":"<p>Item type.</p><small>Introduced in release 20.1.1.</small>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "description":{
            "description":"<p>Description of the item.</p><small>Introduced in release 20.1.1.</small>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "slug":{
            "description":"<p>URL slug of the item.</p><small>Introduced in release 20.1.1.</small>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "isPublished":{
            "description":"<p>Is item published.</p><small>Introduced in release 20.1.1.</small>",
            "x-queryable":true,
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"boolean"
        },
        "repositoryId":{
            "description":"<p>Repository this content item is in.</p><p>No assumptions should be made about the content of the field; the field should be treated as an <em>opaque</em> value.</p><small>Introduced in release 20.1.1.</small>",
            "x-queryable":true,
            "x-opaque":true,
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "channels":{
            "description":"<p>Channels this content item is in.</p><small>Introduced in release 20.1.1.</small>",
            "x-queryable":true,
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "allOf":[
                {
                    "$ref":"#/definitions/ContentItemChannels"
                }
            ]
        },
        "publishedChannels":{
            "description":"<p>Channels this content item is currently published to.</p><small>Introduced in release 20.1.1.</small>",
            "x-queryable":true,
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "allOf":[
                {
                    "$ref":"#/definitions/ContentItemChannels"
                }
            ]
        }
    }
}

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

このコンテンツ・アイテムが存在するチャネル。

リリース20.1.1で導入されました。

すべてに一致

ソースを表示

allOf ContentItemChannels

コンテンツ・アイテムのチャネルIDのセット。

{
    "description":"<p>Channels this content item is in.</p><small>Introduced in release 20.1.1.</small>",
    "x-queryable":true,
    "x-returnedIn":[
        "representation",
        "default",
        "basic"
    ],
    "allOf":[
        {
            "$ref":"#/definitions/ContentItemChannels"
        }
    ]
}

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

このコンテンツ・アイテムが現在公開されているチャネル。

リリース20.1.1で導入されました。

すべてに一致

ソースを表示

allOf ContentItemChannels

コンテンツ・アイテムのチャネルIDのセット。

{
    "description":"<p>Channels this content item is currently published to.</p><small>Introduced in release 20.1.1.</small>",
    "x-queryable":true,
    "x-returnedIn":[
        "representation",
        "default",
        "basic"
    ],
    "allOf":[
        {
            "$ref":"#/definitions/ContentItemChannels"
        }
    ]
}

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

コンテンツ・アイテムのチャネルIDのセット。

すべてに一致

ソースを表示

object SingularResource

すべての単数形のリソースには、特異なリソース定義のプロパティが含まれます。単一のリソースには、他のリソースとの関係を提供するリンク、またはリソース自体をselfがリンクするリンク先のリストが含まれます。
object ContentItemChannels-allOf[1]

{
    "description":"<p>A set of channel ids for a content item.</p>",
    "allOf":[
        {
            "$ref":"#/definitions/SingularResource"
        },
        {
            "properties":{
                "data":{
                    "description":"<p>Channels.</p>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "type":"array",
                    "items":{
                        "allOf":[
                            {
                                "$ref":"#/definitions/ChannelId"
                            }
                        ]
                    }
                }
            }
        }
    ]
}

ネストされたスキーマ : ContentItemChannels-allOf[1]

型: object

ソースを表示

data(optional): array data

チャネル

{
    "properties":{
        "data":{
            "description":"<p>Channels.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"array",
            "items":{
                "allOf":[
                    {
                        "$ref":"#/definitions/ChannelId"
                    }
                ]
            }
        }
    }
}

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

型: array

チャネル

ソースを表示

Array of: items

{
    "description":"<p>Channels.</p>",
    "x-returnedIn":[
        "representation",
        "default",
        "basic"
    ],
    "type":"array",
    "items":{
        "allOf":[
            {
                "$ref":"#/definitions/ChannelId"
            }
        ]
    }
}

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

すべてに一致

ソースを表示

object ChannelId

チャネル識別子。

{
    "allOf":[
        {
            "$ref":"#/definitions/ChannelId"
        }
    ]
}

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

型: object

チャネル識別子。

ソースを表示

id(optional): string

リポジトリの一意の識別子。
フィールドの内容は想定しないでください。フィールドはopaque値として扱われる必要があります。
name(optional): string

チャネルを識別するための短くて判読可能な名前。

{
    "description":"<p>Channel identifier.</p>",
    "properties":{
        "id":{
            "description":"<p>Unique identifier for the repository.</p><p>No assumptions should be made about the content of the field; the field should be treated as an <em>opaque</em> value.</p>",
            "x-opaque":true,
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "name":{
            "description":"<p>Short unique human-readable name to identify the channel.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        }
    }
}

レスポンスの例(リスト・アセット)

{
    "totalResults":2,
    "limit":50,
    "count":2,
    "hasMore":false,
    "offset":0,
    "items":[
        {
            "pageId":100,
            "instanceId":"a47be99b-7b63-4918-bd2d-8373c8484036",
            "version":"2.4",
            "item":{
                "links":[
                    {
                        "rel":"canonical",
                        "href":"http://api.example.com/content/management/api/v1.1/items/CORE81C98B7935194159A2D1D3B0DBE948F5",
                        "templated":false,
                        "mediaType":"application/json",
                        "method":"GET"
                    }
                ]
            }
        },
        {
            "pageId":120,
            "instanceId":"d952fa9d-56cc-4adf-a1f5-0f549f3c49a4",
            "version":"draft",
            "item":{
                "links":[
                    {
                        "rel":"canonical",
                        "href":"http://api.example.com/content/management/api/v1.1/items/CONT051B2BD577E24A3F804785E1CF21B7D3",
                        "templated":false,
                        "mediaType":"application/json",
                        "method":"GET"
                    }
                ]
            }
        }
    ]
}

400レスポンス

不正なリクエスト

401レスポンス

未認可

403レスポンス

禁止

404レスポンス

見つかりません

ヘッダー

Cache-Control: string

キャッシュ・メカニズムのディレクティブ。
Content-Length: string

レスポンス本文のサイズ。
Content-Type: string

レスポンスのコンテンツ・タイプ。

ルート・スキーマ: schema

すべてに一致

ソースを表示

allOf TemplateNotFoundExceptionDetail

{
    "allOf":[
        {
            "$ref":"#/definitions/TemplateNotFoundExceptionDetail"
        }
    ]
}

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

すべてに一致

ソースを表示

object ExceptionDetail

HTTPエラー・コードおよびエラー・メッセージに加えて、リクエストが失敗したときにクライアントに追加情報を提供することが適切な場合もあります。その場合、追加情報がレスポンス本文に含まれます。
object TemplateNotFoundExceptionDetail-allOf[1]

{
    "description":"",
    "allOf":[
        {
            "$ref":"#/definitions/ExceptionDetail"
        },
        {
            "properties":{
                "template":{
                    "description":"<p>Template that does not exist or is not visible to the authenticated user.</p>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "type":"string"
                }
            }
        }
    ]
}

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

型: object

HTTPエラー・コードおよびエラー・メッセージに加えて、リクエストが失敗したときにクライアントに追加情報を提供することが適切な場合もあります。その場合、追加情報がレスポンス本文に含まれます。

ソースを表示

detail(optional): string

この問題の発生に固有の説明。人間が判読できる、場合によっては複数行の詳細で問題を説明しています。
instance(optional): string(uri)

エラーに関する詳細を提供するリンクへのURI。
o:errorCode(optional): string

アプリケーション・エラー・コード。HTTPエラー・コードとは異なります。このコードは、titleやdetailなどのフィールドを比較するのではなく、特定のエラーをチェックするために使用する必要があります。
o:errorDetails(optional): array o:errorDetails

階層構造に複数のエラーがある場合もあります。
o:errorPath(optional): string

エラーが発生した場所を示すXPathまたはJSONパス。
status(optional): integer(int32)

エラーに対応するHTTPステータス・コード。
title(optional): string

問題の短く、判読可能なサマリー。タイトルは、特定のエラーをチェックする方法としては使用しないでください。そのためにはo:errorCodeを使用してください。
type(optional): string(uri)

問題のタイプを識別する絶対URI。このURIが参照解除されると、「推奨」は、HTMLページなどの問題の判読可能なサマリーを提供します。

{
    "description":"<p>In addition to HTTP error code and error messages, it is often desirable to provide additional information to the client when a request fails. In such cases, the additional information will be included in the response body.</p>",
    "properties":{
        "type":{
            "description":"<p>Absolute URI that identifies the problem type. When this URI dereferenced, it <strong>should</strong> provide a human-readable summary of the problem, for example, as a HTML page.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string",
            "format":"uri"
        },
        "title":{
            "description":"<p>Short, human-readable summary of the problem. It is not advisable to use the title as a way of checking for specific errors, use the <code>o:errorCode</code> for this purpose.</p>",
            "x-multiLingual":true,
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "status":{
            "description":"<p>Corresponding HTTP status code for the error.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"integer",
            "format":"int32"
        },
        "detail":{
            "description":"<p>Description specific to this occurrence of the problem. The human-readable, potentially multi-line details describing the problem in more details.</p>",
            "x-multiLingual":true,
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "instance":{
            "description":"<p>URI to the link that provides more detail about the error.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string",
            "format":"uri"
        },
        "o:errorCode":{
            "description":"<p>Application error code, which is different from HTTP error code. This code should be used to check for specific errors, rather than comparing fields such as the <code>title</code> or <code>detail</code>.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "o:errorPath":{
            "description":"<p>XPath or JSON path to indicate where the error occurs.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "o:errorDetails":{
            "description":"<p>Multiple errors can be organized in a hierarchical structure.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"array",
            "items":{
                "allOf":[
                    {
                        "$ref":"#/definitions/ExceptionDetail"
                    }
                ]
            }
        }
    }
}

ネストされたスキーマ : TemplateNotFoundExceptionDetail-allOf[1]

型: object

ソースを表示

template(optional): string

存在しないか、認証されたユーザーに表示されないテンプレート。

{
    "properties":{
        "template":{
            "description":"<p>Template that does not exist or is not visible to the authenticated user.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        }
    }
}

ネストされたスキーマ: o:errorDetails

型: array

階層構造に複数のエラーがある場合もあります。

ソースを表示

Array of: items

{
    "description":"<p>Multiple errors can be organized in a hierarchical structure.</p>",
    "x-returnedIn":[
        "representation",
        "default",
        "basic"
    ],
    "type":"array",
    "items":{
        "allOf":[
            {
                "$ref":"#/definitions/ExceptionDetail"
            }
        ]
    }
}

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

すべてに一致

ソースを表示

object ExceptionDetail

HTTPエラー・コードおよびエラー・メッセージに加えて、リクエストが失敗したときにクライアントに追加情報を提供することが適切な場合もあります。その場合、追加情報がレスポンス本文に含まれます。

{
    "allOf":[
        {
            "$ref":"#/definitions/ExceptionDetail"
        }
    ]
}

レスポンスの例(テンプレートが見つかりません)

{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
    "title":"Template Not Found",
    "status":"404",
    "detail":"Template does not exist or has been deleted, or the authenticated user or client application does not have access to the template.",
    "o:errorCode":"OCE-SITEMGMT-009000",
    "template":{
        "id":"F30F08EB205D44AD20B5A48D1B1B3DD7D74F45978AB6"
    }
}

406レスポンス

受入れられない

416 レスポンス

範囲を満たすことはできません

429 レスポンス

リクエストが多すぎます

500レスポンス

内部サーバー・エラー

501レスポンス

実装されていない

502 レスポンス

ゲートウェイが不良

503レスポンス

サービス使用不可

504レスポンス

ゲートウェイがタイムアウト

先頭に戻る