Oracle Cloud Infrastructure Documentation

Get Details of Execution

Use this API to get details for a configuration execution.

API

/selfservice/v1/customers/{supportIdentifier}/{serviceType}/products/config/instances/{instanceId}/executions/{executionId}

Scope and AuthZ

  • You must have mcs:oci:api:User scope to access this API.
  • You can get configuration execution details only for your customer.
  • You can use Configuration execution API only if your customer has opted-in for Configuration functionality.

Headers

  • Authorization: Bearer <Token>

    Where <Token> is the OAUTH token returned by the Authorization Server (JWT Token).

  • Identifier: <JWKS Identifier>

    Where <JWKS Identifier> is the GUID generated when JWKS URI is set by customer admin in self-service platform.

Base Path

/selfservice/v1/

Dependency

Functionality

  • This API allows you to get details for a configuration execution.
  • Request field that requires explanation:
    • primaryContact is the contact to be used while creating the ticket. This parameter is the valid contact for the Customer Support Identifier (CSI).
  • Response field that requires explanation:
    • id is the unique identifier for the execution.

Verb

GET

Parameters

Name Type Description Mandatory
supportIdentifier Path parameter Customer Support Identifier (CSI) Yes
serviceType Path parameter Service type (For example, EBSO, EBSZ, or EBSI) Yes
instanceId Path parameter Instance name or target name on which patches have to be applied. Yes
executionId Path parameter Unique execution ID for the patch execution. Yes

Sample response 

{
  "id": "3-7JZXAMZ",
  "target": "DCMATI",
  "duration": {
    "unit": "hours",
    "value": 4
  },
  "summary": "Apply Config Changes",
  "scheduledStart": "2020-08-26T8:53:51-07:00",
  "scheduledEnd": "2020-08-26T10:53:51-07:00",
  "scheduledBy": "<email iD>",
  "referenceExecutionId": "3-B3RSD2H",
  "bounce":true,
  "createdOn": "2020-08-25T6:51:41-07:00",
  "createdBy": "<email ID>",
  "updatedOn": "2020-08-25T6:51:41-07:00",
  "updatedBy": "<email ID>",
  "config": {
    "type": "Trace & Debug",
    "activity": {
      "name": "FRD Enable/Disable",
      "type": "Enable",
      "parameters": [
        {
          "name": "UserName",
          "value": "oracle"
        },
        {
          "name": "Auto_Disable_Interval",
          "value": "2"
        }
      ]
    }
  },
  "ticketingDetails": {
    "rfcNumber": "3-7JZXAMZ",
    "primaryContact": "<email ID>",
    "customerNote": "Action Plan",
    "rfcType": "Configuration - EBSO",
    "rfcSubType": "Autoexec-Config",
    "status": "Open",
    "subStatus": "Ready For Execution",
    "customerStatus": "Acknowledged"
  },
  "downStreamExecutions": [
    {
      "id": "3-7JZXAHB",
      "scheduledStart": "2020-08-26T11:53:51-07:00",
      "scheduledEnd": "2020-08-26T11:58:51-07:00",
      "status": "Open",
      "subStatus": "Ready For Execution",
      "custStatus": "Review Update",
      "config": {
        "type": "Trace & Debug",
        "activity": {
          "name": "FRD Enable/Disable",
          "type": "Disable"
        }
      },
      "ticketingDetails": {
        "rfcNumber": "3-7JZXAHB",
        "primaryContact": "<email ID>",
        "customerNote": "Action Plan",
        "rfcType": "Configuration - EBSO",
        "rfcSubType": "Autoexec-Config",
        "status": "Open",
        "subStatus": "Ready For Execution",
        "customerStatus": "Acknowledged"
      }
    }
  ]
}