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 Refresh 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: refreshActivity paths: /fusionEnvironments/{fusionEnvironmentId}/refreshActivities: get: description: 'Returns a list of RefreshActivities. ' operationId: ListRefreshActivities parameters: - $ref: '#/components/parameters/FusionEnvironmentIdentifierPathParam' - $ref: '#/components/parameters/DisplayNameQueryParam' - $ref: '#/components/parameters/ScheduledStartTimeQueryParam' - $ref: '#/components/parameters/ExpectedFinishTimeQueryParam' - $ref: '#/components/parameters/RefreshActivityLifecycleStateQueryParam' - $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 RefreshActivitySummary 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/RefreshActivityCollection' 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 RefreshActivities for a fusion environment tags: - refreshActivity x-related-resource: '#/definitions/RefreshActivity' post: description: 'Creates a new RefreshActivity. ' operationId: CreateRefreshActivity parameters: - $ref: '#/components/parameters/FusionEnvironmentIdentifierPathParam' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Accepted the request. The RefreshActivity will be created. 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 opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string 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 Refresh Activity tags: - refreshActivity x-related-resource: '#/definitions/RefreshActivity' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateRefreshActivityDetails' description: Details for the new RefreshActivity. required: true /fusionEnvironments/{fusionEnvironmentId}/refreshActivities/{refreshActivityId}: delete: description: Deletes a scheduled RefreshActivity resource by identifier operationId: DeleteRefreshActivity parameters: - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/FusionEnvironmentIdentifierPathParam' - $ref: '#/components/parameters/RefreshActivityIdentifierPathParam' responses: 202: description: Accepted the request. The scheduled RefreshActivity will be 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 opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' 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: Delete a scheduled RefreshActivity tags: - refreshActivity x-related-resource: '#/definitions/RefreshActivity' get: description: Gets a RefreshActivity by identifier operationId: GetRefreshActivity parameters: - $ref: '#/components/parameters/FusionEnvironmentIdentifierPathParam' - $ref: '#/components/parameters/RefreshActivityIdentifierPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Retrieves the RefreshActivity 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/RefreshActivity' 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 RefreshActivity tags: - refreshActivity put: description: 'Updates a scheduled RefreshActivity. ' operationId: UpdateRefreshActivity parameters: - $ref: '#/components/parameters/FusionEnvironmentIdentifierPathParam' - $ref: '#/components/parameters/RefreshActivityIdentifierPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/IfMatchHeader' responses: 200: description: Scheduled RefreshActivity 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/RefreshActivity' 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: Updates a scheduled Refresh Activity tags: - refreshActivity x-related-resource: '#/definitions/RefreshActivity' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateRefreshActivityDetails' description: Details for the updating scheduled RefreshActivity. required: true /fusionEnvironments/{fusionEnvironmentId}/timeAvailableForRefresh: get: description: Gets available refresh time for this fusion environment operationId: ListTimeAvailableForRefreshes parameters: - $ref: '#/components/parameters/FusionEnvironmentIdentifierPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/RefreshActivityIdentifierToRescheduleQueryParam' responses: 200: description: Retrieves the available refresh times with the given fusion environment id 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/TimeAvailableForRefreshCollection' 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 Available refresh times tags: - refreshActivity x-related-resource: '#/definitions/FusionEnvironment' components: schemas: TimeAvailableForRefreshSummary: description: one available refresh time. properties: timeAvailableForRefresh: description: refresh time. format: date-time pattern: /([0-9]{4})-(?:[0-9]{2})-([0-9]{2})/ type: string required: - timeAvailableForRefresh type: object RefreshActivitySummary: description: Summary of the refresh activity. properties: displayName: description: A friendly name for the refresh activity. Can be changed later. type: string id: description: The unique identifier (OCID) of the refresh activity. Can't be changed after creation. type: string isDataMaskingOpted: default: false description: Represents if the customer opted for Data Masking or not during refreshActivity. type: boolean 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 x-obmcs-enumref: '#/definitions/RefreshActivity/lifecycleDetails' lifecycleState: description: The current state of the refresh activity. Valid values are Scheduled, In progress , Failed, Completed. type: string x-obmcs-enumref: '#/definitions/RefreshActivity/lifecycleState' refreshIssueDetailsList: description: Details of refresh investigation information, each item represents a different issue. items: $ref: '#/components/schemas/RefreshIssueDetails' type: array serviceAvailability: description: Service availability / impact during refresh activity execution, up down type: string x-obmcs-enumref: '#/definitions/RefreshActivity/serviceAvailability' sourceFusionEnvironmentId: description: The OCID of the Fusion environment that is the source environment for the refresh. type: string timeAccepted: description: The time the refresh activity record was created. An RFC3339 formatted datetime string. format: date-time type: string timeExpectedFinish: description: The time the refresh activity is scheduled to end. An RFC3339 formatted datetime string. format: date-time type: string timeFinished: description: The time the refresh activity actually completed / cancelled / failed. An RFC3339 formatted datetime string. format: date-time type: string timeOfRestorationPoint: description: The date and time of the most recent source environment backup used for the environment refresh. format: date-time type: string timeScheduledStart: description: The time the refresh activity is scheduled to start. An RFC3339 formatted datetime string. format: date-time type: string timeUpdated: description: The time the refresh activity record was updated. An RFC3339 formatted datetime string. format: date-time type: string required: - id - displayName - sourceFusionEnvironmentId - lifecycleState - timeScheduledStart - timeExpectedFinish - serviceAvailability type: object 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 RefreshActivity: description: An environment refresh copies data from a source environment to a target environment, making a copy of the source environment onto the target environment. For more information, see [Refreshing an Environment](/iaas/Content/fusion-applications/refresh-environment.htm). properties: displayName: description: A friendly name for the refresh activity. Can be changed later. type: string id: description: The unique identifier (OCID) of the refresh activity. Can't be changed after creation. type: string isDataMaskingOpted: default: false description: Represents if the customer opted for Data Masking or not during refreshActivity. type: boolean 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 refreshActivity. enum: - ACCEPTED - IN_PROGRESS - NEEDS_ATTENTION - FAILED - SUCCEEDED - CANCELED type: string refreshIssueDetailsList: description: Details of refresh investigation information, each item represents a different issue. items: $ref: '#/components/schemas/RefreshIssueDetails' type: array serviceAvailability: description: Service availability / impact during refresh activity execution up down enum: - AVAILABLE - UNAVAILABLE type: string sourceFusionEnvironmentId: description: The OCID of the Fusion environment that is the source environment for the refresh. type: string timeAccepted: description: The time the refresh activity record was created. An RFC3339 formatted datetime string. format: date-time type: string timeExpectedFinish: description: The time the refresh activity is scheduled to end. An RFC3339 formatted datetime string. format: date-time type: string timeFinished: description: The time the refresh activity actually completed / cancelled / failed. An RFC3339 formatted datetime string. format: date-time type: string timeOfRestorationPoint: description: The date and time of the most recent source environment backup used for the environment refresh. format: date-time type: string timeScheduledStart: description: The time the refresh activity is scheduled to start. An RFC3339 formatted datetime string. format: date-time type: string timeUpdated: description: The time the refresh activity record was updated. An RFC3339 formatted datetime string. format: date-time type: string required: - id - displayName - sourceFusionEnvironmentId - lifecycleState - timeScheduledStart - timeExpectedFinish - serviceAvailability type: object CreateRefreshActivityDetails: description: The information about current refresh. properties: isDataMaskingOpted: default: false description: Represents if the customer opted for Data Masking or not during refreshActivity. type: boolean sourceFusionEnvironmentId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the source environment ' maxLength: 1024 minLength: 1 type: string timeScheduledStart: description: Current time the refresh activity is scheduled to start. An RFC3339 formatted datetime string. format: date-time type: string required: - sourceFusionEnvironmentId type: object RefreshActivityCollection: description: Results of a refresh activity search. properties: items: description: A page of refresh activity objects. items: $ref: '#/components/schemas/RefreshActivitySummary' type: array required: - items type: object UpdateRefreshActivityDetails: description: The information about scheduled refresh. properties: timeScheduledStart: description: Time the refresh activity is scheduled to start. An RFC3339 formatted datetime string. format: date-time type: string type: object RefreshIssueDetails: description: Details of refresh failure or validation failure that needs to be investigated. properties: refreshIssues: description: Detail reasons of refresh failure or validation failure that needs to be shown to customer. type: string type: object TimeAvailableForRefreshCollection: description: The available refresh times for a fusion environment properties: items: description: A list of available refresh time objects. items: $ref: '#/components/schemas/TimeAvailableForRefreshSummary' type: array required: - items type: object parameters: 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 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 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 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 RefreshActivityIdentifierToRescheduleQueryParam: description: A filter that returns all available refresh times including the refresh window of the refresh ID provided in: query name: refreshActivityIdToReschedule required: false x-default-description: Returns all available refresh times 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 RefreshActivityIdentifierPathParam: description: The unique identifier (OCID) of the Refresh activity. in: path name: refreshActivityId required: true schema: type: string FusionEnvironmentIdentifierPathParam: description: unique FusionEnvironment identifier in: path name: fusionEnvironmentId 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 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 minLength: 1 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 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 RequestIdHeader: description: The client request ID for tracing. in: header name: opc-request-id schema: type: string RefreshActivityLifecycleStateQueryParam: 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/RefreshActivity/lifecycleState' schema: type: string 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' 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