サイト管理用のREST API

コンポーネント・リソースを作成するためのリクエスト本文の例を取得

get

/sites/management/api/v1/components/create-form

CREATE FORM

新しいコンポーネントの作成に適したテンプレート・リクエスト本文を取得します。create-formリソースは、新しいComponentの作成時にクライアントがテンプレートとして使用できるリクエスト本文の例を提供します。リクエスト本文のプロパティ値の例は、Componentの作成時に編集、削除、リクエスト本文として使用できます。作成フォームの使用はオプションであり、リクエスト本文の形式のガイドとしてのみ提供されます。

リリース19.4.1.での導入。

成功したレスポンスの例

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

200OK

リクエスト

GET https://api.example.com/sites/management/api/v1/components/create-form

レスポンス本文

{
  "file": "F40B9BE3E69F6DC440559A1F033BB2482DB740ECB2D8",
  "conflicts": {
    "resolution": "create",
    "name": "ContentNavMenu"
  }
}

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

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

400Bad Request - Deleted Filter Required

コンポーネント、テーマ、サイト、テンプレートなどのリソースのリストを作成する際、ごみ箱内にあるリソース、またはごみ箱にないリソースを一覧表示できます。ごみ箱内にあるリソースおよびごみ箱内にないリソースは一覧表示できません。このエラーは、includeDeletedとq問合せパラメータの組合せが、ごみ箱内にあるリソースをリストしようとしており、ごみ箱内にありません。

エラー・コード

OCE-DOCS-001007

解決 - ごみ箱内のリソースのリスト

includeDeleted=trueとdeleted eq "true"の両方を指定して、ごみ箱にリソースをリストします。

解決 - ごみ箱にないリソースのリスト表示

includeDeleted=trueを指定しないか、フィルタでdeleted eq "true"式を使用して、ごみ箱にないリソースをリストします。

レスポンス本文の例

{
  "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
  "title": "Deleted Filter Required",
  "status": "400",
  "detail": "You cannot list resources in the trash and not in the trash at the same time.",
  "o:errorCode": "OCE-DOCS-001007"
}

リリース19.4.3での導入。

リクエスト

問合せパラメータ

excludeFields(optional): string

レスポンスに含めないフィールド名のカンマ区切り文字列。
excludeLinks(optional): string

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

レスポンスに含めるフィールド名のカンマ区切りの文字列。フィールド名を区切るには、ドットを使用してネストされたフィールドを特定できます。フィールド名は大文字と小文字を区別します。フィールドが存在しない場合、フィールド名は無視されます。

links(optional): string

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

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

リンク関係	説明
`parent`	親リソースが読取り可能な場所を示します。このリンクは`up`リンクに相当し、親リソース(単数形のリソースを含むコレクション・リソースなど)へのリンクを提供します。
`self`	リソースの現在の戻り表現を示します。リソース自体を表すリンクに使用されます。たとえば、リソースがコレクションの一部として戻された場合、自己リンクは個々のリソースのURLパスを提供します。
`canonical`	リクエストされたリソースの優先表現を示します。リソースの標準的な形式を表すリンクに使用されます。たとえば、リソースがコレクションの一部として返される場合、正規リンクは個々のリソースの正規の形式のURLパスを提供します。
`create`	リソースを作成できる場所を説明します。コレクション・リソースで、コレクション内に新規リソースを作成するために投稿を実行できる場所を示すために使用されます。
`describedBy`	リソースに関するメタデータ情報を提供するスキーマ・リソースが記述されます。スキーマ・リソースがリソースを説明する場所を示すために、コレクション・リソース、単数形およびリレーション・リソースで使用されます。

トップに戻る

レスポンス

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

application/json
application/vnd.oracle.resource+json;type=create-form

200レスポンス

ヘッダー

Cache-Control: string

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

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

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

ルート・スキーマ: schema

型: object

ソースを表示

conflicts(optional): object conflicts

コンポーネント競合解決の実行方法の詳細。指定しない場合、インポートでは新しいコンポーネントの作成が試行されます。
リリース19.4.1.での導入。
file: string

コンポーネント・パッケージ・ファイル。
リリース19.4.1.での導入。
links(optional): array links

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

{
    "type":"object",
    "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"
                    }
                ]
            }
        },
        "file":{
            "description":"<p>Component package file.</p><small>Introduced in release 19.4.1.</small>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "conflicts":{
            "description":"<p>Details of how component conflict resolution is performed. If not specified, then the import will attempt to create a new component.</p><small>Introduced in release 19.4.1.</small>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"object",
            "properties":{
                "resolution":{
                    "description":"<p>How to handle component conflicts.</p><p>Valid values are:\n<ul><li> <code>create</code> - Import the component with a new identity if a component exists with the same identity. Optionally, a new component name can</li></ul>be specified to avoid any name conflict.\n<ul><li> <code>rename</code> - Import the component with a new name but keeping its identity.  If rename conflict resolution is chosen,</li></ul>then a new component name will also have to be specified.\n<ul><li> <code>overwrite</code> - Overwrite the conflicting component with the one being imported if a component exists with the same identity</li><li> <code>skip</code> - Do not import the component if there is a conflict</li></p><small>Introduced in release 19.4.1.</small>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "type":"string"
                },
                "name":{
                    "description":"<p>If a resolution of <code>rename</code> is chosen, a component name must be provided. If a resolution of <code>create</code> is chosen, a component name may optionally be provided. </p><small>Introduced in release 19.4.1.</small>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "type":"string",
                    "maxLength":255
                }
            },
            "required":[
                "resolution"
            ]
        }
    },
    "required":[
        "file"
    ]
}

ネストされたスキーマ : 競合

型: object

コンポーネント競合解決の実行方法の詳細。指定しない場合、インポートでは新しいコンポーネントの作成が試行されます。

リリース19.4.1.での導入。

ソースを表示

name(optional): string

最大長: 255

renameを解決する場合は、コンポーネント名を指定する必要があります。 createの解決を選択した場合、コンポーネント名を指定することもできます。
リリース19.4.1.での導入。
resolution: string
コンポーネントの競合の処理方法。
有効な値は次のとおりです。
- create - 同じIdのコンポーネントが存在する場合は、新しいidでコンポーネントをインポートします。オプションで、新しいコンポーネント名ができます
名前の競合を避けるために指定する必要があります。
- rename - コンポーネントを新しい名前でインポートしますが、アイデンティティは維持します。名前の変更による競合解決を選択した場合
この場合、新しいコンポーネント名も指定する必要があります。
- overwrite - 同じアイデンティティのコンポーネントが存在する場合、インポートするコンポーネントで競合するコンポーネントを上書きします
- skip - 競合が発生している場合はコンポーネントをインポートしない
リリース19.4.1.での導入。

{
    "description":"<p>Details of how component conflict resolution is performed. If not specified, then the import will attempt to create a new component.</p><small>Introduced in release 19.4.1.</small>",
    "x-returnedIn":[
        "representation",
        "default",
        "basic"
    ],
    "type":"object",
    "properties":{
        "resolution":{
            "description":"<p>How to handle component conflicts.</p><p>Valid values are:\n<ul><li> <code>create</code> - Import the component with a new identity if a component exists with the same identity. Optionally, a new component name can</li></ul>be specified to avoid any name conflict.\n<ul><li> <code>rename</code> - Import the component with a new name but keeping its identity.  If rename conflict resolution is chosen,</li></ul>then a new component name will also have to be specified.\n<ul><li> <code>overwrite</code> - Overwrite the conflicting component with the one being imported if a component exists with the same identity</li><li> <code>skip</code> - Do not import the component if there is a conflict</li></p><small>Introduced in release 19.4.1.</small>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "name":{
            "description":"<p>If a resolution of <code>rename</code> is chosen, a component name must be provided. If a resolution of <code>create</code> is chosen, a component name may optionally be provided. </p><small>Introduced in release 19.4.1.</small>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string",
            "maxLength":255
        }
    },
    "required":[
        "resolution"
    ]
}

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

レスポンスの例 ()

{
    "file":"F40B9BE3E69F6DC440559A1F033BB2482DB740ECB2D8",
    "conflicts":{
        "resolution":"create",
        "name":"ContentNavMenu"
    }
}

400レスポンス

不正なリクエスト

ルート・スキーマ: schema

すべてに一致

ソースを表示

allOf DeletedRequiredExceptionDetail

リリース19.4.3での導入。

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

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

リリース19.4.3での導入。

すべてに一致

ソースを表示

object ExceptionDetail

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

{
    "description":"<small>Introduced in release 19.4.3.</small>",
    "allOf":[
        {
            "$ref":"#/definitions/ExceptionDetail"
        },
        {
        }
    ]
}

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

ネストされたスキーマ: 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":"Deleted Filter Required",
    "status":"400",
    "detail":"You cannot list resources in the trash and not in the trash at the same time.",
    "o:errorCode":"OCE-DOCS-001007"
}

401レスポンス

未認可

406レスポンス

受入れられない

416 レスポンス

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

429 レスポンス

リクエストが多すぎます

500レスポンス

内部サーバー・エラー

501レスポンス

実装されていない

502 レスポンス

ゲートウェイが不良

503レスポンス

サービス使用不可

504レスポンス

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

先頭に戻る