Oracle Scheduled Job API

openapi: 3.2.0
info:
  description: "Use the OS Management Hub API to manage and monitor updates and patches for instances in OCI, your private data center, or 3rd-party clouds. \nFor more information, see [Overview of OS Management Hub](https://docs.cloud.oracle.com/iaas/osmh/doc/overview.htm).\n"
  title: OS Management Hub Scheduled Job API
  version: '20220901'
  x-provenance:
    method: harvested
    first_party: true
    publisher: Oracle
    source: https://docs.oracle.com/en-us/iaas/api/specs/53a02334fff4534e79601c527b7a16800905500d2c670af774e682c05d12a1e6.yaml
    harvested: '2026-08-04'
    note: Published by Oracle as the contract for the OS Management Hub API OCI service and stored verbatim; API Evangelist added only this provenance block.
  x-evidence:
  - url: https://docs.oracle.com/en-us/iaas/api/specs/index.json
    what: Oracle's own index of every OCI service specification
  - url: https://docs.oracle.com/en-us/iaas/api/specs/53a02334fff4534e79601c527b7a16800905500d2c670af774e682c05d12a1e6.yaml
    what: the harvested document for OS Management Hub API
servers:
- url: http://127.0.0.1/20220901
- url: https://127.0.0.1/20220901
tags:
- name: scheduledJob
paths:
  /scheduledJobs:
    get:
      description: 'Lists scheduled jobs that match the specified compartment or scheduled job [OCID](/iaas/Content/General/Concepts/identifiers.htm).

        '
      operationId: ListScheduledJobs
      parameters:
      - $ref: '#/components/parameters/CompartmentIdQueryParam'
      - $ref: '#/components/parameters/DisplayNameQueryParam'
      - $ref: '#/components/parameters/DisplayNameContainsQueryParam'
      - $ref: '#/components/parameters/ScheduledJobLifecycleStateQueryParam'
      - $ref: '#/components/parameters/ManagedInstanceIdQueryParam'
      - $ref: '#/components/parameters/ManagedInstanceGroupIdQueryParam'
      - $ref: '#/components/parameters/ManagedCompartmentIdQueryParam'
      - $ref: '#/components/parameters/LifecycleStageIdQueryParam'
      - $ref: '#/components/parameters/OperationTypeQueryParam'
      - $ref: '#/components/parameters/ScheduleTypeQueryParam'
      - $ref: '#/components/parameters/StartTimeOptionalQueryParam'
      - $ref: '#/components/parameters/EndTimeOptionalQueryParam'
      - $ref: '#/components/parameters/PaginationLimitQueryParam'
      - $ref: '#/components/parameters/PaginationTokenQueryParam'
      - $ref: '#/components/parameters/SortOrderQueryParam'
      - $ref: '#/components/parameters/ScheduledJobSortByQueryParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/RestrictedQueryParam'
      - $ref: '#/components/parameters/ScheduledJobIdentifierQueryParam'
      - $ref: '#/components/parameters/CompartmentIdInSubTreeQueryParam'
      - $ref: '#/components/parameters/MultiLocationQueryParam'
      - $ref: '#/components/parameters/MultiLocationNotEqualToQueryParam'
      - $ref: '#/components/parameters/IsManagedByAutonomousLinuxQueryParam'
      - $ref: '#/components/parameters/DynamicSetIdQueryParam'
      responses:
        200:
          description: The list of scheduled jobs was retrieved.
          headers:
            opc-next-page:
              description: 'For list pagination. When this header appears in the response, additional pages of results remain. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).

                '
              schema:
                type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ScheduledJobCollection'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Gets a list of all scheduled jobs in a compartment
      tags:
      - scheduledJob
      x-example: 'GET /20220901/scheduledJobs?compartmentId=<var>&lt;compartment_OCID&gt;</var>

        Host: osmh.us-phoenix-1.oci.oraclecloud.com

        <var>&lt;authorization and other headers&gt;</var>

        '
      x-related-resource: '#/definitions/ScheduledJob'
    post:
      description: 'Creates a new scheduled job.

        '
      operationId: CreateScheduledJob
      parameters:
      - $ref: '#/components/parameters/RetryTokenHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: The scheduled job was created.
          headers:
            Location:
              description: A link to the created scheduled job.
              schema:
                type: string
                format: url
            etag:
              description: 'For optimistic concurrency control. See `if-match`.

                '
              schema:
                type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ScheduledJob'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        409:
          $ref: '#/components/responses/409'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Creates a new scheduled job.
      tags:
      - scheduledJob
      x-example: "POST /20220901/scheduledJobs\nHost: osmh.us-phoenix-1.oci.oraclecloud.com\n<var>&lt;authorization and other headers&gt;</var>\n{\n  \"compartmentId\": \"ocid1.compartment.oc1..<var>&lt;unique_ID&gt;</var>\",\n  \"displayName\": \"example_scheduled_job_name\",\n  \"description\": \"string\",\n  \"scheduleType\": \"RECURRING\",\n  \"locations\": [\n    \"OCI_COMPUTE\"\n  ],\n  \"timeNextExecution\": \"2025-04-08T23:49:19.805Z\",\n  \"recurringRule\": \"FREQ=WEEKLY;BYDAY=MO,TU,WE,TH;BYHOUR=10;INTERVAL=1\",\n  \"managedInstanceIds\": [\n    \"ocid1.instance.oc1..<var>&lt;unique_ID&gt;</var>\"\n  ],\n  \"isSubcompartmentIncluded\": false,\n  \"operations\": [\n    {\n      \"operationType\": \"UPDATE_ALL\",\n    }\n  ],\n  \"retryIntervals\": [\n    5, 10\n  ],\n  \"isManagedByAutonomousLinux\": false,\n}\n"
      x-related-resource: '#/definitions/ScheduledJob'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateScheduledJobDetails'
        description: Provides the information used to create the scheduled job.
        required: true
  /scheduledJobs/{scheduledJobId}:
    delete:
      description: 'Deletes the specified scheduled job.

        '
      operationId: DeleteScheduledJob
      parameters:
      - $ref: '#/components/parameters/ScheduledJobIdentifierPathParam'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        204:
          description: The scheduled job was deleted.
          headers:
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Cancel (delete) a scheduled job.
      tags:
      - scheduledJob
      x-example: 'DELETE /20220901/scheduledJobs/<var>&lt;resource_OCID&gt;</var>

        Host: osmh.us-ashburn-1.oci.oraclecloud.com

        <var>&lt;authorization and other headers&gt;</var>

        '
      x-related-resource: '#/definitions/ScheduledJob'
    get:
      description: 'Gets information about the specified scheduled job.

        '
      operationId: GetScheduledJob
      parameters:
      - $ref: '#/components/parameters/ScheduledJobIdentifierPathParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: The scheduled job was retrieved.
          headers:
            etag:
              description: 'For optimistic concurrency control. See `if-match`.

                '
              schema:
                type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
            retry-after:
              description: A decimal number representing the number of seconds the client should wait before polling this endpoint again.
              schema:
                type: integer
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ScheduledJob'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Gets a scheduled job
      tags:
      - scheduledJob
      x-example: 'GET /20220901/scheduledJobs/<var>&lt;resource_OCID&gt;</var>

        Host: osmh.us-phoenix-1.oci.oraclecloud.com

        <var>&lt;authorization and other headers&gt;</var>

        '
    put:
      description: 'Updates the specified scheduled job''s name, description, and other details, such as next execution and recurrence.

        '
      operationId: UpdateScheduledJob
      parameters:
      - $ref: '#/components/parameters/ScheduledJobIdentifierPathParam'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: The scheduled job was updated.
          headers:
            etag:
              description: 'For optimistic concurrency control. See `if-match`.

                '
              schema:
                type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ScheduledJob'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Update the specified scheduled job.
      tags:
      - scheduledJob
      x-example: "PUT /20220901/scheduledJobs/<var>&lt;resource_OCID&gt;</var>\nHost: osmh.us-ashburn-1.oci.oraclecloud.com\n<var>&lt;authorization and other headers&gt;</var>\n{\n  \"displayName\": \"new_display_name\",\n  \"description\": \"new_description\",\n  \"scheduleType\": \"ONETIME\",\n  \"timeNextExecution\": \"2025-04-09T00:00:15.766Z\",\n  \"recurringRule\": null,\n  \"operations\": [\n    {\n      \"operationType\": \"UPDATE_ALL\",\n    }\n  ],\n  \"retryIntervals\": [\n      0\n    ]\n}\n"
      x-related-resource: '#/definitions/ScheduledJob'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateScheduledJobDetails'
        description: Provides the information used to update the job.
        required: true
  /scheduledJobs/{scheduledJobId}/actions/changeCompartment:
    post:
      description: Moves a scheduled job to another compartment.
      operationId: ChangeScheduledJobCompartment
      parameters:
      - $ref: '#/components/parameters/ScheduledJobIdPathParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RetryTokenHeader'
      - $ref: '#/components/parameters/ChangeScheduledJobCompartmentDetailsParam'
      responses:
        204:
          description: The scheduled job was successfully moved to the specified compartment.
          headers:
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        409:
          $ref: '#/components/responses/409'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Moves a resource into a different compartment.
      tags:
      - scheduledJob
      x-example: "POST /20220901/scheduledJobs/<var>&lt;resource_OCID&gt;</var>/actions/changeCompartment\nHost: osmh.us-ashburn-1.oci.oraclecloud.com\n<var>&lt;authorization and other headers&gt;</var>\n{\n    \"compartmentId\": \"ocid1.compartment.oc1..&lt;unique_id&gt;\"\n}\n"
      x-obmcs-terraform:
        actionType: UPDATE_FIELD
      x-related-resource: '#/definitions/ScheduledJob'
  /scheduledJobs/{scheduledJobId}/actions/runNow:
    post:
      description: 'Triggers an already created recurring scheduled job to run immediately instead of waiting for its next regularly

        scheduled time. This operation only applies to recurring jobs, not one-time scheduled jobs.

        '
      operationId: RunScheduledJobNow
      parameters:
      - $ref: '#/components/parameters/ScheduledJobIdPathParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RetryTokenHeader'
      responses:
        200:
          description: The scheduled job is running.
          headers:
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        409:
          $ref: '#/components/responses/409'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Triggers a scheduled job to execute immediately
      tags:
      - scheduledJob
      x-example: 'POST /20220901/scheduledJobs/<var>&lt;resource_OCID&gt;</var>/actions/runNow

        Host: osmh.us-ashburn-1.oci.oraclecloud.com

        <var>&lt;authorization and other headers&gt;</var>

        {

        }

        '
      x-related-resource: '#/definitions/ScheduledJob'
components:
  parameters:
    ScheduleTypeQueryParam:
      description: A filter to return only scheduled jobs of the given scheduling type (one-time or recurring).
      in: query
      name: scheduleType
      required: false
      x-default-description: 'null'
      x-obmcs-top-level-enum: '#/definitions/ScheduleTypes'
      schema:
        type: string
        enum:
        - ONETIME
        - RECURRING
    ScheduledJobSortByQueryParam:
      description: 'The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending.

        '
      in: query
      name: sortBy
      schema:
        type: string
        enum:
        - timeCreated
        - displayName
        default: timeCreated
    ManagedInstanceGroupIdQueryParam:
      description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the managed instance group. This filter returns resources associated with this group.
      in: query
      name: managedInstanceGroupId
      required: false
      x-default-description: 'null'
      schema:
        type: string
    ChangeScheduledJobCompartmentDetailsParam:
      description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment to move the scheduled job to.
      in: body
      name: ChangeScheduledJobCompartmentDetails
      required: true
      schema:
        $ref: '#/components/schemas/ChangeScheduledJobCompartmentDetails'
    ManagedCompartmentIdQueryParam:
      description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the managed compartment. This filter returns resources associated with this compartment.
      in: query
      name: managedCompartmentId
      required: false
      x-default-description: 'null'
      schema:
        type: string
    ScheduledJobLifecycleStateQueryParam:
      description: A filter to return only scheduled jobs currently in the given state.
      in: query
      name: lifecycleState
      required: false
      x-default-description: 'null'
      x-obmcs-enumref: '#/definitions/ScheduledJob/lifecycleState'
      schema:
        type: string
    OperationTypeQueryParam:
      description: A filter to return only scheduled jobs with the given operation type.
      in: query
      name: operationType
      required: false
      x-default-description: 'null'
      x-obmcs-top-level-enum: '#/definitions/OperationTypes'
      schema:
        type: string
        enum:
        - INSTALL_PACKAGES
        - UPDATE_PACKAGES
        - REMOVE_PACKAGES
        - UPDATE_ALL
        - UPDATE_SECURITY
        - UPDATE_BUGFIX
        - UPDATE_ENHANCEMENT
        - UPDATE_OTHER
        - UPDATE_KSPLICE_USERSPACE
        - UPDATE_KSPLICE_KERNEL
        - MANAGE_MODULE_STREAMS
        - SWITCH_MODULE_STREAM
        - ATTACH_SOFTWARE_SOURCES
        - DETACH_SOFTWARE_SOURCES
        - SYNC_MANAGEMENT_STATION_MIRROR
        - PROMOTE_LIFECYCLE
        - INSTALL_WINDOWS_UPDATES
        - INSTALL_ALL_WINDOWS_UPDATES
        - INSTALL_SECURITY_WINDOWS_UPDATES
        - INSTALL_BUGFIX_WINDOWS_UPDATES
        - INSTALL_ENHANCEMENT_WINDOWS_UPDATES
        - INSTALL_OTHER_WINDOWS_UPDATES
        - REBOOT
        - RERUN_WORK_REQUEST
        - INSTALL_SNAPS
        - REMOVE_SNAPS
        - SWITCH_SNAP_CHANNEL
    IsManagedByAutonomousLinuxQueryParam:
      description: 'Indicates whether to list only resources managed by the Autonomous Linux service.

        '
      in: query
      name: isManagedByAutonomousLinux
      required: false
      x-default-description: 'null'
      schema:
        type: boolean
    MultiLocationQueryParam:
      description: A filter to return only resources whose location matches the given value.
      in: query
      name: location
      x-default-description: 'null'
      style: form
      explode: true
      schema:
        type: array
        items:
          enum:
          - ON_PREMISE
          - OCI_COMPUTE
          - AZURE
          - EC2
          - GCP
          type: string
          x-obmcs-top-level-enum: '#/definitions/ManagedInstanceLocation'
        maxItems: 5
        uniqueItems: true
    RestrictedQueryParam:
      description: A filter to return only restricted scheduled jobs.
      in: query
      name: isRestricted
      required: false
      x-default-description: false
      schema:
        type: boolean
    CompartmentIdInSubTreeQueryParam:
      description: Indicates whether to include subcompartments in the returned results. Default is false.
      in: query
      name: compartmentIdInSubtree
      required: false
      x-default-description: false
      schema:
        type: boolean
    StartTimeOptionalQueryParam:
      description: 'A filter to return only resources with a date on or after the given value, in ISO 8601 format.


        Example: 2017-07-14T02:40:00.000Z

        '
      in: query
      name: timeStart
      required: false
      x-default-description: 'null'
      schema:
        type: string
        format: date-time
    DynamicSetIdQueryParam:
      description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the dynamic set. This filter returns resources associated with this dynamic set.
      in: query
      name: dynamicSetId
      required: false
      x-default-description: 'null'
      schema:
        type: string
    ScheduledJobIdentifierPathParam:
      description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the scheduled job.
      in: path
      name: scheduledJobId
      required: true
      schema:
        type: string
    SortOrderQueryParam:
      description: The sort order to use, either 'ASC' or 'DESC'.
      in: query
      name: sortOrder
      x-default-description: 'The default value depends upon `sortBy`, and

        in general is ''DESC'' when sorting by time and ''ASC'' otherwise.

        '
      x-obmcs-top-level-enum: '#/definitions/SortOrder'
      schema:
        type: string
        enum:
        - ASC
        - DESC
    MultiLocationNotEqualToQueryParam:
      description: A filter to return only resources whose location does not match the given value.
      in: query
      name: locationNotEqualTo
      x-default-description: 'null'
      style: form
      explode: true
      schema:
        type: array
        items:
          enum:
          - ON_PREMISE
          - OCI_COMPUTE
          - AZURE
          - EC2
          - GCP
          type: string
          x-obmcs-top-level-enum: '#/definitions/ManagedInstanceLocation'
        maxItems: 5
        uniqueItems: true
    EndTimeOptionalQueryParam:
      description: 'A filter to return only resources with a date on or before the given value, in ISO 8601 format.


        Example: 2017-07-14T02:40:00.000Z

        '
      in: query
      name: timeEnd
      required: false
      x-default-description: 'null'
      schema:
        type: string
        format: date-time
    DisplayNameContainsQueryParam:
      description: A filter to return resources that may partially match the given display name.
      in: query
      name: displayNameContains
      x-default-description: 'null'
      schema:
        type: string
        maxLength: 255
        minLength: 1
    ManagedInstanceIdQueryParam:
      description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the managed instance. This filter returns resources associated with this managed instance.
      in: query
      name: managedInstanceId
      required: false
      x-default-description: 'null'
      schema:
        type: string
    RequestIdHeader:
      description: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
      in: header
      name: opc-request-id
      schema:
        type: string
    PaginationTokenQueryParam:
      description: 'For list pagination. The value of the `opc-next-page` response header from the previous "List" call.

        For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).


        Example: `3`

        '
      in: query
      name: page
      x-default-description: 'null'
      schema:
        type: string
        minLength: 1
    DisplayNameQueryParam:
      description: A filter to return resources that match the given user-friendly name.
      in: query
      name: displayName
      x-default-description: 'null'
      schema:
        type: string
        maxLength: 255
        minLength: 1
    ScheduledJobIdentifierQueryParam:
      description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the scheduled job. A filter to return the specified job.
      in: query
      name: id
      x-default-description: 'null'
      schema:
        type: string
    ScheduledJobIdPathParam:
      description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the scheduled job.
      in: path
      name: scheduledJobId
      required: true
      schema:
        type: string
    RetryTokenHeader:
      description: 'A token that uniquely identifies a request so it can be retried in case of a timeout or

        server error without risk of executing that same action again. Retry tokens expire after 24

        hours, but can be invalidated before then due to conflicting operations. For example, if a resource

        has been deleted and purged from the system, then a retry of the original creation request

        might be rejected.

        '
      in: header
      name: opc-retry-token
      required: false
      schema:
        type: string
        maxLength: 64
        minLength: 1
    PaginationLimitQueryParam:
      description: 'For list pagination. The maximum number of results per page, or items to return in a paginated "List" call.

        For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).


        Example: `50`

        '
      in: query
      name: limit
      schema:
        type: integer
        default: 10
        maximum: 100
        minimum: 1
    CompartmentIdQueryParam:
      description: The OCID of the compartment that contains the resources to list. This filter returns only resources contained within the specified compartment.
      in: query
      name: compartmentId
      x-default-description: 'null'
      schema:
        type: string
    LifecycleStageIdQueryParam:
      description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the lifecycle stage. This resource returns resources associated with this lifecycle stage.
      in: query
      name: lifecycleStageId
      required: false
      x-default-description: 'null'
      schema:
        type: string
    IfMatchHeader:
      description: 'For optimistic concurrency control. In the PUT or DELETE call

        for a resource, set the `if-match` parameter to the value of the

        etag from a previous GET or POST response for that resource.

        The resource will be updated or deleted only if the etag you

        provide matches the resource''s current etag value.

        '
      in: header
      name: if-match
      required: false
      schema:
        type: string
  schemas:
    ManageModuleStreamsInScheduledJobDetails:
      description: The set of changes to make to the state of the modules, streams, and profiles on the managed target.
      properties:
        disable:
          description: The set of module streams to disable.
          items:
            $ref: '#/components/schemas/ModuleStreamDetails'
          type: array
        enable:
          description: The set of module streams to enable.
          items:
            $ref: '#/components/schemas/ModuleStreamDetails'
          type: array
        install:
          description: The set of module stream profiles to install.
          items:
            $ref: '#/components/schemas/ModuleStreamProfileDetails'
          type: array
        remove:
          description: The set of module stream profiles to remove.
          items:
            $ref: '#/components/schemas/ModuleStreamProfileDetails'
          type: array
      type: object
      x-example: "{\n    \"manageModuleStreamsDetails\": {\n      \"enable\": [\n        {\n          \"moduleName\": \"ant\",\n          \"streamName\": \"1.10\",\n          \"softwareSourceId\": null\n        }\n      ],\n      \"disable\": [ ],\n      \"install\": [\n        {\n          \"moduleName\": \"ant\",\n          \"streamName\": \"1.10\",\n          \"profileName\": \"common\",\n          \"softwareSourceId\": null\n        }\n      ],\n      \"remove\": [ ]\n    }\n}\n"
    InstallSnapDetails:
      description: Provides the information used to install a snap.
      properties:
        channel:
          description: 'The snap channel to install from (e.g. stable, 1.2/edge, beta, candidate, or a custom channel).

            '
          type: string
          x-default-description: 'null'
        isSigned:
          default: true
          description: 'If false, allows installing snaps not signed by the Snap Store. E.g., snaps from local file. Use with caution.

            '
          type: boolean
        mode:
          default: DEFAULT
          description: 'The confinement mode for the snap.

            '
          enum:
          - DEFAULT
          - CLASSIC
          - JAIL_MODE
          - DEV_MODE
          type: string
          x-obmcs-top-level-enum: '#/definitions/SnapModes'
        name:
          description: 'The name of the snap to install.

            '
          type: string
        revision:
          description: 'The snap revision to install.

            '
          type: string
          x-default-description: 'null'
      required:
      - name
      type: object
    ScheduledJob:
      description: The object that defines a scheduled job. For more information about jobs, see [Managing Jobs](/iaas/osmh/doc/jobs.htm).
      properties:
        compartmentId:
          description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment that contains the scheduled job.
          maxLength: 255
          minLength: 1
          type: string
        definedTags:
          additionalProperties:
            additionalProperties:
              description: 'The value of the tag. Only the String type is supported.

                '
              type: object
            description: 'Key-value pair representing a defined tag key and value, scoped to a namespace.

              Example: `{"CostCenter": "42"}`

              '
            type: object
          description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.

            For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).

            Example: `{"Operations": {"CostCenter": "42"}}`

            '
          type: object
        description:
          description: User-specified description for the scheduled job.
          maxLength: 400
          type: string
        displayName:
          description: User-friendly name for the scheduled job.
          maxLength: 255
          minLength: 1
          type: string
        dynamicSetIds:
          description: "The dynamic set [OCIDs](/iaas/Content/General/Concepts/identifiers.htm) that this scheduled job operates on.\nA scheduled job can only operate on one type of target. therefore this parameter is mutually exclusive with \nmanagedInstanceIds, managedInstanceGroupIds, and managedCompartmentIds.\n"
          items:
            type: string
          maxItems: 255
          type: array
        freeformTags:
          additionalProperties:
            type: string
          description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.

            For more informa

# --- truncated at 32 KB (78 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/oracle/refs/heads/main/openapi/oracle-scheduledjob-api-openapi.yml