サイト管理用のREST API

テンプレート関連ジョブの進捗の取得

get

/sites/management/api/v1/templates/_status/{id}

SINGULAR

テンプレート関連ジョブのステータスを取得します。テンプレートに関連する長時間実行されるバックグラウンド・ジョブ(テンプレートのインポートやコピーなど)の進行状況は、このリソースを使用して監視できます。テンプレートまたはコピー・テンプレートをインポートするリクエストは、テンプレート・ジョブ・ステータスのリソースを指すLocationヘッダーを使用して、テンプレート関連ジョブのステータスを呼出し側に指示します。

リリース19.4.1.での導入。

成功したレスポンスの例

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

200OK - Get the Status of a Running Import Job

処理中のテンプレート・ジョブのジョブ・ステータスで、進捗率が示されます。レスポンスにリンクは含まれません。

リクエスト

GET https://api.example.com/sites/management/api/v1/templates/_status/{id}?links=none

レスポンス本文

{
  "context": "F49F1047E72E2FBBA7AD1754F7253CA453FCE1E1171C1541416472868",
  "action": "import",
  "startTime": "2019-05-31T09:14:29.000Z",
  "progress": "processing",
  "completed": false,
  "completedPercentage": 38,
  "intervalToPoll": 5000
}

200 OK - 失敗したコピー・ジョブのステータスの取得

処理中に発生したエラーを示す、失敗したテンプレート・ジョブのジョブ・ステータス。レスポンスにリンクは含まれません。

リクエスト

GET https://api.example.com/sites/management/api/v1/templates/_status/{id}?links=none

レスポンス本文

{
  "context": "F49F1047E72E2FBBA7AD1754F7253CA453FCE1E1171C1541416472868",
  "action": "copy",
  "startTime": "2019-05-31T09:14:25.000Z",
  "progress": "failed",
  "completed": false,
  "error": {
    "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
    "title": "Template Already Exists",
    "status": 409,
    "detail": "Template with name 'MyTemplate' already exists.",
    "o:errorCode": "OCE-SITEMGMT-009040",
    "o:errorDetails": [
    ]
  }
}

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

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

404Not Found - Template Job Not Found

テンプレート・ジョブが存在しないか、削除されたか、認証されたユーザーまたはクライアント・アプリケーションにジョブへのアクセス権がありません。

エラー・コード

OCE-SITEMGMT-009051

解決 - 識別子のチェック

テンプレート・ジョブ識別子が有効であることを確認してください。

例外詳細フィールド

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

フィールド名	説明
`jobStatus`	存在しないか、認証されたユーザーに表示されないテンプレート・ジョブ・ステータス。

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

レスポンス本文の例

{
  "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
  "title": "Template Job Not Found",
  "status": "404",
  "detail": "Job does not exist or has been deleted, or the authenticated user or client application does not have access to the job.",
  "o:errorCode": "OCE-SITEMGMT-009051",
  "jobStatus": {
    "context": "37D1070720325969AC6C47ACE8B9BFF91533560416423"
  }
}

リリース19.4.1.での導入。

リクエスト

パス・パラメータ

id: string

レスポンスを元の非同期ジョブに関連付けるために使用できるジョブ・コンテキスト識別子の値。非同期ジョブがどのように開始されたかによって、コンテキスト値があるかどうか、およびコンテキスト値は何かが決まります。

問合せパラメータ

excludeFields(optional): string

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

レスポンスからexcludeへのリンク関係名のカンマ区切りリスト。

expand(optional): string

展開するフィールド名のカンマ区切りの文字列。値allを使用して、すべての関係を展開します。

expand問合せパラメータには次のフィールド名を指定できます:

フィールド名	説明
`template`	完了済インポート・ジョブのインポート済テンプレート。
`theme`	完了したインポート・ジョブのインポート・テーマ。
`components`	完了したインポート・ジョブのインポート済コンポーネント。

expansionErrors(optional): string
拡張のエラーの処理方法を指定します。指定しない場合は、デフォルトで関連フィールドにエラーの詳細が含まれます。
有効な値は次のとおりです。
- ignore - エラーを無視して関係を展開しません。関連リンクはレスポンスに含まれません
- include - 展開された関係のかわりにエラー詳細を含めます。関連リンクが返されます
- fail - リクエストの拡張の失敗エラー・レスポンスでの失敗
fields(optional): string

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

links(optional): string

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

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

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

return(optional): string

レスポンス・フィールドおよびリンクの制御に使用するリソース表現を指定します。表現が指定されない場合、fields、excludeFields、links、excludeLinksおよびexpand問合せパラメータの値に基づいて、クライアント定義の表現が戻されます。

次の表現は、return問合せパラメータでサポートされています:

表現	説明
`representation`	フル・リソース表示には、すべてのプロパティとリンクが含まれ、大部分の関係が拡張されます。
`default`	デフォルトのリソース表示には、ほとんどのプロパティとリンクが含まれます。
`basic`	基本的なリソース表現には、いくつかのプロパティといくつかのリンクが含まれます。
`minimal`	最小リソース表現。必須プロパティとリンクなしが含まれます。

トップに戻る

レスポンス

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

application/json
application/vnd.oracle.resource+json;type=singular

200レスポンス

ヘッダー

Cache-Control: string

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

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

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

ルート・スキーマ: schema

すべてに一致

ソースを表示

allOf TemplateJobStatus

識別子: action

テンプレート・ジョブのバックグラウンド・ジョブの詳細。

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

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

識別子: action

テンプレート・ジョブのバックグラウンド・ジョブの詳細。

すべてに一致

ソースを表示

object SingularResource

すべての単数形のリソースには、特異なリソース定義のプロパティが含まれます。単一のリソースには、他のリソースとの関係を提供するリンク、またはリソース自体をselfがリンクするリンク先のリストが含まれます。
object TemplateJobStatus-allOf[1]

{
    "description":"<p>Background job details for template jobs.</p>",
    "discriminator":"action",
    "allOf":[
        {
            "$ref":"#/definitions/SingularResource"
        },
        {
            "properties":{
                "action":{
                    "description":"<p>Type of <em>Template Job Status</em>. Valid values are: <code>copy</code>, <code>import</code>, <code>export</code>, <code>hardDelete</code>.</p>",
                    "x-queryable":true,
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "type":"string"
                },
                "context":{
                    "description":"<p>Job context identifier value that can be used to correlate the response to the original asynchronous job. Depending on how the asynchronous job was initiated will determine whether there is a context value and what the context value is.</p>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic",
                        "minimal"
                    ],
                    "type":"string"
                },
                "startTime":{
                    "description":"<p>Time when the asynchronous job started running. If the asynchronous job has not started this property will not be present. Certain background jobs may not record a start time, so if if the job has started there may not be a start time. Date and time values are in ISO 8601 <code>yyyy-MM-dd'T'HH:mm:ss.SSS'Z'</code> format using a UTC timezone.</p>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "type":"string",
                    "format":"date-time"
                },
                "endTime":{
                    "description":"<p>Time when the asynchronous job finished running, or when the asynchronous job failed. If the asynchronous job has not finished or failed (or not started) this property will not be present. Certain background jobs may not record a stop time, so if if the job has completed there may not be a stop time. Date and time values are in ISO 8601 <code>yyyy-MM-dd'T'HH:mm:ss.SSS'Z'</code> format using a UTC timezone.</p>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "type":"string",
                    "format":"date-time"
                },
                "progress":{
                    "description":"<p>The current progress of the asynchronous job. These values indicate that the asynchronous job has ended: <code>succeeded</code>, <code>failed</code>, <code>aborted</code>. The value <code>blocked</code> means that the asynchronous job requires action, such as waiting for a human to approve something. The values that indicate the asynchronous job is in process are: <code>pending</code>, <code>processing</code>, <code>paused</code>.</p><p>Valid values are:\n<ul><li> <code>pending</code> - Request is waiting to run</li><li> <code>processing</code> - Request is running</li><li> <code>succeeded</code> - Request has completed successfully</li><li> <code>failed</code> - Request has failed</li></ul>\n A processing request failed before it was completed.\n<ul><li> <code>aborted</code> - Request was aborted</li></ul>\nA processing request was aborted before it was completed.\n<ul><li> <code>paused</code> - Request was running, but is now paused</li><li> <code>blocked</code> - Request is blocked</li></ul>\nRequest requires action, such as waiting for a human to approve something.\n</p>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "type":"string"
                },
                "completed":{
                    "description":"<p>Whether the asynchronous job is completed or not.</p>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "type":"boolean"
                },
                "requestStatus":{
                    "description":"<p>HTTP status code of the asynchronous asynchronous job request. This status is not the status obtaining when querying the asynchronous job status, but the status response of the asynchronous job when it is completed. This value is only available after the asynchronous job has ended.</p>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "type":"integer",
                    "format":"int32"
                },
                "message":{
                    "description":"<p>Human-readable message about the current processing status. This message can be used to communicate progress to the end user. Asynchronous requests or jobs may not provide a human-readable status message.</p>",
                    "x-multiLingual":true,
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "type":"string"
                },
                "completedPercentage":{
                    "description":"<p>A number between 0 and 100, capturing how much of the process has been completed. If the asynchronous job has not started the percentage complete will not be provided. Not all background asynchronous jobs support granular process, so the percentage complete may jump from zero to one hundred without any steps.</p>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "type":"integer",
                    "format":"int32"
                },
                "intervalToPoll":{
                    "description":"<p>A number in milliseconds, as a hint to the client on how long the client should wait before checking the status again. Absence of this value means there is no suggested polling interval and the client can poll as required.</p>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "type":"integer",
                    "format":"int64"
                },
                "error":{
                    "description":"<p>Error details for the asynchronous job response when the job fails. This is only available if the asynchronous job has run but failed.</p>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "type":"object"
                },
                "result":{
                    "description":"<p>It may be desirable to include the final result in the status resource so that the client can get the result when it polls the service for the status. The result is captured in this optional property. This property should only be used when the HTTP response can be efficiently returned inside the status resource. If this property is present, then the <code>requestStatus</code> property will be omitted to avoid duplication. The body of the response is a JSON object comprised of response-specific properties. Non-JSON response data may be supported either by Base64 encoding the non-JSON data as a byte string inside the body property or providing a link to the non-JSON resource in the 'links' property of the status resource.</p>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "allOf":[
                        {
                            "$ref":"#/definitions/HttpResponse"
                        }
                    ]
                }
            }
        }
    ]
}

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

型: object

すべての単数形のリソースには、特異なリソース定義のプロパティが含まれます。単一のリソースには、他のリソースとの関係を提供するリンク、またはリソース自体をselfがリンクするリンク先のリストが含まれます。

ソースを表示

links(optional): array links

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

{
    "description":"<p>All singular resources include the properties of the singular resource definition. A singular resource includes a list of links that provide relationships to other resources, or in the case of the <em>self</em> link the resource itself.</p>",
    "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"
                    }
                ]
            }
        }
    }
}

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

型: object

ソースを表示

action(optional): string

「テンプレート・ジョブ・ステータス」のタイプ。有効な値は次のとおりです: copy, import, export, hardDelete。
completed(optional): boolean

非同期ジョブが完了したかどうか。
completedPercentage(optional): integer(int32)

プロセスの完了数を取得し、0から100までの数値。非同期ジョブが開始していない場合、完了率は提供されません。すべてのバックグラウンド非同期ジョブが詳細なプロセスをサポートしているわけではないため、完了率はステップなしでゼロから100にジャンプできます。
context(optional): string

レスポンスを元の非同期ジョブに関連付けるために使用できるジョブ・コンテキスト識別子の値。非同期ジョブがどのように開始されたかによって、コンテキスト値があるかどうか、およびコンテキスト値は何かが決まります。
endTime(optional): string(date-time)

非同期ジョブの実行が終了した時間、または非同期ジョブが失敗した時間。非同期ジョブが終了していないか失敗した(または開始していない)場合、このプロパティは存在しません。特定のバックグラウンド・ジョブは停止時間を記録しないことがあるため、ジョブが完了した場合、停止時間がない可能性があります。日付値と時間値は、UTCタイムゾーンを使用してISO 8601 yyyy-MM-dd'T'HH:mm:ss.SSS'Z'形式です。
error(optional): object error

ジョブの失敗時の非同期ジョブ・レスポンスのエラー詳細。このオプションは、非同期ジョブが実行されたにも失敗した場合にのみ使用可能です。
intervalToPoll(optional): integer(int64)

クライアントがステータスを再度チェックするまでに待機する必要がある時間のヒントとして、1ミリ秒数。この値がない場合、ポーリング間隔は提案されず、クライアントは必要に応じてポーリングできることを意味します。
message(optional): string

現在の処理ステータスに関する、人間が読み取り可能なメッセージ。このメッセージは、エンド・ユーザーに進行状況を通知するために使用されます。非同期リクエストまたはジョブは、判読可能なステータス・メッセージを提供しない場合があります。
progress(optional): string
非同期ジョブの現在の進行状況。これらの値は、非同期ジョブが終了したことを示します: succeeded、failed、aborted。 blockedの値は、非同期ジョブには人による承認の待機など、アクションが必要であることを意味します。非同期ジョブが処理中であることを示す値は次のとおりです: pending、processing、paused。
有効な値は次のとおりです。
- pending - リクエストは実行を待機しています
- processing - リクエストは実行中です
- succeeded - リクエストは正常に完了しました
- failed - リクエストに失敗しました
処理リクエストが完了する前に失敗しました。
- aborted - リクエストは中断されました
処理リクエストが完了する前に中止されました。
- paused - リクエストは実行中でしたが、現在は一時停止しています
- blocked - リクエストはブロックされています
リクエストには、人の承認を待機するなどのアクションが必要です。
requestStatus(optional): integer(int32)

非同期ジョブ・リクエストのHTTPステータス・コード。このステータスは、非同期ジョブ・ステータスの問合せ時に取得するステータスではなく、非同期ジョブが完了したときのステータス・レスポンスです。この値は非同期ジョブの終了後のみ使用可能です。
result(optional): result

クライアントがステータスについてサービスをポーリングする際に結果を取得できるよう、ステータス・リソースに最終結果を含めることが望ましい場合もあります。結果はこのオプション・プロパティで取得されます。このプロパティは、HTTPレスポンスがステータス・リソース内で効率的に返される場合にのみ使用する必要があります。このプロパティが存在する場合は、重複を避けるためにrequestStatusプロパティが省略されます。レスポンスの本文は、レスポンス固有のプロパティで構成されるJSONオブジェクトです。非JSONレスポンス・データは、Base64が、bodyプロパティ内のバイト文字列として非JSONデータをエンコードするか、ステータス・リソースのリンク・プロパティの非JSONリソースへのリンクを提供することでサポートされます。
startTime(optional): string(date-time)

非同期ジョブの実行が開始された時間。非同期ジョブが開始していない場合、このプロパティは表示されません。特定のバックグラウンド・ジョブは開始時間を記録しないことがあるため、ジョブが開始した場合、開始時間がない可能性があります。日付値と時間値は、UTCタイムゾーンを使用してISO 8601 yyyy-MM-dd'T'HH:mm:ss.SSS'Z'形式です。

{
    "properties":{
        "action":{
            "description":"<p>Type of <em>Template Job Status</em>. Valid values are: <code>copy</code>, <code>import</code>, <code>export</code>, <code>hardDelete</code>.</p>",
            "x-queryable":true,
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "context":{
            "description":"<p>Job context identifier value that can be used to correlate the response to the original asynchronous job. Depending on how the asynchronous job was initiated will determine whether there is a context value and what the context value is.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic",
                "minimal"
            ],
            "type":"string"
        },
        "startTime":{
            "description":"<p>Time when the asynchronous job started running. If the asynchronous job has not started this property will not be present. Certain background jobs may not record a start time, so if if the job has started there may not be a start time. Date and time values are in ISO 8601 <code>yyyy-MM-dd'T'HH:mm:ss.SSS'Z'</code> format using a UTC timezone.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string",
            "format":"date-time"
        },
        "endTime":{
            "description":"<p>Time when the asynchronous job finished running, or when the asynchronous job failed. If the asynchronous job has not finished or failed (or not started) this property will not be present. Certain background jobs may not record a stop time, so if if the job has completed there may not be a stop time. Date and time values are in ISO 8601 <code>yyyy-MM-dd'T'HH:mm:ss.SSS'Z'</code> format using a UTC timezone.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string",
            "format":"date-time"
        },
        "progress":{
            "description":"<p>The current progress of the asynchronous job. These values indicate that the asynchronous job has ended: <code>succeeded</code>, <code>failed</code>, <code>aborted</code>. The value <code>blocked</code> means that the asynchronous job requires action, such as waiting for a human to approve something. The values that indicate the asynchronous job is in process are: <code>pending</code>, <code>processing</code>, <code>paused</code>.</p><p>Valid values are:\n<ul><li> <code>pending</code> - Request is waiting to run</li><li> <code>processing</code> - Request is running</li><li> <code>succeeded</code> - Request has completed successfully</li><li> <code>failed</code> - Request has failed</li></ul>\n A processing request failed before it was completed.\n<ul><li> <code>aborted</code> - Request was aborted</li></ul>\nA processing request was aborted before it was completed.\n<ul><li> <code>paused</code> - Request was running, but is now paused</li><li> <code>blocked</code> - Request is blocked</li></ul>\nRequest requires action, such as waiting for a human to approve something.\n</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "completed":{
            "description":"<p>Whether the asynchronous job is completed or not.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"boolean"
        },
        "requestStatus":{
            "description":"<p>HTTP status code of the asynchronous asynchronous job request. This status is not the status obtaining when querying the asynchronous job status, but the status response of the asynchronous job when it is completed. This value is only available after the asynchronous job has ended.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"integer",
            "format":"int32"
        },
        "message":{
            "description":"<p>Human-readable message about the current processing status. This message can be used to communicate progress to the end user. Asynchronous requests or jobs may not provide a human-readable status message.</p>",
            "x-multiLingual":true,
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "completedPercentage":{
            "description":"<p>A number between 0 and 100, capturing how much of the process has been completed. If the asynchronous job has not started the percentage complete will not be provided. Not all background asynchronous jobs support granular process, so the percentage complete may jump from zero to one hundred without any steps.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"integer",
            "format":"int32"
        },
        "intervalToPoll":{
            "description":"<p>A number in milliseconds, as a hint to the client on how long the client should wait before checking the status again. Absence of this value means there is no suggested polling interval and the client can poll as required.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"integer",
            "format":"int64"
        },
        "error":{
            "description":"<p>Error details for the asynchronous job response when the job fails. This is only available if the asynchronous job has run but failed.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"object"
        },
        "result":{
            "description":"<p>It may be desirable to include the final result in the status resource so that the client can get the result when it polls the service for the status. The result is captured in this optional property. This property should only be used when the HTTP response can be efficiently returned inside the status resource. If this property is present, then the <code>requestStatus</code> property will be omitted to avoid duplication. The body of the response is a JSON object comprised of response-specific properties. Non-JSON response data may be supported either by Base64 encoding the non-JSON data as a byte string inside the body property or providing a link to the non-JSON resource in the 'links' property of the status resource.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "allOf":[
                {
                    "$ref":"#/definitions/HttpResponse"
                }
            ]
        }
    }
}

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

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

型: object

ジョブの失敗時の非同期ジョブ・レスポンスのエラー詳細。このオプションは、非同期ジョブが実行されたにも失敗した場合にのみ使用可能です。

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

クライアントがステータスについてサービスをポーリングする際に結果を取得できるよう、ステータス・リソースに最終結果を含めることが望ましい場合もあります。結果はこのオプション・プロパティで取得されます。このプロパティは、HTTPレスポンスがステータス・リソース内で効率的に返される場合にのみ使用する必要があります。このプロパティが存在する場合は、重複を避けるためにrequestStatusプロパティが省略されます。レスポンスの本文は、レスポンス固有のプロパティで構成されるJSONオブジェクトです。非JSONレスポンス・データは、Base64が、bodyプロパティ内のバイト文字列として非JSONデータをエンコードするか、ステータス・リソースのリンク・プロパティの非JSONリソースへのリンクを提供することでサポートされます。

すべてに一致

ソースを表示

object HttpResponse

非同期リクエストのHTTPレスポンスの取得など、構造化データとして返すことができるようにHTTPレスポンスを取得します。

{
    "description":"<p>It may be desirable to include the final result in the status resource so that the client can get the result when it polls the service for the status. The result is captured in this optional property. This property should only be used when the HTTP response can be efficiently returned inside the status resource. If this property is present, then the <code>requestStatus</code> property will be omitted to avoid duplication. The body of the response is a JSON object comprised of response-specific properties. Non-JSON response data may be supported either by Base64 encoding the non-JSON data as a byte string inside the body property or providing a link to the non-JSON resource in the 'links' property of the status resource.</p>",
    "x-returnedIn":[
        "representation",
        "default",
        "basic"
    ],
    "allOf":[
        {
            "$ref":"#/definitions/HttpResponse"
        }
    ]
}

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

型: object

非同期リクエストのHTTPレスポンスの取得など、構造化データとして返すことができるようにHTTPレスポンスを取得します。

ソースを表示

headers(optional): array headers

HTTPレスポンス・ヘッダー。
status (オプション): object status

HTTPステータス・コードのレスポンス値および理由。

{
    "description":"<p>Captures a HTTP response so that it can be returned as structured data, for example capturing a HTTP response for an asynchronous request.</p>",
    "properties":{
        "status":{
            "description":"<p>HTTP status code response value and reason.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"object",
            "properties":{
                "code":{
                    "description":"<p>The corresponding HTTP status code for the exception. For exception that includes a resource does not exist would have a HTTP status of <code>404</code>.</p>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "type":"integer",
                    "format":"int32"
                },
                "reason":{
                    "description":"<p>Short, human-readable summary of the status code.</p>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "type":"string"
                }
            },
            "required":[
                "code",
                "reason"
            ]
        },
        "headers":{
            "description":"<p>HTTP response headers.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "name":{
                        "description":"<p>Header name.</p>",
                        "x-returnedIn":[
                            "representation",
                            "default",
                            "basic"
                        ],
                        "type":"string"
                    },
                    "value":{
                        "description":"<p>Header value.</p>",
                        "x-returnedIn":[
                            "representation",
                            "default",
                            "basic"
                        ],
                        "type":"string"
                    }
                },
                "required":[
                    "name"
                ]
            }
        }
    }
}

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

型: array

HTTPレスポンス・ヘッダー。

ソースを表示

Array of: object items

{
    "description":"<p>HTTP response headers.</p>",
    "x-returnedIn":[
        "representation",
        "default",
        "basic"
    ],
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "name":{
                "description":"<p>Header name.</p>",
                "x-returnedIn":[
                    "representation",
                    "default",
                    "basic"
                ],
                "type":"string"
            },
            "value":{
                "description":"<p>Header value.</p>",
                "x-returnedIn":[
                    "representation",
                    "default",
                    "basic"
                ],
                "type":"string"
            }
        },
        "required":[
            "name"
        ]
    }
}

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

型: object

HTTPステータス・コードのレスポンス値および理由。

ソースを表示

code: integer(int32)

例外に対応するHTTPステータス・コード。リソースを含む例外には404のHTTPステータスが存在します。
reason: string

短い、判読可能なステータス・コードのサマリーです。

{
    "description":"<p>HTTP status code response value and reason.</p>",
    "x-returnedIn":[
        "representation",
        "default",
        "basic"
    ],
    "type":"object",
    "properties":{
        "code":{
            "description":"<p>The corresponding HTTP status code for the exception. For exception that includes a resource does not exist would have a HTTP status of <code>404</code>.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"integer",
            "format":"int32"
        },
        "reason":{
            "description":"<p>Short, human-readable summary of the status code.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        }
    },
    "required":[
        "code",
        "reason"
    ]
}

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

型: object

ソースを表示

name: string

ヘッダー名。
value(optional): string

ヘッダー値。

{
    "type":"object",
    "properties":{
        "name":{
            "description":"<p>Header name.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "value":{
            "description":"<p>Header value.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        }
    },
    "required":[
        "name"
    ]
}

レスポンス例(実行中のインポート・ジョブのステータスの取得)

{
    "context":"F49F1047E72E2FBBA7AD1754F7253CA453FCE1E1171C1541416472868",
    "action":"import",
    "startTime":"2019-05-31T09:14:29.000Z",
    "progress":"processing",
    "completed":false,
    "completedPercentage":38,
    "intervalToPoll":5000
}

400レスポンス

不正なリクエスト

401レスポンス

未認可

404レスポンス

見つかりません

ヘッダー

Cache-Control: string

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

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

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

ルート・スキーマ: schema

すべてに一致

ソースを表示

allOf TemplateJobNotFoundExceptionDetail

リリース19.4.1.での導入。

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

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

リリース19.4.1.での導入。

すべてに一致

ソースを表示

object ExceptionDetail

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

{
    "description":"<small>Introduced in release 19.4.1.</small>",
    "allOf":[
        {
            "$ref":"#/definitions/ExceptionDetail"
        },
        {
            "properties":{
                "jobStatus":{
                    "description":"<p>Template job status that does not exist or is not visible to the authenticated user.</p><small>Introduced in release 19.4.1.</small>",
                    "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"
                    }
                ]
            }
        }
    }
}

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

型: object

ソースを表示

jobStatus(optional): string

存在しないか、認証されたユーザーに表示されないテンプレート・ジョブ・ステータス。
リリース19.4.1.での導入。

{
    "properties":{
        "jobStatus":{
            "description":"<p>Template job status that does not exist or is not visible to the authenticated user.</p><small>Introduced in release 19.4.1.</small>",
            "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 Job Not Found",
    "status":"404",
    "detail":"Job does not exist or has been deleted, or the authenticated user or client application does not have access to the job.",
    "o:errorCode":"OCE-SITEMGMT-009051",
    "jobStatus":{
        "context":"37D1070720325969AC6C47ACE8B9BFF91533560416423"
    }
}

406レスポンス

受入れられない

416 レスポンス

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

429 レスポンス

リクエストが多すぎます

500レスポンス

内部サーバー・エラー

501レスポンス

実装されていない

502 レスポンス

ゲートウェイが不良

503レスポンス

サービス使用不可

504レスポンス

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

先頭に戻る