Oracle Data Masking Activity API

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 Data Masking 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: dataMaskingActivity
paths:
  /fusionEnvironments/{fusionEnvironmentId}/dataMaskingActivities:
    get:
      description: 'Returns a list of DataMaskingActivities.

        '
      operationId: ListDataMaskingActivities
      parameters:
      - $ref: '#/components/parameters/FusionEnvironmentIdentifierPathParam'
      - $ref: '#/components/parameters/DataMaskingActivityLifecycleStateQueryParam'
      - $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 DataMaskingActivitySummary 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/DataMaskingActivityCollection'
        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 DataMaskingActivities for a fusion environment
      tags:
      - dataMaskingActivity
      x-related-resource: '#/definitions/DataMaskingActivity'
    post:
      description: 'Creates a new DataMaskingActivity.

        '
      operationId: CreateDataMaskingActivity
      parameters:
      - $ref: '#/components/parameters/FusionEnvironmentIdentifierPathParam'
      - $ref: '#/components/parameters/RetryTokenHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        202:
          description: Accepted the request. The DataMaskingActivity 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 Data Masking Activity
      tags:
      - dataMaskingActivity
      x-related-resource: '#/definitions/DataMaskingActivity'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateDataMaskingActivityDetails'
        description: Details for the new DataMaskingActivity.
        required: true
  /fusionEnvironments/{fusionEnvironmentId}/dataMaskingActivities/{dataMaskingActivityId}:
    get:
      description: Gets a DataMaskingActivity by identifier
      operationId: GetDataMaskingActivity
      parameters:
      - $ref: '#/components/parameters/FusionEnvironmentIdentifierPathParam'
      - $ref: '#/components/parameters/DataMaskingActivityIdentifierPathParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: Retrieves the DataMaskingActivity 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/DataMaskingActivity'
        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 DataMaskingActivity
      tags:
      - dataMaskingActivity
components:
  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
    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
    DataMaskingActivityIdentifierPathParam:
      description: Unique DataMasking run identifier.
      in: path
      name: dataMaskingActivityId
      required: true
      schema:
        type: string
    DataMaskingActivityLifecycleStateQueryParam:
      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/DataMaskingActivity/lifecycleState'
      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
        minLength: 1
    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
  schemas:
    CreateDataMaskingActivityDetails:
      description: The information about current data masking request.
      properties:
        isResumeDataMasking:
          default: false
          description: This allows the Data Safe service to resume the previously failed data masking activity.
          type: boolean
      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
    DataMaskingActivity:
      description: Details of data masking activity.
      properties:
        fusionEnvironmentId:
          description: Fusion Environment Identifier.
          type: string
        id:
          description: Unique identifier that is immutable on creation.
          type: string
        lifecycleState:
          description: The current state of the DataMaskingActivity.
          enum:
          - ACCEPTED
          - IN_PROGRESS
          - FAILED
          - SUCCEEDED
          - CANCELED
          type: string
        timeMaskingFinish:
          description: The time the data masking activity ended. An RFC3339 formatted datetime string.
          format: date-time
          type: string
        timeMaskingStart:
          description: The time the data masking activity started. An RFC3339 formatted datetime string.
          format: date-time
          type: string
      required:
      - id
      - fusionEnvironmentId
      - lifecycleState
      - timeMaskingStart
      - timeMaskingFinish
      type: object
    DataMaskingActivityCollection:
      description: Results of data masking activities on a given Fusion Environment.
      properties:
        items:
          description: A page of data masking activity objects.
          items:
            $ref: '#/components/schemas/DataMaskingActivitySummary'
          type: array
      required:
      - items
      type: object
    DataMaskingActivitySummary:
      description: Summary of the data masking activity.
      properties:
        id:
          description: Unique identifier that is immutable on creation.
          type: string
        lifecycleState:
          description: The current state of the data masking activity Scheduled, In progress , Failed, Completed
          type: string
          x-obmcs-enumref: '#/definitions/DataMaskingActivity/lifecycleState'
        timeMaskingFinish:
          description: The time the data masking activity actually completed / cancelled / failed. An RFC3339 formatted datetime string.
          format: date-time
          type: string
        timeMaskingStart:
          description: The time the data masking activity started. An RFC3339 formatted datetime string.
          format: date-time
          type: string
      required:
      - id
      - lifecycleState
      - timeMaskingStart
      - timeMaskingFinish
      type: object
  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