サイト管理用のREST API

デフォルト・テンプレートのインポート

post

/sites/management/api/v1/templates/_import

EXTENDED OPERATION

デフォルトのテンプレート、テーマおよびコンポーネントのセットをインポートします。サービスを最初に作成したときに、開発者が使用できるテンプレート、テーマまたはコンポーネントはありません。テンプレート、テーマおよびコンポーネントのデフォルトのセットは、必要に応じてインポートできます。たとえば、テンプレート、テーマおよびコンポーネントの作成方法に関するいくつかのアイデアを開発者に提供します。サイト開発者は、これらのデフォルト・テンプレートを変更またはコピーして、サイト用の独自のテンプレートを作成できます。デフォルトのテンプレート、テーマおよびコンポーネントがすでに存在する場合は、「上書き済」になります。認証されたユーザーがテンプレート、テーマまたはコンポーネントのいずれかを共有権限のために上書きする権限を持っていない場合、影響を受けるテンプレート・インポート・ジョブはエラーをレポートしますが、他のテンプレート・インポート・ジョブは影響を受けません。この操作を実際にコールすることは、すべてのデフォルトのテンプレート・パッケージを個別にインポートした後、各テンプレート・パッケージの各ジョブをモニタリングすることと同じです。

リリース19.4.1.での導入。

認可

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

CECDeveloperUser
CECSitesAdministrator
CECContentAdministrator

テンプレートのインポート

別のサービスからエクスポートされたテンプレートをインポートして、デフォルトのテンプレートをコンパイルすることもできます。

詳細は、「テンプレート・パッケージのインポート」を参照してください。

テンプレートのインポート・ジョブの進捗の取得

テンプレートのインポートの進捗は、テンプレート・ジョブ・ステータスのリソースから監視できます。

詳細は、「テンプレート関連ジョブの進捗の取得」を参照してください。

非同期処理

この操作「のみ」非同期処理をサポートしています。 respond-asyncの値を持つPreferヘッダーがリクエストに含まれている必要があります。 「承認済」レスポンスにはLocationヘッダーが含まれ、非同期処理に関する情報を取得するためにポーリングできる「ステータス・リソース」のロケーションを示します。

ステータスの読取りの詳細は、「テンプレート関連ジョブの進捗の取得」を参照してください。

成功したレスポンスの例

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

202Accepted - Default Templates Import Started

リクエストが受け入れられると、Locationヘッダーは、バッチ処理構文を使用してこの操作で作成された個々のテンプレート・インポート・ジョブをすべて識別するテンプレート・ジョブ・ステータスを参照します。デフォルトのテンプレートのインポート操作では、デフォルトのテンプレートごとに1つのジョブが作成され、ロケーション・ヘッダーでは1つのリクエストですべてのジョブ・ステータスの詳細を読み取る方法が提供されます。各ジョブが完了すると、各ジョブ・ステータスのリソース・レスポンスのtemplateフィールド内にあるリンクを使用して、インポートされたテンプレートを配置できます。

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

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

403Forbidden - Template Overwrite Denied

overwriteの競合解決によってテンプレートがインポートされた場合、テンプレートはすでに存在しますが、認証されたユーザーにそれを上書きする権限がありません。

エラー・コード

OCE-SITEMGMT-009048

解決 - シェア・テンプレート

所有者は、ユーザーがテンプレートを上書きできるようにテンプレートのマネージャとしてユーザーを追加できます。

このエラーが返される場所

このエラー「次の場合があります」がレスポンス本文に返されました。
このエラー「次と等しくない」は非同期ジョブ・ステータスで返されました。

例外詳細フィールド

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

フィールド名	説明
`name`	テンプレート名
`owner`	テンプレート所有者の担当者詳細。

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

レスポンス本文の例

{
  "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
  "title": "Template Overwrite Denied",
  "status": "403",
  "detail": "Template '{name}' already exists and cannot be overwritten.",
  "o:errorCode": "OCE-SITEMGMT-009048",
  "name": "CafeSupremo",
  "owner": {
    "displayName": "John Smith",
    "email": "jsmith@example.com",
    "userName": "jsmith"
  }
}

リリース19.4.1.での導入。

403禁止 - テンプレートのごみ箱での上書き

競合解決がoverwriteのテンプレートをインポートすると、テンプレートはすでに存在し、ごみ箱にあります。

エラー・コード

OCE-SITEMGMT-009110

解決 - テンプレートを完全に削除

自分が所有者である場合は、テンプレートを完全に削除します。所有者でない場合は、所有者にテンプレートを完全に削除するように依頼し、再試行してください。

解決 - テンプレートのリストア

所有者である場合は、テンプレートをリストアして再試行してください。

このエラーが返される場所

このエラー「次の場合があります」がレスポンス本文に返されました。
このエラー「次と等しくない」は非同期ジョブ・ステータスで返されました。

例外詳細フィールド

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

フィールド名	説明
`name`	テンプレート名
`owner`	テンプレート所有者の担当者詳細。

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

レスポンス本文の例

{
  "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
  "title": "Template Overwrite In Trash",
  "status": "403",
  "detail": "Template '{name}' is in trash so cannot be overwritten.",
  "o:errorCode": "OCE-SITEMGMT-009110",
  "name": "CafeSupremo",
  "owner": {
    "displayName": "John Smith",
    "email": "jsmith@example.com",
    "userName": "jsmith"
  }
}

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

403Forbidden - Theme Overwrite Denied

overwriteの競合解決によってテーマがインポートされた場合、そのテーマはすでに存在しますが、認証済ユーザーには上書きする権限がありません。

エラー・コード

OCE-SITEMGMT-009049

解決 - テーマの共有

所有者は、ユーザーがテーマを上書きできるように、テーマのマネージャとしてユーザーを追加できます。

このエラーが返される場所

このエラー「次の場合があります」がレスポンス本文に返されました。
このエラー「次と等しくない」は非同期ジョブ・ステータスで返されました。

例外詳細フィールド

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

フィールド名	説明
`name`	テーマ名。
`owner`	テーマ所有者の連絡先の詳細。

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

レスポンス本文の例

{
  "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
  "title": "Theme Overwrite Denied",
  "status": "403",
  "detail": "Theme '{name}' already exists and cannot be overwritten.",
  "o:errorCode": "OCE-SITEMGMT-009049",
  "name": "CafeSupremoTheme",
  "owner": {
    "displayName": "John Smith",
    "email": "jsmith@example.com",
    "userName": "jsmith"
  }
}

リリース19.4.1.での導入。

403禁止 - ごみ箱でのテーマの上書き

競合解決がoverwriteのテーマをインポートすると、テーマはすでに存在し、ごみ箱にあります。

エラー・コード

OCE-SITEMGMT-009109

解決 - テーマを完全に削除

自分が所有者である場合、テーマを完全に削除します。所有者でない場合は、所有者にテーマを完全に削除するように依頼し、再試行してください。

解決 - テーマのリストア

所有者である場合は、テーマをリストアして再試行してください。

このエラーが返される場所

このエラー「次の場合があります」がレスポンス本文に返されました。
このエラー「次と等しくない」は非同期ジョブ・ステータスで返されました。

例外詳細フィールド

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

フィールド名	説明
`name`	テーマ名。
`owner`	テーマ所有者の連絡先の詳細。

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

レスポンス本文の例

{
  "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
  "title": "Theme Overwrite In Trash",
  "status": "403",
  "detail": "Theme '{name}' is in trash so cannot be overwritten.",
  "o:errorCode": "OCE-SITEMGMT-009109",
  "name": "CafeSupremoTheme",
  "owner": {
    "displayName": "John Smith",
    "email": "jsmith@example.com",
    "userName": "jsmith"
  }
}

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

403Forbidden - Component Overwrite Denied

overwriteの競合解消でコンポーネントをインポートする場合、そのコンポーネントはすでに存在しますが、認証されたユーザーには上書きする権限がありません。

エラー・コード

OCE-SITEMGMT-009050

解決 - コンポーネントの共有

所有者は、ユーザーがコンポーネントを上書きできるように、コンポーネントのmanagerとしてユーザーを追加できます。

このエラーが返される場所

このエラー「次の場合があります」がレスポンス本文に返されました。
このエラー「次と等しくない」は非同期ジョブ・ステータスで返されました。

例外詳細フィールド

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

フィールド名	説明
`name`	コンポーネント名
`owner`	コンポーネント所有者担当者詳細。

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

レスポンス本文の例

{
  "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
  "title": "Component Overwrite Denied",
  "status": "403",
  "detail": "Component '{name}' already exists and cannot be overwritten.",
  "o:errorCode": "OCE-SITEMGMT-009050",
  "name": "ContentNavMenu",
  "owner": {
    "displayName": "John Smith",
    "email": "jsmith@example.com",
    "userName": "jsmith"
  }
}

リリース19.4.1.での導入。

403禁止 - ごみ箱でのコンポーネントの上書き

競合解決がoverwriteのコンポーネントがインポートされ、そのコンポーネントはすでに存在し、ごみ箱にあります。

エラー・コード

OCE-SITEMGMT-009108

解決 - コンポーネントを完全に削除

自分が所有者である場合は、コンポーネントを完全に削除します。所有者でない場合は、所有者にコンポーネントを完全に削除するように依頼し、再試行してください。

解決 - コンポーネントのリストア

所有者である場合は、コンポーネントをリストアして再試行してください。

このエラーが返される場所

このエラー「次の場合があります」がレスポンス本文に返されました。
このエラー「次と等しくない」は非同期ジョブ・ステータスで返されました。

例外詳細フィールド

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

フィールド名	説明
`name`	コンポーネント名
`owner`	コンポーネント所有者担当者詳細。

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

レスポンス本文の例

{
  "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
  "title": "Component Overwrite In Trash",
  "status": "403",
  "detail": "Component '{name}' is in trash so cannot be overwritten.",
  "o:errorCode": "OCE-SITEMGMT-009108",
  "name": "ContentNavMenu",
  "owner": {
    "displayName": "John Smith",
    "email": "jsmith@example.com",
    "userName": "jsmith"
  }
}

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

403禁止 - サイト管理者ロール必須

このタイプのリソースを作成するには、サイト管理者ロールが必要です。

エラー・コード

OCE-SITEMGMT-009140

解決 - サイト・システム設定の変更

サイト、テンプレート、テーマおよびコンポーネントの作成は、サイト管理者に制限できます。管理者以外のユーザーがこのタイプのサイト・リソースを作成できるように、サイト・システム設定を更新します。

このエラーが返される場所

このエラー「次の場合があります」がレスポンス本文に返されました。
このエラー「次と等しくない」は非同期ジョブ・ステータスで返されました。

例外詳細フィールド

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

フィールド名	説明
`resourceType`	サイト管理者のみが作成できるリソース・タイプ。有効な値は次のとおりです。 `site` - サイト・リソース `template` - テンプレート・リソース `theme` - テーマ・リソース `component` - コンポーネント・リソース
`name`	作成中のリソースの名前(使用可能な場合)。

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

レスポンス本文の例

{
  "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
  "title": "Sites Administrator Role Required",
  "status": "403",
  "detail": "The Sites Administrator role is required to create resources of this type.",
  "o:errorCode": "OCE-SITEMGMT-009140",
  "resourceType": "site",
  "name": "value"
}

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

403Forbidden - Storage Limit Reached

ストレージ転送制限に達しました。請求限度は、システム管理者が使用可能なストレージ容量に設定されています。

エラー・コード

OCE-SITEMGMT-009098

解決 - ストレージ制限の増加

ストレージ制限を増やすシステム管理者を取得します。

このエラーが返される場所

このエラー「行わない」がレスポンス本文に返されます。
このエラー「次の場合があります」は非同期ジョブ・ステータスで返されました。

例外詳細フィールド

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

フィールド名	説明
`used`	使用済ストレージ(GB)。
`limit`	ストレージ制限(GB)。

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

レスポンス本文の例

{
  "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
  "title": "Storage Limit Reached",
  "status": "403",
  "detail": "Storage limit has been reached.",
  "o:errorCode": "OCE-SITEMGMT-009098",
  "used": 1.23456789,
  "limit": 1.23456789
}

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

409競合 - Starter Editionのアセット・タイプの制限に達しました

Starter Editionのアセット・タイプの制限に達しました。

エラー・コード

OCE-SITEMGMT-009159

解決 - Premiumにアップグレード

無制限のアセット・タイプにアクセスするには、プレミアムにアップグレードしてください。

このエラーが返される場所

このエラー「行わない」がレスポンス本文に返されます。
このエラー「次の場合があります」は非同期ジョブ・ステータスで返されました。

レスポンス本文の例

{
  "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
  "title": "Starter Edition Asset Types Limit Reached",
  "status": "409",
  "detail": "Starter edition limits the number of asset types that can be created.",
  "o:errorCode": "OCE-SITEMGMT-009159"
}

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

409競合 - 無効なタクソノミ・バージョン

インポートされたタクソノミ・バージョンが既存のタクソノミより低くなっています。

エラー・コード

OCE-SITEMGMT-009162

このエラーが返される場所

このエラー「行わない」がレスポンス本文に返されます。
このエラー「次の場合があります」は非同期ジョブ・ステータスで返されました。

レスポンス本文の例

{
  "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
  "title": "Invalid Taxonomy Version",
  "status": "409",
  "detail": "Imported taxonomy version is lower than the existing taxonomy.",
  "o:errorCode": "OCE-SITEMGMT-009162"
}

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

リクエスト

ヘッダー・パラメータ

Prefer(optional): string

respond-asyncヘッダー値を使用してリクエストの非同期処理をリクエストします。

トップに戻る

レスポンス

202レスポンス

Accepted

400レスポンス

不正なリクエスト

401レスポンス

未認可

403レスポンス

禁止

ルート・スキーマ: schema

すべてに一致

ソースを表示

allOf TemplateOverwriteDeniedExceptionDetail

リリース19.4.1.での導入。

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

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

リリース19.4.1.での導入。

すべてに一致

ソースを表示

object ExceptionDetail

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

{
    "description":"<small>Introduced in release 19.4.1.</small>",
    "allOf":[
        {
            "$ref":"#/definitions/ExceptionDetail"
        },
        {
            "properties":{
                "name":{
                    "description":"<p>Template name. </p><small>Introduced in release 19.4.1.</small>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "type":"string",
                    "maxLength":242
                },
                "owner":{
                    "description":"<p>Template owner contact details.</p><small>Introduced in release 19.4.1.</small>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "allOf":[
                        {
                            "$ref":"#/definitions/UserContact"
                        }
                    ]
                }
            }
        }
    ]
}

ネストされたスキーマ : 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"
                    }
                ]
            }
        }
    }
}

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

型: object

ソースを表示

name(optional): string

最大長: 242

テンプレート名
リリース19.4.1.での導入。
owner(optional): owner

テンプレート所有者の担当者詳細。
リリース19.4.1.での導入。

{
    "properties":{
        "name":{
            "description":"<p>Template name. </p><small>Introduced in release 19.4.1.</small>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string",
            "maxLength":242
        },
        "owner":{
            "description":"<p>Template owner contact details.</p><small>Introduced in release 19.4.1.</small>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "allOf":[
                {
                    "$ref":"#/definitions/UserContact"
                }
            ]
        }
    }
}

ネストされたスキーマ: 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"
        }
    ]
}

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

テンプレート所有者の担当者詳細。

リリース19.4.1.での導入。

すべてに一致

ソースを表示

allOf UserContact

ユーザー担当者詳細。ユーザーの表示名と電子メール・アドレスが含まれます。

{
    "description":"<p>Template owner contact details.</p><small>Introduced in release 19.4.1.</small>",
    "x-returnedIn":[
        "representation",
        "default",
        "basic"
    ],
    "allOf":[
        {
            "$ref":"#/definitions/UserContact"
        }
    ]
}

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

ユーザー担当者詳細。ユーザーの表示名と電子メール・アドレスが含まれます。

すべてに一致

ソースを表示

object SingularResource

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

{
    "description":"<p>User contact details. Contains the display name and email address of a user.</p>",
    "allOf":[
        {
            "$ref":"#/definitions/SingularResource"
        },
        {
            "properties":{
                "displayName":{
                    "description":"<p>Human-readable user display name.</p>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "type":"string"
                },
                "email":{
                    "description":"<p>Email address to use when sending email notifications.</p>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "type":"string"
                },
                "userName":{
                    "description":"<p>User login name. Typically the user email address is used as the user login name.</p>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "type":"string"
                }
            }
        }
    ]
}

ネストされたスキーマ : 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"
                    }
                ]
            }
        }
    }
}

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

型: object

ソースを表示

displayName(optional): string

人間が読み取り可能なユーザー表示名。
email(optional): string

電子メール通知を送信するときに使用する電子メール・アドレス。
userName(optional): string

ユーザーのログイン名。通常、ユーザーの電子メール・アドレスはユーザー・ログイン名として使用されます。

{
    "properties":{
        "displayName":{
            "description":"<p>Human-readable user display name.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "email":{
            "description":"<p>Email address to use when sending email notifications.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "userName":{
            "description":"<p>User login name. Typically the user email address is used as the user login name.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        }
    }
}

ネストされたスキーマ: 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"
        }
    }
}

レスポンスの例(テンプレート上書きが拒否されました)

{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
    "title":"Template Overwrite Denied",
    "status":"403",
    "detail":"Template '{name}' already exists and cannot be overwritten.",
    "o:errorCode":"OCE-SITEMGMT-009048",
    "name":"CafeSupremo",
    "owner":{
        "displayName":"John Smith",
        "email":"jsmith@example.com",
        "userName":"jsmith"
    }
}

レスポンスの例(ごみ箱でのテンプレート上書き)

{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
    "title":"Template Overwrite In Trash",
    "status":"403",
    "detail":"Template '{name}' is in trash so cannot be overwritten.",
    "o:errorCode":"OCE-SITEMGMT-009110",
    "name":"CafeSupremo",
    "owner":{
        "displayName":"John Smith",
        "email":"jsmith@example.com",
        "userName":"jsmith"
    }
}

レスポンスの例(テーマ上書きが拒否されました)

{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
    "title":"Theme Overwrite Denied",
    "status":"403",
    "detail":"Theme '{name}' already exists and cannot be overwritten.",
    "o:errorCode":"OCE-SITEMGMT-009049",
    "name":"CafeSupremoTheme",
    "owner":{
        "displayName":"John Smith",
        "email":"jsmith@example.com",
        "userName":"jsmith"
    }
}

レスポンスの例(ごみ箱での上書き)

{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
    "title":"Theme Overwrite In Trash",
    "status":"403",
    "detail":"Theme '{name}' is in trash so cannot be overwritten.",
    "o:errorCode":"OCE-SITEMGMT-009109",
    "name":"CafeSupremoTheme",
    "owner":{
        "displayName":"John Smith",
        "email":"jsmith@example.com",
        "userName":"jsmith"
    }
}

レスポンスの例(コンポーネント上書きが拒否されました)

{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
    "title":"Component Overwrite Denied",
    "status":"403",
    "detail":"Component '{name}' already exists and cannot be overwritten.",
    "o:errorCode":"OCE-SITEMGMT-009050",
    "name":"ContentNavMenu",
    "owner":{
        "displayName":"John Smith",
        "email":"jsmith@example.com",
        "userName":"jsmith"
    }
}

レスポンスの例(ごみ箱でのコンポーネントの上書き)

{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
    "title":"Component Overwrite In Trash",
    "status":"403",
    "detail":"Component '{name}' is in trash so cannot be overwritten.",
    "o:errorCode":"OCE-SITEMGMT-009108",
    "name":"ContentNavMenu",
    "owner":{
        "displayName":"John Smith",
        "email":"jsmith@example.com",
        "userName":"jsmith"
    }
}

レスポンスの例(Sites Administrator Role Required)

{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
    "title":"Sites Administrator Role Required",
    "status":"403",
    "detail":"The Sites Administrator role is required to create resources of this type.",
    "o:errorCode":"OCE-SITEMGMT-009140",
    "resourceType":"site",
    "name":"value"
}

409レスポンス

競合

413 レスポンス

ペイロードが大きすぎます

429 レスポンス

リクエストが多すぎます

500レスポンス

内部サーバー・エラー

501レスポンス

実装されていない

502 レスポンス

ゲートウェイが不良

503レスポンス

サービス使用不可

504レスポンス

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

先頭に戻る