REST API for Managing Application Caches

View Job Status

get

/paas/api/v1.1/activitylog/{identityDomainId}/job/{jobId}

Several operations return the ID of the job that is carrying out the requested operation. This REST call returns status information for such a job. The URL to fetch the job status is in the Location header of the response from the original operation.

Request

Path Parameters

identityDomainId: Type: string

Required: true

Name of the identity domain for the Oracle Application Container Cloud Service account
jobId: Type: integer

Required: true

ID number of job for which status information is fetched

Response

Supported Media Types

application/json

200 Response

Body

Information and activity for an ongoing job

Root Schema : job-status

Information and activity for an ongoing job

Properties

activityLogId: Type: integer
authDomain: Type: string
authUser: Type: string
identityDomain: Type: string
initiatedBy: Type: string
jobId: Type: integer
messages: Type: array messages

Additional Properties Allowed:
operationId: Type: integer
operationType: Type: string
serviceId: Type: integer
serviceName: Type: string
serviceType: Type: string
startDate: Type: string
status: Type: string
summaryMessage: Type: string

Nested Schema : messages

Type: array

Items

Type: object items

Additional Properties Allowed:

Nested Schema : items

Type: object

Properties

activityDate: Type: string
message: Type: string

404 Response

Not Found. Returned if the job ID does not exist.

Examples

The following example shows how to retrieve information about a job by submitting a GET request on the REST resource using cURL. For more information about cURL, see Use cURL. For more information about endpoint URL structure, including how to determine your region, see Send Requests.

curl -i -X GET -u joe@example.com:joePassword \
 -H "X-ID-TENANT-NAME:ExampleIdentityDomain" \
  https://apaas.us.oraclecloud.com/paas/api/v1.1/activitylog/ExampleIdentityDomain/job/17465

Example of Response Header

The following shows an example of the response header.

HTTP/1.1 200 OK
Date: Wed, 12 Apr 2017 16:10:38 GMT
Transfer-Encoding: chunked
Content-Type: application/json
X-ORACLE-DMS-ECID: e6b609ac-e548-4bee-8d87-fd2b4c6a51bf-0000f356
X-Frame-Options: DENY
Access-Control-Allow-Methods: GET, POST, DELETE, PUT, OPTIONS, HEAD
Access-Control-Allow-Headers: Content-Type, api_key, Authorization, X-ID-TENANT-NAME, X-USER-IDENTITY-DOMAIN-NAME
Access-Control-Allow-Origin: *

Example of Response Body

The following example shows the contents of the response body in JSON format.

{
   "activityLogId":6015,
   "serviceName":"MyCache",
   "serviceType":"caching",
   "identityDomain":"ExampleIdentityDomain",
   "serviceId":7,
   "jobId":17465,
   "startDate":"2017-04-12T16:01:28.238+0000",
   "endDate":"2017-04-12T16:10:27.919+0000",
   "status":"SUCCEED",
   "operationId":7,
   "operationType":"CREATE_SERVICE",
   "summaryMessage":"CREATE_SERVICE",
   "authDomain":"ExampleIdentityDomain",
   "authUser":"joe",
   "initiatedBy":"USER",
   "messages":[
      {
         "activityDate":"2017-04-12T16:01:28.238+0000",
         "message":"Activity Submitted"
      },
      {
         "activityDate":"2017-04-12T16:01:28.317+0000",
         "message":"Activity Started"
      },
      {
         "activityDate":"2017-04-12T16:01:28.334+0000",
         "message":"Started operation to create service [MyCache] in identity domain [ExampleIdentityDomain]."
      },
      {
         "activityDate":"2017-04-12T16:01:47.814+0000",
         "message":"Initialized application creation..."
      },
      {
         "activityDate":"2017-04-12T16:08:23.823+0000",
         "message":"Acquired resources for instance(2G) mycache-cach-1..."
      },
      {
         "activityDate":"2017-04-12T16:09:44.644+0000",
         "message":"Deployed application(v1) for instance(2G) mycache-cach-1..."
      },
      {
         "activityDate":"2017-04-12T16:10:06.448+0000",
         "message":"Successfully created application..."
      },
      {
         "activityDate":"2017-04-12T16:10:27.910+0000",
         "message":"Activity Ended"
      },
      {
         "activityDate":"2017-04-12T16:10:27.919+0000",
         "message":"Activity Ended"
      }
   ]
}