REST API for Oracle SOA Cloud Service

View the Status of an Operation by Job Id

get

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

Returns information about the operation, including activity messages.

Request

Path Parameters

identityDomainId: string

Identity domain ID for the Oracle SOA Cloud Service account.
jobId: string

Job ID of the operation. This is returned in the response header of the operation request.

Header Parameters

X-ID-TENANT-NAME: string

Identity domain ID for the Oracle SOA Cloud Service account.

Response

Supported Media Types

application/json

200 Response

Root Schema : jobid-response

Type: object

Show Source

activityLogId: integer

ID of the activity log.
authDomain: string

Identity domain ID for the Oracle SOA Cloud Service account.
authUser: string

Name of the user account used to perform the operation on the Oracle SOA Cloud Service instance.
endDate: string

Date and time the job ended.
identityDomain: string

Identity domain ID for the Oracle SOA Cloud Service account.
initiatedBy: string

Value is USER when the job is initiated by a service end user.
jobId: integer

Job ID returned by the Location URI in the response header when the operation request was made.
messages: array messages

Groups activity messages.
operationId: integer

ID of the operation.
operationType: string

Type of operation. For example, CREATE_SERVICE, SSH_PUBLIC_KEY_RESET, CONFIG_CHANGE, and so on.
serviceId: integer

ID of the Oracle SOA Cloud Service instance.
serviceName: string

Name of the Oracle SOA Cloud Service instance.
serviceType: string

Cloud service type.
startDate: string

Date and time the job started.
status: string

Status of the job. Example status messages include: RUNNING, SUCCEED, and FAILED.
summaryMessage: string

Operation type.

{
    "required":[
        "jobId",
        "activityLogId",
        "authDomain",
        "authUser",
        "endDate",
        "identityDomain",
        "initiatedBy",
        "messages",
        "operationId",
        "operationType",
        "serviceId",
        "serviceName",
        "serviceType",
        "startDate",
        "status",
        "summaryMessage"
    ],
    "properties":{
        "activityLogId":{
            "type":"integer",
            "description":"ID of the activity log."
        },
        "authDomain":{
            "type":"string",
            "description":"Identity domain ID for the Oracle SOA Cloud Service account."
        },
        "authUser":{
            "type":"string",
            "description":"Name of the user account used to perform the operation on the Oracle SOA Cloud Service instance."
        },
        "endDate":{
            "type":"string",
            "description":"Date and time the job ended."
        },
        "identityDomain":{
            "type":"string",
            "description":"Identity domain ID for the Oracle SOA Cloud Service account."
        },
        "initiatedBy":{
            "type":"string",
            "description":"Value is <code>USER</code> when the job is initiated by a service end user."
        },
        "jobId":{
            "type":"integer",
            "description":"Job ID returned by the <code>Location</code> URI in the response header when the operation request was made."
        },
        "messages":{
            "type":"array",
            "description":"Groups activity messages.",
            "items":{
                "$ref":"#/definitions/job-messages"
            }
        },
        "operationId":{
            "type":"integer",
            "description":"ID of the operation."
        },
        "operationType":{
            "type":"string",
            "description":"Type of operation. For example, <code>CREATE_SERVICE</code>, <code>SSH_PUBLIC_KEY_RESET</code>, <code>CONFIG_CHANGE</code>, and so on."
        },
        "serviceId":{
            "type":"integer",
            "description":"ID of the Oracle SOA Cloud Service instance."
        },
        "serviceName":{
            "type":"string",
            "description":"Name of the Oracle SOA Cloud Service instance."
        },
        "serviceType":{
            "type":"string",
            "description":"Cloud service type. "
        },
        "startDate":{
            "type":"string",
            "description":"Date and time the job started."
        },
        "status":{
            "type":"string",
            "description":"Status of the job. Example status messages include: <code>RUNNING</code>, <code>SUCCEED</code>, and <code>FAILED</code>."
        },
        "summaryMessage":{
            "type":"string",
            "description":"Operation type. "
        }
    }
}

Nested Schema : messages

Type: array

Groups activity messages.

Show Source

Array of: object job-messages

{
    "type":"array",
    "description":"Groups activity messages.",
    "items":{
        "$ref":"#/definitions/job-messages"
    }
}

Nested Schema : job-messages

Type: object

Show Source

activityDate(optional): string

Date and time the activity was logged.
message(optional): string

Details of the activity.

{
    "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 use the job ID to view information about the operation being performed on the Oracle SOA Cloud Service instance by submitting a GET request on the REST resource using cURL. For more information, see Use cURL.

cURL Command

curl -i -X GET -u username:Password1! -H "X-ID-TENANT-NAME:ExampleIdentityDomain" https://rest-server_url.com/paas/api/v1.1/activitylog/ExampleIdentityDomain/job/8722

Example of Response Body

The following example is the response returned in JSON format for an SSH key operation. The response you get depends on the type of operation.

{
  "activityLogId": 135,
  "serviceName": "ExampleInstance",
  "serviceType": "soa",
  "identityDomain": "ExampleIdentityDomain",
  "serviceId": 8,
  "jobId": 8722,
  "startDate": "2019-04-19T22:00:44.598+0000",
  "endDate": "2019-04-19T22:08:30.655+0000",
  "status": "SUCCEED",
  "operationId": 8,
  "operationType": "SSH_PUBLIC_KEY_RESET",
  "summaryMessage": "SSH_PUBLIC_KEY_RESET",
  "authDomain": "ExampleIdentityDomain",
  "authUser": "username",
  "initiatedBy": "USER",
  "messages": [
    {
      "activityDate": "2019-04-19T22:00:44.598+0000",
      "message": "Activity Submitted"
    },
    {
      "activityDate": "2019-04-19T22:00:45.139+0000",
      "message": "Activity Started"
    },
    {
      "activityDate": "2019-04-19T22:00:45.163+0000",
      "message": "Resetting user ssh public key, new ssh public key: ssh-rsa ZYZYBZ3NzaC1yc2EAAAABJQAAAQEAix3Pt+tXlziLKWLyfY2tQUfsuHNvuL9SVeIJSmyqevv4n4AKxZ1wkgXdQmaN7iV2VlTJTf\/rpNAwXGwnSQr7GyGZv4udkyKqyBummnAnVNMPirCBr8scQPCfGB2rjVmfwgNK6TVtAD1t+uDhVIHEf9Jb05v940Abt9\/u5MFkxxoldQy6rRxgky3ZYstU72NOpiwmptYL5CDu3aPljZsx\/raKQACsU0qi3sCzLD76tK4sp+8BTkGBQIIJxa1zqdFHQzQmr2tcf8D6E4sauMqCpXGzLoxgrLMPtHfwkDsAaOc2VPVKafqHgKssbEFRrUclJHy3z9loYV6RzPABQpEEee== rsa-key-20196666"
    },
    {
      "activityDate": "2019-04-19T22:04:05.792+0000",
      "message": "Stopped all Compute resources..."
    },
    {
      "activityDate": "2019-04-19T22:08:29.532+0000",
      "message": "Started all Compute resources..."
    },
    {
      "activityDate": "2019-04-19T22:08:30.633+0000",
      "message": "Successful in resetting the user ssh key as: ssh-rsa ZYZYBZ3NzaC1yc2EAAAABJQAAAQEAix3Pt+tXlziLKWLyfY2tQUfsuHNvuL9SVeIJSmyqevv4n4AKxZ1wkgXdQmaN7iV2VlTJTf\/rpNAwXGwnSQr7GyGZv4udkyKqyBummnAnVNMPirCBr8scQPCfGB2rjVmfwgNK6TVtAD1t+uDhVIHEf9Jb05v940Abt9\/u5MFkxxoldQy6rRxgky3ZYstU72NOpiwmptYL5CDu3aPljZsx\/raKQACsU0qi3sCzLD76tK4sp+8BTkGBQIIJxa1zqdFHQzQmr2tcf8D6E4sauMqCpXGzLoxgrLMPtHfwkDsAaOc2VPVKafqHgKssbEFRrUclJHy3z9loYV6RzPABQpEEee== rsa-key-20196666"
    },
    {
      "activityDate": "2019-04-19T22:08:30.655+0000",
      "message": "Activity Ended"
    }
  ]
}