サイト管理用のREST API

テンプレート・メンバー・リソースを作成するためのリクエスト本文の例の取得

get

/sites/management/api/v1/templates/{id}/members/create-form

CREATE FORM

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

リリース19.4.1.での導入。

認可

このcreate-formリソースにアクセスするには、親リソースへの読取りアクセス権が必要です。

詳細は、「テンプレート詳細の取得」を参照してください。

パス代替識別子

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

nameテンプレート名

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

http://api.example.com/sites/management/api/v1/templates/name:CafeSupremo/members/create-form

リリース19.4.1.での導入。

成功したレスポンスの例

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

200OK

リクエスト

GET https://api.example.com/sites/management/api/v1/templates/{id}/members/create-form

レスポンス本文

{
  "id": "user:jsmith",
  "role": "owner",
  "message": "I added you as a member. It should appear in your list when you sign in to Oracle Content Management."
}

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

この操作は、レスポンス本文に例外の詳細が含まれている次のクライアント・エラー(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

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

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

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

削除対象としてマークされているリソースでは、この問合せパラメータがtrueに設定されているかぎり、読取り、変更およびサポート対象の拡張操作が可能です。 includeDeleted問合せパラメータを送信しない場合、読取り、変更および拡張操作に対するレスポンスは、リソースが完全に削除された場合に戻されるものと同じです。

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

ソースを表示

id: string

ユーザー、クライアント・アプリケーションまたはグループ・メンバーの識別子。
フィールドの内容は想定しないでください。フィールドはopaque値として扱われる必要があります。
リリース19.4.1.での導入。
links(optional): array links

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

最大長: 3000

共有が実行された通知の一部として使用されるメッセージ。
リリース19.4.1.での導入。
role: string
ユーザー、クライアント・アプリケーションまたはグループが与えられた共有ロール。
有効な値は次のとおりです。
- owner - ユーザーが所有者です。
- manager - ユーザーにマネージャ・ロールがあります
- contributor - ユーザーにコントリビュータ・ロールがあります
- downloader - ユーザーにはダウンロード実行者ロールがあります
- viewer - ユーザーの参照者のロール
リリース19.4.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"
                    }
                ]
            }
        },
        "id":{
            "description":"<p>Identifier for the user, client application or group member.</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 19.4.1.</small>",
            "x-opaque":true,
            "x-returnedIn":[
                "representation",
                "default",
                "basic",
                "minimal"
            ],
            "type":"string"
        },
        "role":{
            "description":"<p>Sharing role that the user, client application or group has been given.</p><p>Valid values are:\n<ul><li> <code>owner</code> - User is the owner</li><li> <code>manager</code> - User has Manager role</li><li> <code>contributor</code> - User has Contributor role</li><li> <code>downloader</code> - User has Downloader role</li><li> <code>viewer</code> - User has Viewer role</li></p><small>Introduced in release 19.4.1.</small>",
            "x-queryable":true,
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "message":{
            "description":"<p>Message that will be used as part of the notification that sharing has been performed. </p><small>Introduced in release 19.4.1.</small>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string",
            "maxLength":3000
        }
    },
    "required":[
        "id",
        "role"
    ]
}

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

レスポンスの例 ()

{
    "id":"user:jsmith",
    "role":"owner",
    "message":"I added you as a member. It should appear in your list when you sign in to Oracle Content Management."
}

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レスポンス

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

先頭に戻る