Jump to

• Request
• Response

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 Integration Classic 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 Integration Classic account.

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK.

Body ()

Root Schema : jobid-response

Type: object

Show Source

• activityLogId(optional): integer
  ID of the activity log.
• authDomain(optional): string
  Identity domain ID for the Oracle Integration Classic account.
• authUser(optional): string
  Name of the user account used to perform the operation on the Oracle Integration Classic instance.
• endDate(optional): string
  Date and time the job ended.
• identityDomain(optional): string
  Identity domain ID for the Oracle Integration Classic account.
• initiatedBy(optional): string
  Value is USER when the job is initiated by a service end user.
• jobId(optional): integer
  Job ID returned by the Location URI in the response header when the operation request was made.
• messages(optional): array messages
  Groups activity messages.
• operationId(optional): integer
  ID of the operation.
• operationType(optional): string
  Type of operation. For example, CREATE_SERVICE, SSH_PUBLIC_KEY_RESET, CONFIG_CHANGE, and so on.
• serviceId(optional): integer
  ID of the Oracle Integration Classic instance.
• serviceName(optional): string
  Name of the Oracle Integration Classic instance.
• serviceType(optional): string
  Cloud service type. Valid value is IntegrationCloud for Oracle Integration Classic.
• startDate(optional): string
  Date and time the job started.
• status(optional): string
  Status of the job. Example status messages include: RUNNING, SUCCEED, and FAILED.
• summaryMessage(optional): string
  Operation type. For example, CREATE_SERVICE, SSH_PUBLIC_KEY_RESET, CONFIG_CHANGE, and so on.

{
    "properties":{
        "activityLogId":{
            "type":"integer",
            "description":"ID of the activity log."
        },
        "authDomain":{
            "type":"string",
            "description":"Identity domain ID for the Oracle Integration Classic account."
        },
        "authUser":{
            "type":"string",
            "description":"Name of the user account used to perform the operation on the Oracle Integration Classic instance."
        },
        "endDate":{
            "type":"string",
            "description":"Date and time the job ended."
        },
        "identityDomain":{
            "type":"string",
            "description":"Identity domain ID for the Oracle Integration Classic 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 Integration Classic instance."
        },
        "serviceName":{
            "type":"string",
            "description":"Name of the Oracle Integration Classic instance."
        },
        "serviceType":{
            "type":"string",
            "description":"Cloud service type. Valid value is <code>IntegrationCloud</code> for Oracle Integration Classic."
        },
        "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. For example, <code>CREATE_SERVICE</code>, <code>SSH_PUBLIC_KEY_RESET</code>, <code>CONFIG_CHANGE</code>, and so on."
        }
    }
}

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."
        }
    }
}

Back to Top