サイト管理用のREST API

リクエスト・リソース編集のためのリクエスト本文の例の取得

get

/sites/management/api/v1/requests/{id}/edit-form

EDIT FORM

リクエスト・インスタンスの編集に適したテンプレート・リクエスト本文を取得します。edit-formリソースは、Requestの編集時に更新可能なプロパティを判断するためのテンプレートとしてクライアントに使用されます。レスポンスには編集可能なすべてのプロパティ値が含まれます。これらのプロパティを編集または破棄し、Requestを編集するためのリクエスト本文として使用できます。

認可

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

詳細は、「リクエストの取得」を参照してください。

成功したレスポンスの例

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

200OK

リクエスト

GET https://api.example.com/sites/management/api/v1/requests/{id}/edit-form

レスポンス本文

{
  "justification": "I require a marketing site for our new product.",
  "name": "MyNewProduct",
  "description": "This is a marketing site for my new product.",
  "repository": "F81629473A3DB8B2A28669F19E68209BBAD3340745B0",
  "localizationPolicy": "7D77CB6653BC1FF8E0530100007F6630",
  "defaultLanguage": "en-US",
  "sitePrefix": "News",
  "contentSecurity": {
    "taxonomy": "BC42C4FE109446539C9962DAC0C64CF2",
    "category": "AF11C4FE109446539C9962DAC0C09KF2"
  },
  "includeUpdates": false
}

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

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

404Not Found - Request Not Found

リクエストが存在しないか、削除されたか、認証されたユーザーまたはクライアント・アプリケーションがリクエストへのアクセス権を持っていません。

エラー・コード

OCE-SITEMGMT-009001

解決 - 識別子のチェック

リクエスト識別子が有効であることを確認してください。

解決 - 認可の確認

認証済ユーザーがリクエストをレビューできること、または認証済ユーザーがリクエストを作成したユーザーであることを確認します。

例外詳細フィールド

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

フィールド名	説明
`request`	存在しない、または認証されたユーザーが表示できないリクエストです。

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

レスポンス本文の例

{
  "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
  "title": "Request Not Found",
  "status": "404",
  "detail": "Request does not exist or has been deleted, or the authenticated user or client application does not have access to the request.",
  "o:errorCode": "OCE-SITEMGMT-009001",
  "request": {
    "id": "e77229e8-1f44-4c27-bacb-9a99b7c77af7"
  }
}

リクエスト

パス・パラメータ

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パスを提供します。
`edit`	リソースを編集できる場所について説明します。単一のリソースで使用され、既存のリソースを編集するためにパッチを実行できる場所を示します。
`describedBy`	リソースに関するメタデータ情報を提供するスキーマ・リソースが記述されます。スキーマ・リソースがリソースを説明する場所を示すために、コレクション・リソース、単数形およびリレーション・リソースで使用されます。

トップに戻る

レスポンス

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

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

200レスポンス

ヘッダー

Cache-Control: string

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

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

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

オリジン・サーバーによって特定のバージョンのリソースに割り当てられた不透明識別子。

ルート・スキーマ: schema

型: object

ソースを表示

contentSecurity(optional): contentSecurity

サイトのセキュリティ・カテゴリ。
将来のリリースを対象としています。
この操作は、未使用の将来のリリースを対象としています。この操作は変更される可能性があります。
defaultLanguage(optional): string

サイトのデフォルト言語。ローカリゼーション・ポリシーの必須言語の1つである必要があります。エンタープライズ・サイトに対するリクエストで必要です。
リリース19.2.3.での導入。
description(optional): string

最大長: 1000

サイトの説明は、サイトの目的や使用状況をユーザーが理解するのに役立ちます。説明の内容に制限はありません。任意の文字を含む1行または複数行を指定できます。
includeUpdates(optional): boolean

未公開の更新内容をコピーに含めます。
リリース19.2.2.での導入。
justification(optional): string

最大長: 1000

理由は、承認者がこのリクエストをレビューするのに役立ちます。説明の内容に制限はありません。任意の文字を含む1行または複数行を指定できます。
links(optional): array links

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

サイトの作成時にサイトに関連付けられるローカリゼーション・ポリシーです。ローカリゼーション・ポリシーは、エンタープライズ・サイトに対してのみ設定できます。リクエストに関連付けられているポリシーがローカリゼーション・ポリシーを指定している場合、ローカリゼーション・ポリシーはリクエストに関連付けられません。
リリース19.2.3.での導入。
name(optional): string

最大長: 242

この名前はサイト作成プロセスで使用され、新しいサイトの識別に使用されます。名前は一意である必要があります。指定した名前は既存のサイトの名前と同じにできません。
repository(optional): string

サイトの作成時にサイトに関連付けられるアセット・リポジトリ。リポジトリは、エンタープライズ・サイトに対してのみ設定できます。リクエストに関連付けられているポリシーでリポジトリが指定されている場合、リポジトリをリクエストに関連付けることはできません。
リリース19.2.3.での導入。
sitePrefix(optional): string

最大長: 15

サイトの作成時にサイトに設定されるサイト・プレフィクス。エンタープライズ・サイトのリクエストにのみ設定されます。リクエストに関連付けられているポリシーで許可されている場合のみ設定できます。そうでない場合、サイト・プレフィクスが自動的に生成されます。サイト・プレフィクスの長さは15文字までです。
リリース19.2.3.での導入。

{
    "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"
                    }
                ]
            }
        },
        "justification":{
            "description":"<p>The justification is to help human approvers review this request. There is no restriction on the contents of the description; it can be a single line or multiple lines with any characters.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string",
            "maxLength":1000
        },
        "name":{
            "description":"<p>This name is used during the site creation process and is used to identify the new site. Names must be unique; the name provided cannot be the same as the name of any existing site. </p>",
            "x-sortable":true,
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string",
            "maxLength":242
        },
        "description":{
            "description":"<p>The site description is used to help people understand the purpose and usage of the site. There is no restriction on the contents of the description; it can be a single line or multiple lines with any characters.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string",
            "maxLength":1000
        },
        "repository":{
            "description":"<p>The asset repository that will be associated with the site when it is created. Repositories can be set only for enterprise sites. A repository cannot be associated with a request if the policy associated with the request specifies a repository.</p><small>Introduced in release 19.2.3.</small>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "localizationPolicy":{
            "description":"<p>The localization policy that will be associated with the site when it is created. Localization policies can be set only for enterprise sites. A localization policy cannot be associated with a request if the policy associated with the request specifies a localization policy.</p><small>Introduced in release 19.2.3.</small>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "defaultLanguage":{
            "description":"<p>The default language of the site. Must be one of the required languages of the localization policy. Required in requests for an enterprise site.</p><small>Introduced in release 19.2.3.</small>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "sitePrefix":{
            "description":"<p>The site prefix that will be set on a site when it is created. Will be set only on requests for an enterprise site. Can only be set only if the policy associated with the request allows; otherwise, the site prefix will be automatically generated. Site prefixes are limit to 15 characters in length.</p><small>Introduced in release 19.2.3.</small>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string",
            "maxLength":15
        },
        "contentSecurity":{
            "description":"<p>The security category for the site.</p><div style=\"padding: 0px 0px 10px 20px; border: 2px solid #AE562C; margin: 0; border-left: 15px solid #AE562C; border-radius: 4px; margin-bottom: 10px;\"><h3>Targeted for a Future Release</h3><p>This operation is targeted for an undecided future release. This operation may be subject to change.</p></div>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "allOf":[
                {
                    "$ref":"#/definitions/SiteContentSecurity"
                }
            ]
        },
        "includeUpdates":{
            "description":"<p>Include unpublished updates in the copy.</p><small>Introduced in release 19.2.2.</small>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"boolean"
        }
    }
}

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

サイトのセキュリティ・カテゴリ。

将来のリリースを対象としています。

この操作は、未使用の将来のリリースを対象としています。この操作は変更される可能性があります。

すべてに一致

ソースを表示

object SiteContentSecurity

サイトのコンテンツ・セキュリティ。
将来のリリースを対象としています。
この操作は、未使用の将来のリリースを対象としています。この操作は変更される可能性があります。

{
    "description":"<p>The security category for the site.</p><div style=\"padding: 0px 0px 10px 20px; border: 2px solid #AE562C; margin: 0; border-left: 15px solid #AE562C; border-radius: 4px; margin-bottom: 10px;\"><h3>Targeted for a Future Release</h3><p>This operation is targeted for an undecided future release. This operation may be subject to change.</p></div>",
    "x-returnedIn":[
        "representation",
        "default",
        "basic"
    ],
    "allOf":[
        {
            "$ref":"#/definitions/SiteContentSecurity"
        }
    ]
}

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

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

型: object

サイトのコンテンツ・セキュリティ。

将来のリリースを対象としています。

この操作は、未使用の将来のリリースを対象としています。この操作は変更される可能性があります。

ソースを表示

category(optional): string

関連付けられたタクソノミ・カテゴリ・リソース。
将来のリリースを対象としています。
この操作は、未使用の将来のリリースを対象としています。この操作は変更される可能性があります。
taxonomy(optional): string

関連付けられたタクソノミ・リソース。
将来のリリースを対象としています。
この操作は、未使用の将来のリリースを対象としています。この操作は変更される可能性があります。

{
    "description":"<p>Content security for a site.</p><div style=\"padding: 0px 0px 10px 20px; border: 2px solid #AE562C; margin: 0; border-left: 15px solid #AE562C; border-radius: 4px; margin-bottom: 10px;\"><h3>Targeted for a Future Release</h3><p>This operation is targeted for an undecided future release. This operation may be subject to change.</p></div>",
    "properties":{
        "taxonomy":{
            "description":"<p>Associated Taxonomy resource.</p><div style=\"padding: 0px 0px 10px 20px; border: 2px solid #AE562C; margin: 0; border-left: 15px solid #AE562C; border-radius: 4px; margin-bottom: 10px;\"><h3>Targeted for a Future Release</h3><p>This operation is targeted for an undecided future release. This operation may be subject to change.</p></div>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "category":{
            "description":"<p>Associated Taxonomy Category resource.</p><div style=\"padding: 0px 0px 10px 20px; border: 2px solid #AE562C; margin: 0; border-left: 15px solid #AE562C; border-radius: 4px; margin-bottom: 10px;\"><h3>Targeted for a Future Release</h3><p>This operation is targeted for an undecided future release. This operation may be subject to change.</p></div>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        }
    }
}

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

レスポンスの例 ()

{
    "justification":"I require a marketing site for our new product.",
    "name":"MyNewProduct",
    "description":"This is a marketing site for my new product.",
    "repository":"F81629473A3DB8B2A28669F19E68209BBAD3340745B0",
    "localizationPolicy":"7D77CB6653BC1FF8E0530100007F6630",
    "defaultLanguage":"en-US",
    "sitePrefix":"News",
    "contentSecurity":{
        "taxonomy":"BC42C4FE109446539C9962DAC0C64CF2",
        "category":"AF11C4FE109446539C9962DAC0C09KF2"
    },
    "includeUpdates":false
}

400レスポンス

不正なリクエスト

401レスポンス

未認可

403レスポンス

禁止

404レスポンス

見つかりません

ヘッダー

Cache-Control: string

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

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

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

ルート・スキーマ: schema

すべてに一致

ソースを表示

allOf RequestNotFoundExceptionDetail

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

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

すべてに一致

ソースを表示

object ExceptionDetail

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

{
    "description":"",
    "allOf":[
        {
            "$ref":"#/definitions/ExceptionDetail"
        },
        {
            "properties":{
                "request":{
                    "description":"<p>Request 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"
                    }
                ]
            }
        }
    }
}

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

型: object

ソースを表示

request(optional): string

存在しない、または認証されたユーザーが表示できないリクエストです。

{
    "properties":{
        "request":{
            "description":"<p>Request 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":"Request Not Found",
    "status":"404",
    "detail":"Request does not exist or has been deleted, or the authenticated user or client application does not have access to the request.",
    "o:errorCode":"OCE-SITEMGMT-009001",
    "request":{
        "id":"e77229e8-1f44-4c27-bacb-9a99b7c77af7"
    }
}

406レスポンス

受入れられない

416 レスポンス

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

429 レスポンス

リクエストが多すぎます

500レスポンス

内部サーバー・エラー

501レスポンス

実装されていない

502 レスポンス

ゲートウェイが不良

503レスポンス

サービス使用不可

504レスポンス

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

先頭に戻る