Oracle Cloud Infrastructure Documentation

Schedule Execution

Use this API to schedule or reschedule a configuration execution.

API

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

Scope and AuthZ

  • You must have mcs:oci:api:Approver scope to access this API.
  • You can schedule executions only for your customer instances.
  • 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 schedule or reschedule a ConfigExecution for a customer instance.
  • Request field that requires explanation:
    • scheduledTime is the time in UTC when the execution has to be scheduled. ScheduleTime must be at least 16 minutes from the current time.

Verb

PUT

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 request (Single activity)

{
  "action": "schedule",
  "scheduledTime": "2020-08-26T8:53:51-07:00"
}
//no downstream executions for activties which have single activity type

Sample request (Toggle activity)

{
  "action": "schedule",
  "checkAutoDisable": false,
  "scheduledTime": "2020-08-26T8:53:51-07:00",
  "downStreamExecutions": [
    {
      "scheduledTime": "2020-08-26T11:53:51-07:00",
      "activityType": "Disable"
    }
  ]
}

Sample response (Success single activity)

{
  "id": "3-7JZXAMZ",
  "rfcNumber": "3-7JZXAMZ",
  "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": "Enable"
    }
  }
}

Sample response (Success single activity)

{
  "id": "3-7JZXAMZ",
  "rfcNumber": "3-7JZXAMZ",
  "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": "Enable"
    }
  },
  "downStreamExecutions": [
    {
      "id": "3-7JZXAMZ",
      "rfcNumber": "3-7JZXAMZ",
      "scheduledStart": "2020-08-26T12:52:51-07:00",
      "scheduledEnd": "2020-08-26T12:55:51-07:00",
      "status": "Open",
      "subStatus": "Ready For Execution",
      "custStatus": "Review Update",
      "config": {
        "type": "Trace & Debug",
        "activity": {
          "name": "FRD Enable/Disable",
          "type": "Disable"
        }
      }
    }
  ]
}

Sample response (Conflicts for parent activity)

{
  "id": "3-7JZXAMZ",
  "rfcNumber": "3-7JZXAMZ",
  "status": "Open",
  "subStatus": "Ready For Scheduling",
  "custStatus": "Achnowledged",
  "config": {
    "type": "Trace & Debug",
    "activity": {
      "name": "FRD Enable/Disable",
      "type": "Enable"
    }
  },
  "conflicts": [
    {
      "rfcNumber": "3-7KZXAMB",
      "rfcType": "CODE_PROMO",
      "rfcSubType": "CEMLI_PATCH",
      "status": "Open",
      "subStatus": "Ready For Execution",
      "scheduledStart": "2020-08-26T8:53:51-07:00",
      "scheduledEnd": "2020-08-26T10:53:51-07:00",
      "duration": {
        "unit": "hours",
        "value": 2
      }
    },
    {
      "rfcNumber": "3-7JZXAGH",
      "rfcType": "OCIEBS_Prod_SelfService",
      "rfcSubType": "SelfService_Bounce",
      "status": "Open",
      "subStatus": "Ready For Execution",
      "scheduledStart": "2020-08-26T8:53:51-07:00",
      "scheduledEnd": "2020-08-26T10:53:51-07:00",
      "duration": {
        "unit": "hours",
        "value": 3
      }
    }
  ],
  "downStreamExecutions": [
    {
      "id": "3-7BZXAMG",
      "rfcNumber": "3-7BZXAMG",
      "status": "Open",
      "subStatus": "Ready For Scheduling",
      "custStatus": "Achnowledged",
      "config": {
        "type": "Trace & Debug",
        "activity": {
          "name": "FRD Enable/Disable",
          "type": "Disable"
        }
      }
    }
  ]
}

Sample response (Conflicts for downstream activity)

{
  "id": "3-7JZXAMZ",
  "rfcNumber": "3-7JZXAMZ",
  "status": "Open",
  "subStatus": "Ready For Scheduling",
  "custStatus": "Acknowledged",
  "config": {
    "type": "Trace & Debug",
    "activity": {
      "name": "FRD Enable/Disable",
      "type": "Enable"
    }
  },
  "downStreamExecutions": [
    {
      "id": "3-7BZXAMG",
      "rfcNumber": "3-7BZXAMG",
      "status": "Open",
      "subStatus": "Ready For Scheduling",
      "custStatus": "Achnowledged",
      "config": {
        "type": "Trace & Debug",
        "activity": {
          "name": "FRD Enable/Disable",
          "type": "Disable"
        }
      },
      "conflicts": [
        {
          "rfcNumber": "3-7JGXAR",
          "rfcType": "CODE_PROMO",
          "rfcSubType": "CEMLI_PATCH",
          "status": "Open",
          "subStatus": "Ready For Execution",
          "scheduledStart": "2020-08-26T8:53:51-07:00",
          "scheduledEnd": "2020-08-26T10:53:51-07:00",
          "duration": {
            "unit": "hours",
            "value": 2
          }
        }
      ]
    }
  ]
}