1. REST API for Sites Management
  2. Tasks
  3. Templates
  4. Jobs

Batch Read the Progress of Template Related Jobs

get

/sites/management/api/v1/templates/_status

COLLECTION

Read one or more job status resources in single request. Operations such as importing the default set of templates generates multiple template backgrounds jobs and uses this batching operation to allow all the jobs to be read in one request. Another use of reading a batch of template jobs is if multiple templates are imported or multiple templates are copied; the progress of these jobs can be monitored using a single request.

Introduced in release 19.4.1.

Listing Template Related Jobs

The listing of template 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 template jobs by providing two template job identifiers in a comma-separated list. Links are not included in the response.

Request

GET https://api.example.com/sites/management/api/v1/templates/_status?id=58CF9747BCD41BCB62F6037122019F3,BDAB2BBFEBD944F4AFE9E4326BB6211F&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": "58CF9747BCD41BCB62F6037122019F3",
          "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": "importTemplate",
          "context": "BDAB2BBFEBD944F4AFE9E4326BB6211F",
          "startTime": "2019-07-16T08:19:40.000Z",
          "progress": "pending",
          "completed": false,
          "completedPercentage": 0
        }
      }
  ]
}

Request

Query Parameters

  • 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).

  • Comma-separated list of link relation names to exclude from the response.

  • 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 NameDescription
    templateThe imported template for completed import job.
    themeThe imported theme for completed import job.
    componentsThe imported components for completed import job.

  • 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

  • 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).

  • List of resource identifiers to use for a batched request. The syntax uses a comma-delimited sequence of resource identifiers.

  • 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 RelationshipDescription
    parentDescribes 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.
    selfDescribes 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.
    canonicalDescribes 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.
    childDescribes 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.
    describedByDescribes 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.

  • 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 and expand query parameters.

    The following representations are supported with the return query parameter:

    RepresentationDescription
    representationFull resource representation includes all properties and links and expands most relationships.
    defaultDefault resource representation includes most properties and links.
    basicBasic resource representation includes some properties and some links.
    minimalMinimal resource representation, includes essential properties and no links.
Back to Top

Response

Supported Media Types

200 Response

OK
Headers
Body ()
Root Schema : schema
Type: object
Show Source
Match All
Show Source
  • 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.

Nested Schema : items
Type: array

Collection of Template Job Status elements.

Show Source
Nested Schema : 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.

Match All
Show Source
Nested Schema : SingularResource
Type: 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.

Show Source
  • links
Nested Schema : CollectionResource-allOf[1]
Type: object
Show Source

  • Total number of resources in the response.

  • 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.

  • 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.

  • Actual response offset used. If the request specifies no offset then the actual offset is provided in the response.

  • 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 to true by the client.

Nested Schema : items
Match All
Show Source
Nested Schema : TemplateJobStatus
Discriminator: action

Background job details for template jobs.

Match All
Show Source
Nested Schema : TemplateJobStatus-allOf[1]
Type: object
Show Source

  • Type of Template Job Status. Valid values are: copy, import, export, hardDelete.

  • Whether the asynchronous job is completed or not.

  • 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.

  • 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.

  • 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

    Error details for the asynchronous job response when the job fails. This is only available if the asynchronous job has run but failed.

  • 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.

  • 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.

  • The current progress of the asynchronous job. These values indicate that the asynchronous job has ended: succeeded, failed, aborted. The value blocked 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
    A processing request failed before it was completed.
    • aborted - Request was aborted
    A processing request was aborted before it was completed.
    • paused - Request was running, but is now paused
    • blocked - Request is blocked
    Request requires action, such as waiting for a human to approve something.

  • 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

    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.

  • 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.

Nested Schema : error
Type: object

Error details for the asynchronous job response when the job fails. This is only available if the asynchronous job has run but failed.

Nested Schema : 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.

Match All
Show Source
  • HttpResponse

    Captures a HTTP response so that it can be returned as structured data, for example capturing a HTTP response for an asynchronous request.

Nested Schema : HttpResponse
Type: object

Captures a HTTP response so that it can be returned as structured data, for example capturing a HTTP response for an asynchronous request.

Show Source
Nested Schema : headers
Type: array

HTTP response headers.

Show Source
Nested Schema : status
Type: object

HTTP status code response value and reason.

Show Source

  • The corresponding HTTP status code for the exception. For exception that includes a resource does not exist would have a HTTP status of 404.

  • Short, human-readable summary of the status code.

Nested Schema : items
Type: object
Show Source
Example Response (Batch Read Two Template Jobs)
{
    "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":"58CF9747BCD41BCB62F6037122019F3",
                "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":"importTemplate",
                "context":"BDAB2BBFEBD944F4AFE9E4326BB6211F",
                "startTime":"2019-07-16T08:19:40.000Z",
                "progress":"pending",
                "completed":false,
                "completedPercentage":0
            }
        }
    ]
}

400 Response

Bad Request

401 Response

Unauthorized

406 Response

Not Acceptable

416 Response

Range Not Satisfiable

429 Response

Too Many Requests

500 Response

Internal Server Error

501 Response

Not Implemented

502 Response

Bad Gateway

503 Response

Service Unavailable

504 Response

Gateway Timeout
Back to Top