List of Executions

Use this API to list configuration executions.

API

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

Scope and AuthZ

  • You must have mcs:oci:api:User scope to access this API.
  • You can list executions 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).

Base Path

/selfservice/v1/

Dependency

Functionality

  • This API allows you to list configuration executions.
  • Response field that requires explanation:
    • id is the unique identifier for the ticket.

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
target Query parameter Instance name or target name No
status Query parameter No
subStatus Query parameter No
customerStatus Query parameter No
configType Query parameter No
activityName Query parameter No
activityType Query parameter No

Sample response

[
  {
    "id": "3-7JZXAGH",
    "target": "DCMATI",
    "scheduledStart": "2020-08-26T8:53:51-07:00",
    "scheduledEnd": "2020-08-26T10:53:51-07:00",
    "scheduledBy": "<email ID>",
    "createdOn": "2020-08-25T6:51:41-07:00",
    "createdBy": "<email ID>",
    "config": {
      "type": "Trace & Debug",
      "activity": {
        "name": "FRD Enable/Disable",
        "type": "Enable"
      }
    },
    "ticketingDetails": {
      "rfcNumber": "3-7JZXAMZ",
      "primaryContact": "<email ID>",
      "customerNote": "Action Plan",
      "rfcType": "Configuration - EBSO",
      "rfcSubType": "Autoexec-Config",
      "status": "Open",
      "subStatus": "Ready For Execution",
      "customerStatus": "Acknowledged"
    }
  },
  {
    "id": "3-7JZXAMZ",
    "target": "TCMA1I",
    "scheduledStart": "2020-08-26T8:53:51-07:00",
    "scheduledEnd": "2020-08-26T10:53:51-07:00",
    "scheduledBy": "<email ID>",
    "createdOn": "2020-08-25T6:51:41-07:00",
    "createdBy": "<email ID>",
    "config": {
      "type": "Trace & Debug",
      "activity": {
        "name": "FRD Enable/Disable",
        "type": "Disable"
      }
    },
    "ticketingDetails": {
      "rfcNumber": "3-7JZXAMZ",
      "primaryContact": "<email ID>",
      "customerNote": "Action Plan",
      "rfcType": "Configuration - EBSO",
      "rfcSubType": "Autoexec-Config",
      "status": "Open",
      "subStatus": "Ready For Execution",
      "customerStatus": "Acknowledged"
    }
  }
]