テンプレート・リソースを作成するためのリクエスト本文の例の取得
/sites/management/api/v1/sites/{id}/templates/create-form
新しいテンプレートの作成に適したテンプレート・リクエスト本文を取得します。create-formリソースは、新しいTemplateの作成時にクライアントがテンプレートとして使用できるリクエスト本文の例を提供します。 リクエスト本文のプロパティ値の例は、Templateの作成時に編集、削除、リクエスト本文として使用できます。 作成フォームの使用はオプションであり、リクエスト本文の形式のガイドとしてのみ提供されます。
リリース19.4.1.での導入。
パス代替識別子
「サイト」リソースのデフォルトの識別子は、「サイト識別子」です。 サイト・リソースは代替識別子をサポートしています。
nameサイト名
サイト識別子のかわりに、サイト名を使用してリソース・パスのサイトを一意に識別できます。 サイトのデフォルトのリソース・パス・パラメータはサイト識別子ですが、サイトでの作業時には判読可能なサイト名が簡単になる場合があります。
http://api.example.com/sites/management/api/v1/sites/name:MyNewProduct/templates/create-form
リリース19.4.1.での導入。
成功したレスポンスの例
この操作は、次の成功(2xx)のレスポンスで応答します。 レスポンスHTTPステータス・コードとサンプル本体の完全なリストは、この操作の「レスポンス」に関する項を参照してください。
200OK
リクエスト
GET https://api.example.com/sites/management/api/v1/sites/{id}/templates/create-form
レスポンス本文
{ "name": "CafeSupremo", "description": "A description of something.", "includeUnpublished": false, "type": "inherit" }
リクエスト
- id: string
サイトの不変の識別子。
- excludeFields(optional): string
レスポンスに含めないフィールド名のカンマ区切り文字列。
- excludeLinks(optional): string
レスポンスからexcludeへのリンク関係名のカンマ区切りリスト。
- fields(optional): string
レスポンスに含めるフィールド名のカンマ区切りの文字列。 フィールド名を区切るには、ドットを使用してネストされたフィールドを特定できます。 フィールド名は大文字と小文字を区別します。 フィールドが存在しない場合、フィールド名は無視されます。
- includeDeleted(optional): boolean
削除対象としてマークされているリソースでは、この問合せパラメータが
trueに設定されているかぎり、読取り、変更およびサポート対象の拡張操作が可能です。includeDeleted問合せパラメータを送信しない場合、読取り、変更および拡張操作に対するレスポンスは、リソースが完全に削除された場合に戻されるものと同じです。 - links(optional): string
レスポンス内のincludeへのリンク関係名のカンマ区切りリスト。 デフォルトでは、すべてのリンクが返されます。
次のリンクは、このリソースにより提供されます:
リンク関係 説明 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- description(optional): string
最大長:
1000オプションの説明。 説明の内容に制限はありません。任意の文字を含む1行または複数行を指定できます。
リリース19.4.1.での導入。 - includeUnpublished(optional): boolean
公開されていないコンテンツ・アイテムおよびデジタル・アセットをテンプレートに含めます。
リリース19.4.1.での導入。trueに設定すると、公開済および未公開のコンテンツ・アイテムおよびデジタル・アセットの両方がテンプレートに含まれます。falseに設定すると、公開されたコンテンツ・アイテムおよびデジタル・アセットのみがテンプレートに含まれます。 指定しない場合、デフォルトでは、公開済のコンテンツ・アイテムおよびデジタル・アセットのみが含まれます。 - links(optional): array links
このリソースに対する関連リソースおよびアクションへのHATEOSリンク。 リソースの正規表現へのリンクを含む自己リンクを少なくとも1つ含める必要があります。
- name: string
最大長:
242テンプレートの名前。
リリース19.4.1.での導入。 - type(optional): string
作成するテンプレートのタイプ。
enterpriseに設定すると、サイトがエンタープライズ・サイトでない場合でも、作成されたテンプレートはエンタープライズ・テンプレートになります。inheritに設定すると、テンプレート・タイプはサイトからタイプを継承します。 指定しない場合、テンプレートのデフォルトはサイトからタイプを継承します。有効な値は次のとおりです。
-
inherit- テンプレート・タイプはサイトから継承されます -
enterprise- エンタープライズ・テンプレートの作成
-
arrayこのリソースに対する関連リソースおよびアクションへのHATEOSリンク。 リソースの正規表現へのリンクを含む自己リンクを少なくとも1つ含める必要があります。
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とみなすことができます。
{
"name":"CafeSupremo",
"description":"A description of something.",
"includeUnpublished":false,
"type":"inherit"
}