Schedule Execution

Use this API to schedule or reschedule a bounce execution.

API

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

Scope and AuthZ

  • You must have mcs:oci:api:Approver scope to access this API.
  • You can schedule bounce execution only for your customer instances.
  • You can use Bounce API only if customer has opted-in for bounce 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 schedule or reschedule a Bounce Execution 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 Target name or instance name on which patches have to be applied Yes
executionId Path parameter Unique execution ID for the patch execution Yes

Sample request

{
  "scheduledTime": "2020-08-26T8:53:51-07:00",
  "action": "schedule"
}

Sample response (success)

{
  "scheduledStart": "2020-08-26T8:53:51-07:00",
  "scheduledEnd": "2020-08-26T10:53:51-07:00",
  "status": "Open",
  "subStatus": "Ready For Execution",
  "custStatus": "Review Update"
}

Sample response (conflicts)

{
  "conflicts": [
    {
      "rfcNumber": "3-7JZXAMZ",
      "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
      }
    },
    {
      "rfcNumber": "3-6JZXAMH",
      "rfcType": "Configuration - EBSO",
      "rfcSubType": "Autoexec-Config",
      "status": "Open",
      "subStatus": "Ready For Scheduling/Approval",
      "scheduledStart": "2020-08-26T8:53:51-07:00",
      "scheduledEnd": "2020-08-26T10:53:51-07:00",
      "duration": {
        "unit": "hours",
        "value": 4
      }
    }
  ]
}