サイト・リソースを作成するためのリクエスト本文の例の取得
/sites/management/api/v1/sites/create-form
新規サイトの作成に適したテンプレート・リクエスト本文を取得します。create-formリソースには、新規Siteの作成時にクライアントがテンプレートとして使用できるリクエスト本文の例が用意されています。 リクエスト本文のプロパティ値の例は、Siteの作成時に編集、削除、リクエスト本文として使用できます。 作成フォームの使用はオプションであり、リクエスト本文の形式のガイドとしてのみ提供されます。
成功したレスポンスの例
この操作は、次の成功(2xx)のレスポンスで応答します。 レスポンスHTTPステータス・コードとサンプル本体の完全なリストは、この操作の「レスポンス」に関する項を参照してください。
200OK
リクエスト
GET https://api.example.com/sites/management/api/v1/sites/create-form
レスポンス本文
{ "requestType": "SiteRequest", "justification": "I require a marketing site for our new product.", "template": "F30F08EB205D44AD20B5A48D1B1B3DD7D74F45978AB6", "id": "FCA9C0E5CDCB549A19FFB85987A2352778961003B8A0", "name": "MyNewProduct", "description": "This is a marketing site for my new product.", "repository": "F81629473A3DB8B2A28669F19E68209BBAD3340745B0", "localizationPolicy": "7D77CB6653BC1FF8E0530100007F6630", "defaultLanguage": "en-US", "sitePrefix": "News", "ownedBy": "1234", "contentSecurity": { "taxonomy": "BC42C4FE109446539C9962DAC0C64CF2", "category": "AF11C4FE109446539C9962DAC0C09KF2" } }
クライアント・エラー・レスポンスの例
この操作は、レスポンス本文に例外の詳細が含まれている次のクライアント・エラー(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
レスポンスのコンテンツ・タイプ。
object- contentSecurity(optional): contentSecurity
サイトのセキュリティ・カテゴリ。
将来のリリースを対象としています。
この操作は、未使用の将来のリリースを対象としています。 この操作は変更される可能性があります。
- defaultLanguage(optional): string
サイトのデフォルト言語。 ローカリゼーション・ポリシーの必須言語の1つである必要があります。 エンタープライズ・サイトに対するリクエストで必要です。
リリース19.2.3.での導入。 - description(optional): string
最大長:
1000サイトの説明は、サイトの目的や使用状況をユーザーが理解するのに役立ちます。 説明の内容に制限はありません。任意の文字を含む1行または複数行を指定できます。
- id(optional): string
オプションでサイトの識別子を指定しました。 このIDはサービス内で一意である必要があります。 指定しない場合、識別子は自動的に割り当てられます。
フィールドの内容は想定しないでください。フィールドはopaque値として扱われる必要があります。
- justification(optional): string
最大長:
1000理由は、承認者がこのリクエストをレビューするのに役立ちます。 説明の内容に制限はありません。任意の文字を含む1行または複数行を指定できます。
- links(optional): array links
このリソースに対する関連リソースおよびアクションへのHATEOSリンク。 リソースの正規表現へのリンクを含む自己リンクを少なくとも1つ含める必要があります。
- localizationPolicy(optional): string
サイトの作成時にサイトに関連付けられるローカリゼーション・ポリシーです。 ローカリゼーション・ポリシーは、エンタープライズ・サイトに対してのみ設定できます。 リクエストに関連付けられているポリシーがローカリゼーション・ポリシーを指定している場合、ローカリゼーション・ポリシーはリクエストに関連付けられません。
リリース19.2.3.での導入。 - name: string
最大長:
242この名前はサイト作成プロセスで使用され、新しいサイトの識別に使用されます。 名前は一意である必要があります。指定した名前は既存のサイトの名前と同じにできません。
- ownedBy(optional): string
サイトを所有するユーザーまたはクライアント・アプリケーションを取得します。 サイトを所有するユーザーまたはクライアント・アプリケーションは、別のユーザーのかわりにリクエストが作成された場合にリクエストを作成したユーザーまたはクライアント・アプリケーションとは異なる場合があります。
- repository(optional): string
サイトの作成時にサイトに関連付けられるアセット・リポジトリ。 リポジトリは、エンタープライズ・サイトに対してのみ設定できます。 リクエストに関連付けられているポリシーでリポジトリが指定されている場合、リポジトリをリクエストに関連付けることはできません。
リリース19.2.3.での導入。 - sitePrefix(optional): string
最大長:
15サイトの作成時にサイトに設定されるサイト・プレフィクス。 エンタープライズ・サイトのリクエストにのみ設定されます。 リクエストに関連付けられているポリシーで許可されている場合のみ設定できます。そうでない場合、サイト・プレフィクスが自動的に生成されます。 サイト・プレフィクスの長さは15文字までです。
リリース19.2.3.での導入。 - template: string
リクエストに関連付けられているテンプレートを取得します。 新規サイトのリクエストが作成されると、サイトを作成するテンプレートが指定され、リクエストに関連付けられます。 リクエストが新規サイト・リクエストでない場合、テンプレートは返されません。
サイトのセキュリティ・カテゴリ。
将来のリリースを対象としています。
この操作は、未使用の将来のリリースを対象としています。 この操作は変更される可能性があります。
- object SiteContentSecurity
サイトのコンテンツ・セキュリティ。
将来のリリースを対象としています。
この操作は、未使用の将来のリリースを対象としています。 この操作は変更される可能性があります。
arrayこのリソースに対する関連リソースおよびアクションへのHATEOSリンク。 リソースの正規表現へのリンクを含む自己リンクを少なくとも1つ含める必要があります。
objectサイトのコンテンツ・セキュリティ。
将来のリリースを対象としています。
この操作は、未使用の将来のリリースを対象としています。 この操作は変更される可能性があります。
- category(optional): string
関連付けられたタクソノミ・カテゴリ・リソース。
将来のリリースを対象としています。
この操作は、未使用の将来のリリースを対象としています。 この操作は変更される可能性があります。
- taxonomy(optional): string
関連付けられたタクソノミ・リソース。
将来のリリースを対象としています。
この操作は、未使用の将来のリリースを対象としています。 この操作は変更される可能性があります。
objectREST 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とみなすことができます。
{
"requestType":"SiteRequest",
"justification":"I require a marketing site for our new product.",
"template":"F30F08EB205D44AD20B5A48D1B1B3DD7D74F45978AB6",
"id":"FCA9C0E5CDCB549A19FFB85987A2352778961003B8A0",
"name":"MyNewProduct",
"description":"This is a marketing site for my new product.",
"repository":"F81629473A3DB8B2A28669F19E68209BBAD3340745B0",
"localizationPolicy":"7D77CB6653BC1FF8E0530100007F6630",
"defaultLanguage":"en-US",
"sitePrefix":"News",
"ownedBy":"1234",
"contentSecurity":{
"taxonomy":"BC42C4FE109446539C9962DAC0C64CF2",
"category":"AF11C4FE109446539C9962DAC0C09KF2"
}
}400レスポンス
- object ExceptionDetail
HTTPエラー・コードおよびエラー・メッセージに加えて、リクエストが失敗したときにクライアントに追加情報を提供することが適切な場合もあります。 その場合、追加情報がレスポンス本文に含まれます。
-
objectHTTPエラー・コードおよびエラー・メッセージに加えて、リクエストが失敗したときにクライアントに追加情報を提供することが適切な場合もあります。 その場合、追加情報がレスポンス本文に含まれます。
- 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ページなどの問題の判読可能なサマリーを提供します。
- object ExceptionDetail
HTTPエラー・コードおよびエラー・メッセージに加えて、リクエストが失敗したときにクライアントに追加情報を提供することが適切な場合もあります。 その場合、追加情報がレスポンス本文に含まれます。
{
"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"
}