ルート・スキーマ: schema
型: object
ソースを表示
{
"type":"object",
"allOf":[
{
"$ref":"#/definitions/CollectionResource"
}
],
"properties":{
"items":{
"description":"<p>Collection of <em>Site Job Status</em> elements.</p>",
"x-returnedIn":[
"representation",
"default",
"basic",
"minimal"
],
"type":"array",
"items":{
"allOf":[
{
"$ref":"#/definitions/SiteJobStatus"
}
]
}
}
},
"required":[
"items"
]
}
すべてに一致
ソースを表示
- allOf CollectionResource
REST APIによって返されるすべてのコレクションは、標準のコレクション定義を拡張します。 この定義では、品目の合計数、返される品目のオフセットおよび制限の詳細、品目の数、および使用可能な品目が他にもあるかどうかを示すインジケータに関する情報を提供します。
{
"type":"object",
"allOf":[
{
"$ref":"#/definitions/CollectionResource"
}
],
"properties":{
"items":{
"description":"<p>Collection of <em>Site Job Status</em> elements.</p>",
"x-returnedIn":[
"representation",
"default",
"basic",
"minimal"
],
"type":"array",
"items":{
"allOf":[
{
"$ref":"#/definitions/SiteJobStatus"
}
]
}
}
},
"required":[
"items"
]
}
ネストされたスキーマ: items
型: array
「サイト・ジョブ・ステータス」要素のコレクション。
{
"description":"<p>Collection of <em>Site Job Status</em> elements.</p>",
"x-returnedIn":[
"representation",
"default",
"basic",
"minimal"
],
"type":"array",
"items":{
"allOf":[
{
"$ref":"#/definitions/SiteJobStatus"
}
]
}
}
ネストされたスキーマ : CollectionResource
REST APIによって返されるすべてのコレクションは、標準のコレクション定義を拡張します。 この定義では、品目の合計数、返される品目のオフセットおよび制限の詳細、品目の数、および使用可能な品目が他にもあるかどうかを示すインジケータに関する情報を提供します。
すべてに一致
ソースを表示
{
"description":"<p>All collections returned by REST APIs extend the standard collection definition. The definition provides information about the total number of items, the offset and limit details for the items returned, the number of items and an indicator to whether there are more items available.</p>",
"allOf":[
{
"$ref":"#/definitions/SingularResource"
},
{
"properties":{
"totalResults":{
"description":"<p>Total number of resources that match the request. If provided, this is the total number of available items. If not specified the total is not known, or is not viable to return. Paging limits or offsets are ignored when calculating this value. Only returned if the <code>totalResults</code> parameter is supported and is set to <code>true</code> by the client.</p>",
"x-returnedIn":[
"representation",
"default",
"basic",
"minimal"
],
"type":"integer",
"format":"int64"
},
"limit":{
"description":"<p>Actual response size limit used. If the request specifies too large a limit, or does not specify a limit then the response will specify the limit used.</p>",
"x-returnedIn":[
"representation",
"default",
"basic",
"minimal"
],
"type":"integer",
"format":"int32"
},
"count":{
"description":"<p>Total number of resources in the response.</p>",
"x-returnedIn":[
"representation",
"default",
"basic",
"minimal"
],
"type":"integer",
"format":"int32"
},
"hasMore":{
"description":"<p>Collection has more elements that match the request. Indicates whether there are more items to be returned when a paged request is made and the page was not big enough to return all elements.</p>",
"x-returnedIn":[
"representation",
"default",
"basic",
"minimal"
],
"type":"boolean"
},
"offset":{
"description":"<p>Actual response offset used. If the request specifies no offset then the actual offset is provided in the response.</p>",
"x-returnedIn":[
"representation",
"default",
"basic",
"minimal"
],
"type":"integer",
"format":"int64"
}
}
}
]
}
ネストされたスキーマ : SingularResource
型: object
すべての単数形のリソースには、特異なリソース定義のプロパティが含まれます。 単一のリソースには、他のリソースとの関係を提供するリンク、またはリソース自体をselfがリンクするリンク先のリストが含まれます。
{
"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"
}
]
}
}
}
}
ネストされたスキーマ : CollectionResource-allOf[1]
型: object
ソースを表示
{
"properties":{
"totalResults":{
"description":"<p>Total number of resources that match the request. If provided, this is the total number of available items. If not specified the total is not known, or is not viable to return. Paging limits or offsets are ignored when calculating this value. Only returned if the <code>totalResults</code> parameter is supported and is set to <code>true</code> by the client.</p>",
"x-returnedIn":[
"representation",
"default",
"basic",
"minimal"
],
"type":"integer",
"format":"int64"
},
"limit":{
"description":"<p>Actual response size limit used. If the request specifies too large a limit, or does not specify a limit then the response will specify the limit used.</p>",
"x-returnedIn":[
"representation",
"default",
"basic",
"minimal"
],
"type":"integer",
"format":"int32"
},
"count":{
"description":"<p>Total number of resources in the response.</p>",
"x-returnedIn":[
"representation",
"default",
"basic",
"minimal"
],
"type":"integer",
"format":"int32"
},
"hasMore":{
"description":"<p>Collection has more elements that match the request. Indicates whether there are more items to be returned when a paged request is made and the page was not big enough to return all elements.</p>",
"x-returnedIn":[
"representation",
"default",
"basic",
"minimal"
],
"type":"boolean"
},
"offset":{
"description":"<p>Actual response offset used. If the request specifies no offset then the actual offset is provided in the response.</p>",
"x-returnedIn":[
"representation",
"default",
"basic",
"minimal"
],
"type":"integer",
"format":"int64"
}
}
}
ネストされたスキーマ: items
すべてに一致
ソースを表示
{
"allOf":[
{
"$ref":"#/definitions/SiteJobStatus"
}
]
}
ネストされたスキーマ : SiteJobStatus
識別子: action
すべてに一致
ソースを表示
{
"description":"<p>Background job details for site jobs.</p>",
"discriminator":"action",
"allOf":[
{
"$ref":"#/definitions/SingularResource"
},
{
"properties":{
"action":{
"description":"<p>Type of <em>Site Job Status</em>. Valid values are: <code></code>, <code>translate</code>, <code>copy</code>, <code>publish</code>, <code>importTranslations</code>, <code>hardDelete</code>, <code>copyTheme</code>, <code>copyComponent</code>, <code>refresh</code>, <code>publishTheme</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"
}
]
}
}
}
]
}
ネストされたスキーマ : SiteJobStatus-allOf[1]
型: object
ソースを表示
- action(optional): string
「サイト・ジョブ・ステータス」のタイプ。 有効な値は次のとおりです: translate, copy, publish, importTranslations, hardDelete, copyTheme, copyComponent, refresh, publishTheme。
- 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 - リクエストに失敗しました
処理リクエストが完了する前に失敗しました。
処理リクエストが完了する前に中止されました。
-
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>Site Job Status</em>. Valid values are: <code></code>, <code>translate</code>, <code>copy</code>, <code>publish</code>, <code>importTranslations</code>, <code>hardDelete</code>, <code>copyTheme</code>, <code>copyComponent</code>, <code>refresh</code>, <code>publishTheme</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つ含める必要があります。
{
"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つ以上のプロパティが含まれます。
{
"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リソースへのリンクを提供することでサポートされます。
すべてに一致
ソースを表示
{
"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レスポンスを取得します。
{
"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"
]
}
}
}
}
ネストされたスキーマ: status
型: object
HTTPステータス・コードのレスポンス値および理由。
{
"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"
]
}