openapi: 3.2.0
info:
  description: Use the Fusion Applications Environment Management API to manage the environments where your Fusion Applications run. For more information, see the [Fusion Applications Environment Management documentation](/iaas/Content/fusion-applications/home.htm).
  title: Fusion Applications Environment Management Scheduled Activity API
  version: '20211201'
  x-provenance:
    method: harvested
    first_party: true
    publisher: Oracle
    source: https://docs.oracle.com/en-us/iaas/api/specs/2862e9b2d8df5c1b0fcbcce0eecb2a727ba22660b1a4afb08cc75980114cc127.yaml
    harvested: '2026-08-04'
    note: Published by Oracle as the contract for the Fusion Applications Environment Management 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/2862e9b2d8df5c1b0fcbcce0eecb2a727ba22660b1a4afb08cc75980114cc127.yaml
    what: the harvested document for Fusion Applications Environment Management API
servers:
- url: http://127.0.0.1/20211201
- url: https://127.0.0.1/20211201
tags:
- name: scheduledActivity
paths:
  /fusionEnvironments/{fusionEnvironmentId}/scheduledActivities:
    get:
      description: 'Returns a list of ScheduledActivities.

        '
      operationId: ListScheduledActivities
      parameters:
      - $ref: '#/components/parameters/FusionEnvironmentIdentifierPathParam'
      - $ref: '#/components/parameters/DisplayNameQueryParam'
      - $ref: '#/components/parameters/ScheduledStartTimeQueryParam'
      - $ref: '#/components/parameters/ExpectedFinishTimeQueryParam'
      - $ref: '#/components/parameters/ScheduledActivityRunCycleQueryParam'
      - $ref: '#/components/parameters/ScheduledActivityLifecycleStateQueryParam'
      - $ref: '#/components/parameters/PaginationLimitQueryParam'
      - $ref: '#/components/parameters/PaginationTokenQueryParam'
      - $ref: '#/components/parameters/SortOrderQueryParam'
      - $ref: '#/components/parameters/SortByQueryParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: A page of ScheduledActivitySummary objects.
          headers:
            opc-next-page:
              description: 'For pagination of a list of items. When paging through a list, if this header appears in the response,

                then a partial list might have been returned. Include this value as the `page` parameter for the

                subsequent GET request to get the next batch of items.

                '
              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/ScheduledActivityCollection'
        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 ScheduledActivities for a fusion environment
      tags:
      - scheduledActivity
      x-related-resource: '#/definitions/ScheduledActivity'
  /fusionEnvironments/{fusionEnvironmentId}/scheduledActivities/{scheduledActivityId}:
    get:
      description: Gets a ScheduledActivity by identifier
      operationId: GetScheduledActivity
      parameters:
      - $ref: '#/components/parameters/FusionEnvironmentIdentifierPathParam'
      - $ref: '#/components/parameters/ScheduledActivityIdentifierPathParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: Retrieves the ScheduledActivity with the given id
          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/ScheduledActivity'
        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: Get ScheduledActivity
      tags:
      - scheduledActivity
components:
  responses:
    default:
      description: Unknown Error
      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
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  parameters:
    ExpectedFinishTimeQueryParam:
      description: A filter that returns all resources that end before this date
      in: query
      name: timeExpectedFinishLessThanOrEqualTo
      required: false
      x-default-description: Returns based on other filters by default
      schema:
        type: string
        format: date-time
    ScheduledActivityRunCycleQueryParam:
      description: A filter that returns all resources that match the specified run cycle.
      in: query
      name: runCycle
      required: false
      x-default-description: Returns all states by default
      x-obmcs-enumref: '#/definitions/ScheduledActivity/runCycle'
      schema:
        type: string
    ScheduledActivityIdentifierPathParam:
      description: Unique ScheduledActivity identifier.
      in: path
      name: scheduledActivityId
      required: true
      schema:
        type: string
    SortOrderQueryParam:
      description: The sort order to use, either 'asc' or 'desc'.
      in: query
      name: sortOrder
      required: false
      schema:
        type: string
        enum:
        - ASC
        - DESC
        default: DESC
    DisplayNameQueryParam:
      description: A filter to return only resources that match the entire display name given.
      in: query
      name: displayName
      x-default-description: 'null'
      schema:
        type: string
        maxLength: 255
        minLength: 1
    SortByQueryParam:
      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. If no value is specified timeCreated is default.

        '
      in: query
      name: sortBy
      schema:
        type: string
        enum:
        - TIME_CREATED
        - DISPLAY_NAME
        default: TIME_CREATED
    PaginationTokenQueryParam:
      description: The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
      in: query
      name: page
      schema:
        type: string
        minLength: 1
    RequestIdHeader:
      description: The client request ID for tracing.
      in: header
      name: opc-request-id
      schema:
        type: string
    PaginationLimitQueryParam:
      description: The maximum number of items to return.
      in: query
      name: limit
      schema:
        type: integer
        default: 100
        maximum: 100
        minimum: 1
    ScheduledActivityLifecycleStateQueryParam:
      description: A filter that returns all resources that match the specified status
      in: query
      name: lifecycleState
      required: false
      x-default-description: Returns all lifecycle states by default
      x-obmcs-enumref: '#/definitions/ScheduledActivity/lifecycleState'
      schema:
        type: string
    FusionEnvironmentIdentifierPathParam:
      description: unique FusionEnvironment identifier
      in: path
      name: fusionEnvironmentId
      required: true
      schema:
        type: string
    ScheduledStartTimeQueryParam:
      description: A filter that returns all resources that are scheduled after this date
      in: query
      name: timeScheduledStartGreaterThanOrEqualTo
      required: false
      x-default-description: Returns based on other filters by default
      schema:
        type: string
        format: date-time
  schemas:
    Action:
      description: Action details.
      discriminator:
        propertyName: actionType
      properties:
        actionType:
          description: Type of action.
          enum:
          - QUARTERLY_UPGRADE
          - PATCH
          - VERTEX
          - MFA_ENFORCEMENT
          type: string
        description:
          description: A string that describes the details of the action. It does not have to be unique, and you can change it. Avoid entering confidential information.
          type: string
        referenceKey:
          description: Unique identifier of the object that represents the action.
          type: string
        state:
          description: A string that describes whether the change is applied hot or cold.
          enum:
          - ACCEPTED
          - IN_PROGRESS
          - SUCCEEDED
          - FAILED
          - CANCELED
          type: string
      required:
      - actionType
      - description
    Error:
      description: Error Information.
      properties:
        code:
          description: A short error code that defines the error, meant for programmatic parsing.
          type: string
        message:
          description: A human-readable error string.
          type: string
      required:
      - code
      - message
    ScheduledActivity:
      description: Details of scheduled activity.
      properties:
        actions:
          description: List of actions
          items:
            $ref: '#/components/schemas/Action'
          type: array
        delayInHours:
          description: Cumulative delay hours
          type: integer
        displayName:
          description: scheduled activity display name, can be renamed.
          type: string
        fusionEnvironmentId:
          description: FAaaS Environment Identifier.
          type: string
        id:
          description: Unique identifier that is immutable on creation.
          type: string
        lifecycleDetails:
          description: A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
          enum:
          - NONE
          - ROLLBACKACCEPTED
          - ROLLBACKINPROGRESS
          - ROLLBACKSUCCEEDED
          - ROLLBACKFAILED
          type: string
        lifecycleState:
          description: The current state of the scheduledActivity.
          enum:
          - ACCEPTED
          - IN_PROGRESS
          - FAILED
          - SUCCEEDED
          - CANCELED
          type: string
        runCycle:
          description: run cadence.
          enum:
          - QUARTERLY
          - MONTHLY
          - ONEOFF
          - VERTEX
          type: string
        serviceAvailability:
          description: Service availability / impact during scheduled activity execution up down
          enum:
          - AVAILABLE
          - UNAVAILABLE
          type: string
        timeCreated:
          description: The time the scheduled activity record was created. An RFC3339 formatted datetime string.
          format: date-time
          type: string
        timeExpectedFinish:
          description: Current time the scheduled activity is scheduled to end. An RFC3339 formatted datetime string.
          format: date-time
          type: string
        timeFinished:
          description: The time the scheduled activity actually completed / cancelled / failed. An RFC3339 formatted datetime string.
          format: date-time
          type: string
        timeScheduledStart:
          description: Current time the scheduled activity is scheduled to start. An RFC3339 formatted datetime string.
          format: date-time
          type: string
        timeUpdated:
          description: The time the scheduled activity record was updated. An RFC3339 formatted datetime string.
          format: date-time
          type: string
      required:
      - id
      - displayName
      - runCycle
      - fusionEnvironmentId
      - lifecycleState
      - timeScheduledStart
      - timeExpectedFinish
      - serviceAvailability
      type: object
    ScheduledActivityCollection:
      description: Results of a scheduled activity search.
      properties:
        items:
          description: A page of scheduled activity objects.
          items:
            $ref: '#/components/schemas/ScheduledActivitySummary'
          type: array
      required:
      - items
      type: object
    ScheduledActivitySummary:
      description: Summary of the scheduled activity for a Fusion environment.
      properties:
        actions:
          description: List of actions
          items:
            $ref: '#/components/schemas/Action'
          type: array
        definedTags:
          additionalProperties:
            additionalProperties:
              description: 'The value of the tag. Only string, integer and boolean types are supported.

                '
              type: object
            description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace.

              Example: `{"bar-key": "value"}`

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

            Example: `{"foo-namespace": {"bar-key": "value"}}`

            '
          type: object
        delayInHours:
          description: Cumulative delay hours
          type: integer
        displayName:
          description: A friendly name for the scheduled activity. Can be changed later.
          type: string
        freeformTags:
          additionalProperties:
            type: string
          description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.

            Example: `{"bar-key": "value"}`

            '
          type: object
        fusionEnvironmentId:
          description: The OCID of the Fusion environment for the scheduled activity.
          type: string
        id:
          description: Unique identifier that is immutable on creation.
          type: string
        lifecycleDetails:
          description: A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
          type: string
        lifecycleState:
          description: The current state of the scheduled activity. Valid values are Scheduled, In progress , Failed, Completed.
          type: string
          x-obmcs-enumref: '#/definitions/ScheduledActivity/lifecycleState'
        runCycle:
          description: The run cadence of this scheduled activity. Valid values are Quarterly, Monthly, OneOff, and Vertex.
          type: string
          x-obmcs-enumref: '#/definitions/ScheduledActivity/runCycle'
        serviceAvailability:
          description: Service availability / impact during scheduled activity execution, up down
          type: string
          x-obmcs-enumref: '#/definitions/ScheduledActivity/serviceAvailability'
        timeAccepted:
          description: The time the scheduled activity record was created. An RFC3339 formatted datetime string.
          format: date-time
          type: string
        timeExpectedFinish:
          description: Current time the scheduled activity is scheduled to end. An RFC3339 formatted datetime string.
          format: date-time
          type: string
        timeFinished:
          description: The time the scheduled activity actually completed / cancelled / failed. An RFC3339 formatted datetime string.
          format: date-time
          type: string
        timeScheduledStart:
          description: Current time the scheduled activity is scheduled to start. An RFC3339 formatted datetime string.
          format: date-time
          type: string
        timeUpdated:
          description: The time the scheduled activity record was updated. An RFC3339 formatted datetime string.
          format: date-time
          type: string
      required:
      - id
      - displayName
      - runCycle
      - fusionEnvironmentId
      - lifecycleState
      - timeScheduledStart
      - timeExpectedFinish
      - serviceAvailability
      type: object
x-anchors:
  x-headers:
    etag:
      description: 'For optimistic concurrency control. See `if-match`.

        '
      type: string
    opc-next-page:
      description: 'For pagination of a list of items. When paging through a list, if this header appears in the response,

        then a partial list might have been returned. Include this value as the `page` parameter for the

        subsequent GET request to get the next batch of items.

        '
      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.

        '
      type: string
    opc-work-request-id:
      description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.

        '
      type: string
    retry-after:
      description: A decimal number representing the number of seconds the client should wait before polling this endpoint again.
      format: float
      type: number
  x-properties:
    definedTags:
      additionalProperties:
        additionalProperties:
          description: 'The value of the tag. Only string, integer and boolean types are supported.

            '
          type: object
        description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace.

          Example: `{"bar-key": "value"}`

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

        Example: `{"foo-namespace": {"bar-key": "value"}}`

        '
      type: object
    freeformTags:
      additionalProperties:
        type: string
      description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.

        Example: `{"bar-key": "value"}`

        '
      type: object
    systemTags:
      additionalProperties:
        additionalProperties:
          type: object
        type: object
      description: 'The system tags associated with this resource, if any. The system tags are set by Oracle cloud infrastructure services. Each key is predefined and scoped to namespaces.

        For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).

        Example: `{orcl-cloud: {free-tier-retain: true}}`

        '
      type: object
x-obmcs-client-retries-enabled: true
x-oracle-package: com.oracle.facontrolplane