Batch Read the Progress of Site Related Jobs
/sites/management/api/v1/sites/_status
Read one or more job status resources in single request. For example, if multiple sites are published the progress of the publishing jobs can be monitored using a single request.
Introduced in release 19.4.1.
Listing Site Related Jobs
The listing of site related jobs is not supported by this resource.
Batching
This operation supports batching of GET
requests. Two or more resource instances up to a maximum of 50 can be returned in a single batch response by specifying a comma-separated list of resource identifiers using the id
query parameter. The response will contain details of each GET
response, providing the response status code, headers and response body.
Successful Response Examples
This operation responds with the following success (2xx) responses. For a full list of response HTTP status codes and example bodies, consult the Response section of this operation.
200OK - Batch Read Two Template Jobs
Read the details of two site jobs by providing two site job identifiers in a comma-separated list. Links are not included in the response.
Request
GET https://api.example.com/sites/management/api/v1/sites/_status?id=3A64D8F3F7EB40F9901E7DA11025280A,0E15A12ABD6D45F3B6824F48C838E80E&links=none
Response Body
{ "batch": [ { "status": { "code": 200, "reason": "OK" }, "headers": [ { "name": "Cache-Control", "value": "no-cache, no-store, must-revalidate" }, { "name": "Content-Type", "value": "application/vnd.oracle.resource+json;type=singular" } ], "body": { "action": "copy", "context": "3A64D8F3F7EB40F9901E7DA11025280A", "startTime": "2019-07-16T08:19:39.000Z", "progress": "pending", "completed": false, "completedPercentage": 0 } }, { "status": { "code": 200, "reason": "OK" }, "headers": [ { "name": "Cache-Control", "value": "no-cache, no-store, must-revalidate" }, { "name": "Content-Type", "value": "application/vnd.oracle.resource+json;type=singular" } ], "body": { "action": "publish", "context": "0E15A12ABD6D45F3B6824F48C838E80E", "startTime": "2019-07-16T08:19:40.000Z", "progress": "pending", "completed": false, "completedPercentage": 0 } } ] }
Request
-
excludeFields(optional): string
Comma-delimited string of field names that you do not want in the response. Nested fields can be identified using a dot to separate the field names. Field names are case-sensitive. Field names are ignored if the field does not exist. To reference the fields of the collection the field name can be prepended with the
@
character (for example,@hasMore
). -
excludeLinks(optional): string
Comma-separated list of link relation names to exclude from the response.
-
expand(optional): string
Comma-delimited string of field names that you want to expand. Use the value
all
to expand all relationships.The following field names can be specified in the
expand
query parameter:Field Name Description site
The site that was created by the completed site creation job. translationFile
The details of the translation file. translationJob
The details of the translation job. pages
List of all pages that are included in the site refresh job. translationImportFile
The file containing the site translations to import. theme
The copied theme for completed copy job. component
The copied component for completed copy job. -
expansionErrors(optional): string
Specify how errors in expansion are handled. If not specified, then the default is to include error details in the relationship field.
Valid values are:
-
ignore
- Ignore the error and do not expand the relationship. Relationship links are not included in the response -
include
- Include the error details instead of the expanded relationship. Relationship links are returned -
fail
- Fail the request with an expansion failure error response
-
-
fields(optional): string
Comma-delimited string of field names that you want in the response. Nested properties can be identified using a dot to separate the field names. Field names are case-sensitive. Field names are ignored if the field does not exist. To reference the fields of the collection the field name can be prepended with the
@
character (for example,@hasMore
). -
id(optional): string
List of resource identifiers to use for a batched request. The syntax uses a comma-delimited sequence of resource identifiers.
-
links(optional): string
Comma-separated list of link relation names to include in the response. By default, all links are returned.
The following links are provided by this resource:
Link Relationship Description parent
Describes where the parent resource can be read. Equivalent to an up
link, this link provides the link to the parent resource, such as the collection resource that contains a singular resource.self
Describes the current returned representation of the resource. Used for links that represent the resource itself. For example, if a resource is returned as part of a collection, the self link will provide the URL path for the individual resource. canonical
Describes the preferred representation of the requested resource. Used for links that represent the canonical form of the resource. For example, if a resource is returned as part of a collection, the canonical link will provide the URL path for the canonical form of the individual resource. child
Describes where a related or child resource can be read. Child links are returned in expandable properties and provide the location where unexpanded relationship details can be read. describedBy
Describes the schema resource providing metadata information about the resource. Used on collection, singular and relation resources to indicate where the schema resource is that describes the resource. -
return(optional): string
Specify the resource representation that should be used to control the response fields and links. If no representation is specified, the client-defined representation is returned, based on the values of the
fields
,excludeFields
,links
,excludeLinks
andexpand
query parameters.The following representations are supported with the
return
query parameter:Representation Description representation
Full resource representation includes all properties and links and expands most relationships. default
Default resource representation includes most properties and links. basic
Basic resource representation includes some properties and some links. minimal
Minimal resource representation, includes essential properties and no links.
Response
- application/json
- application/vnd.oracle.resource+json;type=collection
200 Response
-
Cache-Control: string
Directives for caching mechanisms.
-
Content-Length: string
Size of the response body.
-
Content-Type: string
Content type of the response.
object
-
items:
array items
Collection of Site Job Status elements.
-
allOf
CollectionResource
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.
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.
-
object
SingularResource
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 self link the resource itself.
-
object
CollectionResource-allOf[1]
object
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 self link the resource itself.
-
links(optional):
array links
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.
object
-
count(optional):
integer(int32)
Total number of resources in the response.
-
hasMore(optional):
boolean
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.
-
limit(optional):
integer(int32)
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.
-
offset(optional):
integer(int64)
Actual response offset used. If the request specifies no offset then the actual offset is provided in the response.
-
totalResults(optional):
integer(int64)
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
totalResults
parameter is supported and is set totrue
by the client.
-
allOf
SiteJobStatus
Discriminator:
action
Background job details for site jobs.
action
Background job details for site jobs.
-
object
SingularResource
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 self link the resource itself.
-
object
SiteJobStatus-allOf[1]
object
-
action(optional):
string
Type of Site Job Status. Valid values are:
,
translate
,copy
,publish
,importTranslations
,hardDelete
,copyTheme
,copyComponent
,refresh
,publishTheme
. -
completed(optional):
boolean
Whether the asynchronous job is completed or not.
-
completedPercentage(optional):
integer(int32)
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.
-
context(optional):
string
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.
-
endTime(optional):
string(date-time)
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
yyyy-MM-dd'T'HH:mm:ss.SSS'Z'
format using a UTC timezone. -
error(optional):
object error
Error details for the asynchronous job response when the job fails. This is only available if the asynchronous job has run but failed.
-
intervalToPoll(optional):
integer(int64)
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.
-
message(optional):
string
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.
-
progress(optional):
string
The current progress of the asynchronous job. These values indicate that the asynchronous job has ended:
succeeded
,failed
,aborted
. The valueblocked
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:pending
,processing
,paused
.Valid values are:
-
pending
- Request is waiting to run -
processing
- Request is running -
succeeded
- Request has completed successfully -
failed
- Request has failed
-
aborted
- Request was aborted
-
paused
- Request was running, but is now paused -
blocked
- Request is blocked
-
-
requestStatus(optional):
integer(int32)
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.
-
result(optional):
result
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
requestStatus
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. -
startTime(optional):
string(date-time)
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
yyyy-MM-dd'T'HH:mm:ss.SSS'Z'
format using a UTC timezone.
array
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.
object
REST HATEOAS link and related metadata. If responses provide links (for example, a self
link to the resource itself) the links provided will include one or more of the properties defined on this link structure.
-
href(optional):
string
The target resource URI. URI RFC3986 or URI Template RFC6570. If the value is set to URI Template, then the
templated
property must be set totrue
. -
mediaType(optional):
string
Media type, as defined by RFC 2046, describing the link target.
-
method(optional):
string
HTTP method for requesting the target of the link.
Valid values are:
-
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)
Link to the metadata of the resource, such as JSON-schema, that describes the resource expected when dereferencing the target resource.
-
rel(optional):
string
Name of the link relation that, in addition to the type property, can be used to retrieve link details.
-
templated(optional):
boolean
Boolean flag that specifies the
href
property is a URI or URI Template. The property can be assumed to befalse
if the property is not present.
object
Error details for the asynchronous job response when the job fails. This is only available if the asynchronous job has run but failed.
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 requestStatus
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.
-
object
HttpResponse
Captures a HTTP response so that it can be returned as structured data, for example capturing a HTTP response for an asynchronous request.
object
Captures a HTTP response so that it can be returned as structured data, for example capturing a HTTP response for an asynchronous request.
-
headers(optional):
array headers
HTTP response headers.
-
status(optional):
object status
HTTP status code response value and reason.
object
HTTP status code response value and reason.
-
code:
integer(int32)
The corresponding HTTP status code for the exception. For exception that includes a resource does not exist would have a HTTP status of
404
. -
reason:
string
Short, human-readable summary of the status code.
object
-
name:
string
Header name.
-
value(optional):
string
Header value.
{
"batch":[
{
"status":{
"code":200,
"reason":"OK"
},
"headers":[
{
"name":"Cache-Control",
"value":"no-cache, no-store, must-revalidate"
},
{
"name":"Content-Type",
"value":"application/vnd.oracle.resource+json;type=singular"
}
],
"body":{
"action":"copy",
"context":"3A64D8F3F7EB40F9901E7DA11025280A",
"startTime":"2019-07-16T08:19:39.000Z",
"progress":"pending",
"completed":false,
"completedPercentage":0
}
},
{
"status":{
"code":200,
"reason":"OK"
},
"headers":[
{
"name":"Cache-Control",
"value":"no-cache, no-store, must-revalidate"
},
{
"name":"Content-Type",
"value":"application/vnd.oracle.resource+json;type=singular"
}
],
"body":{
"action":"publish",
"context":"0E15A12ABD6D45F3B6824F48C838E80E",
"startTime":"2019-07-16T08:19:40.000Z",
"progress":"pending",
"completed":false,
"completedPercentage":0
}
}
]
}