Jump to

• Request
• Response
• Examples

View the Job Status of an Operation

get

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

Returns the status of an API Platform Cloud Service instance operation.

Request

Path Parameters

• identityDomainId: string
  Name of the identity domain for the API Platform Cloud Service account.
• jobId: string
  Job ID.

Header Parameters

• Authorization: string
  Base64 encoding of the user name and password of the user making the request. For more information, see Security, Authentication and Authorization.

Response

Supported Media Types

• application/json

200 Response

OK. See Status Codes for information about other possible HTTP status codes.

Body ()

Root Schema : Response Body

Type: object

Title: Response Body

Show Source

• activityLogId: integer
  ID of the activity log.
• authDomain: string
  Identity domain ID for the Oracle API Platform Cloud Service account.
• authUser: string
  Name of the user account used to perform the activity.
• endDate: string
  Date and time the operation ended.
• identityDomain: string
  Name of the identity domain for the API Platform Cloud Service account.
• initiatedBy: string
  Name of the user who initiated the operation.
• jobId: integer
  Job ID for the operation.

  Note: This value may be set to No Job Submitted temporarily, just prior to being submitted for processing.

• messages: array messages
  Messages related to the activity.
• operationId: integer
  ID of the operation.
• operationType: string
  Operation type. For example: RESTORE, BACKUP, START_SERVICE, STOP_SERVICE, and so on.
• serviceId: integer
  ID of the API Platform Cloud Service instance.
• serviceName: string
  Name of the service instance.
• serviceType: string
  Type of the service instance. For Oracle API Platform Cloud Service instances, this is APICS.
• startDate: string
  Date and time the operation started.
• status: string
  Final status of the operation. Example status messages include: NEW, RUNNING, SUCCEED, and FAILED.
• summaryMessage: string
  Summary of the activity.

{
    "title":"Response Body",
    "type":"object",
    "description":"",
    "properties":{
        "activityLogId":{
            "type":"integer",
            "description":"ID of the activity log."
        },
        "serviceName":{
            "type":"string",
            "description":"Name of the service instance."
        },
        "serviceType":{
            "type":"string",
            "description":"Type of the service instance. For Oracle API Platform Cloud Service instances, this is <code>APICS</code>."
        },
        "identityDomain":{
            "type":"string",
            "description":"Name of the identity domain for the API Platform Cloud Service account."
        },
        "serviceId":{
            "type":"integer",
            "description":"ID of the API Platform Cloud Service instance."
        },
        "jobId":{
            "type":"integer",
            "description":"Job ID for the operation.<p><b>Note:</b> This value may be set to No Job Submitted temporarily, just prior to being submitted for processing."
        },
        "startDate":{
            "type":"string",
            "description":"Date and time the operation started."
        },
        "endDate":{
            "type":"string",
            "description":"Date and time the operation ended."
        },
        "status":{
            "type":"string",
            "description":"Final status of the operation. Example status messages include: <code>NEW</code>, <code>RUNNING</code>, <code>SUCCEED</code>, and <code>FAILED</code>."
        },
        "operationId":{
            "type":"integer",
            "description":"ID of the operation."
        },
        "operationType":{
            "type":"string",
            "description":"Operation type. For example: <code>RESTORE</code>, <code>BACKUP</code>, <code>START_SERVICE</code>, <code>STOP_SERVICE</code>, and so on."
        },
        "summaryMessage":{
            "type":"string",
            "description":"Summary of the activity."
        },
        "authDomain":{
            "type":"string",
            "description":"Identity domain ID for the Oracle API Platform Cloud Service account."
        },
        "authUser":{
            "type":"string",
            "description":"Name of the user account used to perform the activity."
        },
        "initiatedBy":{
            "type":"string",
            "description":"Name of the user who initiated the operation."
        },
        "messages":{
            "type":"array",
            "description":"Messages related to the activity.",
            "items":{
                "type":"object",
                "properties":{
                    "activityDate":{
                        "type":"string",
                        "description":"Date and time the activity was logged."
                    },
                    "message":{
                        "type":"string",
                        "description":"Details of the activity."
                    }
                }
            }
        }
    }
}

Nested Schema : messages

Type: array

Messages related to the activity.

Show Source

• [0]: object items

{
    "type":"array",
    "description":"Messages related to the activity.",
    "items":{
        "type":"object",
        "properties":{
            "activityDate":{
                "type":"string",
                "description":"Date and time the activity was logged."
            },
            "message":{
                "type":"string",
                "description":"Details of the activity."
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• activityDate: string
  Date and time the activity was logged.
• message: string
  Details of the activity.

{
    "type":"object",
    "properties":{
        "activityDate":{
            "type":"string",
            "description":"Date and time the activity was logged."
        },
        "message":{
            "type":"string",
            "description":"Details of the activity."
        }
    }
}

Examples

The following example shows how to retrieve details about a job by submitting a GET request on the REST resource using cURL. For more information about cURL, see cURL Examples.

curl -i -X GET 
-u apicsadmin:password 
https://example.com:7103/paas/api/v1.1/activitylog/apics/job/26361

Example of Response Headers

The following shows an example of the response headers.

HTTP/1.1 200 OK
Date: Tue, 03 Jan 2017 16:29:24 GMT
Transfer-Encoding: chunked
Content-Type: application/json
X-ORACLE-DMS-ECID: 3a5982a08b890711:-438b5162:158f8ec738a:-8000-0000000000014b4e
X-Frame-Options: DENY
Access-Control-Allow-Methods: GET, POST, DELETE, PUT, OPTIONS, HEAD
Access-Control-Allow-Headers: Content-Type, api_key, Authorization
Access-Control-Allow-Origin: *

Example of Response Body

The following example shows the contents of the response body in JSON format, including details about the operation that corresponds with the jobId you provided.

{
  "activityLogId": 16027,
  "serviceName": "apicsInstance",
  "serviceType": "APICS",
  "identityDomain": "apics",
  "serviceId": 606,
  "jobId": 26361,
  "startDate": "2016-11-23T11:10:51.035+0000",
  "endDate": "2016-11-23T11:16:03.332+0000",
  "status": "SUCCEED",
  "operationId": 606,
  "operationType": "RESTORE",
  "summaryMessage": "RESTORE",
  "authDomain": "apics",
  "authUser": "OCLOUD9_SM_PLATFORM_APPID",
  "initiatedBy": "USER",
  "messages": [
    {
      "activityDate": "2016-11-23T11:10:51.035+0000",
      "message": "Activity Submitted"
    },
    {
      "activityDate": "2016-11-23T11:10:51.052+0000",
      "message": "Activity Started"
    },
    {
      "activityDate": "2016-11-23T11:11:22.037+0000",
      "message": "The backup archive already exists in the block storage and does not need to be downloaded from the Oracle Storage Cloud Service container..."
    },
    {
      "activityDate": "2016-11-23T11:11:22.156+0000",
      "message": "Submitted the restoration precheck for remote execution"
    },
    {
      "activityDate": "2016-11-23T11:11:53.098+0000",
      "message": "Restoration precheck passed..."
    },
    {
      "activityDate": "2016-11-23T11:11:53.254+0000",
      "message": "Submitted the restoration for remote execution"
    },
    {
      "activityDate": "2016-11-23T11:15:56.162+0000",
      "message": "Stopping WebLogic Server...Stopped WebLogic Server...Started the restoration of the configuration data for WebLogic Server administration server...Completed the restoration of the configuration data for WebLogic Server administration server...Starting WebLogic Server...Started WebLogic Server...Unlocked the WebLogic Server domain configuration..."
    },
    {
      "activityDate": "2016-11-23T11:15:56.307+0000",
      "message": "Completed the restoration"
    },
    {
      "activityDate": "2016-11-23T11:16:03.332+0000",
      "message": "Activity Ended"
    }
  ]
}