openapi: 3.2.0
info:
  description: 'Use the Data Catalog APIs to collect, organize, find, access, understand, enrich, and activate technical, business, and operational metadata.

    For more information, see [Data Catalog](https://docs.oracle.com/iaas/data-catalog/home.htm).

    '
  title: Data Catalog API
  version: '20190325'
  x-provenance:
    method: harvested
    first_party: true
    publisher: Oracle
    source: https://docs.oracle.com/en-us/iaas/api/specs/e68b9d092d83c0a95c4348810fdde44cd5f555052f5567599fa994204407882a.yaml
    harvested: '2026-08-04'
    note: Published by Oracle as the contract for the Data Catalog 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/e68b9d092d83c0a95c4348810fdde44cd5f555052f5567599fa994204407882a.yaml
    what: the harvested document for Data Catalog API
servers:
- url: /20190325
tags:
- name: dataCatalog
paths:
  /catalogPrivateEndpoints:
    get:
      description: 'Returns a list of all the catalog private endpoints in the specified compartment.

        '
      operationId: ListCatalogPrivateEndpoints
      parameters:
      - $ref: '#/components/parameters/CompartmentIdQueryParam'
      - $ref: '#/components/parameters/DisplayNameQueryParam'
      - $ref: '#/components/parameters/PaginationLimitQueryParam'
      - $ref: '#/components/parameters/PaginationTokenQueryParam'
      - $ref: '#/components/parameters/LifecycleStateQueryParam'
      - $ref: '#/components/parameters/SortOrderQueryParam'
      - $ref: '#/components/parameters/SortByQueryParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: A list of private reverse connection endpoint summary objects.
          headers:
            opc-next-page:
              description: 'Retrieves the next page of results. When this header appears in the response, additional pages of results remain. 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:
                items:
                  $ref: '#/components/schemas/CatalogPrivateEndpointSummary'
                type: array
        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/DefaultError'
      summary: Lists all the catalog private endpoints in the specified compartment
      tags:
      - dataCatalog
      x-obmcs-client-retries-enabled: true
    post:
      description: Create a new private reverse connection endpoint.
      operationId: CreateCatalogPrivateEndpoint
      parameters:
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/RetryTokenHeader'
      responses:
        202:
          description: Accepted the request. The private reverse connection endpoint 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: 'The OCID of the asynchronous request. Use [GetWorkRequest](/api/#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this OCID to track the status of the asynchronous request.

                '
              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/DefaultError'
      summary: Create a new private reverse connection endpoint.
      tags:
      - dataCatalog
      x-related-resource: '#/definitions/CatalogPrivateEndpoint'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateCatalogPrivateEndpointDetails'
        description: The information used to create the private reverse connection.
        required: true
  /catalogPrivateEndpoints/{catalogPrivateEndpointId}:
    delete:
      description: Deletes a private reverse connection endpoint by identifier.
      operationId: DeleteCatalogPrivateEndpoint
      parameters:
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/CatalogPrivateEndpointIdentifierPathParam'
      responses:
        202:
          description: Accepted the request. The private reverse connection 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: 'The OCID of the asynchronous request. Use [GetWorkRequest](/api/#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this OCID to track the status of the asynchronous request.

                '
              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/DefaultError'
      summary: Delete a private reverse connection endpoint.
      tags:
      - dataCatalog
      x-related-resource: '#/definitions/CatalogPrivateEndpoint'
    get:
      description: Gets a specific private reverse connection by identifier.
      operationId: GetCatalogPrivateEndpoint
      parameters:
      - $ref: '#/components/parameters/CatalogPrivateEndpointIdentifierPathParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: Retrieves the private reverse connection with given id.
          headers:
            etag:
              description: 'For optimistic concurrency control. See [ETags for Optimistic Concurrency Control](/iaas/Content/API/Concepts/usingapi.htm#eleven).

                '
              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/CatalogPrivateEndpoint'
        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/DefaultError'
      summary: Get private reverse connection endpoint.
      tags:
      - dataCatalog
      x-obmcs-client-retries-enabled: true
    put:
      description: Updates the private reverse connection endpoint.
      operationId: UpdateCatalogPrivateEndpoint
      parameters:
      - $ref: '#/components/parameters/CatalogPrivateEndpointIdentifierPathParam'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        202:
          description: Accepted the request. The private reverse connection will be updated.
          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: 'The OCID of the asynchronous request. Use [GetWorkRequest](/api/#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this OCID to track the status of the asynchronous request.

                '
              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/DefaultError'
      summary: Update the private reverse connection endpoint identified by the id.
      tags:
      - dataCatalog
      x-related-resource: '#/definitions/CatalogPrivateEndpoint'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateCatalogPrivateEndpointDetails'
        description: The information to be updated in private reverse connection
        required: true
  /catalogPrivateEndpoints/{catalogPrivateEndpointId}/actions/changeCompartment:
    post:
      description: Moves a resource into a different compartment. When provided, 'If-Match' is checked against 'ETag' values of the resource.
      operationId: ChangeCatalogPrivateEndpointCompartment
      parameters:
      - $ref: '#/components/parameters/CatalogPrivateEndpointIdentifierPathParam'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        202:
          description: Request has been accepted for changing compartment of private endpoint resource
          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: 'The OCID of the asynchronous request. Use [GetWorkRequest](/api/#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this OCID to track the status of the asynchronous request.

                '
              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/DefaultError'
      summary: Moves a resource into a different compartment. When provided, 'If-Match' is checked against 'ETag' values of the resource.
      tags:
      - dataCatalog
      x-related-resource: '#/definitions/CatalogPrivateEndpoint'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ChangeCatalogPrivateEndpointCompartmentDetails'
        description: Details for the target compartment.
        required: true
  /catalogs:
    get:
      description: 'Returns a list of all the data catalogs in the specified compartment.

        '
      operationId: ListCatalogs
      parameters:
      - $ref: '#/components/parameters/CompartmentIdQueryParam'
      - $ref: '#/components/parameters/DisplayNameQueryParam'
      - $ref: '#/components/parameters/PaginationLimitQueryParam'
      - $ref: '#/components/parameters/PaginationTokenQueryParam'
      - $ref: '#/components/parameters/LifecycleStateQueryParam'
      - $ref: '#/components/parameters/SortOrderQueryParam'
      - $ref: '#/components/parameters/SortByQueryParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: A list of catalog summary objects.
          headers:
            opc-next-page:
              description: 'Retrieves the next page of results. When this header appears in the response, additional pages of results remain. 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:
                items:
                  $ref: '#/components/schemas/CatalogSummary'
                type: array
        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/DefaultError'
      summary: Lists all the data catalogs in the specified compartment.
      tags:
      - dataCatalog
      x-obmcs-client-retries-enabled: true
    post:
      description: 'Creates a new data catalog instance that includes a console and an API URL for managing metadata operations.

        For more information, please see the documentation.

        '
      operationId: CreateCatalog
      parameters:
      - $ref: '#/components/parameters/RetryTokenHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        202:
          description: Accepted the request. The data catalog 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: 'The OCID of the asynchronous request. Use [GetWorkRequest](/api/#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this OCID to track the status of the asynchronous request.

                '
              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/DefaultError'
      summary: Creates a new data catalog.
      tags:
      - dataCatalog
      x-related-resource: '#/definitions/Catalog'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateCatalogDetails'
        description: Details for the new data catalog.
        required: true
  /catalogs/{catalogId}:
    delete:
      description: Deletes a data catalog resource by identifier.
      operationId: DeleteCatalog
      parameters:
      - $ref: '#/components/parameters/CatalogIdentifierPathParam'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        202:
          description: Accepted the request. The data catalog 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: 'The OCID of the asynchronous request. Use [GetWorkRequest](/api/#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this OCID to track the status of the asynchronous request.

                '
              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/DefaultError'
      summary: Delete a provisioned data catalog.
      tags:
      - dataCatalog
      x-related-resource: '#/definitions/Catalog'
    get:
      description: Gets a data catalog by identifier.
      operationId: GetCatalog
      parameters:
      - $ref: '#/components/parameters/CatalogIdentifierPathParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: Retrieves the data catalog with the given id.
          headers:
            etag:
              description: 'For optimistic concurrency control. See [ETags for Optimistic Concurrency Control](/iaas/Content/API/Concepts/usingapi.htm#eleven).

                '
              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/Catalog'
        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/DefaultError'
      summary: Get data catalog.
      tags:
      - dataCatalog
      x-obmcs-client-retries-enabled: true
    put:
      description: Updates the data catalog.
      operationId: UpdateCatalog
      parameters:
      - $ref: '#/components/parameters/CatalogIdentifierPathParam'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: The data catalog will be updated and returned by this request.
          headers:
            etag:
              description: 'For optimistic concurrency control. See [ETags for Optimistic Concurrency Control](/iaas/Content/API/Concepts/usingapi.htm#eleven).

                '
              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/Catalog'
        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/DefaultError'
      summary: Update the data catalog identified by the id.
      tags:
      - dataCatalog
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateCatalogDetails'
        description: The data catalog information to be updated.
        required: true
  /catalogs/{catalogId}/actions/attachCatalogPrivateEndpoint:
    post:
      description: Attaches a private reverse connection endpoint resource to a data catalog resource. When provided, 'If-Match' is checked against 'ETag' values of the resource.
      operationId: AttachCatalogPrivateEndpoint
      parameters:
      - $ref: '#/components/parameters/CatalogIdentifierPathParam'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/RetryTokenHeader'
      responses:
        202:
          description: Request has been accepted for processing attach private endpoint
          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: 'The OCID of the asynchronous request. Use [GetWorkRequest](/api/#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this OCID to track the status of the asynchronous request.

                '
              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/DefaultError'
      summary: Attaches a private reverse connection endpoint resource to a data catalog resource.
      tags:
      - dataCatalog
      x-related-resource: '#/definitions/Catalog'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AttachCatalogPrivateEndpointDetails'
        description: Details for private reverse connection endpoint to be used for attachment.
        required: true
  /catalogs/{catalogId}/actions/changeCompartment:
    post:
      description: Moves a resource into a different compartment. When provided, 'If-Match' is checked against 'ETag' values of the resource.
      operationId: ChangeCatalogCompartment
      parameters:
      - $ref: '#/components/parameters/CatalogIdentifierPathParam'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        202:
          description: Request has been accepted for processing change compartment for catalog resource
          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: 'The OCID of the asynchronous request. Use [GetWorkRequest](/api/#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this OCID to track the status of the asynchronous request.

                '
              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/DefaultError'
      summary: Moves a resource into a different compartment. When provided, 'If-Match' is checked against 'ETag' values of the resource.
      tags:
      - dataCatalog
      x-related-resource: '#/definitions/Catalog'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ChangeCatalogCompartmentDetails'
        description: Details for the target compartment.
        required: true
  /catalogs/{catalogId}/actions/detachCatalogPrivateEndpoint:
    post:
      description: Detaches a private reverse connection endpoint resource to a data catalog resource. When provided, 'If-Match' is checked against 'ETag' values of the resource.
      operationId: DetachCatalogPrivateEndpoint
      parameters:
      - $ref: '#/components/parameters/CatalogIdentifierPathParam'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        202:
          description: Request has been accepted for processing detach private endpoint
          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: 'The OCID of the asynchronous request. Use [GetWorkRequest](/api/#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this OCID to track the status of the asynchronous request.

                '
              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/DefaultError'
      summary: Detaches a private reverse connection endpoint resource to a data catalog resource.
      tags:
      - dataCatalog
      x-related-resource: '#/definitions/Catalog'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DetachCatalogPrivateEndpointDetails'
        description: Details for private reverse connection endpoint to be used for attachment
        required: true
  /catalogs/{catalogId}/actions/getRecommendations:
    post:
      description: 'Returns a list of recommendations for the given object and recommendation type.

        By default, it will return inferred recommendations for review. The optional query param ''RecommendationStatus'' can be set,

        to return only recommendations having that status.

        '
      operationId: Recommendations
      parameters:
      - $ref: '#/components/parameters/CatalogIdentifierPathParam'
      - $ref: '#/components/parameters/RecommendationTypeQueryParam'
      - $ref: '#/components/parameters/SourceObjectKeyQueryParam'
      - $ref: '#/components/parameters/SourceObjectTypeQueryParam'
      - $ref: '#/components/parameters/RecommendationStatusQueryParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: A list of recommendations.
          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/RecommendationCollection'
        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/DefaultError'
      summary: Returns a list of recommendations for the given object and recommendation type.
      tags:
      - dataCatalog
      x-obmcs-client-retries-enabled: false
      x-related-resource: '#/definitions/Catalog'
  /catalogs/{catalogId}/actions/objectStats:
    post:
      description: Returns stats on objects by type in the repository.
      operationId: ObjectStats
      parameters:
      - $ref: '#/components/parameters/CatalogIdentifierPathParam'
      - $ref: '#/components/parameters/SortByQueryParam'
      - $ref: '#/components/parameters/SortOrderQueryParam'
      - $ref: '#/components/parameters/PaginationLimitQueryParam'
      - $ref: '#/components/parameters/PaginationTokenQueryParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: Stats on objects by type in the repository.
          headers:
            opc-next-page:
              description: 'Retrieves the next page of results. When this header appears in the response, additional pages of results remain. 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:
                type: string
        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/DefaultError'
      summary: Returns stats on objects in the repository.
      tags:
      - dataCatalog
      x-obmcs-client-retries-enabled: true
      x-related-resource: '#/definitions/Catalog'
  /catalogs/{catalogId}/actions/processRecommendation:
    post:
      description: 'Act on a recommendation. A recommendation can be accepted or rejected. For example, if a recommendation of type LINK_GLOSSARY_TERM

        is accepted, the system will link the source object (e.g. an attribute) to a target glossary term.

        '
      operationId: ProcessRecommendation
      parameters:
      - $ref: '#/components/parameters/CatalogIdentifierPathParam'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: The recommendation was successfully processed.
          headers:
            etag:
              description: 'For optimistic concurrency control. See [ETags for Optimistic Concurrency Control](/iaas/Content/API/Concepts/usingapi.htm#eleven).

                '
              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/ProcessRecommendationDetails'
        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/DefaultError'
      summary: Act on a recommendation.
      tags:
      - dataCatalog
      x-related-resource: '#/definitions/Catalog'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ProcessRecommendationDetails'
        description: Recommendation to be processed.
        required: true
  /catalogs/{catalogId}/actions/suggest:
    post:
      description: Returns a list of potential string matches for a given input string.
      operationId: SuggestMatches
      parameters:
      - $ref: '#/components/parameters/CatalogIdentifierPathParam'
      - $ref: '#/components/parameters/TimeoutQueryParam'
      - $ref: '#/components/parameters/InputTextQueryParam'
      - $ref: '#/components/parameters/SuggestionLimitQueryParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: Suggest results.
          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/SuggestResults'
        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/DefaultError'
      summary: Returns a list of potential string matches for a given input string.
      tags:
      - dataCatalog
      x-obmcs-client-retries-enabled: true
      x-related-resource: '#/definitions/SuggestResults'
  /catalogs/{catalogId}/actions/users:
    post:
      description: Returns active users in the system.
      operationId: Users
      parameters:
      - $ref: '#/components/parameters/CatalogIdentifierPathParam'
      - $ref: '#/components/parameters/SortByQueryParam'
      - $ref: '#/components/parameters/SortOrderQueryParam'
      - $ref: '#/components/parameters/PaginationLimitQueryParam'
      - $ref: '#/components/parameters/PaginationTokenQueryParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: Active users in the system.
          headers:
            opc-next-page:
              description: 'Retrieves the next page of results. When this header appears in the response, additional pages of results remain. 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:
                type: string
        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/DefaultError'
      summary: Returns active users in the system.
      tags:
      - dataCatalog
      x-obmcs-client-retries-enabled: true
      x-related-resource: '#/definitions/Catalog'
  /catalogs/{catalogId}/dataAssets:
    get:
      description: Returns a list of data assets within a data catalog.
      operationId: ListDataAssets
      parameters:
      - $ref: '#/components/parameters/CatalogIdentifierPathParam'
      - $ref: '#/components/parameters/DisplayNameQueryParam'
      - $ref: '#/components/parameters/DisplayNameContainsQueryParam'
      - $ref: '#/components/parameters/LifecycleStateQueryParam'
      - $ref: '#/components/parameters/TimeCreatedQueryParam'
      - $ref: '#/components/parameters/TimeUpdatedQueryParam'
      - $ref: '#/components/parameters/CreatedByIdentifierQueryParam'
      - $ref: '#/components/parameters/UpdatedByIdentifierQueryParam'
      - $ref: '#/components/parameters/ExternalKeyQueryParam'
      - $ref: '#/components/parameters/TypeKeyQueryParam'
      - $ref: '#/components/parameters/DataAssetSummaryFieldsQueryParam'
      - $ref: '#/components/parameters/SortByQueryParam'
      - $ref: '#/components/parameters/SortOrderQueryParam'
      - $ref: '#/components/parameters/PaginationLimitQueryParam'
      - $ref: '#/components/parameters/PaginationTokenQueryParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: A list of data asset objects.
          headers:
            opc-next-page:
              description: 'Retrieves the next page of results. When this header appears in the response, additional pages of results remain. 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/DataAssetCollection'
        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/DefaultError'
      summary: Returns a list of data assets within a data catalog.
      tags:
      - dataCatalog
      x-obmcs-client-retries-enabled: true
    post:
      description: Create a new data asset.
      operationId: CreateDataAsset
      parameters:
      - $ref: '#/components/parameters/CatalogIdentifierPathParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/RetryTokenHeader'
      responses:
        200:
          description: The data asset was successfully created.
          headers:
            etag:
              description: 'For optimistic concurrency control. See [ETags for Optimistic Concurrency Control](/iaas/Content/API/Concepts/usingapi.htm#eleven).

                '
              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/DataAsset'
        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/DefaultError'
      summary: Create a new data asset.
      tags:
      - dataCatalog
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateDataAssetDetails'
        description: The information used to create the data asset.
        required: true
  /catalogs/{catalogId}/dataAssets/{dataAssetKey}:
    delete:
      description: Deletes a specific data asset identified by it's key.
      operationId: DeleteDataAsset
      parameters:
      - $ref: '#/components/parameters/CatalogIdentifierPathParam'
      - $ref: '#/components/parameters/DataAssetKeyPathParam'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        204:
          description: The data asset was successfully 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'
        409:
          $ref: '#/components/responses/409'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/DefaultError'
      summary: Delete a specific data asset identified by it's key.
      tags:
      - dataCatalog
      x-related-resource: '#/definitions/DataAsset'
    get:
      description: Gets a specific data asset for the given key within a data catalog.
      operationId: GetDataAsset
      parameters:
      - $ref: '#/components/parameters/CatalogIdentifierPathParam'
      - $ref: '#/components/parameters/DataAssetKeyPathParam'
      - $ref: '#/components/parameters/DataAssetFieldsQueryParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: Retrieves the data asset with the given key.
          headers:
            etag:
              description: 'For optimistic concurrency control. See [ETags for Optimistic Concurrency Control](/iaas/Content/API/Concepts/usingapi.htm#eleven).

                '
              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/DataAsset'
        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/DefaultError'
      summary: Get a specific data asset for the given key within a data catalog.
      tags:
      - dataCatalog
      x-obmcs-client-retries-enabled: true
    put:
      description: Updates a specific data asset identified by the given key.
      operationId: UpdateDataAsset
      parameters:
      - $ref: '#/components/parameters/CatalogIdentifierPathParam'
      - $ref: '#/components/parameters/DataAssetKeyPathParam'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: The data asset was successfully updated.
          headers:
            etag:
              description: 'For optimistic concurrency control. See [ETags for Optimistic Concurrency Control](/iaas/Content/API/Concepts/usingapi.htm#eleven).

                '
              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/DataAsset'
        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/DefaultError'
      summary: Update a specific data asset identified by the given key.
      tags:
      - dataCatalog
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateDataAssetDetails'
        description: The information to be updated in the data asset.
        required: true
  /catalogs/{catalogId}/dataAssets/{dataAssetKey}/actions/addDataSelectorPatterns:
    post:
      description: Add data selector pattern to the data asset.
      operationId: AddDataSelectorPatterns
      parameters:
      - $ref: '#/components/parameters/CatalogIdentifierPathParam'
      - $ref: '#/components/parameters/DataAssetKeyPathParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RetryTokenHeader'
      responses:
        200:
          description: The patterns were added to the data asset for deriving logical entities.
          headers:
            etag:
              description: 'For optimistic concurrency control. See [ETags for Optimistic Concurrency Control](/iaas/Content/API/Concepts/usingapi.htm#eleven).

                '
              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/DataAsset'
        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/DefaultError'
      summary: Add data selector pattern to the data asset used to derive logical entities during harvesting.
      tags:
      - dataCatalog
      x-related-resource: '#/definitions/DataAsset'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DataSelectorPatternDetails'
        description: The information used to add the patterns for deriving logical entities.
        required: true
  /catalogs/{catalogId}/dataAssets/{dataAssetKey}/actions/asynchronousExport:
    post:
      description: Export technical objects from a Data Asset in Excel format. Returns details about the job which actually performs the export.
      operationId: AsynchronousExportDataAsset
      parameters:
      - $ref: '#/components/parameters/CatalogIdentifierPathParam'
      - $ref: '#/components/parameters/DataAssetKeyPathParam'
      - $ref: '#/components/parameters/DataAssetExportTypeQueryParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/RetryTokenHeader'
      responses:
        202:
          description: Accepted the request. The Data Asset will be exported.
          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/AsynchronousExportDataAssetResult'
        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/DefaultError'
      summary: Export technical objects from a Data Asset in Excel format.
      tags:
      - dataCatalog
      x-related-resource: '#/definitions/DataAsset'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AsynchronousExportDataAssetDetails'
        description: Details needed by the Data Asset export request.
        required: true
  /catalogs/{catalogId}/dataAssets/{dataAssetKey}/actions/import:
    post:
      description: Import technical objects to a Data Asset
      operationId: ImportDataAsset
      parameters:
      - $ref: '#/components/parameters/CatalogIdentifierPathParam'
      - $ref: '#/components/parameters/DataAssetKeyPathParam'
      - $ref: '#/components/parameters/DataAssetImportTypeQueryParam'
      - $ref: '#/components/parameters/IsMissingValueIgnoredQueryParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/RetryTokenHeader'
      responses:
        200:
          description: Details about the job which is launched to complete the import.
          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/ImportDataAssetJobResult'
        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/DefaultError'
      summary: Import technical objects to a Data Asset from an exported file.
      tags:
      - dataCatalog
      x-related-resource: '#/definitions/DataAsset'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ImportDataAssetDetails'
        description: The file contents to be imported.
        required: true
  /catalogs/{catalogId}/dataAssets/{dataAssetKey}/actions/importConnection:
    post:
      description: Import new connection for this data asset.
      operationId: ImportConnection
      parameters:
      - $ref: '#/components/parameters/CatalogIdentifierPathParam'
      - $ref: '#/components/parameters/DataAssetKeyPathParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RetryTokenHeader'
      responses:
        200:
          description: The connections were successfully imported.
          headers:
            etag:
              description: 'For optimistic concurrency control. See [ETags for Optimistic Concurrency Control](/iaas/Content/API/Concepts/usingapi.htm#eleven).

                '
              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/Connection'
        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/DefaultError'
      summary: Import connections from an Oracle wallet file that contains relevant metadata for creating connections.
      tags:
      - dataCatalog
      x-related-resource: '#/definitions/DataAsset'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ImportConnectionDetails'
        description: The information used to create the connections through import.
        required: true
  /catalogs/{catalogId}/dataAssets/{dataAssetKey}/actions/importLineage:
    post:
      description: Imports lineage metadata. Returns details about the job that performs the import.
      operationId: ImportLineage
      parameters:
      - $ref: '#/components/parameters/CatalogIdentifierPathParam'
      - $ref: '#/components/parameters/DataAssetKeyPathParam'
      - $ref: '#/components/parameters/RetryTokenHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: Accepted the request. Lineage will be imported.
          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/ImportLineageJobResult'
        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/DefaultError'
      summary: Imports lineage metadata.
      tags:
      - dataCatalog
      x-obmcs-client-retries-enabled: true
      x-related-resource: '#/definitions/DataAsset'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ImportLineageDetails'
        description: Details needed by the lineage import request.
        required: true
  /catalogs/{catalogId}/dataAssets/{dataAssetKey}/actions/parseConnection:
    post:
      description: Parse data asset references through connections from this data asset.
      operationId: ParseConnection
      parameters:
      - $ref: '#/components/parameters/CatalogIdentifierPathParam'
      - $ref: '#/components/parameters/DataAssetKeyPathParam'
      - $ref: '#/components/parameters/ConnectionKeyQueryParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/RetryTokenHeader'
      responses:
        200:
          description: The connections were successfully parsed.
          headers:
            etag:
              description: 'For optimistic concurrency control. See [ETags for Optimistic Concurrency Control](/iaas/Content/API/Concepts/usingapi.htm#eleven).

                '
              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:
                items:
                  $ref: '#/components/schemas/ConnectionAliasSummary'
                type: array
        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/DefaultError'
      summary: Parse connection from a request payload that contains data asset references.
      tags:
      - dataCatalog
      x-related-resource: '#/definitions/DataAsset'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ParseConnectionDetails'
        description: The information used to parse the connections from payload or connection detail.
        required: true
  /catalogs/{catalogId}/dataAssets/{dataAssetKey}/actions/removeDataSelectorPatterns:
    post:
      description: Remove data selector pattern from the data asset.
      operationId: RemoveDataSelectorPatterns
      parameters:
      - $ref: '#/components/parameters/CatalogIdentifierPathParam'
      - $ref: '#/components/parameters/DataAssetKeyPathParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RetryTokenHeader'
      responses:
        200:
          description: The patterns were removed from the data asset.Logical Entities derived from this pattern will not be a candidate for harvest.
          headers:
            etag:
              description: 'For optimistic concurrency control. See [ETags for Optimistic Concurrency Control](/iaas/Content/API/Concepts/usingapi.htm#eleven).

                '
              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/DataAsset'
        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/DefaultError'
      summary: Remove data selector pattern from the data asset used in deriving logical entities during harvesting.
      tags:
      - dataCatalog
      x-related-resource: '#/definitions/DataAsset'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DataSelectorPatternDetails'
        description: The information used to remove the data selector patterns.
        required: true
  /catalogs/{catalogId}/dataAssets/{dataAssetKey}/actions/synchronousExport:
    post:
      description: Export technical objects from a Data Asset
      operationId: SynchronousExportDataAsset
      parameters:
      - $ref: '#/components/parameters/CatalogIdentifierPathParam'
      - $ref: '#/components/parameters/DataAssetKeyPathParam'
      - $ref: '#/components/parameters/DataAssetExportTypeQueryParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/RetryTokenHeader'
      responses:
        200:
          description: The exported contents
          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/vnd.openxmlformats-officedocument.spreadsheetml.sheet:
              schema:
                format: binary
                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/DefaultError'
      summary: Export technical objects from a Data Asset in Excel file format.
      tags:
      - dataCatalog
      x-related-resource: '#/definitions/DataAsset'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ExportDataAssetDetails'
        description: The details of what needs to be exported.
        required: true
  /catalogs/{catalogId}/dataAssets/{dataAssetKey}/actions/validateConnection:
    post:
      description: Validate connection by connecting to the data asset using credentials in metadata.
      operationId: ValidateConnection
      parameters:
      - $ref: '#/components/parameters/CatalogIdentifierPathParam'
      - $ref: '#/components/parameters/DataAssetKeyPathParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/RetryTokenHeader'
      responses:
        200:
          description: The connections were validated.
          headers:
            etag:
              description: 'For optimistic concurrency control. See [ETags for Optimistic Concurrency Control](/iaas/Content/API/Concepts/usingapi.htm#eleven).

                '
              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/ValidateConnectionResult'
        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/DefaultError'
      summary: Validate connection from a request payload that contains connection metadata.
      tags:
      - dataCatalog
      x-obmcs-client-retries-enabled: true
      x-related-resource: '#/definitions/DataAsset'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ValidateConnectionDetails'
        description: The information used to validate the connections.
        required: true
  /catalogs/{catalogId}/dataAssets/{dataAssetKey}/connections:
    get:
      description: Returns a list of all Connections for a data asset.
      operationId: ListConnections
      parameters:
      - $ref: '#/components/parameters/CatalogIdentifierPathParam'
      - $ref: '#/components/parameters/DataAssetKeyPathParam'
      - $ref: '#/components/parameters/DisplayNameQueryParam'
      - $ref: '#/components/parameters/DisplayNameContainsQueryParam'
      - $ref: '#/components/parameters/LifecycleStateQueryParam'
      - $ref: '#/components/parameters/TimeCreatedQueryParam'
      - $ref: '#/components/parameters/TimeUpdatedQueryParam'
      - $ref: '#/components/parameters/CreatedByIdentifierQueryParam'
      - $ref: '#/components/parameters/UpdatedByIdentifierQueryParam'
      - $ref: '#/components/parameters/ExternalKeyQueryParam'
      - $ref: '#/components/parameters/TimeStatusUpdatedQueryParam'
      - $ref: '#/components/parameters/IsDefaultQueryParam'
      - $ref: '#/components/parameters/ConnectionSummaryFieldsQueryParam'
      - $ref: '#/components/parameters/SortByQueryParam'
      - $ref: '#/components/parameters/SortOrderQueryParam'
      - $ref: '#/components/parameters/PaginationLimitQueryParam'
      - $ref: '#/components/parameters/PaginationTokenQueryParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: A list of connection objects.
          headers:
            opc-next-page:
              description: 'Retrieves the next page of results. When this header appears in the response, additional pages of results remain. 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/ConnectionCollection'
        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/DefaultError'
      summary: Returns a list of all connections for a data asset.
      tags:
      - dataCatalog
      x-obmcs-client-retries-enabled: true
    post:
      description: Creates a new connection.
      operationId: CreateConnection
      parameters:
      - $ref: '#/components/parameters/CatalogIdentifierPathParam'
      - $ref: '#/components/parameters/DataAssetKeyPathParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/RetryTokenHeader'
      responses:
        200:
          description: The connection was successfully created.
          headers:
            etag:
              description: 'For optimistic concurrency control. See [ETags for Optimistic Concurrency Control](/iaas/Content/API/Concepts/usingapi.htm#eleven).

                '
              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/Connection'
        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/DefaultError'
      summary: Create a new connection.
      tags:
      - dataCatalog
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateConnectionDetails'
        description: The information used to create the connection.
        required: true
  /catalogs/{catalogId}/dataAssets/{dataAssetKey}/connections/{connectionKey}:
    delete:
      description: Deletes a specific connection of a data asset.
      operationId: DeleteConnection
      parameters:
      - $ref: '#/components/parameters/CatalogIdentifierPathParam'
      - $ref: '#/components/parameters/DataAssetKeyPathParam'
      - $ref: '#/components/parameters/ConnectionKeyPathParam'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        204:
          description: The connection was successfully 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'
        409:
          $ref: '#/components/responses/409'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/DefaultError'
      summary: Delete a specific connection of a data asset.
      tags:
      - dataCatalog
      x-related-resource: '#/definitions/Connection'
    get:
      description: Gets a specific data asset connection by key.
      operationId: GetConnection
      parameters:
      - $ref: '#/components/parameters/CatalogIdentifierPathParam'
      - $ref: '#/components/parameters/DataAssetKeyPathParam'
      - $ref: '#/components/parameters/ConnectionKeyPathParam'
      - $ref: '#/components/parameters/ConnectionFieldsQueryParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: Retrieves a specific data asset connection.
          headers:
            etag:
              description: 'For optimistic concurrency control. See [ETags for Optimistic Concurrency Control](/iaas/Content/API/Concepts/usingapi.htm#eleven).

                '
              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/Connection'
        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/DefaultError'
      summary: Get a specific data asset connection by key.
      tags:
      - dataCatalog
      x-obmcs-client-retries-enabled: true
    put:
      description: Updates a specific connection of a data asset.
      operationId: UpdateConnection
      parameters:
      - $ref: '#/components/parameters/CatalogIdentifierPathParam'
      - $ref: '#/components/parameters/DataAssetKeyPathParam'
      - $ref: '#/components/parameters/ConnectionKeyPathParam'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: The connection was successfully updated.
          headers:
            etag:
              description: 'For optimistic concurrency control. See [ETags for Optimistic Concurrency Control](/iaas/Content/API/Concepts/usingapi.htm#eleven).

                '
              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/Connection'
        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/DefaultError'
      summary: Update a specific connection of a data asset.
      tags:
      - dataCatalog
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateConnectionDetails'
        description: The information to be updated in the connection.
        required: true
  /catalogs/{catalogId}/dataAssets/{dataAssetKey}/connections/{connectionKey}/actions/test:
    post:
      description: Test the connection by connecting to the data asset using credentials in the metadata.
      operationId: TestConnection
      parameters:
      - $ref: '#/components/parameters/CatalogIdentifierPathParam'
      - $ref: '#/components/parameters/DataAssetKeyPathParam'
      - $ref: '#/components/parameters/ConnectionKeyPathParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/RetryTokenHeader'
      responses:
        200:
          description: The connection was tested successfully.
          headers:
            etag:
              description: 'For optimistic concurrency control. See [ETags for Optimistic Concurrency Control](/iaas/Content/API/Concepts/usingapi.htm#eleven).

                '
              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/ValidateConnectionResult'
        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/DefaultError'
      summary: Test the connection credentials to the parent data asset.
      tags:
      - dataCatalog
      x-obmcs-client-retries-enabled: true
      x-related-resource: '#/definitions/Connection'
  /catalogs/{catalogId}/dataAssets/{dataAssetKey}/connections/{connectionKey}/actions/uploadCredentials:
    post:
      description: Upload connection credentails and metadata for this connection.
      operationId: UploadCredentials
      parameters:
      - $ref: '#/components/parameters/CatalogIdentifierPathParam'
      - $ref: '#/components/parameters/DataAssetKeyPathParam'
      - $ref: '#/components/parameters/ConnectionKeyPathParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RetryTokenHeader'
      responses:
        200:
          description: The connection was successfully updated.
          headers:
            etag:
              description: 'For optimistic concurrency control. See [ETags for Optimistic Concurrency Control](/iaas/Content/API/Concepts/usingapi.htm#eleven).

                '
              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/Connection'
        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/DefaultError'
      summary: Upload connection credentials file and metadata for this connection for update.
      tags:
      - dataCatalog
      x-related-resource: '#/definitions/Connection'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UploadCredentialsDetails'
        description: The information used to upload the credentials file and metadata for updating this connection.
        required: true
  /catalogs/{catalogId}/dataAssets/{dataAssetKey}/entities:
    get:
      description: Returns a list of all entities of a data asset.
      operationId: ListEntities
      parameters:
      - $ref: '#/components/parameters/CatalogIdentifierPathParam'
      - $ref: '#/components/parameters/DataAssetKeyPathParam'
      - $ref: '#/components/parameters/DisplayNameQueryParam'
      - $ref: '#/components/parameters/BusinessNameQueryParam'
      - $ref: '#/components/parameters/DisplayOrBusinessNameContainsQueryParam'
      - $ref: '#/components/parameters/TypeKeyQueryParam'
      - $ref: '#/components/parameters/DisplayNameContainsQueryParam'
      - $ref: '#/components/parameters/LifecycleStateQueryParam'
      - $ref: '#/components/parameters/TimeCreatedQueryParam'
      - $ref: '#/components/parameters/TimeUpdatedQueryParam'
      - $ref: '#/components/parameters/CreatedByIdentifierQueryParam'
      - $ref: '#/components/parameters/UpdatedByIdentifierQueryParam'
      - $ref: '#/components/parameters/ExternalKeyQueryParam'
      - $ref: '#/components/parameters/PatternKeyQueryParam'
      - $ref: '#/components/parameters/TimeExternalQueryParam'
      - $ref: '#/components/parameters/TimeStatusUpdatedQueryParam'
      - $ref: '#/components/parameters/IsLogicalQueryParam'
      - $ref: '#/components/parameters/IsPartitionQueryParam'
      - $ref: '#/components/parameters/FolderKeyQueryParam'
      - $ref: '#/components/parameters/PathQueryParam'
      - $ref: '#/components/parameters/HarvestStatusQueryParam'
      - $ref: '#/components/parameters/LastJobKeyQueryParam'
      - $ref: '#/components/parameters/EntitySummaryFieldsQueryParam'
      - $ref: '#/components/parameters/SortByDisplayOrBusinessNameQueryParam'
      - $ref: '#/components/parameters/SortOrderQueryParam'
      - $ref: '#/components/parameters/PaginationLimitQueryParam'
      - $ref: '#/components/parameters/PaginationTokenQueryParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/IsProcessQueryParam'
      responses:
        200:
          description: A list of entity objects.
          headers:
            opc-next-page:
              description: 'Retrieves the next page of results. When this header appears in the response, additional pages of results remain. 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/EntityCollection'
        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/DefaultError'
      summary: Returns a list of all entities of a data asset.
      tags:
      - dataCatalog
      x-obmcs-client-retries-enabled: true
      x-related-resource: '#/definitions/Entity'
    post:
      description: Creates a new data entity.
      operationId: CreateEntity
      parameters:
      - $ref: '#/components/parameters/CatalogIdentifierPathParam'
      - $ref: '#/components/parameters/DataAssetKeyPathParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/RetryTokenHeader'
      responses:
        200:
          description: The entity was successfully created.
          headers:
            etag:
              description: 'For optimistic concurrency control. See [ETags for Optimistic Concurrency Control](/iaas/Content/API/Concepts/usingapi.htm#eleven).

                '
              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/Entity'
        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/DefaultError'
      summary: Create a new data entity.
      tags:
      - dataCatalog
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateEntityDetails'
        description: The information used to create the data entity.
        required: true
  /catalogs/{catalogId}/dataAssets/{dataAssetKey}/entities/{entityKey}:
    delete:
      description: Deletes a specific data entity.
      operationId: DeleteEntity
      parameters:
      - $ref: '#/components/parameters/CatalogIdentifierPathParam'
      - $ref: '#/components/parameters/DataAssetKeyPathParam'
      - $ref: '#/components/parameters/EntityKeyPathParam'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        204:
          description: The data entity was successfully 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'
        409:
          $ref: '#/components/responses/409'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/DefaultError'
      summary: Delete a specific data entity.
      tags:
      - dataCatalog
      x-related-resource: '#/definitions/Entity'
    get:
      description: Gets a specific data entity by key for a data asset.
      operationId: GetEntity
      parameters:
      - $ref: '#/components/parameters/CatalogIdentifierPathParam'
      - $ref: '#/components/parameters/DataAssetKeyPathParam'
      - $ref: '#/components/parameters/EntityKeyPathParam'
      - $ref: '#/components/parameters/IsIncludeObjectRelationshipsQueryParam'
      - $ref: '#/components/parameters/EntityFieldsQueryParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: Retrieves the data entity with the given key.
          headers:
            etag:
              description: 'For optimistic concurrency control. See [ETags for Optimistic Concurrency Control](/iaas/Content/API/Concepts/usingapi.htm#eleven).

                '
              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/Entity'
        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/DefaultError'
      summary: Get a specific data entity by key for a data asset.
      tags:
      - dataCatalog
      x-obmcs-client-retries-enabled: true
    put:
      description: Updates a specific data entity.
      operationId: UpdateEntity
      parameters:
      - $ref: '#/components/parameters/CatalogIdentifierPathParam'
      - $ref: '#/components/parameters/DataAssetKeyPathParam'
      - $ref: '#/components/parameters/EntityKeyPathParam'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: The data entity was successfully updated.
          headers:
            etag:
              description: 'For optimistic concurrency control. See [ETags for Optimistic Concurrency Control](/iaas/Content/API/Concepts/usingapi.htm#eleven).

                '
              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/Entity'
        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/DefaultError'
      summary: Update a specific data entity.
      tags:
      - dataCatalog
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateEntityDetails'
        description: The information to be updated in the data entity.
        required: true
  /catalogs/{catalogId}/dataAssets/{dataAssetKey}/entities/{entityKey}/actions/fetchLineage:
    post:
      description: Returns lineage for a given entity object.
      operationId: FetchEntityLineage
      parameters:
      - $ref: '#/components/parameters/CatalogIdentifierPathParam'
      - $ref: '#/components/parameters/DataAssetKeyPathParam'
      - $ref: '#/components/parameters/EntityKeyPathParam'
      - $ref: '#/components/parameters/PaginationLimitQueryParam'
      - $ref: '#/components/parameters/PaginationTokenQueryParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/IfMatchHeader'
      responses:
        200:
          description: Retrieves the Lineage for the entity.
          headers:
            opc-next-page:
              description: 'Retrieves the next page of results. When this header appears in the response, additional pages of results remain. 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/EntityLineage'
        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/DefaultError'
      summary: Returns lineage for a given entity object.
      tags:
      - dataCatalog
      x-obmcs-client-retries-enabled: true
      x-related-resource: '#/definitions/Entity'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FetchEntityLineageDetails'
        description: The information needed to obtain desired lineage.
        required: true
  /catalogs/{catalogId}/dataAssets/{dataAssetKey}/entities/{entityKey}/actions/listAggregatedPhysicalEntities:
    post:
      description: List the physical entities aggregated by this logical entity.
      operationId: ListAggregatedPhysicalEntities
      parameters:
      - $ref: '#/components/parameters/CatalogIdentifierPathParam'
      - $ref: '#/components/parameters/DataAssetKeyPathParam'
      - $ref: '#/components/parameters/EntityKeyPathParam'
      - $ref: '#/components/parameters/EntityFieldsQueryParam'
      - $ref: '#/components/parameters/DisplayNameContainsQueryParam'
      - $ref: '#/components/parameters/SortByQueryParam'
      - $ref: '#/components/parameters/SortOrderQueryParam'
      - $ref: '#/components/parameters/PaginationLimitQueryParam'
      - $ref: '#/components/parameters/PaginationTokenQueryParam'
      - $ref: '#/components/parameters/IsIncludePropertiesQueryParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: Retrieves the list of physical entities aggregated by this logical entity with the given key.
          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/EntityCollection'
        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/DefaultError'
      summary: List the physical entities aggregated by this logical entity.
      tags:
      - dataCatalog
      x-obmcs-client-retries-enabled: true
      x-related-resource: '#/definitions/Entity'
  /catalogs/{catalogId}/dataAssets/{dataAssetKey}/entities/{entityKey}/attributes:
    get:
      description: Returns a list of all attributes of an data entity.
      operationId: ListAttributes
      parameters:
      - $ref: '#/components/parameters/CatalogIdentifierPathParam'
      - $ref: '#/components/parameters/DataAssetKeyPathParam'
      - $ref: '#/components/parameters/EntityKeyPathParam'
      - $ref: '#/components/parameters/DisplayNameQueryParam'
      - $ref: '#/components/parameters/BusinessNameQueryParam'
      - $ref: '#/components/parameters/DisplayOrBusinessNameContainsQueryParam'
      - $ref: '#/components/parameters/DisplayNameContainsQueryParam'
      - $ref: '#/components/parameters/LifecycleStateQueryParam'
      - $ref: '#/components/parameters/TimeCreatedQueryParam'
      - $ref: '#/components/parameters/TimeUpdatedQueryParam'
      - $ref: '#/components/parameters/CreatedByIdentifierQueryParam'
      - $ref: '#/components/parameters/UpdatedByIdentifierQueryParam'
      - $ref: '#/components/parameters/ExternalKeyQueryParam'
      - $ref: '#/components/parameters/TimeExternalQueryParam'
      - $ref: '#/components/parameters/ExternalDataTypeQueryParam'
      - $ref: '#/components/parameters/IsIncrementalDataQueryParam'
      - $ref: '#/components/parameters/IsNullableQueryParam'
      - $ref: '#/components/parameters/LengthQueryParam'
      - $ref: '#/components/parameters/PositionQueryParam'
      - $ref: '#/components/parameters/PrecisionQueryParam'
      - $ref: '#/components/parameters/ScaleQueryParam'
      - $ref: '#/components/parameters/AttributeSummaryFieldsQueryParam'
      - $ref: '#/components/parameters/SortByPositionQueryParam'
      - $ref: '#/components/parameters/SortOrderQueryParam'
      - $ref: '#/components/parameters/PaginationLimitQueryParam'
      - $ref: '#/components/parameters/PaginationTokenQueryParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: A list of entity attribute objects.
          headers:
            opc-next-page:
              description: 'Retrieves the next page of results. When this header appears in the response, additional pages of results remain. 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/AttributeCollection'
        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/DefaultError'
      summary: Returns a list of all attributes of an data entity.
      tags:
      - dataCatalog
      x-obmcs-client-retries-enabled: true
    post:
      description: Creates a new entity attribute.
      operationId: CreateAttribute
      parameters:
      - $ref: '#/components/parameters/CatalogIdentifierPathParam'
      - $ref: '#/components/parameters/DataAssetKeyPathParam'
      - $ref: '#/components/parameters/EntityKeyPathParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/RetryTokenHeader'
      responses:
        200:
          description: The entity attribute was successfully created.
          headers:
            etag:
              description: 'For optimistic concurrency control. See [ETags for Optimistic Concurrency Control](/iaas/Content/API/Concepts/usingapi.htm#eleven).

                '
              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/Attribute'
        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/DefaultError'
      summary: Create a new entity attribute.
      tags:
      - dataCatalog
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateAttributeDetails'
        description: The information used to create an entity attribute.
        required: true
  /catalogs/{catalogId}/dataAssets/{dataAssetKey}/entities/{entityKey}/attributes/{attributeKey}:
    delete:
      description: Deletes a specific entity attribute.
      operationId: DeleteAttribute
      parameters:
      - $ref: '#/components/parameters/CatalogIdentifierPathParam'
      - $ref: '#/components/parameters/DataAssetKeyPathParam'
      - $ref: '#/components/parameters/EntityKeyPathParam'
      - $ref: '#/components/parameters/AttributeKeyPathParam'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        204:
          description: The entity attribute was successfully 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'
        409:
          $ref: '#/components/responses/409'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/DefaultError'
      summary: Delete a specific entity attribute.
      tags:
      - dataCatalog
      x-related-resource: '#/definitions/Attribute'
    get:
      description: Gets a specific entity attribute by key.
      operationId: GetAttribute
      parameters:
      - $ref: '#/components/parameters/CatalogIdentifierPathParam'
      - $ref: '#/components/parameters/DataAssetKeyPathParam'
      - $ref: '#/components/parameters/EntityKeyPathParam'
      - $ref: '#/components/parameters/AttributeKeyPathParam'
      - $ref: '#/components/parameters/IsIncludeObjectRelationshipsQueryParam'
      - $ref: '#/components/parameters/AttributeFieldsQueryParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: Retrieves a specific data entity attribute.
          headers:
            etag:
              description: 'For optimistic concurrency control. See [ETags for Optimistic Concurrency Control](/iaas/Content/API/Concepts/usingapi.htm#eleven).

                '
              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/Attribute'
        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/DefaultError'
      summary: Get a specific entity attribute by key.
      tags:
      - dataCatalog
      x-obmcs-client-retries-enabled: true
    put:
      description: Updates a specific data asset attribute.
      operationId: UpdateAttribute
      parameters:
      - $ref: '#/components/parameters/CatalogIdentifierPathParam'
      - $ref: '#/components/parameters/DataAssetKeyPathParam'
      - $ref: '#/components/parameters/EntityKeyPathParam'
      - $ref: '#/components/parameters/AttributeKeyPathParam'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: The attribute was successfully updated.
          headers:
            etag:
              description: 'For optimistic concurrency control. See [ETags for Optimistic Concurrency Control](/iaas/Content/API/Concepts/usingapi.htm#eleven).

                '
              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/Attribute'
        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/DefaultError'
      summary: Update a specific data asset attribute.
      tags:
      - dataCatalog
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateAttributeDetails'
        description: The information to be updated in the attribute.
        required: true
  /catalogs/{catalogId}/dataAssets/{dataAssetKey}/entities/{entityKey}/attributes/{attributeKey}/tags:
    get:
      description: Returns a list of all tags for an entity attribute.
      operationId: ListAttributeTags
      parameters:
      - $ref: '#/components/parameters/CatalogIdentifierPathParam'
      - $ref: '#/components/parameters/DataAssetKeyPathParam'
      - $ref: '#/components/parameters/EntityKeyPathParam'
      - $ref: '#/components/parameters/AttributeKeyPathParam'
      - $ref: '#/components/parameters/NameQueryParam'
      - $ref: '#/components/parameters/LifecycleStateQueryParam'
      - $ref: '#/components/parameters/TermKeyQueryParam'
      - $ref: '#/components/parameters/TermPathQueryParam'
      - $ref: '#/components/parameters/TimeCreatedQueryParam'
      - $ref: '#/components/parameters/CreatedByIdentifierQueryParam'
      - $ref: '#/components/parameters/AttributeTagSummaryFieldsQueryParam'
      - $ref: '#/components/parameters/SortByQueryParam'
      - $ref: '#/components/parameters/SortOrderQueryParam'
      - $ref: '#/components/parameters/PaginationLimitQueryParam'
      - $ref: '#/components/parameters/PaginationTokenQueryParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: A list of entity attribute tag objects.
          headers:
            opc-next-page:
              description: 'Retrieves the next page of results. When this header appears in the response, additional pages of results remain. 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/AttributeTagCollection'
        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/DefaultError'
      summary: Returns a list of all tags for an entity attribute.
      tags:
      - dataCatalog
      x-obmcs-client-retries-enabled: true
    post:
      description: Creates a new entity attribute tag.
      operationId: CreateAttributeTag
      parameters:
      - $ref: '#/components/parameters/CatalogIdentifierPathParam'
      - $ref: '#/components/parameters/DataAssetKeyPathParam'
      - $ref: '#/components/parameters/EntityKeyPathParam'
      - $ref: '#/components/parameters/AttributeKeyPathParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/RetryTokenHeader'
      responses:
        200:
          description: The entity attribute tag was successfully created.
          headers:
            etag:
              description: 'For optimistic concurrency control. See [ETags for Optimistic Concurrency Control](/iaas/Content/API/Concepts/usingapi.htm#eleven).

                '
              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/AttributeTag'
        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/DefaultError'
      summary: Create a new entity attribute tag.
      tags:
      - dataCatalog
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateTagDetails'
        description: The information used to create an entity attribute tag.
        required: true
  /catalogs/{catalogId}/dataAssets/{dataAssetKey}/entities/{entityKey}/attributes/{attributeKey}/tags/{tagKey}:
    delete:
      description: Deletes a specific entity attribute tag.
      operationId: DeleteAttributeTag
      parameters:
      - $ref: '#/components/parameters/CatalogIdentifierPathParam'
      - $ref: '#/components/parameters/DataAssetKeyPathParam'
      - $ref: '#/components/parameters/EntityKeyPathParam'
      - $ref: '#/components/parameters/AttributeKeyPathParam'
      - $ref: '#/components/parameters/TagKeyPathParam'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        204:
          description: The entity attribute tag was successfully 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'
        409:
          $ref: '#/components/responses/409'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/DefaultError'
      summary: Delete a specific entity attribute tag.
      tags:
      - dataCatalog
      x-related-resource: '#/definitions/AttributeTag'
    get:
      description: Gets a specific entity attribute tag by key.
      operationId: GetAttributeTag
      parameters:
      - $ref: '#/components/parameters/CatalogIdentifierPathParam'
      - $ref: '#/components/parameters/DataAssetKeyPathParam'
      - $ref: '#/components/parameters/EntityKeyPathParam'
      - $ref: '#/components/parameters/AttributeKeyPathParam'
      - $ref: '#/components/parameters/TagKeyPathParam'
      - $ref: '#/components/parameters/AttributeTagFieldsQueryParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: Retrieves a specific entity attribute tag.
          headers:
            etag:
              description: 'For optimistic concurrency control. See [ETags for Optimistic Concurrency Control](/iaas/Content/API/Concepts/usingapi.htm#eleven).

                '
              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/AttributeTag'
        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/DefaultError'
      summary: Get a specific entity attribute tag by key.
      tags:
      - dataCatalog
      x-obmcs-client-retries-enabled: true
  /catalogs/{catalogId}/dataAssets/{dataAssetKey}/entities/{entityKey}/rules:
    get:
      description: Returns a list of all rules of a data entity.
      operationId: ListRules
      parameters:
      - $ref: '#/components/parameters/CatalogIdentifierPathParam'
      - $ref: '#/components/parameters/DataAssetKeyPathParam'
      - $ref: '#/components/parameters/EntityKeyPathParam'
      - $ref: '#/components/parameters/DisplayNameQueryParam'
      - $ref: '#/components/parameters/DisplayNameContainsQueryParam'
      - $ref: '#/components/parameters/RuleTypeQueryParam'
      - $ref: '#/components/parameters/LifecycleStateQueryParam'
      - $ref: '#/components/parameters/RuleOriginTypeQueryParam'
      - $ref: '#/components/parameters/ExternalKeyQueryParam'
      - $ref: '#/components/parameters/TimeCreatedQueryParam'
      - $ref: '#/components/parameters/TimeUpdatedQueryParam'
      - $ref: '#/components/parameters/CreatedByIdentifierQueryParam'
      - $ref: '#/components/parameters/UpdatedByIdentifierQueryParam'
      - $ref: '#/components/parameters/RuleSummaryFieldsQueryParam'
      - $ref: '#/components/parameters/SortByQueryParam'
      - $ref: '#/components/parameters/SortOrderQueryParam'
      - $ref: '#/components/parameters/PaginationLimitQueryParam'
      - $ref: '#/components/parameters/PaginationTokenQueryParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: A list of entity rules objects.
          headers:
            opc-next-page:
              description: 'Retrieves the next page of results. When this header appears in the response, additional pages of results remain. 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/RuleCollection'
        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/DefaultError'
      summary: Returns a list of all rules of a data entity.
      tags:
      - dataCatalog
      x-obmcs-client-retries-enabled: true
      x-related-resource: '#/definitions/RuleSummary'
  /catalogs/{catalogId}/dataAssets/{dataAssetKey}/entities/{entityKey}/tags:
    get:
      description: Returns a list of all tags for a data entity.
      operationId: ListEntityTags
      parameters:
      - $ref: '#/components/parameters/CatalogIdentifierPathParam'
      - $ref: '#/components/parameters/DataAssetKeyPathParam'
      - $ref: '#/components/parameters/EntityKeyPathParam'
      - $ref: '#/components/parameters/NameQueryParam'
      - $ref: '#/components/parameters/LifecycleStateQueryParam'
      - $ref: '#/components/parameters/TermKeyQueryParam'
      - $ref: '#/components/parameters/TermPathQueryParam'
      - $ref: '#/components/parameters/TimeCreatedQueryParam'
      - $ref: '#/components/parameters/CreatedByIdentifierQueryParam'
      - $ref: '#/components/parameters/EntityTagSummaryFieldsQueryParam'
      - $ref: '#/components/parameters/SortByQueryParam'
      - $ref: '#/components/parameters/SortOrderQueryParam'
      - $ref: '#/components/parameters/PaginationLimitQueryParam'
      - $ref: '#/components/parameters/PaginationTokenQueryParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: A list of entity tag objects.
          headers:
            opc-next-page:
              description: 'Retrieves the next page of results. When this header appears in the response, additional pages of results remain. 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/EntityTagCollection'
        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/DefaultError'
      summary: Returns a list of all tags for a data entity.
      tags:
      - dataCatalog
      x-obmcs-client-retries-enabled: true
    post:
      description: Creates a new entity tag.
      operationId: CreateEntityTag
      parameters:
      - $ref: '#/components/parameters/CatalogIdentifierPathParam'
      - $ref: '#/components/parameters/DataAssetKeyPathParam'
      - $ref: '#/components/parameters/EntityKeyPathParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/RetryTokenHeader'
      responses:
        200:
          description: The entity tag was successfully created.
          headers:
            etag:
              description: 'For optimistic concurrency control. See [ETags for Optimistic Concurrency Control](/iaas/Content/API/Concepts/usingapi.htm#eleven).

                '
              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/EntityTag'
        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/DefaultError'
      summary: Create a new entity tag.
      tags:
      - dataCatalog
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateTagDetails'
        description: The information used to create the entity tag.
        required: true
  /catalogs/{catalogId}/dataAssets/{dataAssetKey}/entities/{entityKey}/tags/{tagKey}:
    delete:
      description: Deletes a specific entity tag.
      operationId: DeleteEntityTag
      parameters:
      - $ref: '#/components/parameters/CatalogIdentifierPathParam'
      - $ref: '#/components/parameters/DataAssetKeyPathParam'
      - $ref: '#/components/parameters/EntityKeyPathParam'
      - $ref: '#/components/parameters/TagKeyPathParam'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        204:
          description: The entity tag was successfully 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'
        409:
          $ref: '#/components/responses/409'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/DefaultError'
      summary: Delete a specific entity tag.
      tags:
      - dataCatalog
      x-related-resource: '#/definitions/EntityTag'
    get:
      description: Gets a specific entity tag by key.
      operationId: GetEntityTag
      parameters:
      - $ref: '#/components/parameters/CatalogIdentifierPathParam'
      - $ref: '#/components/parameters/DataAssetKeyPathParam'
      - $ref: '#/components/parameters/EntityKeyPathParam'
      - $ref: '#/components/parameters/TagKeyPathParam'
      - $ref: '#/components/parameters/EntityTagFieldsQueryParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: Retrieves a specific data entity tag.
          headers:
            etag:
              description: 'For optimistic concurrency control. See [ETags for Optimistic Concurrency Control](/iaas/Content/API/Concepts/usingapi.htm#eleven).

                '
              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/EntityTag'
        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/DefaultError'
      summary: Get a specific entity tag by key.
      tags:
      - dataCatalog
      x-obmcs-client-retries-enabled: true
  /catalogs/{catalogId}/dataAssets/{dataAssetKey}/folders:
    get:
      description: Returns a list of all folders.
      operationId: ListFolders
      parameters:
      - $ref: '#/components/parameters/CatalogIdentifierPathParam'
      - $ref: '#/components/parameters/DataAssetKeyPathParam'
      - $ref: '#/components/parameters/DisplayNameQueryParam'
      - $ref: '#/components/parameters/BusinessNameQueryParam'
      - $ref: '#/components/parameters/DisplayOrBusinessNameContainsQueryParam'
      - $ref: '#/components/parameters/DisplayNameContainsQueryParam'
      - $ref: '#/components/parameters/LifecycleStateQueryParam'
      - $ref: '#/components/parameters/ParentFolderKeyQueryParam'
      - $ref: '#/components/parameters/PathQueryParam'
      - $ref: '#/components/parameters/ExternalKeyQueryParam'
      - $ref: '#/components/parameters/TimeCreatedQueryParam'
      - $ref: '#/components/parameters/TimeUpdatedQueryParam'
      - $ref: '#/components/parameters/CreatedByIdentifierQueryParam'
      - $ref: '#/components/parameters/UpdatedByIdentifierQueryParam'
      - $ref: '#/components/parameters/HarvestStatusQueryParam'
      - $ref: '#/components/parameters/LastJobKeyQueryParam'
      - $ref: '#/components/parameters/FolderSummaryFieldsQueryParam'
      - $ref: '#/components/parameters/TypeKeyQueryParam'
      - $ref: '#/components/parameters/SortByDisplayOrBusinessNameQueryParam'
      - $ref: '#/components/parameters/SortOrderQueryParam'
      - $ref: '#/components/parameters/PaginationLimitQueryParam'
      - $ref: '#/components/parameters/PaginationTokenQueryParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: A list of folder objects.
          headers:
            opc-next-page:
              description: 'Retrieves the next page of results. When this header appears in the response, additional pages of results remain. 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/FolderCollection'
        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/DefaultError'
      summary: Returns a list of all folders for a data asset.
      tags:
      - dataCatalog
      x-obmcs-client-retries-enabled: true
    post:
      description: Creates a new folder.
      operationId: CreateFolder
      parameters:
      - $ref: '#/components/parameters/CatalogIdentifierPathParam'
      - $ref: '#/components/parameters/DataAssetKeyPathParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/RetryTokenHeader'
      responses:
        200:
          description: The folder was successfully created.
          headers:
            etag:
              description: 'For optimistic concurrency control. See [ETags for Optimistic Concurrency Control](/iaas/Content/API/Concepts/usingapi.htm#eleven).

                '
              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/Folder'
        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/DefaultError'
      summary: Create a new folder.
      tags:
      - dataCatalog
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateFolderDetails'
        description: The information used to create the folder.
        required: true
  /catalogs/{catalogId}/dataAssets/{dataAssetKey}/folders/{folderKey}:
    delete:
      description: Deletes a specific folder of a data asset identified by it's key.
      operationId: DeleteFolder
      parameters:
      - $ref: '#/components/parameters/CatalogIdentifierPathParam'
      - $ref: '#/components/parameters/DataAssetKeyPathParam'
      - $ref: '#/components/parameters/FolderKeyPathParam'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        204:
          description: The folder was successfully 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'
        409:
          $ref: '#/components/responses/409'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/DefaultError'
      summary: Delete a specific folder of a data asset identified by it's key.
      tags:
      - dataCatalog
      x-related-resource: '#/definitions/Folder'
    get:
      description: Gets a specific data asset folder by key.
      operationId: GetFolder
      parameters:
      - $ref: '#/components/parameters/CatalogIdentifierPathParam'
      - $ref: '#/components/parameters/DataAssetKeyPathParam'
      - $ref: '#/components/parameters/FolderKeyPathParam'
      - $ref: '#/components/parameters/IsIncludeObjectRelationshipsQueryParam'
      - $ref: '#/components/parameters/FolderFieldsQueryParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: Retrieves the data asset folder with the given key.
          headers:
            etag:
              description: 'For optimistic concurrency control. See [ETags for Optimistic Concurrency Control](/iaas/Content/API/Concepts/usingapi.htm#eleven).

                '
              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/Folder'
        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/DefaultError'
      summary: Get a specific data asset folder by key.
      tags:
      - dataCatalog
      x-obmcs-client-retries-enabled: true
    put:
      description: Updates a specific folder of a data asset.
      operationId: UpdateFolder
      parameters:
      - $ref: '#/components/parameters/CatalogIdentifierPathParam'
      - $ref: '#/components/parameters/DataAssetKeyPathParam'
      - $ref: '#/components/parameters/FolderKeyPathParam'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: The folder was successfully updated.
          headers:
            etag:
              description: 'For optimistic concurrency control. See [ETags for Optimistic Concurrency Control](/iaas/Content/API/Concepts/usingapi.htm#eleven).

                '
              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/Folder'
        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/DefaultError'
      summary: Update a specific folder of a data asset.
      tags:
      - dataCatalog
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateFolderDetails'
        description: The information to be updated in the folder.
        required: true
  /catalogs/{catalogId}/dataAssets/{dataAssetKey}/folders/{folderKey}/tags:
    get:
      description: Returns a list of all tags for a folder.
      operationId: ListFolderTags
      parameters:
      - $ref: '#/components/parameters/CatalogIdentifierPathParam'
      - $ref: '#/components/parameters/DataAssetKeyPathParam'
      - $ref: '#/components/parameters/FolderKeyPathParam'
      - $ref: '#/components/parameters/NameQueryParam'
      - $ref: '#/components/parameters/LifecycleStateQueryParam'
      - $ref: '#/components/parameters/TermKeyQueryParam'
      - $ref: '#/components/parameters/TermPathQueryParam'
      - $ref: '#/components/parameters/TimeCreatedQueryParam'
      - $ref: '#/components/parameters/CreatedByIdentifierQueryParam'
      - $ref: '#/components/parameters/FolderTagSummaryFieldsQueryParam'
      - $ref: '#/components/parameters/SortByQueryParam'
      - $ref: '#/components/parameters/SortOrderQueryParam'
      - $ref: '#/components/parameters/PaginationLimitQueryParam'
      - $ref: '#/components/parameters/PaginationTokenQueryParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: A list of folder tag objects.
          headers:
            opc-next-page:
              description: 'Retrieves the next page of results. When this header appears in the response, additional pages of results remain. 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/FolderTagCollection'
        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/DefaultError'
      summary: Returns a list of all tags for a folder.
      tags:
      - dataCatalog
      x-obmcs-client-retries-enabled: true
    post:
      description: Creates a new folder tag.
      operationId: CreateFolderTag
      parameters:
      - $ref: '#/components/parameters/CatalogIdentifierPathParam'
      - $ref: '#/components/parameters/DataAssetKeyPathParam'
      - $ref: '#/components/parameters/FolderKeyPathParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/RetryTokenHeader'
      responses:
        200:
          description: The folder tag was successfully created.
          headers:
            etag:
              description: 'For optimistic concurrency control. See [ETags for Optimistic Concurrency Control](/iaas/Content/API/Concepts/usingapi.htm#eleven).

                '
              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/FolderTag'
        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/DefaultError'
      summary: Create a new folder tag.
      tags:
      - dataCatalog
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateTagDetails'
        description: The information used to create the folder tag.
        required: true
  /catalogs/{catalogId}/dataAssets/{dataAssetKey}/folders/{folderKey}/tags/{tagKey}:
    delete:
      description: Deletes a specific folder tag.
      operationId: DeleteFolderTag
      parameters:
      - $ref: '#/components/parameters/CatalogIdentifierPathParam'
      - $ref: '#/components/parameters/DataAssetKeyPathParam'
      - $ref: '#/components/parameters/FolderKeyPathParam'
      - $ref: '#/components/parameters/TagKeyPathParam'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        204:
          description: The folder tag was successfully 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'
        409:
          $ref: '#/components/responses/409'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/DefaultError'
      summary: Delete a specific folder tag.
      tags:
      - dataCatalog
      x-related-resource: '#/definitions/FolderTag'
    get:
      description: Gets a specific folder tag by key.
      operationId: GetFolderTag
      parameters:
      - $ref: '#/components/parameters/CatalogIdentifierPathParam'
      - $ref: '#/components/parameters/DataAssetKeyPathParam'
      - $ref: '#/components/parameters/FolderKeyPathParam'
      - $ref: '#/components/parameters/TagKeyPathParam'
      - $ref: '#/components/parameters/FolderTagFieldsQueryParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: Retrieves a specific folder tag.
          headers:
            etag:
              description: 'For optimistic concurrency control. See [ETags for Optimistic Concurrency Control](/iaas/Content/API/Concepts/usingapi.htm#eleven).

                '
              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/FolderTag'
        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/DefaultError'
      summary: Get a specific folder tag by key.
      tags:
      - dataCatalog
      x-obmcs-client-retries-enabled: true
  /catalogs/{catalogId}/dataAssets/{dataAssetKey}/tags:
    get:
      description: Returns a list of all tags for a data asset.
      operationId: ListDataAssetTags
      parameters:
      - $ref: '#/components/parameters/CatalogIdentifierPathParam'
      - $ref: '#/components/parameters/DataAssetKeyPathParam'
      - $ref: '#/components/parameters/NameQueryParam'
      - $ref: '#/components/parameters/LifecycleStateQueryParam'
      - $ref: '#/components/parameters/TermKeyQueryParam'
      - $ref: '#/components/parameters/TermPathQueryParam'
      - $ref: '#/components/parameters/TimeCreatedQueryParam'
      - $ref: '#/components/parameters/CreatedByIdentifierQueryParam'
      - $ref: '#/components/parameters/DataAssetTagSummaryFieldsQueryParam'
      - $ref: '#/components/parameters/SortByQueryParam'
      - $ref: '#/components/parameters/SortOrderQueryParam'
      - $ref: '#/components/parameters/PaginationLimitQueryParam'
      - $ref: '#/components/parameters/PaginationTokenQueryParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: A list of data asset tag objects.
          headers:
            opc-next-page:
              description: 'Retrieves the next page of results. When this header appears in the response, additional pages of results remain. 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/DataAssetTagCollection'
        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/DefaultError'
      summary: Returns a list of all tags for a data asset.
      tags:
      - dataCatalog
      x-obmcs-client-retries-enabled: true
    post:
      description: Creates a new data asset tag.
      operationId: CreateDataAssetTag
      parameters:
      - $ref: '#/components/parameters/CatalogIdentifierPathParam'
      - $ref: '#/components/parameters/DataAssetKeyPathParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/RetryTokenHeader'
      responses:
        200:
          description: The data asset tag was successfully created.
          headers:
            etag:
              description: 'For optimistic concurrency control. See [ETags for Optimistic Concurrency Control](/iaas/Content/API/Concepts/usingapi.htm#eleven).

                '
              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/DataAssetTag'
        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/DefaultError'
      summary: Create a new data asset tag.
      tags:
      - dataCatalog
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateTagDetails'
        description: The information used to create the data asset tag.
        required: true
  /catalogs/{catalogId}/dataAssets/{dataAssetKey}/tags/{tagKey}:
    delete:
      description: Deletes a specific data asset tag.
      operationId: DeleteDataAssetTag
      parameters:
      - $ref: '#/components/parameters/CatalogIdentifierPathParam'
      - $ref: '#/components/parameters/DataAssetKeyPathParam'
      - $ref: '#/components/parameters/TagKeyPathParam'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        204:
          description: The data asset tag was successfully 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'
        409:
          $ref: '#/components/responses/409'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/DefaultError'
      summary: Delete a specific data asset tag.
      tags:
      - dataCatalog
      x-related-resource: '#/definitions/DataAssetTag'
    get:
      description: Gets a specific data asset tag by key.
      operationId: GetDataAssetTag
      parameters:
      - $ref: '#/components/parameters/CatalogIdentifierPathParam'
      - $ref: '#/components/parameters/DataAssetKeyPathParam'
      - $ref: '#/components/parameters/TagKeyPathParam'
      - $ref: '#/components/parameters/DataAssetTagFieldsQueryParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: Retrieves a specific data asset tag.
          headers:
            etag:
              description: 'For optimistic concurrency control. See [ETags for Optimistic Concurrency Control](/iaas/Content/API/Concepts/usingapi.htm#eleven).

                '
              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/DataAssetTag'
        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/DefaultError'
      summary: Get a specific data asset tag by key.
      tags:
      - dataCatalog
      x-obmcs-client-retries-enabled: true
  /catalogs/{catalogId}/glossaries:
    get:
      description: Returns a list of all glossaries within a data catalog.
      operationId: ListGlossaries
      parameters:
      - $ref: '#/components/parameters/CatalogIdentifierPathParam'
      - $ref: '#/components/parameters/DisplayNameQueryParam'
      - $ref: '#/components/parameters/DisplayNameContainsQueryParam'
      - $ref: '#/components/parameters/LifecycleStateQueryParam'
      - $ref: '#/components/parameters/TimeCreatedQueryParam'
      - $ref: '#/components/parameters/TimeUpdatedQueryParam'
      - $ref: '#/components/parameters/CreatedByIdentifierQueryParam'
      - $ref: '#/components/parameters/UpdatedByIdentifierQueryParam'
      - $ref: '#/components/parameters/GlossarySummaryFieldsQueryParam'
      - $ref: '#/components/parameters/SortByQueryParam'
      - $ref: '#/components/parameters/SortOrderQueryParam'
      - $ref: '#/components/parameters/PaginationLimitQueryParam'
      - $ref: '#/components/parameters/PaginationTokenQueryParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: A list of glossary objects.
          headers:
            opc-next-page:
              description: 'Retrieves the next page of results. When this header appears in the response, additional pages of results remain. 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/GlossaryCollection'
        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/DefaultError'
      summary: Returns a list of all glossaries within a data catalog.
      tags:
      - dataCatalog
      x-obmcs-client-retries-enabled: true
      x-related-resource: '#/definitions/Glossary'
    post:
      description: Creates a new glossary.
      operationId: CreateGlossary
      parameters:
      - $ref: '#/components/parameters/CatalogIdentifierPathParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/RetryTokenHeader'
      responses:
        200:
          description: The glossary was successfully created.
          headers:
            etag:
              description: 'For optimistic concurrency control. See [ETags for Optimistic Concurrency Control](/iaas/Content/API/Concepts/usingapi.htm#eleven).

                '
              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/Glossary'
        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/DefaultError'
      summary: Create a new glossary.
      tags:
      - dataCatalog
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateGlossaryDetails'
        description: The information used to create the glossary.
        required: true
  /catalogs/{catalogId}/glossaries/{glossaryKey}:
    delete:
      description: Deletes a specific glossary identified by it's key.
      operationId: DeleteGlossary
      parameters:
      - $ref: '#/components/parameters/CatalogIdentifierPathParam'
      - $ref: '#/components/parameters/GlossaryKeyPathParam'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        204:
          description: The glossary was successfully 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'
        409:
          $ref: '#/components/responses/409'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/DefaultError'
      summary: Delete a specific glossary identified by it's key.
      tags:
      - dataCatalog
      x-related-resource: '#/definitions/Glossary'
    get:
      description: Gets a specific glossary by key within a data catalog.
      operationId: GetGlossary
      parameters:
      - $ref: '#/components/parameters/CatalogIdentifierPathParam'
      - $ref: '#/components/parameters/GlossaryKeyPathParam'
      - $ref: '#/components/parameters/GlossaryFieldsQueryParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: Retrieves the glossary with the given key.
          headers:
            etag:
              description: 'For optimistic concurrency control. See [ETags for Optimistic Concurrency Control](/iaas/Content/API/Concepts/usingapi.htm#eleven).

                '
              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/Glossary'
        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/DefaultError'
      summary: Get a specific glossary by key within a data catalog.
      tags:
      - dataCatalog
      x-obmcs-client-retries-enabled: true
    put:
      description: Updates a specific glossary identified by the given key.
      operationId: UpdateGlossary
      parameters:
      - $ref: '#/components/parameters/CatalogIdentifierPathParam'
      - $ref: '#/components/parameters/GlossaryKeyPathParam'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: The glossary was successfully updated.
          headers:
            etag:
              description: 'For optimistic concurrency control. See [ETags for Optimistic Concurrency Control](/iaas/Content/API/Concepts/usingapi.htm#eleven).

                '
              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/Glossary'
        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/DefaultError'
      summary: Update a specific glossary identified by the given key.
      tags:
      - dataCatalog
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateGlossaryDetails'
        description: The information to be updated in the glossary.
        required: true
  /catalogs/{catalogId}/glossaries/{glossaryKey}/actions/asynchronousExport:
    post:
      description: 'Exports the contents of a glossary in Excel format. Returns details about the job which actually performs the export.

        '
      operationId: AsynchronousExportGlossary
      parameters:
      - $ref: '#/components/parameters/CatalogIdentifierPathParam'
      - $ref: '#/components/parameters/GlossaryKeyPathParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/RetryTokenHeader'
      responses:
        202:
          description: Accepted the request. The glossary will be exported.
          headers:
            etag:
              description: 'For optimistic concurrency control. See [ETags for Optimistic Concurrency Control](/iaas/Content/API/Concepts/usingapi.htm#eleven).

                '
              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/AsynchronousExportGlossaryResult'
        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/DefaultError'
      summary: Exports the contents of a glossary in Excel format.
      tags:
      - dataCatalog
      x-related-resource: '#/definitions/Glossary'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AsynchronousExportGlossaryDetails'
        description: Details needed by the glossary export request.
        required: true
  /catalogs/{catalogId}/glossaries/{glossaryKey}/actions/expandTree:
    post:
      description: Returns the fully expanded tree hierarchy of parent and child terms in this glossary.
      operationId: ExpandTreeForGlossary
      parameters:
      - $ref: '#/components/parameters/CatalogIdentifierPathParam'
      - $ref: '#/components/parameters/GlossaryKeyPathParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/RetryTokenHeader'
      responses:
        200:
          description: The expanded glossary tree.
          headers:
            etag:
              description: 'For optimistic concurrency control. See [ETags for Optimistic Concurrency Control](/iaas/Content/API/Concepts/usingapi.htm#eleven).

                '
              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:
                items:
                  $ref: '#/components/schemas/GlossaryTreeElement'
                type: array
        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/DefaultError'
      summary: Glossaries contain nested hierarchies of parent and child terms. Returns an expanded tree of this glossary.
      tags:
      - dataCatalog
      x-obmcs-client-retries-enabled: true
      x-related-resource: '#/definitions/Glossary'
  /catalogs/{catalogId}/glossaries/{glossaryKey}/actions/export:
    post:
      description: Export the glossary and the terms and return the exported glossary as csv or json.
      operationId: ExportGlossary
      parameters:
      - $ref: '#/components/parameters/CatalogIdentifierPathParam'
      - $ref: '#/components/parameters/GlossaryKeyPathParam'
      - $ref: '#/components/parameters/ExportGlossaryRelationshipQueryParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/RetryTokenHeader'
      responses:
        200:
          description: The exported glossary contents.
          headers:
            etag:
              description: 'For optimistic concurrency control. See [ETags for Optimistic Concurrency Control](/iaas/Content/API/Concepts/usingapi.htm#eleven).

                '
              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:
                type: string
            text/csv:
              schema:
                type: string
            application/vnd.openxmlformats-officedocument.spreadsheetml.sheet:
              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/DefaultError'
      summary: Glossaries can be exported as csv or json formats. Returns the succesfully exported glossary in the format requested.
      tags:
      - dataCatalog
      x-related-resource: '#/definitions/Glossary'
  /catalogs/{catalogId}/glossaries/{glossaryKey}/actions/import:
    post:
      description: Import the glossary and the terms from csv or json files and return the imported glossary resource.
      operationId: ImportGlossary
      parameters:
      - $ref: '#/components/parameters/CatalogIdentifierPathParam'
      - $ref: '#/components/parameters/GlossaryKeyPathParam'
      - $ref: '#/components/parameters/ImportGlossaryRelationshipQueryParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/RetryTokenHeader'
      responses:
        200:
          description: The imported glossary resource.
          headers:
            etag:
              description: 'For optimistic concurrency control. See [ETags for Optimistic Concurrency Control](/iaas/Content/API/Concepts/usingapi.htm#eleven).

                '
              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:
                items:
                  $ref: '#/components/schemas/Glossary'
        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/DefaultError'
      summary: Glossaries can be imported from csv or json file formats. Returns the succesfully imported glossary.
      tags:
      - dataCatalog
      x-related-resource: '#/definitions/Glossary'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ImportGlossaryDetails'
        description: The file contents to import the glossary.
        required: true
  /catalogs/{catalogId}/glossaries/{glossaryKey}/terms:
    get:
      description: Returns a list of all terms within a glossary.
      operationId: ListTerms
      parameters:
      - $ref: '#/components/parameters/CatalogIdentifierPathParam'
      - $ref: '#/components/parameters/GlossaryKeyPathParam'
      - $ref: '#/components/parameters/DisplayNameQueryParam'
      - $ref: '#/components/parameters/DisplayNameContainsQueryParam'
      - $ref: '#/components/parameters/LifecycleStateQueryParam'
      - $ref: '#/components/parameters/ParentTermKeyQueryParam'
      - $ref: '#/components/parameters/IsAllowedToHaveChildTermsQueryParam'
      - $ref: '#/components/parameters/TermWorkflowStatusQueryParam'
      - $ref: '#/components/parameters/PathQueryParam'
      - $ref: '#/components/parameters/TermSummaryFieldsQueryParam'
      - $ref: '#/components/parameters/SortByQueryParam'
      - $ref: '#/components/parameters/SortOrderQueryParam'
      - $ref: '#/components/parameters/PaginationLimitQueryParam'
      - $ref: '#/components/parameters/PaginationTokenQueryParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: A list of all terms in a glossary.
          headers:
            opc-next-page:
              description: 'Retrieves the next page of results. When this header appears in the response, additional pages of results remain. 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/TermCollection'
        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/DefaultError'
      summary: Returns a list of all terms within a glossary.
      tags:
      - dataCatalog
      x-obmcs-client-retries-enabled: true
      x-related-resource: '#/definitions/Term'
    post:
      description: Create a new term within a glossary.
      operationId: CreateTerm
      parameters:
      - $ref: '#/components/parameters/CatalogIdentifierPathParam'
      - $ref: '#/components/parameters/GlossaryKeyPathParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/RetryTokenHeader'
      responses:
        200:
          description: The term was successfully created.
          headers:
            etag:
              description: 'For optimistic concurrency control. See [ETags for Optimistic Concurrency Control](/iaas/Content/API/Concepts/usingapi.htm#eleven).

                '
              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/Term'
        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/DefaultError'
      summary: Create a new term within a glossary.
      tags:
      - dataCatalog
      x-related-resource: '#/definitions/Term'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateTermDetails'
        description: The information used to create the term.
        required: true
  /catalogs/{catalogId}/glossaries/{glossaryKey}/terms/{termKey}:
    delete:
      description: Deletes a specific glossary term.
      operationId: DeleteTerm
      parameters:
      - $ref: '#/components/parameters/CatalogIdentifierPathParam'
      - $ref: '#/components/parameters/GlossaryKeyPathParam'
      - $ref: '#/components/parameters/TermKeyPathParam'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        204:
          description: The term was successfully 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'
        409:
          $ref: '#/components/responses/409'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/DefaultError'
      summary: Delete a specific glossary term.
      tags:
      - dataCatalog
      x-related-resource: '#/definitions/Term'
    get:
      description: Gets a specific glossary term by key.
      operationId: GetTerm
      parameters:
      - $ref: '#/components/parameters/CatalogIdentifierPathParam'
      - $ref: '#/components/parameters/GlossaryKeyPathParam'
      - $ref: '#/components/parameters/TermKeyPathParam'
      - $ref: '#/components/parameters/TermFieldsQueryParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: Retrieves a specific glossary term.
          headers:
            etag:
              description: 'For optimistic concurrency control. See [ETags for Optimistic Concurrency Control](/iaas/Content/API/Concepts/usingapi.htm#eleven).

                '
              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/Term'
        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/DefaultError'
      summary: Get a specific glossary term by key.
      tags:
      - dataCatalog
      x-obmcs-client-retries-enabled: true
      x-related-resource: '#/definitions/Term'
    put:
      description: Updates a specific glossary term.
      operationId: UpdateTerm
      parameters:
      - $ref: '#/components/parameters/CatalogIdentifierPathParam'
      - $ref: '#/components/parameters/GlossaryKeyPathParam'
      - $ref: '#/components/parameters/TermKeyPathParam'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: The term was successfully updated.
          headers:
            etag:
              description: 'For optimistic concurrency control. See [ETags for Optimistic Concurrency Control](/iaas/Content/API/Concepts/usingapi.htm#eleven).

                '
              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/Term'
        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/DefaultError'
      summary: Update a specific glossary term.
      tags:
      - dataCatalog
      x-related-resource: '#/definitions/Term'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateTermDetails'
        description: The information to be updated in the term.
        required: true
  /catalogs/{catalogId}/glossaries/{glossaryKey}/terms/{termKey}/termRelationships:
    get:
      description: Returns a list of all term relationships within a glossary.
      operationId: ListTermRelationships
      parameters:
      - $ref: '#/components/parameters/CatalogIdentifierPathParam'
      - $ref: '#/components/parameters/GlossaryKeyPathParam'
      - $ref: '#/components/parameters/TermKeyPathParam'
      - $ref: '#/components/parameters/DisplayNameQueryParam'
      - $ref: '#/components/parameters/DisplayNameContainsQueryParam'
      - $ref: '#/components/parameters/LifecycleStateQueryParam'
      - $ref: '#/components/parameters/TermRelationshipSummaryFieldsQueryParam'
      - $ref: '#/components/parameters/SortByQueryParam'
      - $ref: '#/components/parameters/SortOrderQueryParam'
      - $ref: '#/components/parameters/PaginationLimitQueryParam'
      - $ref: '#/components/parameters/PaginationTokenQueryParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: A list of all term relationships for this term in a glossary.
          headers:
            opc-next-page:
              description: 'Retrieves the next page of results. When this header appears in the response, additional pages of results remain. 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/TermRelationshipCollection'
        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/DefaultError'
      summary: Returns a list of all term relationships for a term within a glossary.
      tags:
      - dataCatalog
      x-obmcs-client-retries-enabled: true
      x-related-resource: '#/definitions/TermRelationship'
    post:
      description: Creates a new term relationship for this term within a glossary.
      operationId: CreateTermRelationship
      parameters:
      - $ref: '#/components/parameters/CatalogIdentifierPathParam'
      - $ref: '#/components/parameters/GlossaryKeyPathParam'
      - $ref: '#/components/parameters/TermKeyPathParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/RetryTokenHeader'
      responses:
        200:
          description: The term relationship was successfully created.
          headers:
            etag:
              description: 'For optimistic concurrency control. See [ETags for Optimistic Concurrency Control](/iaas/Content/API/Concepts/usingapi.htm#eleven).

                '
              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/TermRelationship'
        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/DefaultError'
      summary: Create a new term relationship for this term within a glossary.
      tags:
      - dataCatalog
      x-related-resource: '#/definitions/TermRelationship'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateTermRelationshipDetails'
        description: The information used to create the term relationship.
        required: true
  /catalogs/{catalogId}/glossaries/{glossaryKey}/terms/{termKey}/termRelationships/{termRelationshipKey}:
    delete:
      description: Deletes a specific glossary term relationship.
      operationId: DeleteTermRelationship
      parameters:
      - $ref: '#/components/parameters/CatalogIdentifierPathParam'
      - $ref: '#/components/parameters/GlossaryKeyPathParam'
      - $ref: '#/components/parameters/TermKeyPathParam'
      - $ref: '#/components/parameters/TermRelationshipKeyPathParam'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        204:
          description: The term relationship was successfully 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'
        409:
          $ref: '#/components/responses/409'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/DefaultError'
      summary: Delete a specific glossary term relationship.
      tags:
      - dataCatalog
      x-related-resource: '#/definitions/TermRelationship'
    get:
      description: Gets a specific glossary term relationship by key.
      operationId: GetTermRelationship
      parameters:
      - $ref: '#/components/parameters/CatalogIdentifierPathParam'
      - $ref: '#/components/parameters/GlossaryKeyPathParam'
      - $ref: '#/components/parameters/TermKeyPathParam'
      - $ref: '#/components/parameters/TermRelationshipKeyPathParam'
      - $ref: '#/components/parameters/TermRelationshipFieldsQueryParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: Retrieves a specific glossary term relationship.
          headers:
            etag:
              description: 'For optimistic concurrency control. See [ETags for Optimistic Concurrency Control](/iaas/Content/API/Concepts/usingapi.htm#eleven).

                '
              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/TermRelationship'
        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/DefaultError'
      summary: Get a specific glossary term relationship by key.
      tags:
      - dataCatalog
      x-obmcs-client-retries-enabled: true
      x-related-resource: '#/definitions/TermRelationship'
    put:
      description: Updates a specific glossary term relationship.
      operationId: UpdateTermRelationship
      parameters:
      - $ref: '#/components/parameters/CatalogIdentifierPathParam'
      - $ref: '#/components/parameters/GlossaryKeyPathParam'
      - $ref: '#/components/parameters/TermKeyPathParam'
      - $ref: '#/components/parameters/TermRelationshipKeyPathParam'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: The term relationship was successfully updated.
          headers:
            etag:
              description: 'For optimistic concurrency control. See [ETags for Optimistic Concurrency Control](/iaas/Content/API/Concepts/usingapi.htm#eleven).

                '
              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/TermRelationship'
        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/DefaultError'
      summary: Update a specific glossary term relationship.
      tags:
      - dataCatalog
      x-related-resource: '#/definitions/TermRelationship'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateTermRelationshipDetails'
        description: The information to be updated in the term relationship.
        required: true
  /catalogs/{catalogId}/jobDefinitions:
    get:
      description: Returns a list of job definitions within a data catalog.
      operationId: ListJobDefinitions
      parameters:
      - $ref: '#/components/parameters/CatalogIdentifierPathParam'
      - $ref: '#/components/parameters/DisplayNameQueryParam'
      - $ref: '#/components/parameters/DisplayNameContainsQueryParam'
      - $ref: '#/components/parameters/JobExecutionStateQueryParam'
      - $ref: '#/components/parameters/LifecycleStateQueryParam'
      - $ref: '#/components/parameters/JobTypeQueryParam'
      - $ref: '#/components/parameters/IsIncrementalQueryParam'
      - $ref: '#/components/parameters/DataAssetKeyQueryParam'
      - $ref: '#/components/parameters/GlossaryKeyQueryParam'
      - $ref: '#/components/parameters/ConnectionKeyQueryParam'
      - $ref: '#/components/parameters/TimeCreatedQueryParam'
      - $ref: '#/components/parameters/TimeUpdatedQueryParam'
      - $ref: '#/components/parameters/CreatedByIdentifierQueryParam'
      - $ref: '#/components/parameters/UpdatedByIdentifierQueryParam'
      - $ref: '#/components/parameters/SampleDataSizeInMBsQueryParam'
      - $ref: '#/components/parameters/JobDefinitionSummaryFieldsQueryParam'
      - $ref: '#/components/parameters/SortByExecutionTimeQueryParam'
      - $ref: '#/components/parameters/SortOrderQueryParam'
      - $ref: '#/components/parameters/PaginationLimitQueryParam'
      - $ref: '#/components/parameters/PaginationTokenQueryParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: A list of job definition objects.
          headers:
            opc-next-page:
              description: 'Retrieves the next page of results. When this header appears in the response, additional pages of results remain. 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/JobDefinitionCollection'
        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/DefaultError'
      summary: Returns a list of job definitions within a data catalog.
      tags:
      - dataCatalog
      x-obmcs-client-retries-enabled: true
    post:
      description: Creates a new job definition.
      operationId: CreateJobDefinition
      parameters:
      - $ref: '#/components/parameters/CatalogIdentifierPathParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/RetryTokenHeader'
      responses:
        200:
          description: The job definition was successfully created.
          headers:
            etag:
              description: 'For optimistic concurrency control. See [ETags for Optimistic Concurrency Control](/iaas/Content/API/Concepts/usingapi.htm#eleven).

                '
              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/JobDefinition'
        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/DefaultError'
      summary: Create a new job definition.
      tags:
      - dataCatalog
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateJobDefinitionDetails'
        description: The information used to create the job definition.
        required: true
  /catalogs/{catalogId}/jobDefinitions/{jobDefinitionKey}:
    delete:
      description: Deletes a specific job definition identified by it's key.
      operationId: DeleteJobDefinition
      parameters:
      - $ref: '#/components/parameters/CatalogIdentifierPathParam'
      - $ref: '#/components/parameters/JobDefinitionKeyPathParam'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        204:
          description: The job definition was successfully 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'
        409:
          $ref: '#/components/responses/409'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/DefaultError'
      summary: Delete a specific job definition identified by it's key.
      tags:
      - dataCatalog
      x-related-resource: '#/definitions/JobDefinition'
    get:
      description: Gets a specific job definition by key within a data catalog.
      operationId: GetJobDefinition
      parameters:
      - $ref: '#/components/parameters/CatalogIdentifierPathParam'
      - $ref: '#/components/parameters/JobDefinitionKeyPathParam'
      - $ref: '#/components/parameters/JobDefinitionFieldsQueryParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: Retrieves the job definition with the given key.
          headers:
            etag:
              description: 'For optimistic concurrency control. See [ETags for Optimistic Concurrency Control](/iaas/Content/API/Concepts/usingapi.htm#eleven).

                '
              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/JobDefinition'
        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/DefaultError'
      summary: Get a specific job definition by key within a data catalog.
      tags:
      - dataCatalog
      x-obmcs-client-retries-enabled: true
    put:
      description: Update a specific job definition identified by the given key.
      operationId: UpdateJobDefinition
      parameters:
      - $ref: '#/components/parameters/CatalogIdentifierPathParam'
      - $ref: '#/components/parameters/JobDefinitionKeyPathParam'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: The job definition was successfully updated.
          headers:
            etag:
              description: 'For optimistic concurrency control. See [ETags for Optimistic Concurrency Control](/iaas/Content/API/Concepts/usingapi.htm#eleven).

                '
              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/JobDefinition'
        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/DefaultError'
      summary: Update a specific job definition identified by the given key.
      tags:
      - dataCatalog
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateJobDefinitionDetails'
        description: The information to be updated in the job definition.
        required: true
  /catalogs/{catalogId}/jobs:
    get:
      description: Returns a list of jobs within a data catalog.
      operationId: ListJobs
      parameters:
      - $ref: '#/components/parameters/CatalogIdentifierPathParam'
      - $ref: '#/components/parameters/DisplayNameQueryParam'
      - $ref: '#/components/parameters/DisplayNameContainsQueryParam'
      - $ref: '#/components/parameters/JobLifecycleStateQueryParam'
      - $ref: '#/components/parameters/TimeCreatedQueryParam'
      - $ref: '#/components/parameters/TimeUpdatedQueryParam'
      - $ref: '#/components/parameters/CreatedByIdentifierQueryParam'
      - $ref: '#/components/parameters/UpdatedByIdentifierQueryParam'
      - $ref: '#/components/parameters/JobTypeQueryParam'
      - $ref: '#/components/parameters/JobDefinitionKeyQueryParam'
      - $ref: '#/components/parameters/DataAssetKeyQueryParam'
      - $ref: '#/components/parameters/GlossaryKeyQueryParam'
      - $ref: '#/components/parameters/JobScheduleCronExpressionQueryParam'
      - $ref: '#/components/parameters/JobTimeScheduleBeginQueryParam'
      - $ref: '#/components/parameters/JobTimeScheduleEndQueryParam'
      - $ref: '#/components/parameters/JobScheduleTypeQueryParam'
      - $ref: '#/components/parameters/ConnectionKeyQueryParam'
      - $ref: '#/components/parameters/JobSummaryFieldsQueryParam'
      - $ref: '#/components/parameters/JobExecutionCountQueryParam'
      - $ref: '#/components/parameters/JobLatestExecutionQueryParam'
      - $ref: '#/components/parameters/SortByQueryParam'
      - $ref: '#/components/parameters/SortOrderQueryParam'
      - $ref: '#/components/parameters/PaginationLimitQueryParam'
      - $ref: '#/components/parameters/PaginationTokenQueryParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: A list of job objects.
          headers:
            opc-next-page:
              description: 'Retrieves the next page of results. When this header appears in the response, additional pages of results remain. 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/JobCollection'
        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/DefaultError'
      summary: Returns a list of jobs within a data catalog.
      tags:
      - dataCatalog
      x-obmcs-client-retries-enabled: true
    post:
      description: Creates a new job.
      operationId: CreateJob
      parameters:
      - $ref: '#/components/parameters/CatalogIdentifierPathParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/RetryTokenHeader'
      responses:
        200:
          description: The job was successfully created.
          headers:
            etag:
              description: 'For optimistic concurrency control. See [ETags for Optimistic Concurrency Control](/iaas/Content/API/Concepts/usingapi.htm#eleven).

                '
              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/Job'
        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/DefaultError'
      summary: Create a new job.
      tags:
      - dataCatalog
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateJobDetails'
        description: The information used to create the job.
        required: true
  /catalogs/{catalogId}/jobs/{jobKey}:
    delete:
      description: Deletes a specific job identified by it's key.
      operationId: DeleteJob
      parameters:
      - $ref: '#/components/parameters/CatalogIdentifierPathParam'
      - $ref: '#/components/parameters/JobKeyPathParam'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        204:
          description: The job was successfully 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'
        409:
          $ref: '#/components/responses/409'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/DefaultError'
      summary: Delete a specific job identified by it's key.
      tags:
      - dataCatalog
      x-related-resource: '#/definitions/Job'
    get:
      description: Gets a specific job by key within a data catalog.
      operationId: GetJob
      parameters:
      - $ref: '#/components/parameters/CatalogIdentifierPathParam'
      - $ref: '#/components/parameters/JobKeyPathParam'
      - $ref: '#/components/parameters/JobFieldsQueryParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: Retrieves the job with the given key.
          headers:
            etag:
              description: 'For optimistic concurrency control. See [ETags for Optimistic Concurrency Control](/iaas/Content/API/Concepts/usingapi.htm#eleven).

                '
              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/Job'
        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/DefaultError'
      summary: Get a specific job by key within a data catalog.
      tags:
      - dataCatalog
      x-obmcs-client-retries-enabled: true
    put:
      description: Updates a specific job identified by the given key.
      operationId: UpdateJob
      parameters:
      - $ref: '#/components/parameters/CatalogIdentifierPathParam'
      - $ref: '#/components/parameters/JobKeyPathParam'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: The job was successfully updated.
          headers:
            etag:
              description: 'For optimistic concurrency control. See [ETags for Optimistic Concurrency Control](/iaas/Content/API/Concepts/usingapi.htm#eleven).

                '
              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/Job'
        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/DefaultError'
      summary: Update a specific job identified by the given key.
      tags:
      - dataCatalog
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateJobDetails'
        description: The information to be updated in the job.
        required: true
  /catalogs/{catalogId}/jobs/{jobKey}/executions:
    get:
      description: Returns a list of job executions for a job.
      operationId: ListJobExecutions
      parameters:
      - $ref: '#/components/parameters/CatalogIdentifierPathParam'
      - $ref: '#/components/parameters/JobKeyPathParam'
      - $ref: '#/components/parameters/JobExecutionLifecycleStateQueryParam'
      - $ref: '#/components/parameters/TimeCreatedQueryParam'
      - $ref: '#/components/parameters/TimeUpdatedQueryParam'
      - $ref: '#/components/parameters/CreatedByIdentifierQueryParam'
      - $ref: '#/components/parameters/UpdatedByIdentifierQueryParam'
      - $ref: '#/components/parameters/JobTypeQueryParam'
      - $ref: '#/components/parameters/JobExecutionSubTypeQueryParam'
      - $ref: '#/components/parameters/JobExecutionParentKeyQueryParam'
      - $ref: '#/components/parameters/JobExecutionTimeStartedQueryParam'
      - $ref: '#/components/parameters/JobExecutionTimeEndedQueryParam'
      - $ref: '#/components/parameters/JobExecutionErrorCodeQueryParam'
      - $ref: '#/components/parameters/JobExecutionErrorMessageQueryParam'
      - $ref: '#/components/parameters/JobExecutionProcessKeyQueryParam'
      - $ref: '#/components/parameters/JobExecutionExternalUrlQueryParam'
      - $ref: '#/components/parameters/JobExecutionEventKeyQueryParam'
      - $ref: '#/components/parameters/EntityKeyQueryParam'
      - $ref: '#/components/parameters/JobExecutionSummaryFieldsQueryParam'
      - $ref: '#/components/parameters/SortByTimeCreatedOnlyQueryParam'
      - $ref: '#/components/parameters/SortOrderQueryParam'
      - $ref: '#/components/parameters/PaginationLimitQueryParam'
      - $ref: '#/components/parameters/PaginationTokenQueryParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: A list of job execution objects.
          headers:
            opc-next-page:
              description: 'Retrieves the next page of results. When this header appears in the response, additional pages of results remain. 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/JobExecutionCollection'
        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/DefaultError'
      summary: Returns a list of job executions for a job.
      tags:
      - dataCatalog
      x-obmcs-client-retries-enabled: true
    post:
      description: Creates a new job execution.
      operationId: CreateJobExecution
      parameters:
      - $ref: '#/components/parameters/CatalogIdentifierPathParam'
      - $ref: '#/components/parameters/JobKeyPathParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/RetryTokenHeader'
      responses:
        200:
          description: The job execution was successfully created.
          headers:
            etag:
              description: 'For optimistic concurrency control. See [ETags for Optimistic Concurrency Control](/iaas/Content/API/Concepts/usingapi.htm#eleven).

                '
              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/JobExecution'
        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/DefaultError'
      summary: Create a new job execution.
      tags:
      - dataCatalog
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateJobExecutionDetails'
        description: The information used to create the job execution.
        required: true
  /catalogs/{catalogId}/jobs/{jobKey}/executions/{jobExecutionKey}:
    get:
      description: Gets a specific job execution by key.
      operationId: GetJobExecution
      parameters:
      - $ref: '#/components/parameters/CatalogIdentifierPathParam'
      - $ref: '#/components/parameters/JobKeyPathParam'
      - $ref: '#/components/parameters/JobExecutionKeyPathParam'
      - $ref: '#/components/parameters/JobExecutionFieldsQueryParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: Retrieves the job execution with the given key.
          headers:
            etag:
              description: 'For optimistic concurrency control. See [ETags for Optimistic Concurrency Control](/iaas/Content/API/Concepts/usingapi.htm#eleven).

                '
              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/JobExecution'
        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/DefaultError'
      summary: Get a specific job execution by key.
      tags:
      - dataCatalog
      x-obmcs-client-retries-enabled: true
  /catalogs/{catalogId}/jobs/{jobKey}/executions/{jobExecutionKey}/logs:
    get:
      description: Returns a list of job logs.
      operationId: ListJobLogs
      parameters:
      - $ref: '#/components/parameters/CatalogIdentifierPathParam'
      - $ref: '#/components/parameters/JobKeyPathParam'
      - $ref: '#/components/parameters/JobExecutionKeyPathParam'
      - $ref: '#/components/parameters/LifecycleStateQueryParam'
      - $ref: '#/components/parameters/JobLogSeverityQueryParam'
      - $ref: '#/components/parameters/TimeCreatedQueryParam'
      - $ref: '#/components/parameters/TimeUpdatedQueryParam'
      - $ref: '#/components/parameters/CreatedByIdentifierQueryParam'
      - $ref: '#/components/parameters/UpdatedByIdentifierQueryParam'
      - $ref: '#/components/parameters/JobLogSummaryFieldsQueryParam'
      - $ref: '#/components/parameters/SortByQueryParam'
      - $ref: '#/components/parameters/SortOrderQueryParam'
      - $ref: '#/components/parameters/PaginationLimitQueryParam'
      - $ref: '#/components/parameters/PaginationTokenQueryParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: A list of job log objects.
          headers:
            opc-next-page:
              description: 'Retrieves the next page of results. When this header appears in the response, additional pages of results remain. 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/JobLogCollection'
        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/DefaultError'
      summary: Returns a list of job logs.
      tags:
      - dataCatalog
      x-obmcs-client-retries-enabled: true
  /catalogs/{catalogId}/jobs/{jobKey}/executions/{jobExecutionKey}/logs/{jobLogKey}:
    get:
      description: Gets a specific job log by key.
      operationId: GetJobLog
      parameters:
      - $ref: '#/components/parameters/CatalogIdentifierPathParam'
      - $ref: '#/components/parameters/JobKeyPathParam'
      - $ref: '#/components/parameters/JobExecutionKeyPathParam'
      - $ref: '#/components/parameters/JobLogKeyPathParam'
      - $ref: '#/components/parameters/JobLogFieldsQueryParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: Retrieves the job log with the given key.
          headers:
            etag:
              description: 'For optimistic concurrency control. See [ETags for Optimistic Concurrency Control](/iaas/Content/API/Concepts/usingapi.htm#eleven).

                '
              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/JobLog'
        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/DefaultError'
      summary: Get a specific job log by key.
      tags:
      - dataCatalog
      x-obmcs-client-retries-enabled: true
  /catalogs/{catalogId}/jobs/{jobKey}/executions/{jobExecutionKey}/metrics:
    get:
      description: Returns a list of job metrics.
      operationId: ListJobMetrics
      parameters:
      - $ref: '#/components/parameters/CatalogIdentifierPathParam'
      - $ref: '#/components/parameters/JobKeyPathParam'
      - $ref: '#/components/parameters/JobExecutionKeyPathParam'
      - $ref: '#/components/parameters/DisplayNameQueryParam'
      - $ref: '#/components/parameters/DisplayNameContainsQueryParam'
      - $ref: '#/components/parameters/JobMetricCategoryQueryParam'
      - $ref: '#/components/parameters/JobMetricSubCategoryQueryParam'
      - $ref: '#/components/parameters/JobMetricUnitQueryParam'
      - $ref: '#/components/parameters/JobMetricValueQueryParam'
      - $ref: '#/components/parameters/JobMetricBatchKeyQueryParam'
      - $ref: '#/components/parameters/TimeCreatedQueryParam'
      - $ref: '#/components/parameters/TimeUpdatedQueryParam'
      - $ref: '#/components/parameters/TimeInsertedQueryParam'
      - $ref: '#/components/parameters/CreatedByIdentifierQueryParam'
      - $ref: '#/components/parameters/UpdatedByIdentifierQueryParam'
      - $ref: '#/components/parameters/JobMetricSummaryFieldsQueryParam'
      - $ref: '#/components/parameters/SortByQueryParam'
      - $ref: '#/components/parameters/SortOrderQueryParam'
      - $ref: '#/components/parameters/PaginationLimitQueryParam'
      - $ref: '#/components/parameters/PaginationTokenQueryParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: A list of job metrics objects.
          headers:
            opc-next-page:
              description: 'Retrieves the next page of results. When this header appears in the response, additional pages of results remain. 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/JobMetricCollection'
        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/DefaultError'
      summary: Returns a list of job metrics.
      tags:
      - dataCatalog
      x-obmcs-client-retries-enabled: true
  /catalogs/{catalogId}/jobs/{jobKey}/executions/{jobExecutionKey}/metrics/{jobMetricsKey}:
    get:
      description: Gets a specific job metric by key.
      operationId: GetJobMetrics
      parameters:
      - $ref: '#/components/parameters/CatalogIdentifierPathParam'
      - $ref: '#/components/parameters/JobKeyPathParam'
      - $ref: '#/components/parameters/JobExecutionKeyPathParam'
      - $ref: '#/components/parameters/JobMetricsKeyPathParam'
      - $ref: '#/components/parameters/JobMetricFieldsQueryParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: Retrieves the job metrics with the given key.
          headers:
            etag:
              description: 'For optimistic concurrency control. See [ETags for Optimistic Concurrency Control](/iaas/Content/API/Concepts/usingapi.htm#eleven).

                '
              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/JobMetric'
        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/DefaultError'
      summary: Get a specific job metric by key.
      tags:
      - dataCatalog
      x-obmcs-client-retries-enabled: true
  /catalogs/{catalogId}/namespaces:
    get:
      description: Returns a list of namespaces within a data catalog.
      operationId: ListNamespaces
      parameters:
      - $ref: '#/components/parameters/CatalogIdentifierPathParam'
      - $ref: '#/components/parameters/DisplayNameQueryParam'
      - $ref: '#/components/parameters/DisplayNameContainsQueryParam'
      - $ref: '#/components/parameters/LifecycleStateQueryParam'
      - $ref: '#/components/parameters/TimeCreatedQueryParam'
      - $ref: '#/components/parameters/TimeUpdatedQueryParam'
      - $ref: '#/components/parameters/CreatedByIdentifierQueryParam'
      - $ref: '#/components/parameters/UpdatedByIdentifierQueryParam'
      - $ref: '#/components/parameters/SortByQueryParam'
      - $ref: '#/components/parameters/SortOrderQueryParam'
      - $ref: '#/components/parameters/NamespaceSummaryFieldsQueryParam'
      - $ref: '#/components/parameters/PaginationLimitQueryParam'
      - $ref: '#/components/parameters/PaginationTokenQueryParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: A list of Namespace objects.
          headers:
            opc-next-page:
              description: 'Retrieves the next page of results. When this header appears in the response, additional pages of results remain. 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/NamespaceCollection'
        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/DefaultError'
      summary: Returns a list of namespaces within a data catalog.
      tags:
      - dataCatalog
      x-obmcs-client-retries-enabled: true
      x-related-resource: '#/definitions/Namespace'
    post:
      description: Create a new Namespace to be used by a custom property
      operationId: CreateNamespace
      parameters:
      - $ref: '#/components/parameters/CatalogIdentifierPathParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/RetryTokenHeader'
      responses:
        200:
          description: The Namespace was successfully created.
          headers:
            etag:
              description: 'For optimistic concurrency control. See [ETags for Optimistic Concurrency Control](/iaas/Content/API/Concepts/usingapi.htm#eleven).

                '
              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/Namespace'
        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/DefaultError'
      summary: Create a new Namespace to be used by a custom property
      tags:
      - dataCatalog
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateNamespaceDetails'
        description: 'The information used to create the Namespace.

          '
        required: true
  /catalogs/{catalogId}/namespaces/{namespaceId}:
    delete:
      description: Deletes a specific Namespace identified by it's key.
      operationId: DeleteNamespace
      parameters:
      - $ref: '#/components/parameters/CatalogIdentifierPathParam'
      - $ref: '#/components/parameters/NamespaceIdentifierPathParam'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        204:
          description: The namespace was successfully 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'
        409:
          $ref: '#/components/responses/409'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/DefaultError'
      summary: Delete a specific Namespace identified by it's key.
      tags:
      - dataCatalog
      x-related-resource: '#/definitions/Namespace'
    get:
      description: Gets a specific namespace for the given key within a data catalog.
      operationId: GetNamespace
      parameters:
      - $ref: '#/components/parameters/CatalogIdentifierPathParam'
      - $ref: '#/components/parameters/NamespaceIdentifierPathParam'
      - $ref: '#/components/parameters/NamespaceFieldsQueryParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: Retrieves the Namespace with the given key.
          headers:
            etag:
              description: 'For optimistic concurrency control. See [ETags for Optimistic Concurrency Control](/iaas/Content/API/Concepts/usingapi.htm#eleven).

                '
              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/Namespace'
        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/DefaultError'
      summary: Get a specific namespace for the given key within a data catalog.
      tags:
      - dataCatalog
      x-obmcs-client-retries-enabled: true
    put:
      description: Updates a specific namespace identified by the given key.
      operationId: UpdateNamespace
      parameters:
      - $ref: '#/components/parameters/CatalogIdentifierPathParam'
      - $ref: '#/components/parameters/NamespaceIdentifierPathParam'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: The namespace was successfully updated.
          headers:
            etag:
              description: 'For optimistic concurrency control. See [ETags for Optimistic Concurrency Control](/iaas/Content/API/Concepts/usingapi.htm#eleven).

                '
              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/Namespace'
        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/DefaultError'
      summary: Update a specific namespace identified by the given key.
      tags:
      - dataCatalog
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateNamespaceDetails'
        description: The information to be updated in the namespace.
        required: true
  /catalogs/{catalogId}/namespaces/{namespaceId}/customProperties:
    get:
      description: Returns a list of custom properties within a data catalog.
      operationId: ListCustomProperties
      parameters:
      - $ref: '#/components/parameters/CatalogIdentifierPathParam'
      - $ref: '#/components/parameters/NamespaceIdentifierPathParam'
      - $ref: '#/components/parameters/DisplayNameQueryParam'
      - $ref: '#/components/parameters/DisplayNameContainsQueryParam'
      - $ref: '#/components/parameters/CustomPropertyDataTypeQueryParam'
      - $ref: '#/components/parameters/CustomPropertyTypeQueryParam'
      - $ref: '#/components/parameters/LifecycleStateQueryParam'
      - $ref: '#/components/parameters/TimeCreatedQueryParam'
      - $ref: '#/components/parameters/TimeUpdatedQueryParam'
      - $ref: '#/components/parameters/CreatedByIdentifierQueryParam'
      - $ref: '#/components/parameters/UpdatedByIdentifierQueryParam'
      - $ref: '#/components/parameters/CustomPropertySummaryFieldsQueryParam'
      - $ref: '#/components/parameters/SortOrderQueryParam'
      - $ref: '#/components/parameters/SortByUsageCountQueryParam'
      - $ref: '#/components/parameters/PaginationLimitQueryParam'
      - $ref: '#/components/parameters/PaginationTokenQueryParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: A list of custom property objects.
          headers:
            opc-next-page:
              description: 'Retrieves the next page of results. When this header appears in the response, additional pages of results remain. 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/CustomPropertyCollection'
        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/DefaultError'
      summary: Returns a list of custom properties within a data catalog.
      tags:
      - dataCatalog
      x-obmcs-client-retries-enabled: true
      x-related-resource: '#/definitions/CustomProperty'
    post:
      description: Create a new Custom Property
      operationId: CreateCustomProperty
      parameters:
      - $ref: '#/components/parameters/CatalogIdentifierPathParam'
      - $ref: '#/components/parameters/NamespaceIdentifierPathParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/RetryTokenHeader'
      responses:
        200:
          description: The Custom Property was successfully created.
          headers:
            etag:
              description: 'For optimistic concurrency control. See [ETags for Optimistic Concurrency Control](/iaas/Content/API/Concepts/usingapi.htm#eleven).

                '
              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/CustomProperty'
        400:
          $ref: '#/components/responses/400'
        404:
          $ref: '#/components/responses/404'
        401:
          $ref: '#/components/responses/401'
        409:
          $ref: '#/components/responses/409'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/DefaultError'
      summary: Create a new Custom Property
      tags:
      - dataCatalog
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateCustomPropertyDetails'
        description: 'The information used to create the Custom Property.

          '
        required: true
  /catalogs/{catalogId}/namespaces/{namespaceId}/customProperties/{customPropertyKey}:
    delete:
      description: Deletes a specific custom property identified by it's key.
      operationId: DeleteCustomProperty
      parameters:
      - $ref: '#/components/parameters/CatalogIdentifierPathParam'
      - $ref: '#/components/parameters/NamespaceIdentifierPathParam'
      - $ref: '#/components/parameters/CustomPropertyKeyPathParam'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        204:
          description: The custom property was successfully 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'
        409:
          $ref: '#/components/responses/409'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/DefaultError'
      summary: Delete a specific custom property identified by it's key.
      tags:
      - dataCatalog
      x-related-resource: '#/definitions/CustomProperty'
    get:
      description: Gets a specific custom property for the given key within a data catalog.
      operationId: GetCustomProperty
      parameters:
      - $ref: '#/components/parameters/CatalogIdentifierPathParam'
      - $ref: '#/components/parameters/NamespaceIdentifierPathParam'
      - $ref: '#/components/parameters/CustomPropertyKeyPathParam'
      - $ref: '#/components/parameters/CustomPropertyFieldsQueryParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: Retrieves the custom property with the given key.
          headers:
            etag:
              description: 'For optimistic concurrency control. See [ETags for Optimistic Concurrency Control](/iaas/Content/API/Concepts/usingapi.htm#eleven).

                '
              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/CustomProperty'
        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/DefaultError'
      summary: Get a specific custom property for the given key within a data catalog.
      tags:
      - dataCatalog
      x-obmcs-client-retries-enabled: true
    put:
      description: Updates a specific custom property identified by the given key.
      operationId: UpdateCustomProperty
      parameters:
      - $ref: '#/components/parameters/CatalogIdentifierPathParam'
      - $ref: '#/components/parameters/NamespaceIdentifierPathParam'
      - $ref: '#/components/parameters/CustomPropertyKeyPathParam'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: The custom property was successfully updated.
          headers:
            etag:
              description: 'For optimistic concurrency control. See [ETags for Optimistic Concurrency Control](/iaas/Content/API/Concepts/usingapi.htm#eleven).

                '
              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/CustomProperty'
        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/DefaultError'
      summary: Update a specific custom property identified by the given key.
      tags:
      - dataCatalog
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateCustomPropertyDetails'
        description: The information to be updated in the custom property.
        required: true
  /catalogs/{catalogId}/patterns:
    get:
      description: Returns a list of patterns within a data catalog.
      operationId: ListPatterns
      parameters:
      - $ref: '#/components/parameters/CatalogIdentifierPathParam'
      - $ref: '#/components/parameters/DisplayNameQueryParam'
      - $ref: '#/components/parameters/DisplayNameContainsQueryParam'
      - $ref: '#/components/parameters/LifecycleStateQueryParam'
      - $ref: '#/components/parameters/TimeCreatedQueryParam'
      - $ref: '#/components/parameters/TimeUpdatedQueryParam'
      - $ref: '#/components/parameters/CreatedByIdentifierQueryParam'
      - $ref: '#/components/parameters/UpdatedByIdentifierQueryParam'
      - $ref: '#/components/parameters/PatternSummaryFieldsQueryParam'
      - $ref: '#/components/parameters/SortByQueryParam'
      - $ref: '#/components/parameters/SortOrderQueryParam'
      - $ref: '#/components/parameters/PaginationLimitQueryParam'
      - $ref: '#/components/parameters/PaginationTokenQueryParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: A list of pattern objects.
          headers:
            opc-next-page:
              description: 'Retrieves the next page of results. When this header appears in the response, additional pages of results remain. 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/PatternCollection'
        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/DefaultError'
      summary: Returns a list of patterns defined in this data catalog.
      tags:
      - dataCatalog
      x-obmcs-client-retries-enabled: true
      x-related-resource: '#/definitions/Pattern'
    post:
      description: Create a new pattern.
      operationId: CreatePattern
      parameters:
      - $ref: '#/components/parameters/CatalogIdentifierPathParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/RetryTokenHeader'
      responses:
        200:
          description: The pattern was successfully created.
          headers:
            etag:
              description: 'For optimistic concurrency control. See [ETags for Optimistic Concurrency Control](/iaas/Content/API/Concepts/usingapi.htm#eleven).

                '
              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/Pattern'
        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/DefaultError'
      summary: Create a new pattern.
      tags:
      - dataCatalog
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreatePatternDetails'
        description: The information used to create the pattern.
        required: true
  /catalogs/{catalogId}/patterns/{patternKey}:
    delete:
      description: Deletes a specific pattern identified by it's key.
      operationId: DeletePattern
      parameters:
      - $ref: '#/components/parameters/CatalogIdentifierPathParam'
      - $ref: '#/components/parameters/PatternKeyPathParam'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        204:
          description: The pattern was successfully 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'
        409:
          $ref: '#/components/responses/409'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/DefaultError'
      summary: Delete a specific pattern identified by it's key.
      tags:
      - dataCatalog
      x-related-resource: '#/definitions/Pattern'
    get:
      description: Gets a specific pattern for the given key within a data catalog.
      operationId: GetPattern
      parameters:
      - $ref: '#/components/parameters/CatalogIdentifierPathParam'
      - $ref: '#/components/parameters/PatternKeyPathParam'
      - $ref: '#/components/parameters/PatternFieldsQueryParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: Retrieves the pattern with the given key.
          headers:
            etag:
              description: 'For optimistic concurrency control. See [ETags for Optimistic Concurrency Control](/iaas/Content/API/Concepts/usingapi.htm#eleven).

                '
              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/Pattern'
        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/DefaultError'
      summary: Get a specific pattern for the given key within a data catalog.
      tags:
      - dataCatalog
      x-obmcs-client-retries-enabled: true
    put:
      description: Updates a specific pattern identified by the given key.
      operationId: UpdatePattern
      parameters:
      - $ref: '#/components/parameters/CatalogIdentifierPathParam'
      - $ref: '#/components/parameters/PatternKeyPathParam'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: The pattern was successfully updated.
          headers:
            etag:
              description: 'For optimistic concurrency control. See [ETags for Optimistic Concurrency Control](/iaas/Content/API/Concepts/usingapi.htm#eleven).

                '
              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/Pattern'
        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/DefaultError'
      summary: Update a specific pattern identified by the given key.
      tags:
      - dataCatalog
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdatePatternDetails'
        description: The information to be updated in the pattern.
        required: true
  /catalogs/{catalogId}/patterns/{patternKey}/actions/listDerivedLogicalEntities:
    post:
      description: List logical entities derived from this pattern.
      operationId: ListDerivedLogicalEntities
      parameters:
      - $ref: '#/components/parameters/CatalogIdentifierPathParam'
      - $ref: '#/components/parameters/PatternKeyPathParam'
      - $ref: '#/components/parameters/DisplayNameContainsQueryParam'
      - $ref: '#/components/parameters/SortByQueryParam'
      - $ref: '#/components/parameters/SortOrderQueryParam'
      - $ref: '#/components/parameters/PaginationLimitQueryParam'
      - $ref: '#/components/parameters/PaginationTokenQueryParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RetryTokenHeader'
      responses:
        200:
          description: The list of logical entities derived from this pattern.
          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/EntityCollection'
        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/DefaultError'
      summary: List the logical entities derived using this pattern usually as part of the harvest.
      tags:
      - dataCatalog
      x-obmcs-client-retries-enabled: true
      x-related-resource: '#/definitions/Pattern'
  /catalogs/{catalogId}/patterns/{patternKey}/actions/validate:
    post:
      description: Validate pattern by deriving file groups representing logical entities using the expression
      operationId: ValidatePattern
      parameters:
      - $ref: '#/components/parameters/CatalogIdentifierPathParam'
      - $ref: '#/components/parameters/PatternKeyPathParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/RetryTokenHeader'
      responses:
        200:
          description: The pattern was validated.
          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/ValidatePatternResult'
        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/DefaultError'
      summary: Validate the pattern based on the expression and input set of files to return file groups and logical entities
      tags:
      - dataCatalog
      x-obmcs-client-retries-enabled: true
      x-related-resource: '#/definitions/Pattern'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ValidatePatternDetails'
        description: The information used to validate the pattern.
        required: true
  /catalogs/{catalogId}/search:
    post:
      description: Returns a list of search results within a data catalog.
      operationId: SearchCriteria
      parameters:
      - $ref: '#/components/parameters/CatalogIdentifierPathParam'
      - $ref: '#/components/parameters/DisplayNameQueryParam'
      - $ref: '#/components/parameters/NameQueryParam'
      - $ref: '#/components/parameters/LifecycleStateQueryParam'
      - $ref: '#/components/parameters/TimeoutQueryParam'
      - $ref: '#/components/parameters/SortByQueryParam'
      - $ref: '#/components/parameters/SortOrderQueryParam'
      - $ref: '#/components/parameters/PaginationLimitQueryParam'
      - $ref: '#/components/parameters/PaginationTokenQueryParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: Search result set.
          headers:
            opc-next-page:
              description: 'Retrieves the next page of results. When this header appears in the response, additional pages of results remain. 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/SearchResultCollection'
        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/DefaultError'
      summary: Returns a list of search results within a data catalog.
      tags:
      - dataCatalog
      x-obmcs-client-retries-enabled: true
      x-related-resource: '#/definitions/SearchResult'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SearchCriteria'
        description: The information used to create an extended search results.
  /catalogs/{catalogId}/tags:
    get:
      description: Returns a list of all user created tags in the system.
      operationId: ListTags
      parameters:
      - $ref: '#/components/parameters/CatalogIdentifierPathParam'
      - $ref: '#/components/parameters/DisplayNameQueryParam'
      - $ref: '#/components/parameters/DisplayNameContainsQueryParam'
      - $ref: '#/components/parameters/LifecycleStateQueryParam'
      - $ref: '#/components/parameters/TermSummaryFieldsQueryParam'
      - $ref: '#/components/parameters/SortByQueryParam'
      - $ref: '#/components/parameters/SortOrderQueryParam'
      - $ref: '#/components/parameters/PaginationLimitQueryParam'
      - $ref: '#/components/parameters/PaginationTokenQueryParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: List of all user tags in the system.
          headers:
            opc-next-page:
              description: 'Retrieves the next page of results. When this header appears in the response, additional pages of results remain. 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/TermCollection'
        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/DefaultError'
      summary: Returns a list of all user created tags in the system.
      tags:
      - dataCatalog
      x-obmcs-client-retries-enabled: true
      x-related-resource: '#/definitions/Term'
  /catalogs/{catalogId}/types:
    get:
      description: Returns a list of all types within a data catalog.
      operationId: ListTypes
      parameters:
      - $ref: '#/components/parameters/CatalogIdentifierPathParam'
      - $ref: '#/components/parameters/NameQueryParam'
      - $ref: '#/components/parameters/LifecycleStateQueryParam'
      - $ref: '#/components/parameters/TypeIsInternalQueryParam'
      - $ref: '#/components/parameters/TypeIsTagQueryParam'
      - $ref: '#/components/parameters/TypeIsApprovedQueryParam'
      - $ref: '#/components/parameters/ExternalDataTypeQueryParam'
      - $ref: '#/components/parameters/TypeCategoryQueryParam'
      - $ref: '#/components/parameters/TypeSummaryFieldsQueryParam'
      - $ref: '#/components/parameters/SortByQueryParam'
      - $ref: '#/components/parameters/SortOrderQueryParam'
      - $ref: '#/components/parameters/PaginationLimitQueryParam'
      - $ref: '#/components/parameters/PaginationTokenQueryParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: A list of type objects.
          headers:
            opc-next-page:
              description: 'Retrieves the next page of results. When this header appears in the response, additional pages of results remain. 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/TypeCollection'
        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/DefaultError'
      summary: Returns a list of all types within a data catalog.
      tags:
      - dataCatalog
      x-obmcs-client-retries-enabled: true
  /catalogs/{catalogId}/types/{typeKey}:
    get:
      description: Gets a specific type by key within a data catalog.
      operationId: GetType
      parameters:
      - $ref: '#/components/parameters/CatalogIdentifierPathParam'
      - $ref: '#/components/parameters/TypeKeyPathParam'
      - $ref: '#/components/parameters/TypeFieldsQueryParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: Retrieves a specific type.
          headers:
            etag:
              description: 'For optimistic concurrency control. See [ETags for Optimistic Concurrency Control](/iaas/Content/API/Concepts/usingapi.htm#eleven).

                '
              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/Type'
        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/DefaultError'
      summary: Get a specific type by key within a data catalog.
      tags:
      - dataCatalog
      x-obmcs-client-retries-enabled: true
  /catalogs/{catalogId}/types/{typeKey}/actions/associateCustomProperties:
    post:
      description: Associate the custom property for the given type
      operationId: AssociateCustomProperty
      parameters:
      - $ref: '#/components/parameters/CatalogIdentifierPathParam'
      - $ref: '#/components/parameters/TypeKeyPathParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RetryTokenHeader'
      responses:
        200:
          description: The custom properties were successfully associated with the type. Returning the type resource with newly added custom properties.
          headers:
            etag:
              description: 'For optimistic concurrency control. See [ETags for Optimistic Concurrency Control](/iaas/Content/API/Concepts/usingapi.htm#eleven).

                '
              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/Type'
        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/DefaultError'
      summary: Associate the custom property for the given type
      tags:
      - dataCatalog
      x-related-resource: '#/definitions/Type'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TypeCustomPropertyDetails'
        description: 'The information used to associate the custom property for the type.

          '
        required: true
  /catalogs/{catalogId}/types/{typeKey}/actions/disassociateCustomProperties:
    post:
      description: Remove the custom property for the given type
      operationId: DisassociateCustomProperty
      parameters:
      - $ref: '#/components/parameters/CatalogIdentifierPathParam'
      - $ref: '#/components/parameters/TypeKeyPathParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RetryTokenHeader'
      responses:
        200:
          description: The custom properties were successfully removed for the type.Returning the type resource with properties removed.
          headers:
            etag:
              description: 'For optimistic concurrency control. See [ETags for Optimistic Concurrency Control](/iaas/Content/API/Concepts/usingapi.htm#eleven).

                '
              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/Type'
        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/DefaultError'
      summary: Remove the custom property for the given type
      tags:
      - dataCatalog
      x-related-resource: '#/definitions/Type'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TypeCustomPropertyDetails'
        description: 'The information used to remove the custom properties.

          '
        required: true
  /metastores:
    get:
      description: 'Returns a list of all metastores in the specified compartment.

        '
      operationId: ListMetastores
      parameters:
      - $ref: '#/components/parameters/CompartmentIdQueryParam'
      - $ref: '#/components/parameters/DisplayNameQueryParam'
      - $ref: '#/components/parameters/PaginationLimitQueryParam'
      - $ref: '#/components/parameters/PaginationTokenQueryParam'
      - $ref: '#/components/parameters/LifecycleStateQueryParam'
      - $ref: '#/components/parameters/SortOrderQueryParam'
      - $ref: '#/components/parameters/SortByQueryParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: A list of metastore summary objects.
          headers:
            opc-next-page:
              description: 'Retrieves the next page of results. When this header appears in the response, additional pages of results remain. 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:
                items:
                  $ref: '#/components/schemas/MetastoreSummary'
                type: array
        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/DefaultError'
      summary: Lists all metastores in the specified compartment.
      tags:
      - dataCatalog
      x-obmcs-client-retries-enabled: true
    post:
      description: 'Creates a new metastore.

        '
      operationId: CreateMetastore
      parameters:
      - $ref: '#/components/parameters/RetryTokenHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        202:
          description: Accepted the request. The metastore 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: 'The OCID of the asynchronous request. Use [GetWorkRequest](/api/#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this OCID to track the status of the asynchronous request.

                '
              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/DefaultError'
      summary: Creates a new metastore.
      tags:
      - dataCatalog
      x-related-resource: '#/definitions/Metastore'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateMetastoreDetails'
        description: Information about a new metastore to be created.
        required: true
  /metastores/{metastoreId}:
    delete:
      description: Deletes a metastore resource by identifier.
      operationId: DeleteMetastore
      parameters:
      - $ref: '#/components/parameters/MetastoreIdentifierPathParam'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        202:
          description: Accepted the request. The metastore 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: 'The OCID of the asynchronous request. Use [GetWorkRequest](/api/#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this OCID to track the status of the asynchronous request.

                '
              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/DefaultError'
      summary: Delete a metastore.
      tags:
      - dataCatalog
      x-related-resource: '#/definitions/Metastore'
    get:
      description: Gets a metastore by identifier.
      operationId: GetMetastore
      parameters:
      - $ref: '#/components/parameters/MetastoreIdentifierPathParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: Retrieves the metastore with the given id.
          headers:
            etag:
              description: 'For optimistic concurrency control. See [ETags for Optimistic Concurrency Control](/iaas/Content/API/Concepts/usingapi.htm#eleven).

                '
              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/Metastore'
        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/DefaultError'
      summary: Get a metastore.
      tags:
      - dataCatalog
      x-obmcs-client-retries-enabled: true
    put:
      description: Updates a metastore resource by identifier.
      operationId: UpdateMetastore
      parameters:
      - $ref: '#/components/parameters/MetastoreIdentifierPathParam'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: The metastore was successfully updated.
          headers:
            etag:
              description: 'For optimistic concurrency control. See [ETags for Optimistic Concurrency Control](/iaas/Content/API/Concepts/usingapi.htm#eleven).

                '
              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/Metastore'
        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/DefaultError'
      summary: Update a metastore.
      tags:
      - dataCatalog
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateMetastoreDetails'
        description: The metastore information to be updated.
        required: true
  /metastores/{metastoreId}/actions/changeCompartment:
    post:
      description: Moves a resource into a different compartment. When provided, 'If-Match' is checked against 'ETag' values of the resource.
      operationId: ChangeMetastoreCompartment
      parameters:
      - $ref: '#/components/parameters/MetastoreIdentifierPathParam'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        202:
          description: Accepted the request. The metastore will be moved.
          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: 'The OCID of the asynchronous request. Use [GetWorkRequest](/api/#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this OCID to track the status of the asynchronous request.

                '
              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/DefaultError'
      summary: Moves a resource into a different compartment. When provided, 'If-Match' is checked against 'ETag' values of the resource.
      tags:
      - dataCatalog
      x-related-resource: '#/definitions/Metastore'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ChangeMetastoreCompartmentDetails'
        description: Information about a change in metastore compartment.
        required: true
  /workRequests:
    get:
      description: 'Lists the work requests in a compartment.

        '
      operationId: ListWorkRequests
      parameters:
      - $ref: '#/components/parameters/CompartmentIdQueryParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/PaginationTokenQueryParam'
      - $ref: '#/components/parameters/PaginationLimitQueryParam'
      responses:
        200:
          description: A list of work request objects.
          headers:
            opc-next-page:
              description: 'Retrieves the next page of results. When this header appears in the response, additional pages of results remain. 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:
                items:
                  $ref: '#/components/schemas/WorkRequest'
                type: array
        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/DefaultError'
      summary: List work requests.
      tags:
      - dataCatalog
      x-obmcs-client-retries-enabled: true
      x-related-resource: '#/definitions/WorkRequest'
  /workRequests/{workRequestId}:
    get:
      description: Gets the status of the work request with the given OCID.
      operationId: GetWorkRequest
      parameters:
      - $ref: '#/components/parameters/WorkRequestIdPathParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: The detail of the work request.
          headers:
            etag:
              description: 'For optimistic concurrency control. See [ETags for Optimistic Concurrency Control](/iaas/Content/API/Concepts/usingapi.htm#eleven).

                '
              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 non-negative integer representing the number of seconds the client should wait

                before polling this endpoint again.

                '
              schema:
                type: integer
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkRequest'
        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/DefaultError'
      summary: Get work request status.
      tags:
      - dataCatalog
      x-obmcs-client-retries-enabled: true
      x-related-resource: '#/definitions/WorkRequest'
  /workRequests/{workRequestId}/errors:
    get:
      description: 'Returns a (paginated) list of errors for a given work request.

        '
      operationId: ListWorkRequestErrors
      parameters:
      - $ref: '#/components/parameters/WorkRequestIdPathParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/PaginationTokenQueryParam'
      - $ref: '#/components/parameters/PaginationLimitQueryParam'
      - $ref: '#/components/parameters/SortByWorkRequestErrorQueryParam'
      - $ref: '#/components/parameters/SortOrderQueryParam'
      responses:
        200:
          description: List of work request errors.
          headers:
            opc-next-page:
              description: 'Retrieves the next page of results. When this header appears in the response, additional pages of results remain. 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:
                items:
                  $ref: '#/components/schemas/WorkRequestError'
                type: array
        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/DefaultError'
      summary: Lists work request errors.
      tags:
      - dataCatalog
      x-obmcs-client-retries-enabled: true
      x-related-resource: '#/definitions/WorkRequestError'
  /workRequests/{workRequestId}/logs:
    get:
      description: 'Returns a (paginated) list of logs for a given work request.

        '
      operationId: ListWorkRequestLogs
      parameters:
      - $ref: '#/components/parameters/WorkRequestIdPathParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/PaginationTokenQueryParam'
      - $ref: '#/components/parameters/PaginationLimitQueryParam'
      - $ref: '#/components/parameters/SortByWorkRequestLogQueryParam'
      - $ref: '#/components/parameters/SortOrderQueryParam'
      responses:
        200:
          description: List of work request logs.
          headers:
            opc-next-page:
              description: 'Retrieves the next page of results. When this header appears in the response, additional pages of results remain. 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:
                items:
                  $ref: '#/components/schemas/WorkRequestLog'
                type: array
        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/DefaultError'
      summary: Lists work request logs.
      tags:
      - dataCatalog
      x-obmcs-client-retries-enabled: true
      x-related-resource: '#/definitions/WorkRequestLog'
components:
  parameters:
    NameQueryParam:
      description: Immutable resource name.
      in: query
      name: name
      required: false
      schema:
        type: string
        maxLength: 255
        minLength: 1
    DataAssetTagSummaryFieldsQueryParam:
      description: 'Specifies the fields to return in a data asset tag summary response.

        '
      in: query
      name: fields
      style: form
      explode: true
      schema:
        type: array
        items:
          enum:
          - key
          - name
          - termKey
          - termPath
          - termDescription
          - lifecycleState
          - timeCreated
          - uri
          - glossaryKey
          - dataAssetKey
          type: string
    UpdatedByIdentifierQueryParam:
      description: OCID of the user who updated the resource.
      in: query
      name: updatedById
      required: false
      schema:
        type: string
        maxLength: 255
        minLength: 1
    SampleDataSizeInMBsQueryParam:
      description: The sample data size in MB, specified as number of rows, for a metadata harvest.
      in: query
      name: sampleDataSizeInMBs
      required: false
      schema:
        type: string
    ConnectionSummaryFieldsQueryParam:
      description: 'Specifies the fields to return in a connection summary response.

        '
      in: query
      name: fields
      style: form
      explode: true
      schema:
        type: array
        items:
          enum:
          - key
          - displayName
          - description
          - dataAssetKey
          - typeKey
          - timeCreated
          - externalKey
          - lifecycleState
          - isDefault
          - uri
          type: string
    PatternFieldsQueryParam:
      description: 'Specifies the fields to return in a pattern response.

        '
      in: query
      name: fields
      style: form
      explode: true
      schema:
        type: array
        items:
          enum:
          - key
          - displayName
          - description
          - catalogId
          - expression
          - lifecycleState
          - timeCreated
          - timeUpdated
          - createdById
          - updatedById
          - properties
          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
    FolderKeyPathParam:
      description: Unique folder key.
      in: path
      name: folderKey
      required: true
      schema:
        type: string
    TimeUpdatedQueryParam:
      description: Time that the resource was updated. An [RFC3339](https://tools.ietf.org/html/rfc3339) formatted datetime string.
      in: query
      name: timeUpdated
      required: false
      schema:
        type: string
        format: date-time
    JobExecutionTimeEndedQueryParam:
      description: 'Time that the job execution ended or null if the job is still running or hasn''t run yet.

        An [RFC3339](https://tools.ietf.org/html/rfc3339) formatted datetime string.

        '
      in: query
      name: timeEnd
      required: false
      schema:
        type: string
        format: date-time
    TermRelationshipFieldsQueryParam:
      description: 'Specifies the fields to return in a term relationship response.

        '
      in: query
      name: fields
      style: form
      explode: true
      schema:
        type: array
        items:
          enum:
          - key
          - displayName
          - description
          - relatedTermKey
          - relatedTermDisplayName
          - parentTermKey
          - parentTermDisplayName
          - lifecycleState
          - timeCreated
          - uri
          type: string
    IsDefaultQueryParam:
      description: Indicates whether this connection is the default connection.
      in: query
      name: isDefault
      required: false
      schema:
        type: boolean
    JobExecutionLifecycleStateQueryParam:
      description: Job execution lifecycle state.
      in: query
      name: lifecycleState
      required: false
      x-obmcs-top-level-enum: '#/definitions/JobExecutionState'
      schema:
        type: string
        enum:
        - CREATED
        - IN_PROGRESS
        - INACTIVE
        - FAILED
        - SUCCEEDED
        - CANCELED
        - SUCCEEDED_WITH_WARNINGS
    JobExecutionExternalUrlQueryParam:
      description: The a URL of the job for accessing this resource and its status.
      in: query
      name: externalUrl
      required: false
      schema:
        type: string
    LifecycleStateQueryParam:
      description: A filter to return only resources that match the specified lifecycle state. The value is case insensitive.
      in: query
      name: lifecycleState
      required: false
      x-obmcs-top-level-enum: '#/definitions/LifecycleState'
      schema:
        type: string
        enum:
        - CREATING
        - ACTIVE
        - INACTIVE
        - UPDATING
        - DELETING
        - DELETED
        - FAILED
        - MOVING
    AttributeKeyPathParam:
      description: Unique attribute key.
      in: path
      name: attributeKey
      required: true
      schema:
        type: string
    DisplayNameContainsQueryParam:
      description: 'A filter to return only resources that match display name pattern given. The match is not case sensitive.

        For Example : /folders?displayNameContains=Cu.*

        The above would match all folders with display name that starts with "Cu" or has the pattern "Cu" anywhere in between.

        '
      in: query
      name: displayNameContains
      schema:
        type: string
        maxLength: 255
        minLength: 1
    JobExecutionKeyPathParam:
      description: The key of the job execution.
      in: path
      name: jobExecutionKey
      required: true
      schema:
        type: string
    JobLogKeyPathParam:
      description: Unique job log key.
      in: path
      name: jobLogKey
      required: true
      schema:
        type: string
    NamespaceSummaryFieldsQueryParam:
      description: 'Specifies the fields to return in a namespace summary response.

        '
      in: query
      name: fields
      style: form
      explode: true
      schema:
        type: array
        items:
          enum:
          - key
          - displayName
          - description
          - lifecycleState
          - timeCreated
          type: string
    GlossarySummaryFieldsQueryParam:
      description: 'Specifies the fields to return in a glossary summary response.

        '
      in: query
      name: fields
      style: form
      explode: true
      schema:
        type: array
        items:
          enum:
          - key
          - displayName
          - description
          - catalogId
          - lifecycleState
          - timeCreated
          - uri
          - workflowStatus
          type: string
    JobMetricsKeyPathParam:
      description: Unique job metrics key.
      in: path
      name: jobMetricsKey
      required: true
      schema:
        type: string
    PositionQueryParam:
      description: Position of the attribute in the record definition.
      in: query
      name: position
      required: false
      schema:
        type: integer
        format: int32
    RecommendationTypeQueryParam:
      description: A filter used to return only recommendations of the specified type.
      in: query
      name: recommendationType
      required: true
      style: form
      explode: true
      schema:
        type: array
        items:
          enum:
          - LINK_GLOSSARY_TERM
          type: string
          x-obmcs-top-level-enum: '#/definitions/RecommendationType'
    ExportGlossaryRelationshipQueryParam:
      description: Specify if the relationship metadata is exported for the glossary.
      in: query
      name: isRelationshipExported
      required: false
      schema:
        type: boolean
        default: false
    ScaleQueryParam:
      description: Scale of the attribute value usually applies to float data type.
      in: query
      name: scale
      required: false
      schema:
        type: integer
        format: int32
    IsIncludePropertiesQueryParam:
      description: Indicates whether the properties map will be provided in the response.
      in: query
      name: isIncludeProperties
      required: false
      schema:
        type: boolean
        default: false
    JobExecutionStateQueryParam:
      description: Job execution state.
      in: query
      name: jobExecutionState
      required: false
      x-obmcs-top-level-enum: '#/definitions/JobExecutionState'
      schema:
        type: string
        enum:
        - CREATED
        - IN_PROGRESS
        - INACTIVE
        - FAILED
        - SUCCEEDED
        - CANCELED
        - SUCCEEDED_WITH_WARNINGS
    JobExecutionSubTypeQueryParam:
      description: Sub-type of this job execution.
      in: query
      name: subType
      required: false
      schema:
        type: string
    TermKeyQueryParam:
      description: Unique key of the related term.
      in: query
      name: termKey
      required: false
      schema:
        type: string
    TimeInsertedQueryParam:
      description: 'The time the metric was logged or captured in the system where the job executed.

        An [RFC3339](https://tools.ietf.org/html/rfc3339) formatted datetime string.

        '
      in: query
      name: timeInserted
      required: false
      schema:
        type: string
        format: date-time
    JobMetricValueQueryParam:
      description: Value of this metric.
      in: query
      name: value
      required: false
      schema:
        type: string
    CustomPropertyKeyPathParam:
      description: Unique Custom Property key
      in: path
      name: customPropertyKey
      required: true
      schema:
        type: string
    PatternKeyPathParam:
      description: Unique pattern key.
      in: path
      name: patternKey
      required: true
      schema:
        type: string
    DisplayOrBusinessNameContainsQueryParam:
      description: 'A filter to return only resources that match display name or business name pattern given. The match is not case sensitive.

        For Example : /folders?displayOrBusinessNameContains=Cu.*

        The above would match all folders with display name or business name that starts with "Cu" or has the pattern "Cu" anywhere in between.

        '
      in: query
      name: displayOrBusinessNameContains
      schema:
        type: string
        maxLength: 255
        minLength: 1
    CustomPropertyDataTypeQueryParam:
      description: 'Return the custom properties which has specified data types

        '
      in: query
      name: dataTypes
      style: form
      explode: true
      schema:
        type: array
        items:
          enum:
          - TEXT
          - RICH_TEXT
          - BOOLEAN
          - NUMBER
          - DATE
          type: string
          x-obmcs-top-level-enum: '#/definitions/CustomPropertyDataType'
    IsIncrementalDataQueryParam:
      description: Identifies whether this attribute can be used as a watermark to extract incremental data.
      in: query
      name: isIncrementalData
      required: false
      schema:
        type: boolean
    TypeCategoryQueryParam:
      description: Indicates the category of this type . For example, data assets or connections.
      in: query
      name: typeCategory
      schema:
        type: string
    CustomPropertySummaryFieldsQueryParam:
      description: 'Specifies the fields to return in a custom property summary response.

        '
      in: query
      name: fields
      style: form
      explode: true
      schema:
        type: array
        items:
          enum:
          - key
          - displayName
          - description
          - dataType
          - namespaceName
          - lifecycleState
          - timeCreated
          type: string
    IsMissingValueIgnoredQueryParam:
      description: Specify whether to ignore the missing values in the import file.
      in: query
      name: isMissingValueIgnored
      required: false
      schema:
        type: boolean
        default: true
    JobMetricSummaryFieldsQueryParam:
      description: 'Specifies the fields to return in a job metric summary response.

        '
      in: query
      name: fields
      style: form
      explode: true
      schema:
        type: array
        items:
          enum:
          - key
          - description
          - displayName
          - timeInserted
          - category
          - subCategory
          - unit
          - value
          - batchKey
          - jobExecutionKey
          - timeCreated
          - uri
          type: string
    PaginationLimitQueryParam:
      description: The maximum number of items to return.
      in: query
      name: limit
      schema:
        type: integer
        maximum: 1000
        minimum: 1
    JobMetricSubCategoryQueryParam:
      description: Sub category of this metric under the category. Used for aggregating values. May be null.
      in: query
      name: subCategory
      required: false
      schema:
        type: string
    JobFieldsQueryParam:
      description: 'Specifies the fields to return in a job response.

        '
      in: query
      name: fields
      style: form
      explode: true
      schema:
        type: array
        items:
          enum:
          - key
          - displayName
          - description
          - catalogId
          - lifecycleState
          - timeCreated
          - timeUpdated
          - jobType
          - scheduleCronExpression
          - timeScheduleBegin
          - timeScheduleEnd
          - scheduleType
          - connectionKey
          - jobDefinitionKey
          - internalVersion
          - executionCount
          - timeOfLatestExecution
          - executions
          - createdById
          - updatedById
          - uri
          - jobDefinitionName
          - errorCode
          - errorMessage
          type: string
    DataAssetFieldsQueryParam:
      description: 'Specifies the fields to return in a data asset response.

        '
      in: query
      name: fields
      style: form
      explode: true
      schema:
        type: array
        items:
          enum:
          - key
          - displayName
          - description
          - catalogId
          - externalKey
          - typeKey
          - lifecycleState
          - timeCreated
          - timeUpdated
          - createdById
          - updatedById
          - uri
          - properties
          type: string
    IsAllowedToHaveChildTermsQueryParam:
      description: Indicates whether a term may contain child terms.
      in: query
      name: isAllowedToHaveChildTerms
      required: false
      schema:
        type: boolean
    SortByUsageCountQueryParam:
      description: 'The field to sort by. Only one sort order may be provided. Default order for USAGECOUNT and DISPLAYNAME is Ascending

        '
      in: query
      name: sortBy
      schema:
        type: string
        enum:
        - DISPLAYNAME
        - USAGECOUNT
    TypeKeyPathParam:
      description: Unique type key.
      in: path
      name: typeKey
      required: true
      schema:
        type: string
    InputTextQueryParam:
      description: 'Text input string used for computing potential matching suggestions.

        '
      in: query
      name: inputText
      required: true
      schema:
        type: string
    ParentTermKeyQueryParam:
      description: Unique key of the parent term.
      in: query
      name: parentTermKey
      required: false
      schema:
        type: string
    CatalogPrivateEndpointIdentifierPathParam:
      description: Unique private reverse connection identifier.
      in: path
      name: catalogPrivateEndpointId
      required: true
      schema:
        type: string
    SuggestionLimitQueryParam:
      description: 'Limit for the list of potential matches returned from the Suggest API. If not specified, will default to 10.

        '
      in: query
      name: limit
      required: false
      schema:
        type: integer
        format: int32
        default: 10
        maximum: 30
    JobKeyPathParam:
      description: Unique job key.
      in: path
      name: jobKey
      required: true
      schema:
        type: string
    SortOrderQueryParam:
      description: The sort order to use, either 'asc' or 'desc'.
      in: query
      name: sortOrder
      schema:
        type: string
        enum:
        - ASC
        - DESC
    JobMetricUnitQueryParam:
      description: Unit of this metric.
      in: query
      name: unit
      required: false
      schema:
        type: string
    EntityKeyQueryParam:
      description: Unique entity key.
      in: query
      name: dataEntityKey
      required: false
      schema:
        type: string
    IsIncrementalQueryParam:
      description: Whether job definition is an incremental harvest (true) or a full harvest (false).
      in: query
      name: isIncremental
      required: false
      schema:
        type: boolean
    ParentFolderKeyQueryParam:
      description: Unique folder key.
      in: query
      name: parentFolderKey
      required: false
      schema:
        type: string
    BusinessNameQueryParam:
      description: A filter to return only resources that match the entire business name given. The match is not case sensitive.
      in: query
      name: businessName
      schema:
        type: string
        maxLength: 255
        minLength: 1
    DataAssetKeyPathParam:
      description: Unique data asset key.
      in: path
      name: dataAssetKey
      required: true
      schema:
        type: string
    TypeIsApprovedQueryParam:
      description: Indicates whether the type is approved for use as a classifying object.
      in: query
      name: isApproved
      schema:
        type: string
    JobLogFieldsQueryParam:
      description: 'Specifies the fields to return in a job log response.

        '
      in: query
      name: fields
      style: form
      explode: true
      schema:
        type: array
        items:
          enum:
          - key
          - jobExecutionKey
          - createdById
          - updatedById
          - timeUpdated
          - timeCreated
          - severity
          - logMessage
          - uri
          type: string
    SortByExecutionTimeQueryParam:
      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. Default order for TIMELATESTEXECUTIONSTARTED is descending. If no value is specified TIMECREATED is default.

        '
      in: query
      name: sortBy
      schema:
        type: string
        enum:
        - TIMECREATED
        - DISPLAYNAME
        - TIMELATESTEXECUTIONSTARTED
    WorkRequestIdPathParam:
      description: The OCID of the asynchronous request.
      in: path
      name: workRequestId
      required: true
      schema:
        type: string
    IsPartitionQueryParam:
      description: Identifies if an object is a sub object (partition) of a physical or materialized parent object.
      in: query
      name: isPartition
      required: false
      schema:
        type: boolean
    AttributeTagSummaryFieldsQueryParam:
      description: 'Specifies the fields to return in an entity attribute tag summary response.

        '
      in: query
      name: fields
      style: form
      explode: true
      schema:
        type: array
        items:
          enum:
          - key
          - name
          - termKey
          - termPath
          - termDescription
          - lifecycleState
          - timeCreated
          - uri
          - glossaryKey
          - attributeKey
          type: string
    JobExecutionSummaryFieldsQueryParam:
      description: 'Specifies the fields to return in a job execution summary response.

        '
      in: query
      name: fields
      style: form
      explode: true
      schema:
        type: array
        items:
          enum:
          - key
          - jobKey
          - jobType
          - parentKey
          - scheduleInstanceKey
          - lifecycleState
          - timeCreated
          - timeStarted
          - timeEnded
          - uri
          type: string
    JobMetricCategoryQueryParam:
      description: Category of this metric.
      in: query
      name: category
      required: false
      schema:
        type: string
    JobDefinitionKeyPathParam:
      description: Unique job definition key.
      in: path
      name: jobDefinitionKey
      required: true
      schema:
        type: string
    PatternSummaryFieldsQueryParam:
      description: 'Specifies the fields to return in a pattern summary response.

        '
      in: query
      name: fields
      style: form
      explode: true
      schema:
        type: array
        items:
          enum:
          - key
          - displayName
          - description
          - catalogId
          - expression
          - lifecycleState
          - timeCreated
          type: string
    DataAssetTagFieldsQueryParam:
      description: 'Specifies the fields to return in a data asset tag response.

        '
      in: query
      name: fields
      style: form
      explode: true
      schema:
        type: array
        items:
          enum:
          - key
          - name
          - termKey
          - termPath
          - termDescription
          - lifecycleState
          - timeCreated
          - createdById
          - uri
          - dataAssetKey
          type: string
    TypeFieldsQueryParam:
      description: 'Specifies the fields to return in a type response.

        '
      in: query
      name: fields
      style: form
      explode: true
      schema:
        type: array
        items:
          enum:
          - key
          - description
          - name
          - catalogId
          - properties
          - isInternal
          - isTag
          - isApproved
          - typeCategory
          - externalTypeName
          - lifecycleState
          - uri
          type: string
    CompartmentIdQueryParam:
      description: The OCID of the compartment where you want to list resources.
      in: query
      name: compartmentId
      required: true
      schema:
        type: string
    TermPathQueryParam:
      description: Path of the related term.
      in: query
      name: termPath
      required: false
      schema:
        type: string
    HarvestStatusQueryParam:
      description: Harvest status of the harvestable resource as updated by the harvest process.
      in: query
      name: harvestStatus
      required: false
      x-obmcs-top-level-enum: '#/definitions/HarvestStatus'
      schema:
        type: string
        enum:
        - COMPLETE
        - ERROR
        - IN_PROGRESS
        - DEFERRED
    IsProcessQueryParam:
      description: A filter to return only process entities.
      in: query
      name: isProcess
      schema:
        type: boolean
    RuleOriginTypeQueryParam:
      description: Rule origin type used to filter the response to a list rules call.
      in: query
      name: originType
      required: false
      x-obmcs-top-level-enum: '#/definitions/RuleOriginType'
      schema:
        type: string
        enum:
        - SOURCE
        - USER
        - PROFILING
    JobExecutionCountQueryParam:
      description: 'The total number of executions for this job schedule.

        '
      in: query
      name: executionCount
      required: false
      schema:
        type: integer
    IsLogicalQueryParam:
      description: 'Identifies if the object is a physical object (materialized) or virtual/logical object defined on other objects.

        '
      in: query
      name: isLogical
      required: false
      schema:
        type: boolean
    JobDefinitionFieldsQueryParam:
      description: 'Specifies the fields to return in a job definition response.

        '
      in: query
      name: fields
      style: form
      explode: true
      schema:
        type: array
        items:
          enum:
          - key
          - displayName
          - description
          - catalogId
          - jobType
          - isIncremental
          - dataAssetKey
          - connectionKey
          - internalVersion
          - lifecycleState
          - timeCreated
          - timeUpdated
          - createdById
          - updatedById
          - uri
          - isSampleDataExtracted
          - sampleDataSizeInMBs
          - timeLatestExecutionStarted
          - timeLatestExecutionEnded
          - jobExecutionState
          - scheduleType
          - properties
          type: string
    JobTimeScheduleBeginQueryParam:
      description: Date that the schedule should be operational. An [RFC3339](https://tools.ietf.org/html/rfc3339) formatted datetime string.
      in: query
      name: timeScheduleBegin
      required: false
      schema:
        type: string
        format: date-time
    JobExecutionEventKeyQueryParam:
      description: Event that triggered the execution of this job or null.
      in: query
      name: eventKey
      required: false
      schema:
        type: string
    GlossaryKeyPathParam:
      description: Unique glossary key.
      in: path
      name: glossaryKey
      required: true
      schema:
        type: string
    FolderTagFieldsQueryParam:
      description: 'Specifies the fields to return in a folder tag response.

        '
      in: query
      name: fields
      style: form
      explode: true
      schema:
        type: array
        items:
          enum:
          - key
          - name
          - termKey
          - termPath
          - termDescription
          - lifecycleState
          - timeCreated
          - createdById
          - uri
          - folderKey
          type: string
    ImportGlossaryRelationshipQueryParam:
      description: Specify if the relationship metadata is imported for the glossary.
      in: query
      name: isRelationshipImported
      required: false
      schema:
        type: boolean
        default: false
    IsIncludeObjectRelationshipsQueryParam:
      description: Indicates whether the list of objects and their relationships to this object will be provided in the response.
      in: query
      name: isIncludeObjectRelationships
      required: false
      schema:
        type: boolean
        default: false
    RuleSummaryFieldsQueryParam:
      description: 'Specifies the fields to return in a rule summary response.

        '
      in: query
      name: fields
      style: form
      explode: true
      schema:
        type: array
        items:
          enum:
          - key
          - displayName
          - ruleType
          - externalKey
          - referencedFolderKey
          - referencedFolderName
          - referencedEntityKey
          - referencedEntityName
          - referencedRuleKey
          - referencedRuleName
          - originType
          - lifecycleState
          - timeCreated
          - uri
          type: string
    NamespaceIdentifierPathParam:
      description: Unique namespace identifier.
      in: path
      name: namespaceId
      required: true
      schema:
        type: string
    JobMetricFieldsQueryParam:
      description: 'Specifies the fields to return in a job metric response.

        '
      in: query
      name: fields
      style: form
      explode: true
      schema:
        type: array
        items:
          enum:
          - key
          - description
          - displayName
          - timeInserted
          - category
          - subCategory
          - unit
          - value
          - batchKey
          - jobExecutionKey
          - createdById
          - updatedById
          - timeUpdated
          - timeCreated
          - uri
          type: string
    JobLogSummaryFieldsQueryParam:
      description: 'Specifies the fields to return in a job log summary response.

        '
      in: query
      name: fields
      style: form
      explode: true
      schema:
        type: array
        items:
          enum:
          - key
          - jobExecutionKey
          - severity
          - timeCreated
          - logMessage
          - uri
          type: string
    JobExecutionFieldsQueryParam:
      description: 'Specifies the fields to return in a job execution response.

        '
      in: query
      name: fields
      style: form
      explode: true
      schema:
        type: array
        items:
          enum:
          - key
          - jobKey
          - jobType
          - subType
          - parentKey
          - scheduleInstanceKey
          - lifecycleState
          - timeCreated
          - timeStarted
          - timeEnded
          - errorCode
          - errorMessage
          - processKey
          - externalUrl
          - eventKey
          - dataEntityKey
          - createdById
          - updatedById
          - properties
          - uri
          type: string
    JobDefinitionKeyQueryParam:
      description: Unique job definition key.
      in: query
      name: jobDefinitionKey
      required: false
      schema:
        type: string
    TypeIsInternalQueryParam:
      description: Indicates whether the type is internal, making it unavailable for use by metadata elements.
      in: query
      name: isInternal
      required: false
      schema:
        type: string
    TermWorkflowStatusQueryParam:
      description: Status of the approval workflow for this business term in the glossary.
      in: query
      name: workflowStatus
      required: false
      x-obmcs-top-level-enum: '#/definitions/TermWorkflowStatus'
      schema:
        type: string
        enum:
        - NEW
        - APPROVED
        - UNDER_REVIEW
        - ESCALATED
    ConnectionKeyPathParam:
      description: Unique connection key.
      in: path
      name: connectionKey
      required: true
      schema:
        type: string
    MetastoreIdentifierPathParam:
      description: The metastore's OCID.
      in: path
      name: metastoreId
      required: true
      schema:
        type: string
    JobScheduleTypeQueryParam:
      description: Type of the job schedule.
      in: query
      name: scheduleType
      required: false
      x-obmcs-top-level-enum: '#/definitions/JobScheduleType'
      schema:
        type: string
        enum:
        - SCHEDULED
        - IMMEDIATE
    RecommendationStatusQueryParam:
      description: A filter used to return only recommendations having the requested status.
      in: query
      name: recommendationStatus
      required: false
      x-obmcs-top-level-enum: '#/definitions/RecommendationStatus'
      schema:
        type: string
        enum:
        - ACCEPTED
        - REJECTED
        - INFERRED
    GlossaryFieldsQueryParam:
      description: 'Specifies the fields to return in a glossary response.

        '
      in: query
      name: fields
      style: form
      explode: true
      schema:
        type: array
        items:
          enum:
          - key
          - displayName
          - description
          - catalogId
          - lifecycleState
          - timeCreated
          - timeUpdated
          - createdById
          - updatedById
          - owner
          - workflowStatus
          - uri
          type: string
    JobTimeScheduleEndQueryParam:
      description: Date that the schedule should end from being operational. An [RFC3339](https://tools.ietf.org/html/rfc3339) formatted datetime string.
      in: query
      name: timeScheduleEnd
      required: false
      schema:
        type: string
        format: date-time
    TimeoutQueryParam:
      description: 'A search timeout string (for example, timeout=4000ms), bounding the search request to be executed within the

        specified time value and bail with the hits accumulated up to that point when expired.

        Defaults to no timeout.

        '
      in: query
      name: timeout
      required: false
      schema:
        type: string
    TypeKeyQueryParam:
      description: The key of the object type.
      in: query
      name: typeKey
      required: false
      schema:
        type: string
    PathQueryParam:
      description: Full path of the resource for resources that support paths.
      in: query
      name: path
      required: false
      schema:
        type: string
    NamespaceFieldsQueryParam:
      description: 'Specifies the fields to return in a namespace response.

        '
      in: query
      name: fields
      style: form
      explode: true
      schema:
        type: array
        items:
          enum:
          - key
          - displayName
          - description
          - lifecycleState
          - timeCreated
          - timeUpdated
          - createdById
          - updatedById
          - properties
          type: string
    LastJobKeyQueryParam:
      description: Key of the last harvest process to update this resource.
      in: query
      name: lastJobKey
      required: false
      schema:
        type: string
    EntityTagFieldsQueryParam:
      description: 'Specifies the fields to return in an entity tag response.

        '
      in: query
      name: fields
      style: form
      explode: true
      schema:
        type: array
        items:
          enum:
          - key
          - name
          - termKey
          - termPath
          - termDescription
          - lifecycleState
          - timeCreated
          - createdById
          - uri
          - entityKey
          type: string
    FolderKeyQueryParam:
      description: Key of the associated folder.
      in: query
      name: folderKey
      required: false
      schema:
        type: string
    SourceObjectKeyQueryParam:
      description: A filter used to provide the unique identifier of the source object, for which a list of recommendations will be returned for review.
      in: query
      name: sourceObjectKey
      required: true
      schema:
        type: string
        maxLength: 255
        minLength: 1
    JobExecutionErrorMessageQueryParam:
      description: 'Error message returned from the job execution or null if job is still running or didn''t return an error.

        '
      in: query
      name: errorMessage
      required: false
      schema:
        type: string
    ExternalKeyQueryParam:
      description: Unique external identifier of this resource in the external source system.
      in: query
      name: externalKey
      required: false
      schema:
        type: string
    EntitySummaryFieldsQueryParam:
      description: 'Specifies the fields to return in an entity summary response.

        '
      in: query
      name: fields
      style: form
      explode: true
      schema:
        type: array
        items:
          enum:
          - key
          - displayName
          - description
          - dataAssetKey
          - timeCreated
          - timeUpdated
          - updatedById
          - lifecycleState
          - folderKey
          - folderName
          - externalKey
          - path
          - uri
          type: string
    JobExecutionTimeStartedQueryParam:
      description: 'Time that the job execution was started or in the case of a future time, the time when the job will start.

        An [RFC3339](https://tools.ietf.org/html/rfc3339) formatted datetime string.

        '
      in: query
      name: timeStart
      required: false
      schema:
        type: string
        format: date-time
    FolderFieldsQueryParam:
      description: 'Specifies the fields to return in a folder response.

        '
      in: query
      name: fields
      style: form
      explode: true
      schema:
        type: array
        items:
          enum:
          - key
          - displayName
          - description
          - parentFolderKey
          - path
          - dataAssetKey
          - properties
          - externalKey
          - timeCreated
          - timeUpdated
          - createdById
          - updatedById
          - timeExternal
          - lifecycleState
          - harvestStatus
          - lastJobKey
          - uri
          type: string
    AttributeTagFieldsQueryParam:
      description: 'Specifies the fields to return in an entity attribute tag response.

        '
      in: query
      name: fields
      style: form
      explode: true
      schema:
        type: array
        items:
          enum:
          - key
          - name
          - termKey
          - termPath
          - termDescription
          - lifecycleState
          - timeCreated
          - createdById
          - uri
          - attributeKey
          type: string
    DataAssetImportTypeQueryParam:
      description: Type of import.
      in: query
      name: importType
      required: true
      style: form
      explode: true
      schema:
        type: array
        items:
          enum:
          - CUSTOM_PROPERTY_VALUES
          - ALL
          type: string
          x-obmcs-top-level-enum: '#/definitions/DataAssetImportExportTypeFilter'
    IsNullableQueryParam:
      description: Identifies whether this attribute can be assigned null value.
      in: query
      name: isNullable
      required: false
      schema:
        type: boolean
    TimeStatusUpdatedQueryParam:
      description: Time that the resource's status was last updated. An [RFC3339](https://tools.ietf.org/html/rfc3339) formatted datetime string.
      in: query
      name: timeStatusUpdated
      required: false
      schema:
        type: string
        format: date-time
    JobExecutionErrorCodeQueryParam:
      description: 'Error code returned from the job execution or null if job is still running or didn''t return an error.

        '
      in: query
      name: errorCode
      required: false
      schema:
        type: string
    SourceObjectTypeQueryParam:
      description: A filter used to provide the type of the source object, for which a list of recommendations will be returned for review.
      in: query
      name: sourceObjectType
      required: true
      x-obmcs-top-level-enum: '#/definitions/RecommendationResourceType'
      schema:
        type: string
        enum:
        - DATA_ENTITY
        - ATTRIBUTE
        - TERM
        - CATEGORY
    ExternalDataTypeQueryParam:
      description: Data type as defined in an external system.
      in: query
      name: externalTypeName
      required: false
      schema:
        type: string
    FolderSummaryFieldsQueryParam:
      description: 'Specifies the fields to return in a folder summary response.

        '
      in: query
      name: fields
      style: form
      explode: true
      schema:
        type: array
        items:
          enum:
          - key
          - displayName
          - description
          - parentFolderKey
          - path
          - dataAssetKey
          - externalKey
          - timeExternal
          - timeCreated
          - lifecycleState
          - uri
          type: string
    CustomPropertyFieldsQueryParam:
      description: 'Specifies the fields to return in a custom property response.

        '
      in: query
      name: fields
      style: form
      explode: true
      schema:
        type: array
        items:
          enum:
          - key
          - displayName
          - description
          - dataType
          - namespaceName
          - lifecycleState
          - timeCreated
          - timeUpdated
          - createdById
          - updatedById
          - properties
          type: string
    TermFieldsQueryParam:
      description: 'Specifies the fields to return in a term response.

        '
      in: query
      name: fields
      style: form
      explode: true
      schema:
        type: array
        items:
          enum:
          - key
          - displayName
          - description
          - glossaryKey
          - parentTermKey
          - isAllowedToHaveChildTerms
          - path
          - lifecycleState
          - timeCreated
          - timeUpdated
          - createdById
          - updatedById
          - owner
          - workflowStatus
          - uri
          - relatedTerms
          - associatedObjectCount
          - associatedObjects
          type: string
    JobLogSeverityQueryParam:
      description: Severity level for this Log.
      in: query
      name: severity
      required: false
      schema:
        type: string
    TimeExternalQueryParam:
      description: Last modified timestamp of this object in the external system.
      in: query
      name: timeExternal
      required: false
      schema:
        type: string
        format: date-time
    CreatedByIdentifierQueryParam:
      description: OCID of the user who created the resource.
      in: query
      name: createdById
      required: false
      schema:
        type: string
        maxLength: 255
        minLength: 1
    SortByPositionQueryParam:
      description: 'The field to sort by. Only one sort order may be provided. DISPLAYORBUSINESSNAME considers businessName of a given object if set, else its displayName is used.

        Default sort order for TIMECREATED is descending and default sort order for DISPLAYNAME, POSITION and DISPLAYORBUSINESSNAME is ascending. If no order is specified, POSITION is the default.

        '
      in: query
      name: sortBy
      schema:
        type: string
        enum:
        - TIMECREATED
        - DISPLAYNAME
        - POSITION
        - DISPLAYORBUSINESSNAME
    TimeCreatedQueryParam:
      description: Time that the resource was created. An [RFC3339](https://tools.ietf.org/html/rfc3339) formatted datetime string.
      in: query
      name: timeCreated
      required: false
      schema:
        type: string
        format: date-time
    RequestIdHeader:
      description: The client request ID for tracing.
      in: header
      name: opc-request-id
      schema:
        type: string
    FolderTagSummaryFieldsQueryParam:
      description: 'Specifies the fields to return in a folder tag summary response.

        '
      in: query
      name: fields
      style: form
      explode: true
      schema:
        type: array
        items:
          enum:
          - key
          - name
          - termKey
          - termPath
          - termDescription
          - lifecycleState
          - timeCreated
          - uri
          - glossaryKey
          - folderKey
          type: string
    JobTypeQueryParam:
      description: Job type.
      in: query
      name: jobType
      required: false
      x-obmcs-top-level-enum: '#/definitions/JobType'
      schema:
        type: string
        enum:
        - HARVEST
        - PROFILING
        - SAMPLING
        - PREVIEW
        - IMPORT
        - EXPORT
        - IMPORT_GLOSSARY
        - EXPORT_GLOSSARY
        - INTERNAL
        - PURGE
        - IMMEDIATE
        - SCHEDULED
        - IMMEDIATE_EXECUTION
        - SCHEDULED_EXECUTION
        - SCHEDULED_EXECUTION_INSTANCE
        - ASYNC_DELETE
        - IMPORT_DATA_ASSET
        - CREATE_SCAN_PROXY
        - ASYNC_EXPORT_GLOSSARY
        - ASYNC_EXPORT_DATA_ASSET
    EntityTagSummaryFieldsQueryParam:
      description: 'Specifies the fields to return in an entity tag summary response.

        '
      in: query
      name: fields
      style: form
      explode: true
      schema:
        type: array
        items:
          enum:
          - key
          - name
          - termKey
          - termPath
          - termDescription
          - lifecycleState
          - timeCreated
          - uri
          - glossaryKey
          - entityKey
          type: string
    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:
        - TIMECREATED
        - DISPLAYNAME
    DataAssetExportTypeQueryParam:
      description: Type of export.
      in: query
      name: exportType
      required: true
      style: form
      explode: true
      schema:
        type: array
        items:
          enum:
          - CUSTOM_PROPERTY_VALUES
          - ALL
          type: string
          x-obmcs-top-level-enum: '#/definitions/DataAssetImportExportTypeFilter'
    JobLatestExecutionQueryParam:
      description: 'The date and time the most recent execution for this job ,in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339).

        Example: `2019-03-25T21:10:29.600Z`

        '
      in: query
      name: timeOfLatestExecution
      required: false
      schema:
        type: string
        format: date-time
    AttributeFieldsQueryParam:
      description: 'Specifies the fields to return in an entity attribute response.

        '
      in: query
      name: fields
      style: form
      explode: true
      schema:
        type: array
        items:
          enum:
          - key
          - displayName
          - description
          - entityKey
          - lifecycleState
          - timeCreated
          - timeUpdated
          - createdById
          - updatedById
          - externalDataType
          - externalKey
          - isIncrementalData
          - isNullable
          - length
          - position
          - precision
          - scale
          - timeExternal
          - uri
          - properties
          - path
          - minCollectionCount
          - maxCollectionCount
          - datatypeEntityKey
          - externalDatatypeEntityKey
          - parentAttributeKey
          - externalParentAttributeKey
          - typeKey
          type: string
    TermRelationshipKeyPathParam:
      description: Unique glossary term relationship key.
      in: path
      name: termRelationshipKey
      required: true
      schema:
        type: string
    CustomPropertyTypeQueryParam:
      description: A filter to return only resources that match the entire type name given. The match is not case sensitive
      in: query
      name: typeName
      style: form
      explode: true
      schema:
        type: array
        items:
          enum:
          - DATA_ASSET
          - AUTONOMOUS_DATA_WAREHOUSE
          - HIVE
          - KAFKA
          - MYSQL
          - ORACLE_OBJECT_STORAGE
          - AUTONOMOUS_TRANSACTION_PROCESSING
          - ORACLE
          - POSTGRESQL
          - MICROSOFT_AZURE_SQL_DATABASE
          - MICROSOFT_SQL_SERVER
          - IBM_DB2
          - DATA_ENTITY
          - LOGICAL_ENTITY
          - TABLE
          - VIEW
          - ATTRIBUTE
          - FOLDER
          - ORACLE_ANALYTICS_SUBJECT_AREA_COLUMN
          - ORACLE_ANALYTICS_LOGICAL_COLUMN
          - ORACLE_ANALYTICS_PHYSICAL_COLUMN
          - ORACLE_ANALYTICS_ANALYSIS_COLUMN
          - ORACLE_ANALYTICS_SERVER
          - ORACLE_ANALYTICS_CLOUD
          - ORACLE_ANALYTICS_SUBJECT_AREA
          - ORACLE_ANALYTICS_DASHBOARD
          - ORACLE_ANALYTICS_BUSINESS_MODEL
          - ORACLE_ANALYTICS_PHYSICAL_DATABASE
          - ORACLE_ANALYTICS_PHYSICAL_SCHEMA
          - ORACLE_ANALYTICS_PRESENTATION_TABLE
          - ORACLE_ANALYTICS_LOGICAL_TABLE
          - ORACLE_ANALYTICS_PHYSICAL_TABLE
          - ORACLE_ANALYTICS_ANALYSIS
          - DATABASE_SCHEMA
          - TOPIC
          - CONNECTION
          - GLOSSARY
          - TERM
          - CATEGORY
          - FILE
          - BUCKET
          - MESSAGE
          - UNRECOGNIZED_FILE
          type: string
    TermKeyPathParam:
      description: Unique glossary term key.
      in: path
      name: termKey
      required: true
      schema:
        type: string
    GlossaryKeyQueryParam:
      description: Unique glossary key.
      in: query
      name: glossaryKey
      required: false
      schema:
        type: string
    JobExecutionParentKeyQueryParam:
      description: The unique key of the parent execution or null if this job execution has no parent.
      in: query
      name: parentKey
      required: false
      schema:
        type: string
    LengthQueryParam:
      description: Max allowed length of the attribute value.
      in: query
      name: length
      required: false
      schema:
        type: integer
        format: int64
    DisplayNameQueryParam:
      description: A filter to return only resources that match the entire display name given. The match is not case sensitive.
      in: query
      name: displayName
      schema:
        type: string
        maxLength: 255
        minLength: 1
    ConnectionKeyQueryParam:
      description: Unique connection key.
      in: query
      name: connectionKey
      required: false
      schema:
        type: string
    TermRelationshipSummaryFieldsQueryParam:
      description: 'Specifies the fields to return in a term relationship summary response.

        '
      in: query
      name: fields
      style: form
      explode: true
      schema:
        type: array
        items:
          enum:
          - key
          - displayName
          - description
          - relatedTermKey
          - relatedTermDisplayName
          - parentTermKey
          - parentTermDisplayName
          - lifecycleState
          - timeCreated
          - uri
          type: string
    JobLifecycleStateQueryParam:
      description: Job lifecycle state.
      in: query
      name: lifecycleState
      required: false
      x-obmcs-top-level-enum: '#/definitions/JobLifecycleState'
      schema:
        type: string
        enum:
        - ACTIVE
        - INACTIVE
        - EXPIRED
    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
        maxLength: 1024
        minLength: 1
    JobMetricBatchKeyQueryParam:
      description: Batch key for grouping, may be null.
      in: query
      name: batchKey
      required: false
      schema:
        type: string
    CatalogIdentifierPathParam:
      description: Unique catalog identifier.
      in: path
      name: catalogId
      required: true
      schema:
        type: string
    TypeSummaryFieldsQueryParam:
      description: 'Specifies the fields to return in a type summary response.

        '
      in: query
      name: fields
      style: form
      explode: true
      schema:
        type: array
        items:
          enum:
          - key
          - description
          - name
          - catalogId
          - lifecycleState
          - typeCategory
          - uri
          type: string
    RuleTypeQueryParam:
      description: Rule type used to filter the response to a list rules call.
      in: query
      name: ruleType
      required: false
      x-obmcs-top-level-enum: '#/definitions/RuleType'
      schema:
        type: string
        enum:
        - PRIMARYKEY
        - FOREIGNKEY
        - UNIQUEKEY
    AttributeSummaryFieldsQueryParam:
      description: 'Specifies the fields to return in an entity attribute summary response.

        '
      in: query
      name: fields
      style: form
      explode: true
      schema:
        type: array
        items:
          enum:
          - key
          - displayName
          - description
          - entityKey
          - lifecycleState
          - timeCreated
          - externalDataType
          - externalKey
          - length
          - precision
          - scale
          - isNullable
          - uri
          - path
          - minCollectionCount
          - maxCollectionCount
          - datatypeEntityKey
          - externalDatatypeEntityKey
          - parentAttributeKey
          - externalParentAttributeKey
          - position
          - typeKey
          type: string
    EntityKeyPathParam:
      description: Unique entity key.
      in: path
      name: entityKey
      required: true
      schema:
        type: string
    JobScheduleCronExpressionQueryParam:
      description: 'Interval on which the job will be run. Value is specified as a cron-supported time specification "nickname".

        The following subset of those is supported: @monthly, @weekly, @daily, @hourly.

        For metastore sync, an additional option @default is supported, which will schedule jobs at a more granular frequency.

        '
      in: query
      name: scheduleCronExpression
      required: false
      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
    ConnectionFieldsQueryParam:
      description: 'Specifies the fields to return in a connection response.

        '
      in: query
      name: fields
      style: form
      explode: true
      schema:
        type: array
        items:
          enum:
          - key
          - displayName
          - description
          - dataAssetKey
          - typeKey
          - timeCreated
          - timeUpdated
          - createdById
          - updatedById
          - properties
          - externalKey
          - timeStatusUpdated
          - lifecycleState
          - isDefault
          - uri
          type: string
    SortByWorkRequestLogQueryParam:
      description: 'The field to sort by. Only one sort order may be provided. Default order for TIMESTAMP is descending. Default order for MESSAGE is ascending. If no value is specified TIMESTAMP is default.

        '
      in: query
      name: sortBy
      schema:
        type: string
        enum:
        - MESSAGE
        - TIMESTAMP
    SortByTimeCreatedOnlyQueryParam:
      description: 'The field to sort by. Only one sort order may be provided; the default is descending. Use sortOrder query param to specify order.

        '
      in: query
      name: sortBy
      schema:
        type: string
        enum:
        - TIMECREATED
    DataAssetSummaryFieldsQueryParam:
      description: 'Specifies the fields to return in a data asset summary response.

        '
      in: query
      name: fields
      style: form
      explode: true
      schema:
        type: array
        items:
          enum:
          - key
          - displayName
          - description
          - catalogId
          - externalKey
          - typeKey
          - lifecycleState
          - timeCreated
          - uri
          type: string
    TagKeyPathParam:
      description: Unique tag key.
      in: path
      name: tagKey
      required: true
      schema:
        type: string
    DataAssetKeyQueryParam:
      description: Unique data asset key.
      in: query
      name: dataAssetKey
      required: false
      schema:
        type: string
    SortByDisplayOrBusinessNameQueryParam:
      description: 'The field to sort by. Only one sort order may be provided. DISPLAYORBUSINESSNAME considers businessName of a given object if set, else its displayName is used.

        Default sort order for TIMECREATED is descending and default sort order for DISPLAYNAME and DISPLAYORBUSINESSNAME is ascending. If no order is specified, TIMECREATED is the default.

        '
      in: query
      name: sortBy
      schema:
        type: string
        enum:
        - TIMECREATED
        - DISPLAYNAME
        - DISPLAYORBUSINESSNAME
    SortByWorkRequestErrorQueryParam:
      description: 'The field to sort by. Only one sort order may be provided. Default order for TIMESTAMP is descending. Default order for CODE and MESSAGE is ascending. If no value is specified TIMESTAMP is default.

        '
      in: query
      name: sortBy
      schema:
        type: string
        enum:
        - CODE
        - TIMESTAMP
    JobDefinitionSummaryFieldsQueryParam:
      description: 'Specifies the fields to return in a job definition summary response.

        '
      in: query
      name: fields
      style: form
      explode: true
      schema:
        type: array
        items:
          enum:
          - key
          - displayName
          - description
          - catalogId
          - jobType
          - connectionKey
          - lifecycleState
          - timeCreated
          - isSampleDataExtracted
          - uri
          - timeLatestExecutionStarted
          - timeLatestExecutionEnded
          - jobExecutionState
          - scheduleType
          type: string
    TypeIsTagQueryParam:
      description: Indicates whether the type can be used for tagging metadata elements.
      in: query
      name: isTag
      required: false
      schema:
        type: string
    EntityFieldsQueryParam:
      description: 'Specifies the fields to return in an entity response.

        '
      in: query
      name: fields
      style: form
      explode: true
      schema:
        type: array
        items:
          enum:
          - key
          - displayName
          - description
          - dataAssetKey
          - timeCreated
          - timeUpdated
          - createdById
          - updatedById
          - lifecycleState
          - externalKey
          - timeExternal
          - timeStatusUpdated
          - isLogical
          - isPartition
          - folderKey
          - folderName
          - typeKey
          - path
          - harvestStatus
          - lastJobKey
          - uri
          - properties
          type: string
    TermSummaryFieldsQueryParam:
      description: 'Specifies the fields to return in a term summary response.

        '
      in: query
      name: fields
      style: form
      explode: true
      schema:
        type: array
        items:
          enum:
          - key
          - displayName
          - description
          - glossaryKey
          - parentTermKey
          - isAllowedToHaveChildTerms
          - path
          - lifecycleState
          - timeCreated
          - workflowStatus
          - associatedObjectCount
          - uri
          type: string
    PatternKeyQueryParam:
      description: Unique pattern key.
      in: query
      name: patternKey
      required: false
      schema:
        type: string
    PrecisionQueryParam:
      description: Precision of the attribute value usually applies to float data type.
      in: query
      name: precision
      required: false
      schema:
        type: integer
        format: int32
    JobExecutionProcessKeyQueryParam:
      description: Process identifier related to the job execution.
      in: query
      name: processKey
      required: false
      schema:
        type: string
    JobSummaryFieldsQueryParam:
      description: 'Specifies the fields to return in a job summary response.

        '
      in: query
      name: fields
      style: form
      explode: true
      schema:
        type: array
        items:
          enum:
          - key
          - displayName
          - description
          - catalogId
          - jobDefinitionKey
          - lifecycleState
          - timeCreated
          - timeUpdated
          - createdById
          - updatedById
          - jobType
          - scheduleCronExpression
          - timeScheduleBegin
          - scheduleType
          - executionCount
          - timeOfLatestExecution
          - executions
          - uri
          - jobDefinitionName
          - errorCode
          - errorMessage
          type: string
  schemas:
    GlossaryTreeElement:
      allOf:
      - $ref: '#/components/schemas/TermSummary'
      - description: Child terms of the enclosing parent term.
        properties:
          childTerms:
            description: An array of child terms.
            items:
              $ref: '#/components/schemas/GlossaryTreeElement'
            type: array
        type: object
      description: Glossary tree element with child terms.
      type: object
    AttachCatalogPrivateEndpointDetails:
      description: Information about the attaching the private endpoint resource to a catalog
      properties:
        catalogPrivateEndpointId:
          description: The identifier of the private endpoint to be attached to the catalog resource.
          maxLength: 255
          minLength: 1
          type: string
      required:
      - catalogPrivateEndpointId
      type: object
    EntityCollection:
      description: 'Results of a data entities listing. Data entities are representation of a dataset with a set of attributes.

        '
      properties:
        count:
          description: Total number of items returned.
          type: integer
        items:
          description: Collection of data entities.
          items:
            $ref: '#/components/schemas/EntitySummary'
          type: array
      required:
      - items
      type: object
    JobExecution:
      description: A job execution is a unit of work being executed on behalf of a job.
      properties:
        createdById:
          description: OCID of the user who created the job execution.
          maxLength: 255
          minLength: 1
          type: string
        dataEntityKey:
          description: The key of the associated data entity resource.
          maxLength: 255
          minLength: 1
          type: string
        errorCode:
          description: 'Error code returned from the job execution or null if job is still running or didn''t return an error.

            '
          type: string
        errorMessage:
          description: 'Error message returned from the job execution or null if job is still running or didn''t return an error.

            '
          type: string
        eventKey:
          description: 'An identifier used for log message correlation.

            '
          maxLength: 255
          type: string
        externalUrl:
          description: 'If the job is an external process, then a URL of the job for accessing this resource and its status.

            '
          type: string
        jobKey:
          description: The unique key of the parent job.
          maxLength: 255
          minLength: 1
          type: string
        jobType:
          description: Type of the job execution.
          enum:
          - HARVEST
          - PROFILING
          - SAMPLING
          - PREVIEW
          - IMPORT
          - EXPORT
          - IMPORT_GLOSSARY
          - EXPORT_GLOSSARY
          - INTERNAL
          - PURGE
          - IMMEDIATE
          - SCHEDULED
          - IMMEDIATE_EXECUTION
          - SCHEDULED_EXECUTION
          - SCHEDULED_EXECUTION_INSTANCE
          - ASYNC_DELETE
          - IMPORT_DATA_ASSET
          - CREATE_SCAN_PROXY
          - ASYNC_EXPORT_GLOSSARY
          - ASYNC_EXPORT_DATA_ASSET
          type: string
          x-obmcs-top-level-enum: '#/definitions/JobType'
        key:
          description: Unique key of the job execution resource.
          maxLength: 255
          minLength: 1
          type: string
        lifecycleState:
          description: Status of the job execution, such as running, paused, or completed.
          enum:
          - CREATED
          - IN_PROGRESS
          - INACTIVE
          - FAILED
          - SUCCEEDED
          - CANCELED
          - SUCCEEDED_WITH_WARNINGS
          type: string
          x-obmcs-top-level-enum: '#/definitions/JobExecutionState'
        parentKey:
          description: The unique key of the parent execution or null if this job execution has no parent.
          maxLength: 255
          type: string
        processKey:
          description: Process identifier related to the job execution if the job is an external job.
          maxLength: 255
          type: string
        properties:
          additionalProperties:
            additionalProperties:
              description: The string value of the job execution context property.
              type: string
            description: 'Key-value pair representing properties of a job execution scoped to a category.

              Example: `{"host": "host1", "port": "1521", "database": "orcl"}`

              '
            type: object
          description: 'A map of maps that contains the execution context properties which are specific to a job execution. Each job

            execution may define it''s set of required and optional properties. The map keys are category names and the

            values are maps of property name to property value. Every property is contained inside of a category. Most

            job executions have required properties within the "default" category.

            Example: `{"properties": { "default": { "host": "host1", "port": "1521", "database": "orcl"}}}`

            '
          type: object
        scheduleInstanceKey:
          description: The unique key of the triggering external scheduler resource or null if this job execution is not externally triggered.
          maxLength: 255
          type: string
        subType:
          description: Sub-type of this job execution.
          type: string
        timeCreated:
          description: 'The date and time the job execution was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339).

            Example: `2019-03-25T21:10:29.600Z`

            '
          format: date-time
          type: string
        timeEnded:
          description: 'Time that the job execution ended or null if it hasn''t yet completed.

            An [RFC3339](https://tools.ietf.org/html/rfc3339) formatted datetime string.

            '
          format: date-time
          type: string
        timeStarted:
          description: Time that job execution started. An [RFC3339](https://tools.ietf.org/html/rfc3339) formatted datetime string.
          format: date-time
          type: string
        updatedBy:
          description: OCID of the user who updated the job execution.
          maxLength: 255
          minLength: 1
          type: string
        uri:
          description: URI to the job execution instance in the API.
          type: string
      required:
      - key
      type: object
    TermAssociatedObject:
      description: Projection of an object that is tagged to a term.
      properties:
        key:
          description: Immutable key used to uniquely identify the associated object.
          maxLength: 255
          minLength: 1
          type: string
        name:
          description: Name of the associated object.
          maxLength: 255
          type: string
        uri:
          description: URI of the associated object within the data catalog API.
          type: string
      required:
      - key
      type: object
    CreateGlossaryDetails:
      description: Properties used in glossary create operations.
      properties:
        customPropertyMembers:
          description: The list of customized properties along with the values for this object
          items:
            $ref: '#/components/schemas/CustomPropertySetUsage'
          type: array
        description:
          description: Detailed description of the glossary.
          maxLength: 400
          type: string
        displayName:
          description: 'A user-friendly display name. Does not have to be unique, and it''s changeable.

            Avoid entering confidential information.

            '
          maxLength: 255
          minLength: 1
          type: string
        owner:
          description: OCID of the user who is the owner of the glossary.
          maxLength: 255
          minLength: 1
          type: string
        workflowStatus:
          description: Status of the approval process workflow for this business glossary.
          enum:
          - NEW
          - APPROVED
          - UNDER_REVIEW
          - ESCALATED
          type: string
          x-obmcs-top-level-enum: '#/definitions/TermWorkflowStatus'
      required:
      - displayName
      type: object
    TermSummary:
      description: 'Summary of a term. A defined business term in a business glossary. As well as a term definition, simple format

        rules for attributes mapping to the term (for example, the expected data type and length restrictions) may be

        stated at the term level.

        '
      properties:
        associatedObjectCount:
          description: The number of objects tagged with this term.
          type: integer
        description:
          description: Detailed description of the term.
          maxLength: 400
          type: string
        displayName:
          description: 'A user-friendly display name. Does not have to be unique, and it''s changeable.

            Avoid entering confidential information.

            '
          maxLength: 255
          minLength: 1
          type: string
        glossaryKey:
          description: Unique id of the parent glossary.
          maxLength: 255
          minLength: 1
          type: string
        isAllowedToHaveChildTerms:
          default: true
          description: Indicates whether a term may contain child terms.
          type: boolean
        key:
          description: Unique term key that is immutable.
          maxLength: 255
          minLength: 1
          type: string
        lifecycleState:
          description: State of the term.
          enum:
          - CREATING
          - ACTIVE
          - INACTIVE
          - UPDATING
          - DELETING
          - DELETED
          - FAILED
          - MOVING
          type: string
          x-obmcs-top-level-enum: '#/definitions/LifecycleState'
        parentTermKey:
          description: This terms parent term key. Will be null if the term has no parent term.
          maxLength: 255
          type: string
        path:
          description: Absolute path of the term.
          type: string
        timeCreated:
          description: 'The date and time the term was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339).

            Example: `2019-03-25T21:10:29.600Z`

            '
          format: date-time
          type: string
        uri:
          description: URI to the term instance in the API.
          type: string
        workflowStatus:
          description: Status of the approval process workflow for this business term in the glossary.
          enum:
          - NEW
          - APPROVED
          - UNDER_REVIEW
          - ESCALATED
          type: string
          x-obmcs-top-level-enum: '#/definitions/TermWorkflowStatus'
      required:
      - key
      type: object
    CreateFolderDetails:
      description: Properties used in folder create operations.
      properties:
        businessName:
          description: Optional user friendly business name of the folder. If set, this supplements the harvested display name of the object.
          maxLength: 255
          type: string
        customPropertyMembers:
          description: The list of customized properties along with the values for this object
          items:
            $ref: '#/components/schemas/CustomPropertySetUsage'
          type: array
        description:
          description: Detailed description of a folder.
          maxLength: 400
          type: string
        displayName:
          description: 'A user-friendly display name. Does not have to be unique, and it''s changeable.

            Avoid entering confidential information.

            '
          maxLength: 255
          minLength: 1
          type: string
        harvestStatus:
          description: Folder harvesting status.
          enum:
          - COMPLETE
          - ERROR
          - IN_PROGRESS
          - DEFERRED
          type: string
          x-obmcs-top-level-enum: '#/definitions/HarvestStatus'
        lastJobKey:
          description: The job key of the harvest process that updated the folder definition from the source system.
          maxLength: 255
          type: string
          x-default-description: null
        parentFolderKey:
          description: The key of the containing folder or null if there isn't a parent folder.
          maxLength: 255
          type: string
        properties:
          additionalProperties:
            additionalProperties:
              description: The string value of the folder property.
              type: string
            description: 'Key-value pair representing properties of a folder scoped to a category.

              Example: `{"key1": "value1"}`

              '
            type: object
          description: 'A map of maps that contains the properties which are specific to the folder type. Each folder type

            definition defines it''s set of required and optional properties. The map keys are category names and the

            values are maps of property name to property value. Every property is contained inside of a category. Most

            folders have required properties within the "default" category. To determine the set of optional and

            required properties for a folder type, a query can be done on ''/types?type=folder'' that returns a

            collection of all folder types. The appropriate folder type, which includes definitions of all of

            it''s properties, can be identified from this collection.

            Example: `{"properties": { "default": { "key1": "value1"}}}`

            '
          type: object
        timeExternal:
          description: Last modified timestamp of this object in the external system.
          format: date-time
          type: string
        typeKey:
          description: Type key of the object. Type keys can be found via the '/types' endpoint.
          maxLength: 255
          minLength: 1
          type: string
      required:
      - displayName
      - timeExternal
      type: object
    JobMetricCollection:
      description: 'Results of a job metrics listing. Job metrics are datum about a job execution in key value pairs.

        '
      properties:
        count:
          description: Total number of items returned.
          type: integer
        items:
          description: Collection of job metrics.
          items:
            $ref: '#/components/schemas/JobMetricSummary'
          type: array
      required:
      - items
      type: object
    AsynchronousExportDataAssetDetails:
      allOf:
      - $ref: '#/components/schemas/AsynchronousExportRequestDetails'
      - properties:
          exportScope:
            description: Array of objects and their child types to be selected for export.
            items:
              $ref: '#/components/schemas/DataAssetExportScope'
            maxItems: 100
            type: array
        type: object
      description: Details needed by the Data Asset export request.
      type: object
    UpdateTermRelationshipDetails:
      description: Properties used in term relationship update operations.
      properties:
        description:
          description: Detailed description of the term relationship usually defined at the time of creation.
          maxLength: 400
          type: string
        displayName:
          description: 'A user-friendly display name. Is changeable. The combination of ''displayName'' and ''parentTermKey''

            must be unique. Avoid entering confidential information. This is the same as ''relationshipType'' for ''termRelationship''.

            '
          maxLength: 255
          minLength: 1
          type: string
      type: object
    FetchEntityLineageDetails:
      allOf:
      - $ref: '#/components/schemas/ObjectLineageRequestDetails'
      description: The information needed to obtain desired lineage.
      type: object
    CreateMetastoreDetails:
      description: Information about a new metastore.
      properties:
        compartmentId:
          description: OCID of the compartment which holds the metastore.
          maxLength: 255
          minLength: 1
          type: string
        defaultExternalTableLocation:
          description: 'Location under which external tables will be created by default. This references Object Storage

            using an HDFS URI format. Example: oci://bucket@namespace/sub-dir/

            '
          maxLength: 2000
          minLength: 1
          type: string
        defaultManagedTableLocation:
          description: 'Location under which managed tables will be created by default. This references Object Storage

            using an HDFS URI format. Example: oci://bucket@namespace/sub-dir/

            '
          maxLength: 2000
          minLength: 1
          type: string
        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: 'Usage of predefined tag keys. These predefined keys are scoped to namespaces.

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

            '
          type: object
        displayName:
          description: Mutable name of the metastore.
          maxLength: 255
          minLength: 1
          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
      required:
      - compartmentId
      - defaultManagedTableLocation
      - defaultExternalTableLocation
      type: object
    SearchResultCollection:
      description: 'The list of search result items matching the criteria returned from the search operation. Search errors and

        messages, if any , will be part of the standard error response.

        '
      properties:
        count:
          description: Total number of items returned.
          type: integer
        facetedSearchAggregation:
          description: Aggregations/facets on properties of data objects.
          items:
            $ref: '#/components/schemas/FacetedSearchAggregation'
          type: array
        items:
          description: Search result set.
          items:
            $ref: '#/components/schemas/SearchResult'
          type: array
        query:
          description: String that data objects are to be searched with.
          type: string
        sortableFields:
          description: A list of fields or properties used in the sorting of a search result.
          items:
            type: string
          type: array
      type: object
    TermRelationshipCollection:
      description: 'Results of a terms relationship listing. Term relationships are associations between two terms in business glossary.

        '
      properties:
        count:
          description: Total number of items returned.
          type: integer
        items:
          description: Collection of term relationships.
          items:
            $ref: '#/components/schemas/TermRelationshipSummary'
          type: array
      required:
      - items
      type: object
    LineageRelationship:
      description: Declares how two elements of object lineage are related.
      properties:
        fromObjectKey:
          description: Object key of source lineage element.
          maxLength: 255
          minLength: 1
          type: string
        relationshipType:
          description: Type of the relationship.
          maxLength: 255
          minLength: 1
          type: string
        toObjectKey:
          description: Object key of target lineage element.
          maxLength: 255
          minLength: 1
          type: string
      type: object
    UpdateDataAssetDetails:
      description: Properties used in data asset update operations.
      properties:
        customPropertyMembers:
          description: The list of customized properties along with the values for this object
          items:
            $ref: '#/components/schemas/CustomPropertySetUsage'
          type: array
        description:
          description: Detailed description of the data asset.
          maxLength: 400
          type: string
        displayName:
          description: 'A user-friendly display name. Does not have to be unique, and it''s changeable.

            Avoid entering confidential information.

            '
          maxLength: 255
          minLength: 1
          type: string
        properties:
          additionalProperties:
            additionalProperties:
              description: The string value of the data asset property.
              type: string
            description: 'Key-value pair representing properties of a data asset scoped to a category.

              Example: `{"host": "host1", "port": "1521", "database": "orcl"}`

              '
            type: object
          description: 'A map of maps that contains the properties which are specific to the asset type. Each data asset type

            definition defines it''s set of required and optional properties. The map keys are category names and the

            values are maps of property name to property value. Every property is contained inside of a category. Most

            data assets have required properties within the "default" category.

            Example: `{"properties": { "default": { "host": "host1", "port": "1521", "database": "orcl"}}}`

            '
          type: object
      type: object
    FacetedSearchSortRequest:
      description: Object with sort criteria details
      properties:
        sortBy:
          description: Filed name that needs to be sorted by.
          example: timeCreated
          type: string
        sortOrder:
          description: Sort order for search results.
          enum:
          - ASC
          - DESC
          example: ASC
          type: string
      type: object
    SuggestResults:
      description: 'The list of potential matches returned from the suggest operation for the given input text. The size of the list will be determined

        by the limit parameter.

        '
      properties:
        inputText:
          description: Input string for which the potential matches are computed.
          type: string
        items:
          description: List of suggestions.
          items:
            $ref: '#/components/schemas/SuggestListItem'
          maxItems: 30
          type: array
        searchLatencyInMs:
          description: Time taken to compute the result, in milliseconds.
          type: integer
        totalCount:
          description: Total number of items returned.
          type: integer
      required:
      - totalCount
      - inputText
      type: object
    TypeCustomPropertyDetails:
      description: Array of custom property IDs for which we have to associate the custom property to the type
      properties:
        customPropertyIds:
          description: array of custom property Ids
          items:
            type: string
          type: array
        isEventEnabled:
          default: false
          description: If an OCI Event will be emitted when the custom property is modified.
          type: boolean
      type: object
    ExportDataAssetDetails:
      description: The details of what needs to be exported.
      properties:
        exportScope:
          description: Array of objects and their child types to be selected for export.
          items:
            $ref: '#/components/schemas/DataAssetExportScope'
          maxItems: 100
          type: array
      type: object
    UpdateJobDetails:
      description: Job properties that can be updated.
      properties:
        connectionKey:
          description: The key of the connection resource that is used for the harvest by this job.
          maxLength: 255
          minLength: 1
          type: string
        description:
          description: Detailed description of the job.
          maxLength: 400
          type: string
        displayName:
          description: 'A user-friendly display name. Does not have to be unique, and it''s changeable.

            Avoid entering confidential information.

            '
          maxLength: 255
          minLength: 1
          type: string
        scheduleCronExpression:
          description: 'Interval on which the job will be run. Value is specified as a cron-supported time specification "nickname".

            The following subset of those is supported: @monthly, @weekly, @daily, @hourly.

            For metastore sync, an additional option @default is supported, which will schedule jobs at a more granular frequency.

            '
          type: string
        timeScheduleBegin:
          description: Date that the schedule should be operational. An [RFC3339](https://tools.ietf.org/html/rfc3339) formatted datetime string.
          format: date-time
          type: string
        timeScheduleEnd:
          description: Date that the schedule should end from being operational. An [RFC3339](https://tools.ietf.org/html/rfc3339) formatted datetime string.
          format: date-time
          type: string
      type: object
    AsynchronousExportRequestDetails:
      description: Details for an export request.
      properties:
        objectStorageTarget:
          $ref: '#/components/schemas/ObjectStorageObjectReference'
      type: object
    BaseTagSummary:
      description: Represents the association of an object to a term.
      properties:
        glossaryKey:
          description: Unique id of the parent glossary of the term.
          maxLength: 255
          minLength: 1
          type: string
        key:
          description: Unique tag key that is immutable.
          maxLength: 255
          minLength: 1
          type: string
        lifecycleState:
          description: State of the Tag.
          enum:
          - CREATING
          - ACTIVE
          - INACTIVE
          - UPDATING
          - DELETING
          - DELETED
          - FAILED
          - MOVING
          type: string
          x-obmcs-top-level-enum: '#/definitions/LifecycleState'
        name:
          description: Name of the tag that matches the term name.
          maxLength: 255
          minLength: 1
          type: string
        termDescription:
          description: Description of the related term.
          maxLength: 400
          type: string
        termKey:
          description: Unique key of the related term.
          maxLength: 255
          type: string
        termPath:
          description: Path of the related term.
          type: string
        timeCreated:
          description: 'The date and time the tag was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339).

            Example: `2019-03-25T21:10:29.600Z`

            '
          format: date-time
          type: string
        uri:
          description: URI to the tag instance in the API.
          type: string
      required:
      - key
      type: object
    EntityTag:
      allOf:
      - $ref: '#/components/schemas/BaseTag'
      - properties:
          entityKey:
            description: The unique key of the parent entity.
            maxLength: 255
            minLength: 1
            type: string
        type: object
      description: Represents an association of an entity to a term.
      type: object
    UpdateNamespaceDetails:
      description: Properties used in namespace update operations.
      properties:
        description:
          description: Detailed description of the namespace.
          maxLength: 400
          type: string
        displayName:
          description: 'A user-friendly display name. Does not have to be unique, and it''s changeable.

            Avoid entering confidential information.

            '
          maxLength: 255
          minLength: 1
          type: string
        isServiceDefined:
          default: false
          description: If this field is defined by service or by a user
          type: boolean
      type: object
    ImportDataAssetDetails:
      description: Specifies the file contents to be imported.
      properties:
        importFileContents:
          description: The file contents to be imported. File size not to exceed 10 MB.
          format: byte
          type: string
      required:
      - importFileContents
      type: object
    AsynchronousExportGlossaryResult:
      allOf:
      - $ref: '#/components/schemas/AsynchronousExportResult'
      description: Details about the job which performs an export.
      type: object
    ConnectionAliasSummary:
      description: Summary representation of database aliases parsed from the file metadata.
      properties:
        aliasDetails:
          description: 'The description about the database alias parsed from the file metadata.

            '
          type: string
        aliasName:
          description: 'A user-friendly display name. Does not have to be unique, and it''s changeable.

            Avoid entering confidential information.

            '
          maxLength: 255
          minLength: 1
          type: string
      required:
      - aliasName
      type: object
    SearchResult:
      description: 'The search result object is the definition of an element that is returned as part of search. It contains basic

        information about the object such as key, name and description. The search result also contains the list of tags

        for each object along with other contextual information like the data asset root, folder, or entity parents.

        '
      properties:
        attributeType:
          description: Type name of the attribute. For example - complex, primitive, or array.
          maxLength: 255
          type: string
        businessName:
          description: Optional user friendly business name of the data object. If set, this supplements the harvested display name of the object.
          maxLength: 255
          type: string
        createdById:
          description: OCID of the user who created the resource.
          maxLength: 255
          minLength: 1
          type: string
        customProperties:
          description: Custom properties defined by users.
          items:
            $ref: '#/components/schemas/FacetedSearchCustomProperty'
          type: array
        dataAssetKey:
          description: Unique key of the data asset that is the root parent of this object.
          maxLength: 255
          minLength: 1
          type: string
        dataAssetName:
          description: Name of the data asset that is the root parent of this object.
          maxLength: 255
          type: string
        dataAssetType:
          description: Type name of the data asset. For example, Oracle, MySQL or Oracle Object Storage.
          maxLength: 255
          type: string
        description:
          description: Detailed description of the object.
          maxLength: 400
          type: string
        entityName:
          description: Name of the parent entity object if this object is an attribute.
          maxLength: 255
          type: string
        entityType:
          description: Type name of the entity. For example, table, view, external table, file, or object.
          maxLength: 255
          type: string
        entitykey:
          description: Unique key of the entity object if this object is an attribute.
          maxLength: 255
          type: string
        expression:
          description: Expression for logical entities against which names of dataObjects will be matched.
          type: string
        externalDataType:
          description: Data type of the object if the object is an attribute. Null otherwise.
          maxLength: 255
          type: string
        externalTypeName:
          description: Name of the external object type in the host data asset. For example, column, field, table, view, or file.
          maxLength: 255
          type: string
        folderKey:
          description: Unique key of the folder object if this object is a sub folder, entity, or attribute.
          maxLength: 255
          type: string
        folderName:
          description: Name of the parent folder object if this object is a sub folder, entity, or attribute.
          maxLength: 255
          type: string
        folderType:
          description: Type name of the folder. For example, schema, directory, or topic.
          maxLength: 255
          type: string
        glossaryKey:
          description: Unique id of the parent glossary.
          maxLength: 255
          type: string
        glossaryName:
          description: Name of the parent glossary if this object is a term.
          maxLength: 255
          type: string
        key:
          description: Unique key of the object returned as part of the search result.
          maxLength: 255
          minLength: 1
          type: string
        lifecycleState:
          description: The current state of the data object.
          enum:
          - CREATING
          - ACTIVE
          - INACTIVE
          - UPDATING
          - DELETING
          - DELETED
          - FAILED
          - MOVING
          type: string
          x-obmcs-top-level-enum: '#/definitions/LifecycleState'
        name:
          description: Name of the object.
          maxLength: 255
          type: string
        parentTermKey:
          description: This terms parent term key. Will be null if the term has no parent term.
          maxLength: 255
          type: string
        parentTermName:
          description: Name of the parent term. Will be null if the term has no parent term.
          maxLength: 255
          type: string
        path:
          description: Absolute path of this resource, which could be a term, folder, entity etc, usually resolvable to this resource through a namespace hierarchy.
          type: string
        properties:
          additionalProperties:
            additionalProperties:
              description: The string value of the element type property.
              type: string
            description: 'Key-value pair representing properties of a search result element type  scoped to a category.

              Example: `{"key1": "value1"}`

              '
            type: object
          description: 'A map of maps that contains the properties which are specific to the element type in the search result.

            The map keys are category names and the values are maps of property name to property value. Every property

            is contained inside of a category. Most element types have required properties within the "default" category.

            Example: `{"properties": { "default": { "key1": "value1"}}}`

            '
          type: object
        tagSummary:
          description: Array of the tags associated with this object.
          items:
            $ref: '#/components/schemas/SearchTagSummary'
          type: array
        termSummary:
          description: Array of the terms associated with this object.
          items:
            $ref: '#/components/schemas/SearchTermSummary'
          type: array
        timeCreated:
          description: 'The date and time the result object was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339).

            Example: `2019-03-25T21:10:29.600Z`

            '
          format: date-time
          type: string
        timeUpdated:
          description: 'The date and time the result object was updated, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339).

            Example: `2019-03-25T21:10:29.600Z`

            '
          format: date-time
          type: string
        typeName:
          description: Name of the object type.
          maxLength: 255
          type: string
        updatedById:
          description: OCID of the user who updated the resource.
          maxLength: 255
          minLength: 1
          type: string
      type: object
    DataAssetCollection:
      description: 'Results of a data assets listing. A data asset is often synonymous with a ''System'', such as a database, or may be a file container or a message stream.

        '
      properties:
        count:
          description: Total number of items returned.
          type: integer
        items:
          description: Collection of data asset summaries.
          items:
            $ref: '#/components/schemas/DataAssetSummary'
          type: array
      required:
      - items
      type: object
    CreateJobDefinitionDetails:
      description: 'Representation of a job definition Resource. Job definitions define the harvest scope and includes the list of

        objects to be harvested along with a schedule. The list of objects is usually specified through a combination of

        object type, regular expressions, or specific names of objects and a sample size for the data harvested.

        '
      properties:
        connectionKey:
          description: The key of the connection resource to be used for the job.
          maxLength: 255
          minLength: 1
          type: string
        dataAssetKey:
          description: The key of the data asset for which the job is defined.
          maxLength: 255
          minLength: 1
          type: string
        description:
          description: Detailed description of the job definition.
          maxLength: 400
          type: string
        displayName:
          description: 'A user-friendly display name. Does not have to be unique, and it''s changeable.

            Avoid entering confidential information.

            '
          maxLength: 255
          minLength: 1
          type: string
        glossaryKey:
          description: Unique key of the glossary to which this job applies.
          maxLength: 255
          minLength: 1
          type: string
        isIncremental:
          default: false
          description: Specifies if the job definition is incremental or full.
          type: boolean
        isSampleDataExtracted:
          default: true
          description: Specify if sample data to be extracted as part of this harvest.
          type: boolean
        jobType:
          description: Type of the job definition.
          enum:
          - HARVEST
          - PROFILING
          - SAMPLING
          - PREVIEW
          - IMPORT
          - EXPORT
          - IMPORT_GLOSSARY
          - EXPORT_GLOSSARY
          - INTERNAL
          - PURGE
          - IMMEDIATE
          - SCHEDULED
          - IMMEDIATE_EXECUTION
          - SCHEDULED_EXECUTION
          - SCHEDULED_EXECUTION_INSTANCE
          - ASYNC_DELETE
          - IMPORT_DATA_ASSET
          - CREATE_SCAN_PROXY
          - ASYNC_EXPORT_GLOSSARY
          - ASYNC_EXPORT_DATA_ASSET
          type: string
          x-obmcs-top-level-enum: '#/definitions/JobType'
        properties:
          additionalProperties:
            additionalProperties:
              description: The string value of the job definition property.
              type: string
            description: 'Key-value pair representing properties of a job definition scoped to a category.

              Example: `{"host": "host1", "port": "1521", "database": "orcl"}`

              '
            type: object
          description: 'A map of maps that contains the properties which are specific to the job type. Each job type

            definition may define it''s set of required and optional properties. The map keys are category names and the

            values are maps of property name to property value. Every property is contained inside of a category. Most

            job definitions have required properties within the "default" category.

            Example: `{"properties": { "default": { "host": "host1", "port": "1521", "database": "orcl"}}}`

            '
          type: object
        sampleDataSizeInMBs:
          default: 5
          description: Specify the sample data size in MB, specified as number of rows, for this metadata harvest.
          type: integer
      required:
      - displayName
      - jobType
      type: object
    AttributeTagCollection:
      description: 'Results of an attribute tags listing. Attribnute tags allow association of business terms with attributes.

        '
      properties:
        count:
          description: Total number of items returned.
          type: integer
        items:
          description: Collection of attribute tags.
          items:
            $ref: '#/components/schemas/AttributeTagSummary'
          type: array
      required:
      - items
      type: object
    CreateNamespaceDetails:
      description: Properties used in custom property create operations.
      properties:
        description:
          description: Detailed description of the Namespace.
          maxLength: 400
          type: string
        displayName:
          description: 'A user-friendly display name. Does not have to be unique, and it''s changeable.

            Avoid entering confidential information.

            '
          maxLength: 255
          minLength: 1
          type: string
        isServiceDefined:
          default: false
          description: If this field is defined by service or by a user
          type: boolean
      required:
      - displayName
      type: object
    ImportLineageJobResult:
      description: Information about lineage import operation.
      properties:
        dataAssetKey:
          description: The unique key of the data asset on which import is triggered.
          maxLength: 255
          minLength: 1
          type: string
        importJobDefinitionKey:
          description: The unique key of the job definition resource that is used for the import.
          maxLength: 255
          minLength: 1
          type: string
        importJobExecutionKey:
          description: The unique key of the parent job execution for which the log resource is created.
          maxLength: 255
          minLength: 1
          type: string
        importJobExecutionStatus:
          description: The state of the import job execution.
          enum:
          - CREATED
          - IN_PROGRESS
          - INACTIVE
          - FAILED
          - SUCCEEDED
          - CANCELED
          - SUCCEEDED_WITH_WARNINGS
          type: string
          x-obmcs-top-level-enum: '#/definitions/JobExecutionState'
        importJobKey:
          description: The unique key of the job for the import.
          maxLength: 255
          minLength: 1
          type: string
      required:
      - dataAssetKey
      - importJobExecutionKey
      type: object
    CreateJobDetails:
      description: Properties used to create a job.
      properties:
        connectionKey:
          description: 'The key of the connection used by the job. This connection will override the default connection specified in

            the associated job definition. All executions will use this connection.

            '
          maxLength: 255
          minLength: 1
          type: string
          x-default-description: The connection inherited from the associated job definition.
        description:
          description: Detailed description of the job.
          maxLength: 400
          type: string
        displayName:
          description: 'A user-friendly display name. Does not have to be unique, and it''s changeable.

            Avoid entering confidential information.

            '
          maxLength: 255
          minLength: 1
          type: string
        jobDefinitionKey:
          description: The unique key of the job definition that defined the scope of this job.
          maxLength: 255
          minLength: 1
          type: string
        scheduleCronExpression:
          description: 'Interval on which the job will be run. Value is specified as a cron-supported time specification "nickname".

            The following subset of those is supported: @monthly, @weekly, @daily, @hourly.

            For metastore sync, an additional option @default is supported, which will schedule jobs at a more granular frequency.

            '
          type: string
        timeScheduleBegin:
          description: Date that the schedule should be operational. An [RFC3339](https://tools.ietf.org/html/rfc3339) formatted datetime string.
          format: date-time
          type: string
        timeScheduleEnd:
          description: Date that the schedule should end from being operational. An [RFC3339](https://tools.ietf.org/html/rfc3339) formatted datetime string.
          format: date-time
          type: string
      required:
      - displayName
      - jobDefinitionKey
      type: object
    Job:
      description: Details of a job. Jobs are scheduled instances of a job definition.
      properties:
        catalogId:
          description: The data catalog's OCID.
          maxLength: 255
          minLength: 1
          type: string
        connectionKey:
          description: 'The key of the connection used by the job. This connection will override the default connection specified in

            the associated job definition. All executions will use this connection.

            '
          maxLength: 255
          minLength: 1
          type: string
        createdById:
          description: OCID of the user who created this job.
          maxLength: 255
          minLength: 1
          type: string
        dataAssetKey:
          description: Unique key of the data asset to which this job applies, if the job involves a data asset.
          maxLength: 255
          minLength: 1
          type: string
        description:
          description: Detailed description of the job.
          maxLength: 400
          type: string
        displayName:
          description: 'A user-friendly display name. Does not have to be unique, and it''s changeable.

            Avoid entering confidential information.

            '
          maxLength: 255
          minLength: 1
          type: string
        errorCode:
          description: 'Error code returned from the latest job execution for this job. Useful when the latest Job execution is in FAILED state.

            '
          type: string
        errorMessage:
          description: 'Error message returned from the latest job execution for this job. Useful when the latest Job Execution is in a FAILED state.

            '
          type: string
        executionCount:
          description: 'The total number of executions for this job schedule.

            '
          type: integer
        glossaryKey:
          description: Unique key of the glossary to which this job applies.
          maxLength: 255
          minLength: 1
          type: string
        internalVersion:
          description: Internal version of the job resource.
          type: string
        jobDefinitionKey:
          description: The unique key of the job definition resource that defined the scope of this job.
          maxLength: 255
          minLength: 1
          type: string
        jobDefinitionName:
          description: The display name of the job definition resource that defined the scope of this job.
          maxLength: 255
          minLength: 1
          type: string
        jobType:
          description: Type of the job.
          enum:
          - HARVEST
          - PROFILING
          - SAMPLING
          - PREVIEW
          - IMPORT
          - EXPORT
          - IMPORT_GLOSSARY
          - EXPORT_GLOSSARY
          - INTERNAL
          - PURGE
          - IMMEDIATE
          - SCHEDULED
          - IMMEDIATE_EXECUTION
          - SCHEDULED_EXECUTION
          - SCHEDULED_EXECUTION_INSTANCE
          - ASYNC_DELETE
          - IMPORT_DATA_ASSET
          - CREATE_SCAN_PROXY
          - ASYNC_EXPORT_GLOSSARY
          - ASYNC_EXPORT_DATA_ASSET
          type: string
          x-obmcs-top-level-enum: '#/definitions/JobType'
        key:
          description: Unique key of the job resource.
          maxLength: 255
          minLength: 1
          type: string
        lifecycleState:
          description: Lifecycle state for job.
          enum:
          - ACTIVE
          - INACTIVE
          - EXPIRED
          type: string
          x-obmcs-top-level-enum: '#/definitions/JobLifecycleState'
        scheduleCronExpression:
          description: 'Interval on which the job will be run. Value is specified as a cron-supported time specification "nickname".

            The following subset of those is supported: @monthly, @weekly, @daily, @hourly.

            For metastore sync, an additional option @default is supported, which will schedule jobs at a more granular frequency.

            '
          type: string
        scheduleType:
          description: Type of job schedule that is inferred from the scheduling properties.
          enum:
          - SCHEDULED
          - IMMEDIATE
          type: string
          x-obmcs-top-level-enum: '#/definitions/JobScheduleType'
        timeCreated:
          description: 'The date and time the job was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339).

            Example: `2019-03-25T21:10:29.600Z`

            '
          format: date-time
          type: string
        timeOfLatestExecution:
          description: 'The date and time of the most recent execution for this Job, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339).

            Example: `2019-03-25T21:10:29.600Z`

            '
          format: date-time
          type: string
        timeScheduleBegin:
          description: Date that the schedule should be operational. An [RFC3339](https://tools.ietf.org/html/rfc3339) formatted datetime string.
          format: date-time
          type: string
        timeScheduleEnd:
          description: Date that the schedule should end from being operational. An [RFC3339](https://tools.ietf.org/html/rfc3339) formatted datetime string.
          format: date-time
          type: string
        timeUpdated:
          description: Time that this job was last updated. An [RFC3339](https://tools.ietf.org/html/rfc3339) formatted datetime string.
          format: date-time
          type: string
        updatedById:
          description: OCID of the user who updated this job.
          maxLength: 255
          minLength: 1
          type: string
        uri:
          description: URI to the job instance in the API.
          type: string
      required:
      - key
      type: object
    CatalogSummary:
      description: Summary of the data catalog.
      properties:
        attachedCatalogPrivateEndpoints:
          description: The list of private reverse connection endpoints attached to the catalog
          items:
            type: string
          type: array
        compartmentId:
          description: Compartment identifier.
          maxLength: 255
          minLength: 1
          type: string
        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: 'Usage of predefined tag keys. These predefined keys are scoped to namespaces.

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

            '
          type: object
        displayName:
          description: Data catalog identifier, that can be renamed.
          maxLength: 255
          minLength: 1
          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
        id:
          description: Unique identifier that is immutable on creation.
          maxLength: 255
          minLength: 1
          type: string
        lifecycleDetails:
          description: An 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 data catalog resource.
          enum:
          - CREATING
          - ACTIVE
          - INACTIVE
          - UPDATING
          - DELETING
          - DELETED
          - FAILED
          - MOVING
          type: string
          x-obmcs-top-level-enum: '#/definitions/LifecycleState'
        numberOfObjects:
          description: The number of high level objects added to the data catalog.
          type: integer
        timeCreated:
          description: The time the data catalog was created. An [RFC3339](https://tools.ietf.org/html/rfc3339) formatted datetime string.
          format: date-time
          type: string
        timeUpdated:
          description: The time the data catalog was updated. An [RFC3339](https://tools.ietf.org/html/rfc3339) formatted datetime string.
          format: date-time
          type: string
      required:
      - id
      - compartmentId
      type: object
    SearchTagSummary:
      description: Represents the association of an object to a term. Returned as part of search result.
      properties:
        displayName:
          description: Name of the tag that matches the term name.
          maxLength: 255
          minLength: 1
          type: string
        key:
          description: Unique tag key that is immutable.
          maxLength: 255
          minLength: 1
          type: string
      required:
      - displayName
      type: object
    ValidateConnectionResult:
      description: Details regarding the validation of a connection resource.
      properties:
        message:
          description: The message from the connection validation.
          type: string
        status:
          description: The status returned from the connection validation.
          enum:
          - SUCCEEDED
          - FAILED
          type: string
          x-obmcs-top-level-enum: '#/definitions/ConnectionResult'
      required:
      - status
      type: object
    CreateEntityDetails:
      description: Properties used in data entity create operations.
      properties:
        businessName:
          description: Optional user friendly business name of the data entity. If set, this supplements the harvested display name of the object.
          maxLength: 255
          type: string
        customPropertyMembers:
          description: The list of customized properties along with the values for this object
          items:
            $ref: '#/components/schemas/CustomPropertySetUsage'
          type: array
        description:
          description: Detailed description of a data entity.
          maxLength: 400
          type: string
        displayName:
          description: 'A user-friendly display name. Does not have to be unique, and it''s changeable.

            Avoid entering confidential information.

            '
          maxLength: 255
          minLength: 1
          type: string
        folderKey:
          description: Key of the associated folder.
          maxLength: 255
          type: string
        harvestStatus:
          description: 'Status of the object as updated by the harvest process. When an entity object is created , it''s harvest status

            will indicate if the entity''s metadata has been fully harvested or not. The harvest process can perform

            shallow harvesting to allow users to browse the metadata and can on-demand deep harvest on any object

            This requires a harvest status indicator for catalog objects.

            '
          enum:
          - COMPLETE
          - ERROR
          - IN_PROGRESS
          - DEFERRED
          type: string
          x-obmcs-top-level-enum: '#/definitions/HarvestStatus'
        isLogical:
          default: false
          description: Property to indicate if the object is a physical materialized object or virtual. For example, View.
          type: boolean
        isPartition:
          default: false
          description: Property to indicate if the object is a sub object of a parent physical object.
          type: boolean
        lastJobKey:
          description: Key of the last harvest process to update this object.
          maxLength: 255
          type: string
        patternKey:
          description: Key of the associated pattern if this is a logical entity.
          maxLength: 255
          type: string
        properties:
          additionalProperties:
            additionalProperties:
              description: The string value of the data entity property.
              type: string
            description: 'Key-value pair representing properties of a data entity scoped to a category.

              Example: `{"key1": "value1"}`

              '
            type: object
          description: 'A map of maps that contains the properties which are specific to the entity type. Each entity type

            definition defines it''s set of required and optional properties. The map keys are category names and the

            values are maps of property name to property value. Every property is contained inside of a category. Most

            entities have required properties within the "default" category. To determine the set of required and

            optional properties for an entity type, a query can be done on ''/types?type=dataEntity'' that returns a

            collection of all entity types. The appropriate entity type, which includes definitions of all of

            it''s properties, can be identified from this collection.

            Example: `{"properties": { "default": { "key1": "value1"}}}`

            '
          type: object
        realizedExpression:
          description: The expression realized after resolving qualifiers . Used in deriving this logical entity
          type: string
        timeExternal:
          description: Last modified timestamp of the object in the external system.
          format: date-time
          type: string
        typeKey:
          description: The type of data entity object. Type key's can be found via the '/types' endpoint.
          maxLength: 255
          minLength: 1
          type: string
      required:
      - displayName
      - timeExternal
      type: object
    EntityTagSummary:
      allOf:
      - $ref: '#/components/schemas/BaseTagSummary'
      - properties:
          entityKey:
            description: The unique key of the parent entity.
            maxLength: 255
            minLength: 1
            type: string
        type: object
      description: Summary of an entity tag.
      type: object
    JobLog:
      description: 'Job log details. A job log is an audit log record inserted during the lifecycle of a job execution instance.

        '
      properties:
        createdById:
          description: 'OCID of the user who created the log record for this job. Usually the executor of the job instance.

            '
          maxLength: 255
          minLength: 1
          type: string
        jobExecutionKey:
          description: The unique key of the parent job execution for which the log resource was created.
          maxLength: 255
          minLength: 1
          type: string
        key:
          description: Unique key of the job log that is immutable.
          maxLength: 255
          minLength: 1
          type: string
        logMessage:
          description: Message for this job log.
          type: string
        severity:
          description: Severity level for this log.
          type: string
        timeCreated:
          description: 'The date and time the job log was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339).

            Example: `2019-03-25T21:10:29.600Z`

            '
          format: date-time
          type: string
        timeUpdated:
          description: Job log update time. An [RFC3339](https://tools.ietf.org/html/rfc3339) formatted datetime string.
          format: date-time
          type: string
        updatedById:
          description: 'OCID of the user who created the log record for this job. Usually the executor of the job instance.

            '
          maxLength: 255
          minLength: 1
          type: string
        uri:
          description: URI to the job log instance in the API.
          type: string
      required:
      - key
      type: object
    DataAssetSummary:
      description: 'Summary of a data asset. A physical store, or stream, of data known to the data catalog and containing one or

        many data entities, possibly in an organized structure of folders. A data asset is often synonymous with

        a ''System'', such as a database, or may be a file container or a message stream.

        '
      properties:
        catalogId:
          description: The data catalog's OCID.
          maxLength: 255
          minLength: 1
          type: string
        description:
          description: Detailed description of the data asset.
          maxLength: 400
          type: string
        displayName:
          description: 'A user-friendly display name. Does not have to be unique, and it''s changeable.

            Avoid entering confidential information.

            '
          maxLength: 255
          minLength: 1
          type: string
        externalKey:
          description: 'External URI that can be used to reference the object. Format will differ based on the type of object.

            '
          maxLength: 255
          minLength: 1
          type: string
        key:
          description: Unique data asset key that is immutable.
          type: string
        lifecycleDetails:
          description: 'A message describing the current state in more detail. An object not in ACTIVE state may have functional limitations,

            see service documentation for details.

            '
          maxLength: 255
          minLength: 1
          type: string
        lifecycleState:
          description: State of the data asset.
          enum:
          - CREATING
          - ACTIVE
          - INACTIVE
          - UPDATING
          - DELETING
          - DELETED
          - FAILED
          - MOVING
          type: string
          x-obmcs-top-level-enum: '#/definitions/LifecycleState'
        timeCreated:
          description: 'The date and time the data asset was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339).

            Example: `2019-03-25T21:10:29.600Z`

            '
          format: date-time
          type: string
        typeKey:
          description: The key of the object type. Type keys's can be found via the '/types' endpoint.
          maxLength: 255
          minLength: 1
          type: string
        uri:
          description: URI to the data asset instance in the API.
          type: string
      required:
      - key
      type: object
    CreatePatternDetails:
      description: Properties used in pattern create operations.
      properties:
        checkFailureLimit:
          description: 'The maximum number of UNMATCHED files, in checkFilePathList, above which the check fails. Optional, if

            checkFilePathList is provided - but if isEnableCheckFailureLimit is set to true it is required.

            '
          type: integer
        checkFilePathList:
          description: 'List of file paths against which the pattern can be tried, as a check. This documents, for reference

            purposes, some example objects a pattern is meant to work with. If isEnableCheckFailureLimit is set to true,

            this will be run as a validation during the request, such that if the check fails the request fails. If

            isEnableCheckFailureLimit instead is set to (the default) false, a pattern will still be created or updated even

            if the check fails, with a lifecycleState of FAILED.

            '
          items:
            type: string
          type: array
        description:
          description: Detailed description of the Pattern.
          maxLength: 400
          type: string
        displayName:
          description: 'A user-friendly display name. Does not have to be unique, and it''s changeable.

            Avoid entering confidential information.

            '
          maxLength: 255
          minLength: 1
          type: string
        expression:
          description: 'Input string which drives the selection process, allowing for fine-grained control using qualifiers.

            Refer to the user documentation for details of the format and examples. A pattern cannot include both

            a prefix and an expression.

            '
          type: string
        filePathPrefix:
          description: 'Input string which drives the selection process.

            Refer to the user documentation for details of the format and examples. A pattern cannot include both

            a prefix and an expression.

            '
          type: string
        isEnableCheckFailureLimit:
          default: false
          description: 'Indicates whether the pattern check, against the checkFilePathList, will fail the request if the count of

            UNMATCHED files is above the checkFailureLimit.

            '
          type: boolean
        properties:
          additionalProperties:
            additionalProperties:
              description: The string value of the pattern property.
              type: string
            description: 'Key-value pair representing properties of a pattern scoped to a category.

              Example: `{"tbd"}`

              '
            type: object
          description: 'A map of maps that contains the properties which are specific to the pattern type. Each pattern type

            definition defines it''s set of required and optional properties.

            Example: `{"properties": { "default": { "tbd"}}}`

            '
          type: object
      required:
      - displayName
      type: object
    EntityTagCollection:
      description: 'Results of an entity tags listing. Entity tags allow assciation of business terms with entities.

        '
      properties:
        count:
          description: Total number of items returned.
          type: integer
        items:
          description: Collection of entity tags.
          items:
            $ref: '#/components/schemas/EntityTagSummary'
          type: array
      required:
      - items
      type: object
    SuggestListItem:
      description: 'Details of a potential match returned from the suggest operation for the given input text.

        by the limit parameter.

        '
      properties:
        objectCount:
          description: The number of objects which contain this suggestion.
          type: integer
        suggestion:
          description: Potential string match. Matching is based on the frequency of usage within the catalog.
          type: string
      type: object
    ImportLineageDetails:
      description: Specifies the lineage contents to be imported.
      properties:
        lineagePayload:
          description: The payload used to import lineage.
          format: byte
          type: string
      required:
      - lineagePayload
      type: object
    AttributeTagSummary:
      allOf:
      - $ref: '#/components/schemas/BaseTagSummary'
      - properties:
          attributeKey:
            description: The unique key of the parent attribute.
            maxLength: 255
            minLength: 1
            type: string
        type: object
      description: Summary of an entity attribute tag.
      type: object
    EntityLineage:
      allOf:
      - $ref: '#/components/schemas/ObjectLineage'
      description: Lineage for a data entity.
      type: object
    FacetedSearchCustomProperty:
      description: Details about custom property
      properties:
        dataType:
          description: Data type of the custom property field
          type: string
        name:
          description: Name of custom property field
          type: string
        value:
          description: Value of the custom property field
          type: string
      type: object
    JobSummary:
      description: 'Details of a job. Jobs are scheduled instances of a job definition.

        '
      properties:
        catalogId:
          description: The data catalog's OCID.
          maxLength: 255
          minLength: 1
          type: string
        createdById:
          description: OCID of the user who created this job.
          maxLength: 255
          minLength: 1
          type: string
        dataAssetKey:
          description: Unique key of the data asset to which this job applies, if the job involves a data asset.
          maxLength: 255
          minLength: 1
          type: string
        description:
          description: Detailed description of the job.
          maxLength: 400
          type: string
        displayName:
          description: 'A user-friendly display name. Does not have to be unique, and it''s changeable.

            Avoid entering confidential information.

            '
          maxLength: 255
          minLength: 1
          type: string
        errorCode:
          description: 'Error code returned from the latest job execution for this job. Useful when the latest Job execution is in FAILED state.

            '
          type: string
        errorMessage:
          description: 'Error message returned from the latest job execution for this job. Useful when the latest Job Execution is in a FAILED state.

            '
          type: string
        executionCount:
          description: 'The total number of executions for this job schedule.

            '
          type: integer
        executions:
          description: Array of the executions summary associated with this job.
          items:
            $ref: '#/components/schemas/JobExecutionSummary'
          type: array
        glossaryKey:
          description: Unique key of the glossary to which this job applies.
          maxLength: 255
          minLength: 1
          type: string
        jobDefinitionKey:
          description: The unique key of the job definition resource that defined the scope of this job.
          maxLength: 255
          minLength: 1
          type: string
        jobDefinitionName:
          description: The display name of the job definition resource that defined the scope of this job.
          maxLength: 255
          minLength: 1
          type: string
        jobType:
          description: Type of the job.
          enum:
          - HARVEST
          - PROFILING
          - SAMPLING
          - PREVIEW
          - IMPORT
          - EXPORT
          - IMPORT_GLOSSARY
          - EXPORT_GLOSSARY
          - INTERNAL
          - PURGE
          - IMMEDIATE
          - SCHEDULED
          - IMMEDIATE_EXECUTION
          - SCHEDULED_EXECUTION
          - SCHEDULED_EXECUTION_INSTANCE
          - ASYNC_DELETE
          - IMPORT_DATA_ASSET
          - CREATE_SCAN_PROXY
          - ASYNC_EXPORT_GLOSSARY
          - ASYNC_EXPORT_DATA_ASSET
          type: string
          x-obmcs-top-level-enum: '#/definitions/JobType'
        key:
          description: Unique key of the job.
          maxLength: 255
          minLength: 1
          type: string
        lifecycleState:
          description: Lifecycle state of the job, such as running, paused, or completed.
          enum:
          - ACTIVE
          - INACTIVE
          - EXPIRED
          type: string
          x-obmcs-top-level-enum: '#/definitions/JobLifecycleState'
        scheduleCronExpression:
          description: 'Interval on which the job will be run. Value is specified as a cron-supported time specification "nickname".

            The following subset of those is supported: @monthly, @weekly, @daily, @hourly.

            For metastore sync, an additional option @default is supported, which will schedule jobs at a more granular frequency.

            '
          type: string
        scheduleType:
          description: Type of job schedule that is inferred from the scheduling properties.
          type: string
        timeCreated:
          description: 'The date and time the job was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339).

            Example: `2019-03-25T21:10:29.600Z`

            '
          format: date-time
          type: string
        timeOfLatestExecution:
          description: 'The date and time of the most recent execution for this job, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339).

            Example: `2019-03-25T21:10:29.600Z`

            '
          format: date-time
          type: string
        timeScheduleBegin:
          description: Date that the schedule should be operational. An [RFC3339](https://tools.ietf.org/html/rfc3339) formatted datetime string.
          format: date-time
          type: string
        timeUpdated:
          description: Time that this job was last updated. An [RFC3339](https://tools.ietf.org/html/rfc3339) formatted datetime string.
          format: date-time
          type: string
        updatedById:
          description: OCID of the user who updated this job.
          maxLength: 255
          minLength: 1
          type: string
        uri:
          description: URI to the job instance in the API.
          type: string
      required:
      - key
      type: object
    GlossarySummary:
      description: 'Summary of a glossary. A glossary of business terms, such as ''Customer'', ''Account'', ''Contact'', ''Address'',

        or ''Product'', with definitions, used to provide common meaning across disparate data assets. Business glossaries

        may be hierarchical where some terms may contain child terms to allow them to be used as ''taxonomies''.

        By linking data assets, data entities, and attributes to glossaries and glossary terms, the glossary can act as a

        way of organizing data catalog objects in a hierarchy to make a large number of objects more navigable and easier to

        consume. Objects in the data catalog, such as data assets or data entities, may be linked to any level in the

        glossary, so that the glossary can be used to browse the available data according to the business model of the

        organization.

        '
      properties:
        catalogId:
          description: The data catalog's OCID.
          maxLength: 255
          minLength: 1
          type: string
        description:
          description: Detailed description of the glossary.
          maxLength: 400
          type: string
        displayName:
          description: 'A user-friendly display name. Does not have to be unique, and it''s changeable.

            Avoid entering confidential information.

            '
          maxLength: 255
          minLength: 1
          type: string
        importJobDefinitionKey:
          description: The unique key of the job definition resource that was used in the Glossary import.
          maxLength: 255
          minLength: 1
          type: string
        importJobKey:
          description: The unique key of the job policy for Glossary import.
          maxLength: 255
          minLength: 1
          type: string
        key:
          description: Unique glossary key that is immutable.
          maxLength: 255
          minLength: 1
          type: string
        latestImportJobExecutionKey:
          description: The unique key of the parent job execution for which the log resource was created.
          maxLength: 255
          minLength: 1
          type: string
        latestImportJobExecutionStatus:
          description: 'Status of the latest glossary import job execution, such as running, paused, or completed.

            This may include additional information like time import started , import file size and % of completion

            '
          type: string
        lifecycleState:
          description: State of the Glossary.
          enum:
          - CREATING
          - ACTIVE
          - INACTIVE
          - UPDATING
          - DELETING
          - DELETED
          - FAILED
          - MOVING
          type: string
          x-obmcs-top-level-enum: '#/definitions/LifecycleState'
        timeCreated:
          description: 'The date and time the glossary was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339).

            Example: `2019-03-25T21:10:29.600Z`

            '
          format: date-time
          type: string
        uri:
          description: URI to the glossary instance in the API.
          type: string
        workflowStatus:
          description: Status of the approval process workflow for this business glossary.
          enum:
          - NEW
          - APPROVED
          - UNDER_REVIEW
          - ESCALATED
          type: string
          x-obmcs-top-level-enum: '#/definitions/TermWorkflowStatus'
      required:
      - key
      type: object
    RuleAttribute:
      description: 'Object that defines a usage of an attribute in the context of a rule.

        Example: For a UNIQUEKEY rule, declares the attribute in a table whose value must be unique.

        '
      properties:
        displayName:
          description: 'A user-friendly display name. Does not have to be unique, and it''s changeable.

            Avoid entering confidential information.

            '
          maxLength: 255
          minLength: 1
          type: string
        key:
          description: Immutable unique key of the attribute.
          maxLength: 255
          minLength: 1
          type: string
        position:
          description: Position of the attribute in the record definition.
          format: int32
          type: integer
      required:
      - key
      type: object
    Type:
      description: 'Full data catalog type definition. Fully defines a type of the data catalog. All types are statically defined

        in the system and are immutable. It isn''t possible to create new types or update existing types via the API.

        '
      properties:
        catalogId:
          description: The data catalog's OCID.
          maxLength: 255
          minLength: 1
          type: string
        customProperties:
          description: Custom properties associated with this Type.
          items:
            $ref: '#/components/schemas/CustomPropertySummary'
          type: array
        description:
          description: Detailed description of the type.
          maxLength: 400
          type: string
        externalTypeName:
          description: Mapping type equivalence in the external system.
          type: string
        isApproved:
          description: Indicates whether the type is approved for use as a classifying object.
          type: boolean
        isInternal:
          description: Indicates whether the type is internal, making it unavailable for use by metadata elements.
          type: boolean
        isTag:
          description: Indicates whether the type can be used for tagging metadata elements.
          type: boolean
        key:
          description: Unique type key that is immutable.
          maxLength: 255
          minLength: 1
          type: string
        lifecycleState:
          description: The current state of the type.
          enum:
          - CREATING
          - ACTIVE
          - INACTIVE
          - UPDATING
          - DELETING
          - DELETED
          - FAILED
          - MOVING
          type: string
          x-obmcs-top-level-enum: '#/definitions/LifecycleState'
        name:
          description: The immutable name of the type.
          maxLength: 255
          minLength: 1
          type: string
        parentTypeKey:
          description: Unique key of the parent type.
          maxLength: 255
          minLength: 1
          type: string
        parentTypeName:
          description: Name of the parent type.
          maxLength: 255
          minLength: 1
          type: string
        properties:
          additionalProperties:
            description: "Array of property attribute maps scoped to a category.\nExample:\n`\"attributes:\": [\n  {\n    \"name\": \"host\",\n    \"type\": \"string\",\n    \"isRequired\": true,\n    \"isUpdatable\": false\n  },\n  ...\n]`\n"
            items:
              $ref: '#/components/schemas/PropertyDefinition'
            type: array
          description: "A map of arrays which defines the type specific properties, both required and optional. The map keys are\ncategory names and the values are arrays contiaing all property details. Every property is contained inside\nof a category. Most types have required properties within the \"default\" category.\nExample:\n`{\n   \"properties\": {\n     \"default\": {\n       \"attributes:\": [\n         {\n           \"name\": \"host\",\n           \"type\": \"string\",\n           \"isRequired\": true,\n           \"isUpdatable\": false\n         },\n         ...\n       ]\n     }\n   }\n }`\n"
          type: object
        typeCategory:
          description: Indicates the category this type belongs to. For instance, data assets, connections.
          type: string
        uri:
          description: URI to the type instance in the API.
          type: string
      required:
      - key
      type: object
    JobMetric:
      description: 'A set of metrics are collected periodically to assess the state and performance characteristics of the execution

        instance of a job. The metrics are grouped based on their category and sub categories and aggregated based on

        their batch information.

        '
      properties:
        batchKey:
          description: Batch key for grouping, may be null.
          maxLength: 255
          type: string
        category:
          description: Category of this metric.
          type: string
        createdById:
          description: 'OCID of the user who created the metric for this job. Usually the executor of the job instance.

            '
          maxLength: 255
          minLength: 1
          type: string
        description:
          description: Detailed description of the metric.
          maxLength: 400
          type: string
        displayName:
          description: 'A user-friendly display name. Does not have to be unique, and it''s changeable.

            Avoid entering confidential information.

            '
          maxLength: 255
          minLength: 1
          type: string
        jobExecutionKey:
          description: The unique key of the parent job execution for which the job metric resource is being created.
          maxLength: 255
          minLength: 1
          type: string
        key:
          description: Key of the job metric that is immutable.
          maxLength: 255
          minLength: 1
          type: string
        subCategory:
          description: Sub category of this metric under the category. Used for aggregating values. May be null.
          type: string
        timeCreated:
          description: 'The date and time the job metric was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339).

            Example: `2019-03-25T21:10:29.600Z`

            '
          format: date-time
          type: string
        timeInserted:
          description: 'The time the metric was logged or captured in the system where the job executed.

            An [RFC3339](https://tools.ietf.org/html/rfc3339) formatted datetime string.

            '
          format: date-time
          type: string
        timeUpdated:
          description: The last time that this metric was updated. An [RFC3339](https://tools.ietf.org/html/rfc3339) formatted datetime string.
          format: date-time
          type: string
        unit:
          description: Unit of this metric.
          type: string
        updatedById:
          description: 'OCID of the user who created the metric for this job. Usually the executor of the job instance.

            '
          maxLength: 255
          minLength: 1
          type: string
        uri:
          description: URI to the job metric instance in the API.
          type: string
        value:
          description: Value of this metric.
          type: string
      required:
      - key
      type: object
    CreateTermDetails:
      description: Properties used in term create operations.
      properties:
        customPropertyMembers:
          description: The list of customized properties along with the values for this object
          items:
            $ref: '#/components/schemas/CustomPropertySetUsage'
          type: array
        description:
          description: Detailed description of the term.
          maxLength: 400
          type: string
        displayName:
          description: 'A user-friendly display name. Is changeable. The combination of ''displayName'' and ''parentTermKey''

            must be unique. Avoid entering confidential information.

            '
          maxLength: 255
          minLength: 1
          type: string
        isAllowedToHaveChildTerms:
          default: true
          description: Indicates whether a term may contain child terms.
          type: boolean
        owner:
          description: OCID of the user who is the owner of this business terminology.
          maxLength: 255
          minLength: 1
          type: string
        parentTermKey:
          description: The parent key of the term. In the case of a root-level category only, the term would have no parent and this should be left unset.
          maxLength: 255
          type: string
        workflowStatus:
          description: Status of the approval process workflow for this business term in the glossary.
          enum:
          - NEW
          - APPROVED
          - UNDER_REVIEW
          - ESCALATED
          type: string
          x-obmcs-top-level-enum: '#/definitions/TermWorkflowStatus'
      required:
      - displayName
      type: object
    ImportConnectionDetails:
      description: Import connection from the connection metadata and oracle wallet file.
      properties:
        connectionDetail:
          $ref: '#/components/schemas/CreateConnectionDetails'
        connectionPayload:
          description: The information used to import the connection.
          format: byte
          type: string
      required:
      - connectionPayload
      type: object
    RuleCollection:
      description: 'Results of an rule listing. Rules describe an item of data with name and ruletype.

        '
      properties:
        count:
          description: Total number of items returned.
          type: integer
        items:
          description: Collection of rules.
          items:
            $ref: '#/components/schemas/RuleSummary'
          type: array
      required:
      - items
      type: object
    UpdateCatalogPrivateEndpointDetails:
      description: Information about the modified private endpoint resource
      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: 'Usage of predefined tag keys. These predefined keys are scoped to namespaces.

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

            '
          type: object
        displayName:
          description: Display name of the private endpoint resource.
          maxLength: 255
          minLength: 1
          type: string
        dnsZones:
          description: 'List of DNS zones to be used by the data assets to be harvested.

            Example: custpvtsubnet.oraclevcn.com for data asset: db.custpvtsubnet.oraclevcn.com

            '
          items:
            maxLength: 253
            minLength: 1
            type: string
          maxItems: 30
          minItems: 1
          type: array
        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
        securityAttributes:
          additionalProperties:
            additionalProperties:
              description: 'Attribute value and mode. Only the String type is supported for value. Mode is currently always "enforce".


                Example: `{"value": "42", "mode": "enforce"}`

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


              Example: `{"MaxEgressCount": {"value": "42", "mode": "enforce"}}`

              '
            type: object
          description: 'Security attributes 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: `{"Oracle-ZPR": {"MaxEgressCount": {"value": "42", "mode": "enforce"}}}`

            '
          type: object
      type: object
    WorkRequest:
      description: A description of workrequest status.
      properties:
        compartmentId:
          description: 'The ocid of the compartment that contains the work request. Work requests should be scoped to

            the same compartment as the resource the work request affects. If the work request affects multiple resources,

            and those resources are not in the same compartment, it is up to the service team to pick the primary

            resource whose compartment should be used.

            '
          maxLength: 255
          minLength: 1
          type: string
        id:
          description: The id of the work request.
          maxLength: 255
          minLength: 1
          type: string
        operationType:
          description: Type of the work request.
          enum:
          - CREATE_CATALOG
          - UPDATE_CATALOG
          - DELETE_CATALOG
          - MOVE_CATALOG
          - CREATE_CATALOG_PRIVATE_ENDPOINT
          - DELETE_CATALOG_PRIVATE_ENDPOINT
          - UPDATE_CATALOG_PRIVATE_ENDPOINT
          - MOVE_CATALOG_PRIVATE_ENDPOINT
          - ATTACH_CATALOG_PRIVATE_ENDPOINT
          - DETACH_CATALOG_PRIVATE_ENDPOINT
          - CREATE_METASTORE
          - UPDATE_METASTORE
          - DELETE_METASTORE
          - MOVE_METASTORE
          type: string
        percentComplete:
          description: Percentage of the request completed.
          format: float
          type: number
        resources:
          description: The resources affected by this work request.
          items:
            $ref: '#/components/schemas/WorkRequestResource'
          type: array
        status:
          description: Status of current work request.
          enum:
          - ACCEPTED
          - IN_PROGRESS
          - FAILED
          - SUCCEEDED
          - CANCELING
          - CANCELED
          type: string
        timeAccepted:
          description: 'The date and time the request was created, as described in

            [RFC 3339](https://tools.ietf.org/rfc/rfc3339), section 14.29.

            '
          format: date-time
          type: string
        timeFinished:
          description: 'The date and time the object was finished, as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339).

            '
          format: date-time
          type: string
        timeStarted:
          description: 'The date and time the request was started, as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339),

            section 14.29.

            '
          format: date-time
          type: string
      required:
      - operationType
      - status
      - id
      - compartmentId
      - resources
      - percentComplete
      - timeAccepted
    TypeCollection:
      description: 'Results of a types listing. Types define the basic type of catalog objects and are immutable.

        '
      properties:
        count:
          description: Total number of items returned.
          type: integer
        items:
          description: Collection of types.
          items:
            $ref: '#/components/schemas/TypeSummary'
          type: array
      required:
      - items
      type: object
    FolderSummary:
      description: 'Summary of a folder.

        A generic term used in the data catalog for an external organization concept used for a collection of data entities

        or processes within a data asset. This term is an internal term which models multiple external types of folder,

        such as file directories, database schemas, and so on. Some data assets, such as Object Store containers,

        may contain many levels of folders.

        '
      properties:
        businessName:
          description: Optional user friendly business name of the folder. If set, this supplements the harvested display name of the object.
          maxLength: 255
          type: string
        dataAssetKey:
          description: The unique key of the parent data asset.
          maxLength: 255
          minLength: 1
          type: string
        description:
          description: Detailed description of a folder.
          maxLength: 400
          type: string
        displayName:
          description: 'A user-friendly display name. Does not have to be unique, and it''s changeable.

            Avoid entering confidential information.

            '
          maxLength: 255
          minLength: 1
          type: string
        externalKey:
          description: Unique external key of this object from the source systems.
          maxLength: 255
          minLength: 1
          type: string
        key:
          description: Unique folder key that is immutable.
          maxLength: 255
          minLength: 1
          type: string
        lifecycleDetails:
          description: 'A message describing the current state in more detail. An object not in ACTIVE state may have functional limitations,

            see service documentation for details.

            '
          maxLength: 255
          minLength: 1
          type: string
        lifecycleState:
          description: State of the folder.
          enum:
          - CREATING
          - ACTIVE
          - INACTIVE
          - UPDATING
          - DELETING
          - DELETED
          - FAILED
          - MOVING
          type: string
          x-obmcs-top-level-enum: '#/definitions/LifecycleState'
        objectStorageUrl:
          description: URL of the folder in the object store.
          maxLength: 2000
          minLength: 1
          type: string
        parentFolderKey:
          description: The key of the containing folder or null if there is no parent.
          maxLength: 255
          type: string
        path:
          description: Full path of the folder.
          type: string
        timeCreated:
          description: 'The date and time the folder was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339).

            Example: `2019-03-25T21:10:29.600Z`

            '
          format: date-time
          type: string
        timeExternal:
          description: Last modified timestamp of this object in the external system.
          format: date-time
          type: string
        timeUpdated:
          description: 'The date and time the folder was last updated, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: 2019-03-25T21:10:29.600Z

            '
          format: date-time
          type: string
        typeKey:
          description: The type of folder object. Type keys can be found via the '/types' endpoint.
          maxLength: 255
          minLength: 1
          type: string
        uri:
          description: URI of the folder resource within the data catalog API.
          type: string
      required:
      - key
      type: object
    CustomPropertyGetUsage:
      description: Details of a single custom property
      properties:
        allowedValues:
          description: Allowed values for the custom property if any
          items:
            type: string
          type: array
        dataType:
          description: The data type of the custom property
          enum:
          - TEXT
          - RICH_TEXT
          - BOOLEAN
          - NUMBER
          - DATE
          type: string
          x-obmcs-top-level-enum: '#/definitions/CustomPropertyDataType'
        description:
          description: Description of the custom property
          type: string
        displayName:
          description: Display name of the custom property
          type: string
        isEditable:
          default: true
          description: If this field is a editable field
          type: boolean
        isEventEnabled:
          default: false
          description: If an OCI Event will be emitted when the custom property is modified.
          type: boolean
        isHidden:
          default: true
          description: If this field is a hidden field
          type: boolean
        isListType:
          default: false
          description: Is this property allowed to have list of values
          type: boolean
        isMultiValued:
          default: false
          description: If this field allows multiple values to be set
          type: boolean
        isShownInList:
          default: false
          description: If this field is displayed in a list view of applicable objects.
          type: boolean
        key:
          description: Unique Identifier of the attribute which is ID
          type: string
        namespaceKey:
          description: Unique namespace key that is immutable
          type: string
        namespaceName:
          description: Namespace name of the custom property
          type: string
        value:
          description: The custom property value
          type: string
      type: object
    WorkRequestResource:
      description: A resource created or operated on by a work request.
      properties:
        actionType:
          description: 'The way in which this resource is affected by the work tracked in the work request.

            A resource being created, updated, or deleted will remain in the IN_PROGRESS state until

            work is complete for that resource at which point it will transition to CREATED, UPDATED,

            or DELETED, respectively.

            '
          enum:
          - CREATED
          - UPDATED
          - DELETED
          - IN_PROGRESS
          - MOVED
          type: string
        entityType:
          description: The resource type the work request affects.
          type: string
        entityUri:
          description: The URI path that the user can do a GET to access the resource metadata
          type: string
        identifier:
          description: The identifier of the resource the work request affects.
          type: string
      required:
      - actionType
      - entityType
      - identifier
    DataSelectorPatternDetails:
      description: 'List of pattern Ids.  Used in the addition and removal of patterns in data assets.

        '
      properties:
        items:
          description: Collection of pattern Ids.
          items:
            type: string
          type: array
      required:
      - items
      type: object
    CatalogPrivateEndpointSummary:
      description: A private network reverse connection creates a connection from service to customer subnet over a private network.
      properties:
        attachedCatalogs:
          description: The list of catalogs using the private reverse connection endpoint
          items:
            type: string
          type: array
        compartmentId:
          description: Identifier of the compartment this private endpoint belongs to
          type: string
        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: 'Usage of predefined tag keys. These predefined keys are scoped to namespaces.

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

            '
          type: object
        displayName:
          description: Mutable name of the Private Reverse Connection Endpoint
          maxLength: 255
          minLength: 1
          type: string
        dnsZones:
          description: 'List of DNS zones to be used by the data assets to be harvested.

            Example: custpvtsubnet.oraclevcn.com for data asset: db.custpvtsubnet.oraclevcn.com

            '
          items:
            maxLength: 253
            minLength: 1
            type: string
          maxItems: 30
          minItems: 1
          type: array
        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
        id:
          description: Unique identifier that is immutable
          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.
          maxLength: 255
          minLength: 1
          type: string
        lifecycleState:
          description: The current state of the private endpoint resource.
          enum:
          - CREATING
          - ACTIVE
          - INACTIVE
          - UPDATING
          - DELETING
          - DELETED
          - FAILED
          - MOVING
          type: string
          x-obmcs-top-level-enum: '#/definitions/LifecycleState'
        securityAttributes:
          additionalProperties:
            additionalProperties:
              description: 'Attribute value and mode. Only the String type is supported for value. Mode is currently always "enforce".


                Example: `{"value": "42", "mode": "enforce"}`

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


              Example: `{"MaxEgressCount": {"value": "42", "mode": "enforce"}}`

              '
            type: object
          description: 'Security attributes 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: `{"Oracle-ZPR": {"MaxEgressCount": {"value": "42", "mode": "enforce"}}}`

            '
          type: object
        subnetId:
          description: Subnet Identifier
          type: string
        timeCreated:
          description: The time the private endpoint was created. An [RFC3339](https://tools.ietf.org/html/rfc3339) formatted datetime string.
          format: date-time
          type: string
        timeUpdated:
          description: The time the private endpoint was updated. An [RFC3339](https://tools.ietf.org/html/rfc3339) formatted datetime string.
          format: date-time
          type: string
      required:
      - id
      - compartmentId
      - subnetId
      - dnsZones
      type: object
    WorkRequestError:
      description: An error encountered while executing a work request.
      properties:
        code:
          description: 'A machine-usable code for the error that occured. Error codes are listed on

            (https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm)

            '
          type: string
        message:
          description: A human readable description of the issue encountered.
          type: string
        timestamp:
          description: The time the error occured. An [RFC3339](https://tools.ietf.org/html/rfc3339) formatted datetime string.
          format: date-time
          type: string
      required:
      - code
      - message
      - timestamp
    UpdateJobDefinitionDetails:
      description: Update information for a job definition resource.
      properties:
        connectionKey:
          description: The key of the connection resource to be used for harvest, sampling, profiling jobs.
          maxLength: 255
          minLength: 1
          type: string
        dataAssetKey:
          description: The key of the data asset for which the job is defined.
          maxLength: 255
          minLength: 1
          type: string
        description:
          description: Detailed description of the job definition.
          maxLength: 400
          type: string
        displayName:
          description: 'A user-friendly display name. Does not have to be unique, and it''s changeable.

            Avoid entering confidential information.

            '
          maxLength: 255
          minLength: 1
          type: string
        glossaryKey:
          description: Unique key of the glossary to which this job applies.
          maxLength: 255
          minLength: 1
          type: string
        isIncremental:
          description: Specifies if the job definition is incremental or full.
          type: boolean
        isSampleDataExtracted:
          default: true
          description: Specify if sample data to be extracted as part of this harvest.
          type: boolean
        properties:
          additionalProperties:
            additionalProperties:
              description: The string value of the job definition property.
              type: string
            description: 'Key-value pair representing properties of a job definition scoped to a category.

              Example: `{"host": "host1", "port": "1521", "database": "orcl"}`

              '
            type: object
          description: 'A map of maps that contains the properties which are specific to the job type. Each job type

            definition may define it''s set of required and optional properties. The map keys are category names and the

            values are maps of property name to property value. Every property is contained inside of a category. Most

            job definitions have required properties within the "default" category.

            Example: `{"properties": { "default": { "host": "host1", "port": "1521", "database": "orcl"}}}`

            '
          type: object
        sampleDataSizeInMBs:
          default: 5
          description: Specify the sample data size in MB, specified as number of rows, for this metadata harvest.
          type: integer
      type: object
    CustomPropertyCollection:
      description: 'Results of a custom properties listing. A custom property is an user defined attribute tied to the first class object of data catalog

        '
      properties:
        count:
          description: Total number of items returned.
          type: integer
        items:
          description: Collection of custom property summaries
          items:
            $ref: '#/components/schemas/CustomPropertySummary'
          type: array
      required:
      - items
      type: object
    CustomPropertySummary:
      description: 'Summary of a custom property

        '
      properties:
        allowedValues:
          description: Allowed values for the custom property if any
          items:
            type: string
          type: array
        createdById:
          description: OCID of the user who created the custom property.
          maxLength: 255
          minLength: 1
          type: string
        dataType:
          description: Data type of the custom property
          enum:
          - TEXT
          - RICH_TEXT
          - BOOLEAN
          - NUMBER
          - DATE
          type: string
          x-obmcs-top-level-enum: '#/definitions/CustomPropertyDataType'
        description:
          description: Description of the custom property
          type: string
        displayName:
          description: Display name of the custom property
          type: string
        events:
          description: Event configuration for this custom property, against the desired subset of object types to which the property applies.
          items:
            $ref: '#/components/schemas/EventConfig'
          type: array
        isEditable:
          default: true
          description: If this field is a editable field
          type: boolean
        isEventEnabled:
          default: false
          description: If an OCI Event will be emitted when the custom property is modified.
          type: boolean
        isFilterable:
          default: false
          description: If this field allows to filter or create facets from UI
          type: boolean
        isHidden:
          default: true
          description: If this field is a hidden field
          type: boolean
        isHiddenInSearch:
          default: false
          description: If this field is allowed to pop in search results
          type: boolean
        isMultiValued:
          default: false
          description: If this field allows multiple values to be set
          type: boolean
        isServiceDefined:
          default: false
          description: If this field is defined by service or by a user
          type: boolean
        isShownInList:
          default: false
          description: If this field is displayed in a list view of applicable objects.
          type: boolean
        isSortable:
          default: false
          description: If this field allows to sort from UI
          type: boolean
        key:
          description: Unique custom property key that is immutable.
          type: string
        lifecycleState:
          description: The current state of the custom property.
          enum:
          - CREATING
          - ACTIVE
          - INACTIVE
          - UPDATING
          - DELETING
          - DELETED
          - FAILED
          - MOVING
          type: string
          x-obmcs-top-level-enum: '#/definitions/LifecycleState'
        namespaceName:
          description: Namespace name of the custom property
          type: string
        scope:
          description: 'Type or scope of the custom property belongs to. This will be an array of type id it will be belongs to

            '
          items:
            $ref: '#/components/schemas/CustomPropertyTypeUsage'
          type: array
        timeCreated:
          description: 'The date and time the custom property was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339).

            Example: `2019-03-25T21:10:29.600Z`

            '
          format: date-time
          type: string
        timeUpdated:
          description: 'The last time that any change was made to the custom property. An [RFC3339](https://tools.ietf.org/html/rfc3339) formatted datetime string.

            '
          format: date-time
          type: string
        updatedById:
          description: OCID of the user who last modified the custom property.
          maxLength: 255
          minLength: 1
          type: string
        usageCount:
          description: Total number of first class objects using this custom property
          type: integer
      required:
      - key
      type: object
    UpdateCustomPropertyDetails:
      description: Properties used in custom atrribute update operations.
      properties:
        allowedValues:
          description: Allowed values for the custom property if any
          items:
            type: string
          type: array
        description:
          description: Detailed description of the data asset.
          maxLength: 400
          type: string
        displayName:
          description: 'A user-friendly display name. Does not have to be unique, and it''s changeable.

            Avoid entering confidential information.

            '
          maxLength: 255
          minLength: 1
          type: string
        isEditable:
          default: true
          description: If this field is a editable field
          type: boolean
        isEventEnabled:
          default: false
          description: If an OCI Event will be emitted when the custom property is modified.
          type: boolean
        isFilterable:
          default: false
          description: If this field allows to filter or create facets from UI
          type: boolean
        isHidden:
          default: true
          description: If this field is a hidden field
          type: boolean
        isHiddenInSearch:
          default: false
          description: If this field is allowed to pop in search results
          type: boolean
        isMultiValued:
          default: false
          description: If this field allows multiple values to be set
          type: boolean
        isShownInList:
          default: false
          description: If this field is displayed in a list view of applicable objects.
          type: boolean
        isSortable:
          default: false
          description: If this field allows to sort from UI
          type: boolean
        properties:
          additionalProperties:
            additionalProperties:
              description: The string value of the data asset property.
              type: string
            description: 'Key-value pair representing properties of a data asset scoped to a category.

              Example: `{"host": "host1", "port": "1521", "database": "orcl"}`

              '
            type: object
          description: 'A map of maps that contains the properties which are specific to the asset type. Each data asset type

            definition defines it''s set of required and optional properties. The map keys are category names and the

            values are maps of property name to property value. Every property is contained inside of a category. Most

            data assets have required properties within the "default" category.

            Example: `{"properties": { "default": { "host": "host1", "port": "1521", "database": "orcl"}}}`

            '
          type: object
      type: object
    Catalog:
      description: A data catalog enables you to collect, organize, find, access, understand, enrich, and activate technical, business, and operational metadata.
      properties:
        attachedCatalogPrivateEndpoints:
          description: The list of private reverse connection endpoints attached to the catalog
          items:
            type: string
          type: array
        compartmentId:
          description: Compartment identifier.
          type: string
        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: 'Usage of predefined tag keys. These predefined keys are scoped to namespaces.

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

            '
          type: object
        displayName:
          description: Data catalog identifier, which can be renamed.
          maxLength: 255
          minLength: 1
          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
        id:
          description: OCID of the data catalog instance.
          maxLength: 255
          minLength: 1
          type: string
        lifecycleDetails:
          description: 'An message describing the current state in more detail.

            For example, it can be used to provide actionable information for a resource in ''Failed'' state.

            '
          type: string
        lifecycleState:
          description: The current state of the data catalog resource.
          enum:
          - CREATING
          - ACTIVE
          - INACTIVE
          - UPDATING
          - DELETING
          - DELETED
          - FAILED
          - MOVING
          type: string
          x-obmcs-top-level-enum: '#/definitions/LifecycleState'
        numberOfObjects:
          description: 'The number of data objects added to the data catalog.

            Please see the data catalog documentation for further information on how this is calculated.

            '
          type: integer
        serviceApiUrl:
          description: The REST front endpoint URL to the data catalog instance.
          format: uri
          type: string
        serviceConsoleUrl:
          description: The console front endpoint URL to the data catalog instance.
          format: uri
          type: string
        timeCreated:
          description: The time the data catalog was created. An [RFC3339](https://tools.ietf.org/html/rfc3339) formatted datetime string.
          format: date-time
          type: string
        timeUpdated:
          description: The time the data catalog was updated. An [RFC3339](https://tools.ietf.org/html/rfc3339) formatted datetime string.
          format: date-time
          type: string
      required:
      - id
      - compartmentId
      type: object
    RuleSummary:
      description: 'A list of rule resources. One or more rules can be defined for a data entity.

        Each rule can be defined on one or more attributes of the data entity.

        '
      properties:
        attributes:
          description: 'Attributes associated with a rule.

            A UNIQUEKEY rule would contain (at least) one attribute, for the local table column(s) on which uniqueness is defined.

            '
          items:
            $ref: '#/components/schemas/RuleAttribute'
          type: array
        description:
          description: Detailed description of a rule.
          maxLength: 400
          type: string
        displayName:
          description: 'A user-friendly display name. Does not have to be unique, and it''s changeable.

            Avoid entering confidential information.

            '
          maxLength: 255
          minLength: 1
          type: string
        externalKey:
          description: 'External URI that can be used to reference the object. Format will differ based on the type of object.

            '
          maxLength: 255
          minLength: 1
          type: string
        key:
          description: Immutable unique key of a rule.
          maxLength: 255
          minLength: 1
          type: string
        lifecycleState:
          description: State of the rule.
          enum:
          - CREATING
          - ACTIVE
          - INACTIVE
          - UPDATING
          - DELETING
          - DELETED
          - FAILED
          - MOVING
          type: string
          x-obmcs-top-level-enum: '#/definitions/LifecycleState'
        originType:
          description: Origin type of the rule.
          enum:
          - SOURCE
          - USER
          - PROFILING
          type: string
          x-obmcs-top-level-enum: '#/definitions/RuleOriginType'
        referencedAttributes:
          description: 'Attributes associated with referenced rule, applicable only when rule type is FOREIGNKEY.

            A FOREIGNKEY rule would contain (at least) one attribute, for the local table column(s), and (at least) one referencedAttribute for referenced table column(s).

            '
          items:
            $ref: '#/components/schemas/RuleAttribute'
          type: array
        referencedEntityKey:
          description: Entity key that represents the referenced entity, applicable only when rule type is FOREIGNKEY.
          maxLength: 255
          minLength: 1
          type: string
        referencedEntityName:
          description: Entity name that represents the referenced entity, applicable only when rule type is FOREIGNKEY.
          maxLength: 255
          minLength: 1
          type: string
        referencedFolderKey:
          description: Folder key that represents the referenced folder, applicable only when rule type FOREIGNKEY.
          maxLength: 255
          minLength: 1
          type: string
        referencedFolderName:
          description: Folder name that represents the referenced folder, applicable only when rule type FOREIGNKEY.
          maxLength: 255
          minLength: 1
          type: string
        referencedRuleKey:
          description: Rule key that represents the referenced rule, applicable only when rule type is FOREIGNKEY.
          maxLength: 255
          minLength: 1
          type: string
        referencedRuleName:
          description: Rule name that represents the referenced rule, applicable only when rule type is FOREIGNKEY.
          maxLength: 255
          minLength: 1
          type: string
        ruleType:
          description: Type of a rule.
          enum:
          - PRIMARYKEY
          - FOREIGNKEY
          - UNIQUEKEY
          type: string
          x-obmcs-top-level-enum: '#/definitions/RuleType'
        timeCreated:
          description: 'The date and time the rule was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339).

            Example: `2019-03-25T21:10:29.600Z`

            '
          format: date-time
          type: string
        uri:
          description: URI to the rule instance in the API.
          type: string
      required:
      - key
      type: object
    FacetedSearchDateFilterRequest:
      description: Object with date filter criteria
      properties:
        fieldName:
          description: Date field name that needs to be filtered by. Acceptable fields include TimeCreated and TimeUpdated.
          type: string
        timeAfter:
          description: 'The date and time the request was created, as described in

            [RFC 3339](https://tools.ietf.org/rfc/rfc3339), section 14.29.

            '
          format: date-time
          type: string
        timeBefore:
          description: 'The date and time the request was created, as described in

            [RFC 3339](https://tools.ietf.org/rfc/rfc3339), section 14.29.

            '
          format: date-time
          type: string
      type: object
    ConnectionSummary:
      description: Summary representation of a connection to a data asset.
      properties:
        dataAssetKey:
          description: The unique key of the parent data asset.
          maxLength: 255
          minLength: 1
          type: string
        description:
          description: A description of the connection.
          maxLength: 400
          type: string
        displayName:
          description: 'A user-friendly display name. Does not have to be unique, and it''s changeable.

            Avoid entering confidential information.

            '
          maxLength: 255
          minLength: 1
          type: string
        externalKey:
          description: Unique external key for this object as defined in the source systems.
          maxLength: 255
          minLength: 1
          type: string
        isDefault:
          description: Indicates whether this connection is the default connection.
          type: boolean
        key:
          description: Unique connection key that is immutable.
          maxLength: 255
          minLength: 1
          type: string
        lifecycleState:
          description: The current state of the connection.
          enum:
          - CREATING
          - ACTIVE
          - INACTIVE
          - UPDATING
          - DELETING
          - DELETED
          - FAILED
          - MOVING
          type: string
          x-obmcs-top-level-enum: '#/definitions/LifecycleState'
        timeCreated:
          description: 'The date and time the connection was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339).

            Example: `2019-03-25T21:10:29.600Z`

            '
          format: date-time
          type: string
        typeKey:
          description: The key of the object type. Type key's can be found via the '/types' endpoint.
          maxLength: 255
          minLength: 1
          type: string
        uri:
          description: URI to the connection instance in the API.
          type: string
      required:
      - key
      type: object
    FacetedSearchStringFilterRequest:
      description: Object with string filter criteria
      properties:
        field:
          description: 'String/boolean/numerical field name that needs to be filtered by.

            Acceptable field names: CatalogType, AttributeType, FolderType, DataAssetType, CreatedBy, UpdatedBy, Term, Tag, DataAssetName, LifeCycleState.

            '
          type: string
        values:
          description: 'Array of values that the search results needs to be filtered by.

            Acceptable values for field ''CatalogType'': DataAsset, Folder, DataEntity, Attribute, Term, Category, Glossary, Pattern, Job, Schedule, CustomProperty.

            For other fields, acceptable values can be derived by inspecting the data object.

            '
          items:
            type: string
          type: array
      type: object
    PatternCollection:
      description: 'Results of a pattern listing. Patterns are used in entity harvesting.

        '
      properties:
        count:
          description: Total number of items returned.
          type: integer
        items:
          description: Collection of pattern summaries.
          items:
            $ref: '#/components/schemas/PatternSummary'
          type: array
      required:
      - items
      type: object
    FolderTag:
      allOf:
      - $ref: '#/components/schemas/BaseTag'
      - properties:
          folderKey:
            description: The unique key of the folder associated with this tag.
            maxLength: 255
            minLength: 1
            type: string
        type: object
      description: Represents an association of a folder to a term.
      type: object
    Namespace:
      description: 'Namespace Definition

        '
      properties:
        createdById:
          description: OCID of the user who created the namespace.
          maxLength: 255
          minLength: 1
          type: string
        description:
          description: Description for the namespace
          type: string
        displayName:
          description: Name of the Namespace
          type: string
        isServiceDefined:
          default: false
          description: If this field is defined by service or by a user
          type: boolean
        key:
          description: Unique namespace key that is immutable.
          type: string
        lifecycleState:
          description: The current state of the namespace.
          enum:
          - CREATING
          - ACTIVE
          - INACTIVE
          - UPDATING
          - DELETING
          - DELETED
          - FAILED
          - MOVING
          type: string
          x-obmcs-top-level-enum: '#/definitions/LifecycleState'
        timeCreated:
          description: 'The date and time the namespace was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339).

            Example: `2019-03-25T21:10:29.600Z`

            '
          format: date-time
          type: string
        timeUpdated:
          description: 'The last time that any change was made to the namespace. An [RFC3339](https://tools.ietf.org/html/rfc3339) formatted datetime string.

            '
          format: date-time
          type: string
        updatedById:
          description: OCID of the user who last modified the namespace.
          maxLength: 255
          minLength: 1
          type: string
      required:
      - key
      type: object
    SearchTermSummary:
      description: 'Summary of a term associated with an object. This is a brief summary returned as part of the search result.

        '
      properties:
        displayName:
          description: 'A user-friendly display name. Does not have to be unique, and it''s changeable.

            Avoid entering confidential information.

            '
          maxLength: 255
          minLength: 1
          type: string
        glossaryKey:
          description: Unique id of the parent glossary.
          maxLength: 255
          minLength: 1
          type: string
        glossaryName:
          description: Name of the parent glossary.
          maxLength: 255
          minLength: 1
          type: string
        key:
          description: Unique term key that is immutable.
          maxLength: 255
          minLength: 1
          type: string
        parentTermKey:
          description: This terms parent term key. Will be null if the term has no parent term.
          maxLength: 255
          type: string
        parentTermName:
          description: Name of the parent term key. Will be null if the term has no parent term.
          maxLength: 255
          type: string
      required:
      - displayName
      type: object
    DataAssetTagSummary:
      allOf:
      - $ref: '#/components/schemas/BaseTagSummary'
      - properties:
          dataAssetKey:
            description: The unique key of the parent data asset.
            maxLength: 255
            minLength: 1
            type: string
        type: object
      description: Summary of a data asset tag.
      type: object
    CustomPropertyTypeUsage:
      description: Object which describes the indivial object stats for every custom property
      properties:
        count:
          description: Number of objects associated with this type
          type: integer
        isEventEnabled:
          default: false
          description: If an OCI Event will be emitted when the custom property is modified.
          type: boolean
        typeId:
          description: Unique type key identifier
          type: string
        typeName:
          description: Name of the type associated with
          type: string
      type: object
    AttributeCollection:
      description: 'Results of an attributes listing. Attributes describe an item of data with name and datatype.

        '
      properties:
        count:
          description: Total number of items returned.
          type: integer
        items:
          description: Collection of attributes.
          items:
            $ref: '#/components/schemas/AttributeSummary'
          type: array
      required:
      - items
      type: object
    AttributeTag:
      allOf:
      - $ref: '#/components/schemas/BaseTag'
      - properties:
          attributeKey:
            description: The unique key of the parent attribute.
            maxLength: 255
            minLength: 1
            type: string
        type: object
      description: Represents an association of an entity attribute to a term.
      type: object
    DataAsset:
      description: 'Data asset representation. A physical store, or stream, of data known to the data catalog and containing

        one or many data entities, possibly in an organized structure of folders. A data asset is often synonymous

        with a ''System'', such as a database, or may be a file container or a message stream.

        '
      properties:
        catalogId:
          description: The data catalog's OCID.
          maxLength: 255
          minLength: 1
          type: string
        createdById:
          description: OCID of the user who created the data asset.
          maxLength: 255
          minLength: 1
          type: string
        customPropertyMembers:
          description: The list of customized properties along with the values for this object
          items:
            $ref: '#/components/schemas/CustomPropertyGetUsage'
          type: array
        dataSelectorPatterns:
          description: The list of data selector patterns used in the harvest for this data asset to derive logical entities.
          items:
            $ref: '#/components/schemas/PatternSummary'
          type: array
        description:
          description: Detailed description of the data asset.
          maxLength: 400
          type: string
        displayName:
          description: 'A user-friendly display name. Does not have to be unique, and it''s changeable.

            Avoid entering confidential information.

            '
          maxLength: 255
          minLength: 1
          type: string
        externalKey:
          description: 'External URI that can be used to reference the object. Format will differ based on the type of object.

            '
          maxLength: 255
          minLength: 1
          type: string
        key:
          description: Unique data asset key that is immutable.
          maxLength: 255
          minLength: 1
          type: string
        lifecycleDetails:
          description: 'A message describing the current state in more detail. An object not in ACTIVE state may have functional limitations,

            see service documentation for details.

            '
          maxLength: 255
          minLength: 1
          type: string
        lifecycleState:
          description: The current state of the data asset.
          enum:
          - CREATING
          - ACTIVE
          - INACTIVE
          - UPDATING
          - DELETING
          - DELETED
          - FAILED
          - MOVING
          type: string
          x-obmcs-top-level-enum: '#/definitions/LifecycleState'
        properties:
          additionalProperties:
            additionalProperties:
              description: The string value of the data asset property.
              type: string
            description: 'Key-value pair representing properties of a data asset scoped to a category.

              Example: `{"host": "host1", "port": "1521", "database": "orcl"}`

              '
            type: object
          description: 'A map of maps that contains the properties which are specific to the asset type. Each data asset type

            definition defines it''s set of required and optional properties. The map keys are category names and the

            values are maps of property name to property value. Every property is contained inside of a category. Most

            data assets have required properties within the "default" category.

            Example: `{"properties": { "default": { "host": "host1", "port": "1521", "database": "orcl"}}}`

            '
          type: object
        timeCreated:
          description: 'The date and time the data asset was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339).

            Example: `2019-03-25T21:10:29.600Z`

            '
          format: date-time
          type: string
        timeHarvested:
          description: 'The last time that a harvest was performed on the data asset. An [RFC3339](https://tools.ietf.org/html/rfc3339) formatted datetime string.

            '
          format: date-time
          type: string
        timeUpdated:
          description: 'The last time that any change was made to the data asset. An [RFC3339](https://tools.ietf.org/html/rfc3339) formatted datetime string.

            '
          format: date-time
          type: string
        typeKey:
          description: The key of the object type. Type key's can be found via the '/types' endpoint.
          maxLength: 255
          minLength: 1
          type: string
        updatedById:
          description: OCID of the user who last modified the data asset.
          maxLength: 255
          minLength: 1
          type: string
        uri:
          description: URI to the data asset instance in the API.
          type: string
      required:
      - key
      type: object
    UpdatePatternDetails:
      description: Properties used in pattern update operations.
      properties:
        checkFailureLimit:
          description: 'The maximum number of UNMATCHED files, in checkFilePathList, above which the check fails. Optional, if

            checkFilePathList is provided - but if isEnableCheckFailureLimit is set to true it is required.

            '
          type: integer
        checkFilePathList:
          description: 'List of file paths against which the pattern can be tried, as a check. This documents, for reference

            purposes, some example objects a pattern is meant to work with. If isEnableCheckFailureLimit is set to true,

            this will be run as a validation during the request, such that if the check fails the request fails. If

            isEnableCheckFailureLimit instead is set to (the default) false, a pattern will still be created or updated even

            if the check fails, with a lifecycleState of FAILED.

            '
          items:
            type: string
          type: array
        description:
          description: Detailed description of the Pattern.
          maxLength: 400
          type: string
        displayName:
          description: 'A user-friendly display name. Does not have to be unique, and it''s changeable.

            Avoid entering confidential information.

            '
          maxLength: 255
          minLength: 1
          type: string
        expression:
          description: 'Input string which drives the selection process, allowing for fine-grained control using qualifiers.

            Refer to the user documentation for details of the format and examples. A pattern cannot include both

            a prefix and an expression.

            '
          type: string
        filePathPrefix:
          description: 'Input string which drives the selection process.

            Refer to the user documentation for details of the format and examples. A pattern cannot include both

            a prefix and an expression.

            '
          type: string
        isEnableCheckFailureLimit:
          default: false
          description: 'Indicates whether the pattern check, against the checkFilePathList, will fail the request if the count of

            UNMATCHED files is above the checkFailureLimit.

            '
          type: boolean
        properties:
          additionalProperties:
            additionalProperties:
              description: The string value of the pattern property.
              type: string
            description: 'Key-value pair representing properties of a pattern scoped to a category.

              Example: `{"tbd"}`

              '
            type: object
          description: 'A map of maps that contains the properties which are specific to the pattern type. Each pattern type

            definition defines it''s set of required and optional properties.

            Example: `{"properties": { "default": { "tbd"}}}`

            '
          type: object
      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
    UpdateAttributeDetails:
      description: Properties used in attribute update operations.
      properties:
        businessName:
          description: Optional user friendly business name of the attribute. If set, this supplements the harvested display name of the object.
          maxLength: 255
          type: string
        customPropertyMembers:
          description: The list of customized properties along with the values for this object
          items:
            $ref: '#/components/schemas/CustomPropertySetUsage'
          type: array
        description:
          description: Detailed description of the attribute.
          maxLength: 400
          type: string
        displayName:
          description: 'A user-friendly display name. Does not have to be unique, and it''s changeable.

            Avoid entering confidential information.

            '
          maxLength: 255
          minLength: 1
          type: string
        externalDataType:
          description: Data type of the attribute as defined in the external system.
          type: string
        externalDatatypeEntityKey:
          description: External entity key that represents the datatype of this attribute , applicable if this attribute is a complex type.
          maxLength: 255
          minLength: 1
          type: string
        externalParentAttributeKey:
          description: External attribute key that represents the parent attribute  of this attribute , applicable if the parent attribute is of complex type.
          maxLength: 255
          minLength: 1
          type: string
        isIncrementalData:
          description: Property that identifies if this attribute can be used as a watermark to extract incremental data.
          type: boolean
        isNullable:
          description: Property that identifies if this attribute can be assigned nullable values.
          type: boolean
        length:
          description: Max allowed length of the attribute value.
          format: int64
          type: integer
        maxCollectionCount:
          description: 'The maximum count for the number of instances of a given type stored in this collection type attribute,applicable if this attribute is a complex type.

            For type specifications in systems that specify only "capacity" without upper or lower bound , this property can also be used to just mean "capacity".

            Some examples are Varray size in Oracle , Occurs Clause in Cobol , capacity in XmlSchemaObjectCollection , maxOccurs in  Xml , maxItems in Json

            '
          format: int32
          type: integer
        minCollectionCount:
          description: The minimum count for the number of instances of a given type stored in this collection type attribute,applicable if this attribute is a complex type.
          format: int32
          type: integer
        position:
          description: Position of the attribute in the record definition.
          format: int32
          type: integer
        precision:
          description: Precision of the attribute value usually applies to float data type.
          format: int32
          type: integer
        properties:
          additionalProperties:
            additionalProperties:
              description: The string value of the attribute property.
              type: string
            description: 'Key-value pair representing properties of an Attribute scoped to a category.

              Example: `{"key1": "value1"}`

              '
            type: object
          description: 'A map of maps that contains the properties which are specific to the attribute type. Each attribute type

            definition defines it''s set of required and optional properties. The map keys are category names and the

            values are maps of property name to property value. Every property is contained inside of a category. Most

            attributes have required properties within the "default" category. To determine the set of required and

            optional properties for an Attribute type, a query can be done on ''/types?type=attribute'' which returns a

            collection of all attribute types. The appropriate attribute type, which will include definitions of all

            of it''s properties, can be identified from this collection.

            Example: `{"properties": { "default": { "key1": "value1"}}}`

            '
          type: object
        scale:
          description: Scale of the attribute value usually applies to float data type.
          format: int32
          type: integer
        timeExternal:
          description: Last modified timestamp of this object in the external system.
          format: date-time
          type: string
      type: object
    EventConfig:
      description: Describes an event configuration, for a given object type and property. Primarily, whether a property change will result in an event being emitted.
      properties:
        createdById:
          description: OCID of the user who created the configuration.
          maxLength: 255
          minLength: 1
          type: string
        eventConfigStatus:
          description: Status of the configuration.
          enum:
          - ENABLED
          - DISABLED
          type: string
          x-obmcs-top-level-enum: '#/definitions/EventConfigStatus'
        propertyId:
          description: Unique property key identifier.
          type: string
        propertyName:
          description: Name of the property.
          type: string
        timeCreated:
          description: 'The date and time the event was configured, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339).

            Example: `2019-03-25T21:10:29.600Z`

            '
          format: date-time
          type: string
        timeUpdated:
          description: 'The last time that any change was made to the configuration. An [RFC3339](https://tools.ietf.org/html/rfc3339) formatted datetime string.

            '
          format: date-time
          type: string
        typeId:
          description: Unique type key identifier.
          type: string
        typeName:
          description: Name of the type.
          type: string
        updatedById:
          description: OCID of the user who last modified the configuration.
          maxLength: 255
          minLength: 1
          type: string
      type: object
    UpdateFolderDetails:
      description: Properties used in folder update operations.
      properties:
        businessName:
          description: Optional user friendly business name of the folder. If set, this supplements the harvested display name of the object.
          maxLength: 255
          type: string
        customPropertyMembers:
          description: The list of customized properties along with the values for this object
          items:
            $ref: '#/components/schemas/CustomPropertySetUsage'
          type: array
        description:
          description: Detailed description of a folder.
          maxLength: 400
          type: string
        displayName:
          description: 'A user-friendly display name. Does not have to be unique, and it''s changeable.

            Avoid entering confidential information.

            '
          maxLength: 255
          minLength: 1
          type: string
        harvestStatus:
          description: Harvest status of the folder.
          enum:
          - COMPLETE
          - ERROR
          - IN_PROGRESS
          - DEFERRED
          type: string
          x-obmcs-top-level-enum: '#/definitions/HarvestStatus'
        lastJobKey:
          description: The key of the last harvest process to update the metadata of this object.
          maxLength: 255
          type: string
        parentFolderKey:
          description: The key of the containing folder.
          maxLength: 255
          type: string
        properties:
          additionalProperties:
            additionalProperties:
              description: The string value of the folder property.
              type: string
            description: 'Key-value pair representing properties of a folder scoped to a category.

              Example: `{"key1": "value1"}`

              '
            type: object
          description: 'A map of maps that contains the properties which are specific to the folder type. Each folder type

            definition defines it''s set of required and optional properties. The map keys are category names and the

            values are maps of property name to property value. Every property is contained inside of a category. Most

            folders have required properties within the "default" category. To determine the set of optional and

            required properties for a folder type, a query can be done on ''/types?type=folder'' that returns a

            collection of all folder types. The appropriate folder type, which includes definitions of all of

            it''s properties, can be identified from this collection.

            Example: `{"properties": { "default": { "key1": "value1"}}}`

            '
          type: object
        timeExternal:
          description: Last modified timestamp of this object in the external system.
          format: date-time
          type: string
      type: object
    JobExecutionCollection:
      description: 'Results of a job executions listing. Job executions are execution instances of a scheduled job.

        '
      properties:
        count:
          description: Total number of items returned.
          type: integer
        items:
          description: Collection of job executions.
          items:
            $ref: '#/components/schemas/JobExecutionSummary'
          type: array
      required:
      - items
      type: object
    GlossaryCollection:
      description: 'Results of a glossaries listing.  Glossary is an organizing concept for business terms to provide a unified semantic model across disparate data assets.

        '
      properties:
        count:
          description: Total number of items returned.
          type: integer
        items:
          description: Collection of glossaries.
          items:
            $ref: '#/components/schemas/GlossarySummary'
          type: array
      required:
      - items
      type: object
    CreateConnectionDetails:
      description: Properties used in connection create operations.
      properties:
        customPropertyMembers:
          description: The list of customized properties along with the values for this object
          items:
            $ref: '#/components/schemas/CustomPropertySetUsage'
          type: array
        description:
          description: A description of the connection.
          maxLength: 400
          type: string
        displayName:
          description: 'A user-friendly display name. Does not have to be unique, and it''s changeable.

            Avoid entering confidential information.

            '
          maxLength: 255
          minLength: 1
          type: string
        encProperties:
          additionalProperties:
            additionalProperties:
              description: The string value of the sensitive connection property.
              type: string
            description: 'Key-value pair representing sensitive properties of a connection scoped to a category.

              Example: `{"password": "example-password"}`

              '
            type: object
          description: 'A map of maps that contains the encrypted values for sensitive properties which are specific to the

            connection type. Each connection type definition defines it''s set of required and optional properties.

            The map keys are category names and the values are maps of property name to property value. Every property is

            contained inside of a category. Most connections have required properties within the "default" category.

            To determine the set of optional and required properties for a connection type, a query can be done

            on ''/types?type=connection'' that returns a collection of all connection types. The appropriate connection

            type, which will include definitions of all of it''s properties, can be identified from this collection.

            Example: `{"encProperties": { "default": { "password": "example-password"}}}`

            '
          type: object
        isDefault:
          description: 'Indicates whether this connection is the default connection. The first connection of a data asset defaults

            to being the default, subsequent connections default to not being the default. If a default connection already

            exists, then trying to create a connection as the default will fail. In this case the default connection would

            need to be updated not to be the default and then the new connection can then be created as the default.

            '
          type: boolean
        properties:
          additionalProperties:
            additionalProperties:
              description: The string value of the connection property.
              type: string
            description: 'Key-value pair representing properties of a connection scoped to a category.

              Example: `{"username": "user1"}`

              '
            type: object
          description: 'A map of maps that contains the properties which are specific to the connection type. Each connection type

            definition defines it''s set of required and optional properties. The map keys are category names and the

            values are maps of property name to property value. Every property is contained inside of a category. Most

            connections have required properties within the "default" category. To determine the set of optional and

            required properties for a connection type, a query can be done on ''/types?type=connection'' that returns a

            collection of all connection types. The appropriate connection type, which will include definitions of all

            of it''s properties, can be identified from this collection.

            Example: `{"properties": { "default": { "username": "user1"}}}`

            '
          type: object
        typeKey:
          description: The key of the object type. Type key's can be found via the '/types' endpoint.
          maxLength: 255
          minLength: 1
          type: string
      required:
      - displayName
      - typeKey
      - properties
      type: object
    CreateDataAssetDetails:
      description: Properties used in data asset create operations.
      properties:
        customPropertyMembers:
          description: The list of customized properties along with the values for this object
          items:
            $ref: '#/components/schemas/CustomPropertySetUsage'
          type: array
        description:
          description: Detailed description of the data asset.
          maxLength: 400
          type: string
        displayName:
          description: 'A user-friendly display name. Does not have to be unique, and it''s changeable.

            Avoid entering confidential information.

            '
          maxLength: 255
          minLength: 1
          type: string
        properties:
          additionalProperties:
            additionalProperties:
              description: The string value of the data asset property.
              type: string
            description: 'Key-value pair representing properties of a data asset scoped to a category.

              Example: `{"host": "host1", "port": "1521", "database": "orcl"}`

              '
            type: object
          description: 'A map of maps that contains the properties which are specific to the data asset type. Each data asset type

            definition defines it''s set of required and optional properties. The map keys are category names and the

            values are maps of property name to property value. Every property is contained inside of a category. Most

            data assets have required properties within the "default" category. To determine the set of optional and

            required properties for a data asset type, a query can be done on ''/types?type=dataAsset'' that returns a

            collection of all data asset types. The appropriate data asset type, which includes definitions of all of

            it''s properties, can be identified from this collection.

            Example: `{"properties": { "default": { "host": "host1", "port": "1521", "database": "orcl"}}}`

            '
          type: object
        typeKey:
          description: The key of the data asset type. This can be obtained via the '/types' endpoint.
          maxLength: 255
          minLength: 1
          type: string
      required:
      - displayName
      - typeKey
      type: object
    FacetedSearchAggregation:
      description: Aggregation/facets on properties of data object.
      properties:
        aggregation:
          additionalProperties:
            format: int64
            type: integer
          description: Count of number of data objects having property.
          type: object
        dataType:
          description: Data type of object property.
          type: string
        propertyType:
          description: 'Type of property that indicates if it was defined by the user or system.

            CUSTOM_PROPERTY is defined by the user on a data object.

            DEFAULT_PROPERTY is defined by the system on a data object.

            '
          enum:
          - CUSTOM_PROPERTY
          - DEFAULT_PROPERTY
          type: string
        type:
          description: Name of data object property
          type: string
      type: object
    DataAssetTag:
      allOf:
      - $ref: '#/components/schemas/BaseTag'
      - properties:
          dataAssetKey:
            description: The unique key of the parent data asset.
            maxLength: 255
            minLength: 1
            type: string
        type: object
      description: Represents an association of a data asset to a term.
      type: object
    CreateCatalogDetails:
      description: The information about a new data catalog.
      properties:
        compartmentId:
          description: Compartment identifier.
          maxLength: 255
          minLength: 1
          type: string
        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: 'Usage of predefined tag keys. These predefined keys are scoped to namespaces.

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

            '
          type: object
        displayName:
          description: Data catalog identifier.
          maxLength: 255
          minLength: 1
          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
      required:
      - compartmentId
      type: object
    NamespaceSummary:
      description: 'Summary of a namespace

        '
      properties:
        description:
          description: Detailed description of the namespace.
          maxLength: 400
          type: string
        displayName:
          description: Name of the namespace
          type: string
        isServiceDefined:
          default: false
          description: If this field is defined by service or by a user
          type: boolean
        key:
          description: Unique namespace key that is immutable.
          type: string
        lifecycleState:
          description: The current state of the namespace.
          enum:
          - CREATING
          - ACTIVE
          - INACTIVE
          - UPDATING
          - DELETING
          - DELETED
          - FAILED
          - MOVING
          type: string
          x-obmcs-top-level-enum: '#/definitions/LifecycleState'
        timeCreated:
          description: 'The date and time the namespace was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339).

            Example: `2019-03-25T21:10:29.600Z`

            '
          format: date-time
          type: string
      required:
      - key
      type: object
    UpdateConnectionDetails:
      description: Properties used in connection update operations.
      properties:
        customPropertyMembers:
          description: The list of customized properties along with the values for this object
          items:
            $ref: '#/components/schemas/CustomPropertySetUsage'
          type: array
        description:
          description: A description of the connection.
          maxLength: 400
          type: string
        displayName:
          description: 'A user-friendly display name. Does not have to be unique, and it''s changeable.

            Avoid entering confidential information.

            '
          maxLength: 255
          minLength: 1
          type: string
        encProperties:
          additionalProperties:
            additionalProperties:
              description: The string value of the sensitive connection property.
              type: string
            description: 'Key-value pair representing sensitive properties of a connection scoped to a category.

              Example: `{"password": "example-password"}`

              '
            type: object
          description: 'A map of maps that contains the encrypted values for sensitive properties which are specific to the

            connection type. Each connection type definition defines it''s set of required and optional properties.

            The map keys are category names and the values are maps of property name to property value. Every property is

            contained inside of a category. Most connections have required properties within the "default" category.

            To determine the set of optional and required properties for a connection type, a query can be done

            on ''/types?type=connection'' that returns a collection of all connection types. The appropriate connection

            type, which will include definitions of all of it''s properties, can be identified from this collection.

            Example: `{"encProperties": { "default": { "password": "example-password"}}}`

            '
          type: object
        isDefault:
          description: Indicates whether this connection is the default connection.
          type: boolean
        properties:
          additionalProperties:
            additionalProperties:
              description: The string value of the connection property.
              type: string
            description: 'Key-value pair representing properties of a connection scoped to a category.

              Example: `{"username": "user1"}`

              '
            type: object
          description: 'A map of maps that contains the properties which are specific to the connection type. Each connection type

            definition defines it''s set of required and optional properties. The map keys are category names and the

            values are maps of property name to property value. Every property is contained inside of a category. Most

            connections have required properties within the "default" category. To determine the set of optional and

            required properties for a connection type, a query can be done on ''/types?type=connection'' that returns a

            collection of all connection types. The appropriate connection type, which will include definitions of all

            of it''s properties, can be identified from this collection.

            Example: `{"properties": { "default": { "username": "user1"}}}`

            '
          type: object
      type: object
    CreateCatalogPrivateEndpointDetails:
      description: Information about the new private endpoint resource
      properties:
        compartmentId:
          description: Compartment identifier.
          maxLength: 255
          minLength: 1
          type: string
        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: 'Usage of predefined tag keys. These predefined keys are scoped to namespaces.

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

            '
          type: object
        displayName:
          description: Display name of the private endpoint resource being created.
          maxLength: 255
          minLength: 1
          type: string
        dnsZones:
          description: 'List of DNS zones to be used by the data assets to be harvested.

            Example: custpvtsubnet.oraclevcn.com for data asset: db.custpvtsubnet.oraclevcn.com

            '
          items:
            maxLength: 253
            minLength: 1
            type: string
          maxItems: 30
          minItems: 1
          type: array
        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
        securityAttributes:
          additionalProperties:
            additionalProperties:
              description: 'Attribute value and mode. Only the String type is supported for value. Mode is currently always "enforce".


                Example: `{"value": "42", "mode": "enforce"}`

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


              Example: `{"MaxEgressCount": {"value": "42", "mode": "enforce"}}`

              '
            type: object
          description: 'Security attributes 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: `{"Oracle-ZPR": {"MaxEgressCount": {"value": "42", "mode": "enforce"}}}`

            '
          type: object
        subnetId:
          description: 'The OCID of subnet to which the reverse connection is to be created

            '
          maxLength: 255
          minLength: 1
          type: string
      required:
      - subnetId
      - dnsZones
      - compartmentId
      type: object
    CustomProperty:
      description: 'Custom Property Definition

        '
      properties:
        allowedValues:
          description: Allowed values for the custom property if any
          items:
            type: string
          type: array
        createdById:
          description: OCID of the user who created the custom property.
          maxLength: 255
          minLength: 1
          type: string
        dataType:
          description: Data type of the custom property
          enum:
          - TEXT
          - RICH_TEXT
          - BOOLEAN
          - NUMBER
          - DATE
          type: string
          x-obmcs-top-level-enum: '#/definitions/CustomPropertyDataType'
        description:
          description: Description for the custom property
          type: string
        displayName:
          description: Display name of the custom property
          type: string
        events:
          description: Event configuration for this custom property, against the desired subset of object types to which the property applies.
          items:
            $ref: '#/components/schemas/EventConfig'
          type: array
        isEditable:
          default: true
          description: If this field is a editable field
          type: boolean
        isEventEnabled:
          default: false
          description: If an OCI Event will be emitted when the custom property is modified.
          type: boolean
        isFilterable:
          default: false
          description: If this field allows to filter or create facets from UI
          type: boolean
        isHidden:
          default: true
          description: If this field is a hidden field
          type: boolean
        isHiddenInSearch:
          default: false
          description: If this field is allowed to pop in search results
          type: boolean
        isListType:
          default: false
          description: Is this property allowed to have list of values
          type: boolean
        isMultiValued:
          default: false
          description: If this field allows multiple values to be set
          type: boolean
        isServiceDefined:
          default: false
          description: If this field is defined by service or by a user
          type: boolean
        isShownInList:
          default: false
          description: If this field is displayed in a list view of applicable objects.
          type: boolean
        isSortable:
          default: false
          description: If this field allows to sort from UI
          type: boolean
        key:
          description: Unique data asset key that is immutable.
          type: string
        lifecycleState:
          description: The current state of the custom property.
          enum:
          - CREATING
          - ACTIVE
          - INACTIVE
          - UPDATING
          - DELETING
          - DELETED
          - FAILED
          - MOVING
          type: string
          x-obmcs-top-level-enum: '#/definitions/LifecycleState'
        namespaceName:
          description: Namespace name of the custom property
          type: string
        properties:
          additionalProperties:
            additionalProperties:
              description: The string value of the data asset property.
              type: string
            description: 'Key-value pair representing properties of a data asset scoped to a category.

              Example: `{"host": "host1", "port": "1521", "database": "orcl"}`

              '
            type: object
          description: 'A map of maps that contains the properties which are specific to the asset type. Each data asset type

            definition defines it''s set of required and optional properties. The map keys are category names and the

            values are maps of property name to property value. Every property is contained inside of a category. Most

            data assets have required properties within the "default" category.

            Example: `{"properties": { "default": { "host": "host1", "port": "1521", "database": "orcl"}}}`

            '
          type: object
        scope:
          description: The set of object types to which the custom property applies.
          items:
            $ref: '#/components/schemas/CustomPropertyTypeUsage'
          type: array
        timeCreated:
          description: 'The date and time the custom property was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339).

            Example: `2019-03-25T21:10:29.600Z`

            '
          format: date-time
          type: string
        timeUpdated:
          description: 'The last time that any change was made to the custom property. An [RFC3339](https://tools.ietf.org/html/rfc3339) formatted datetime string.

            '
          format: date-time
          type: string
        updatedById:
          description: OCID of the user who last modified the custom property.
          maxLength: 255
          minLength: 1
          type: string
        usageCount:
          description: Total number of first class objects using this custom property
          type: integer
      required:
      - key
      type: object
    ImportDataAssetJobResult:
      description: Information about a data asset import operation.
      properties:
        dataAssetKey:
          description: The unique key of the data asset on which import is triggered.
          type: string
        importJobDefinitionKey:
          description: The unique key of the job definition resource that is used for the import.
          maxLength: 255
          minLength: 1
          type: string
        importJobExecutionKey:
          description: The unique key of the parent job execution for which the log resource is created.
          maxLength: 255
          minLength: 1
          type: string
        importJobExecutionStatus:
          description: The status of the import job execution.
          enum:
          - CREATED
          - IN_PROGRESS
          - INACTIVE
          - FAILED
          - SUCCEEDED
          - CANCELED
          - SUCCEEDED_WITH_WARNINGS
          type: string
          x-obmcs-top-level-enum: '#/definitions/JobExecutionState'
        importJobKey:
          description: The unique key of the job policy for the import.
          maxLength: 255
          minLength: 1
          type: string
      required:
      - dataAssetKey
      type: object
    ProcessRecommendationDetails:
      description: 'Details of recommendation to be processed.

        '
      properties:
        properties:
          additionalProperties:
            additionalProperties:
              description: The string value of the property.
              type: string
            description: 'Key-value pair representing properties of a recommendation.

              Example: `{"key1": "value1"}`

              '
            type: object
          description: "A map of maps that contains additional properties which are specific to the associated objects.\nEach associated object defines it's set of required and optional properties.\nExample: `{\n            \"DataEntity\": {\n              \"parentId\": \"entityId\"\n            },\n            \"Term\": {\n              \"parentId\": \"glossaryId\"\n            }\n          }`\n"
          type: object
        recommendationKey:
          description: Unique identifier of the recommendation.
          maxLength: 255
          minLength: 1
          type: string
        recommendationStatus:
          description: The status of a recommendation.
          enum:
          - ACCEPTED
          - REJECTED
          - INFERRED
          type: string
          x-obmcs-top-level-enum: '#/definitions/RecommendationStatus'
      required:
      - recommendationKey
      - recommendationStatus
      type: object
    LineageObject:
      description: Object describing an individual element of object lineage.
      properties:
        description:
          description: Detailed description of the object.
          maxLength: 400
          minLength: 1
          type: string
        displayName:
          description: Display name of the object.
          maxLength: 255
          minLength: 1
          type: string
        isIntraLineageAvailable:
          default: false
          description: 'Indicates if intra-lineage is available for this given object. If yes, drill-down can be requested for

            this object.

            '
          type: boolean
        objectKey:
          description: Key of the object, such as an entity, about which this lineage applies.
          maxLength: 255
          minLength: 1
          type: string
        parentKey:
          description: Key of the parent object for this object.
          maxLength: 255
          minLength: 1
          type: string
        parentPath:
          description: Full path of the parent object.
          maxLength: 255
          minLength: 1
          type: string
        properties:
          additionalProperties:
            additionalProperties:
              description: The string value of the data asset property.
              type: string
            description: 'Key-value pair representing properties of a data entity scoped to a category.

              Example: `{"key1": "value1"}`

              '
            type: object
          description: 'A map of maps that contains the properties which are specific to the entity type. Each entity type

            definition defines it''s set of required and optional properties. The map keys are category names and the

            values are maps of property name to property value. Every property is contained inside of a category. Most

            data entities have required properties within the "default" category.

            Example: `{"properties": { "default": { "key1": "value1"}}}`

            '
          maxProperties: 100
          type: object
        timeCreated:
          description: 'The time that this object was created. An [RFC3339](https://tools.ietf.org/html/rfc3339) formatted datetime string.

            '
          format: date-time
          type: string
        timeUpdated:
          description: 'The time that this object was updated. An [RFC3339](https://tools.ietf.org/html/rfc3339) formatted datetime string.

            '
          format: date-time
          type: string
        typeKey:
          description: Type key of the object. Type keys can be found via the '/types' endpoint.
          maxLength: 255
          minLength: 1
          type: string
        typeName:
          description: Type name of the object. Type keys can be found via the '/types' endpoint.
          maxLength: 255
          minLength: 1
          type: string
      type: object
    JobCollection:
      description: 'Results of a jobs listing. Jobs are scheduled instances of a job definition.

        '
      properties:
        count:
          description: Total number of items returned.
          type: integer
        items:
          description: Collection of jobs.
          items:
            $ref: '#/components/schemas/JobSummary'
          type: array
      required:
      - items
      type: object
    FacetedSearchFilterRequest:
      description: Object with details about filter criteria.
      properties:
        searchDateFilters:
          description: Object with date filter criteria
          items:
            $ref: '#/components/schemas/FacetedSearchDateFilterRequest'
          type: array
        searchStringFilters:
          description: Object with string filter criteria
          items:
            $ref: '#/components/schemas/FacetedSearchStringFilterRequest'
          type: array
      type: object
    TermRelationshipSummary:
      description: 'Summary of a term relationship. Business term relationship between two terms in a business glossary.

        '
      properties:
        description:
          description: Detailed description of the term relationship usually defined at the time of creation.
          maxLength: 400
          type: string
        displayName:
          description: 'A user-friendly display name. Does not have to be unique, and it''s changeable.

            Avoid entering confidential information.This is the same as relationshipType for termRelationship

            '
          maxLength: 255
          minLength: 1
          type: string
        key:
          description: Unique term relationship key that is immutable.
          maxLength: 255
          minLength: 1
          type: string
        lifecycleState:
          description: State of the term relationship.
          enum:
          - CREATING
          - ACTIVE
          - INACTIVE
          - UPDATING
          - DELETING
          - DELETED
          - FAILED
          - MOVING
          type: string
          x-obmcs-top-level-enum: '#/definitions/LifecycleState'
        parentTermDescription:
          description: Description of the parent term.
          maxLength: 400
          type: string
        parentTermDisplayName:
          description: Name of the parent term.
          maxLength: 255
          minLength: 1
          type: string
        parentTermGlossaryKey:
          description: Glossary key of the parent term.
          type: string
        parentTermKey:
          description: This relationships parent term key.
          maxLength: 255
          type: string
        parentTermPath:
          description: Full path of the parent term.
          type: string
        relatedTermDescription:
          description: Description of the related term.
          maxLength: 400
          type: string
        relatedTermDisplayName:
          description: Name of the related term.
          maxLength: 255
          minLength: 1
          type: string
        relatedTermGlossaryKey:
          description: Glossary key of the related term.
          type: string
        relatedTermKey:
          description: Unique id of the related term.
          maxLength: 255
          minLength: 1
          type: string
        relatedTermPath:
          description: Full path of the related term.
          type: string
        timeCreated:
          description: 'The date and time the term relationship was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339).

            Example: `2019-03-25T21:10:29.600Z`

            '
          format: date-time
          type: string
        uri:
          description: URI to the term relationship instance in the API.
          type: string
      required:
      - key
      type: object
    BaseTag:
      description: Represents the association of an object to a term. Tags are immutable.
      properties:
        createdById:
          description: OCID of the user who created the tag.
          maxLength: 255
          minLength: 1
          type: string
        key:
          description: Unique tag key that is immutable.
          maxLength: 255
          minLength: 1
          type: string
        lifecycleState:
          description: The current state of the tag.
          enum:
          - CREATING
          - ACTIVE
          - INACTIVE
          - UPDATING
          - DELETING
          - DELETED
          - FAILED
          - MOVING
          type: string
          x-obmcs-top-level-enum: '#/definitions/LifecycleState'
        name:
          description: Name of the tag which matches the term name.
          maxLength: 255
          minLength: 1
          type: string
        termDescription:
          description: Description of the related term.
          maxLength: 400
          type: string
        termKey:
          description: Unique key of the related term.
          maxLength: 255
          type: string
        termPath:
          description: Path of the related term.
          type: string
        timeCreated:
          description: 'The date and time the tag was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339).

            Example: `2019-03-25T21:10:29.600Z`

            '
          format: date-time
          type: string
        uri:
          description: URI to the tag instance in the API.
          type: string
      required:
      - key
      type: object
    UpdateEntityDetails:
      description: Properties used in entity update operations.
      properties:
        businessName:
          description: Optional user friendly business name of the data entity. If set, this supplements the harvested display name of the object.
          maxLength: 255
          type: string
        customPropertyMembers:
          description: The list of customized properties along with the values for this object
          items:
            $ref: '#/components/schemas/CustomPropertySetUsage'
          type: array
        description:
          description: Detailed description of a data entity.
          maxLength: 400
          type: string
        displayName:
          description: 'A user-friendly display name. Does not have to be unique, and it''s changeable.

            Avoid entering confidential information.

            '
          maxLength: 255
          minLength: 1
          type: string
        folderKey:
          description: Key of the associated folder.
          maxLength: 255
          type: string
        harvestStatus:
          description: 'Status of the object as updated by the harvest process. When an entity object is created, it''s harvest status

            will indicate if the entity''s metadata has been fully harvested or not. The harvest process can perform

            shallow harvesting to allow users to browse the metadata and can on-demand deep harvest on any object

            This requires a harvest status indicator for catalog objects.

            '
          enum:
          - COMPLETE
          - ERROR
          - IN_PROGRESS
          - DEFERRED
          type: string
          x-obmcs-top-level-enum: '#/definitions/HarvestStatus'
        isLogical:
          description: Property to indicate if the object is a physical materialized object or virtual. For example, View.
          type: boolean
        isPartition:
          description: Property to indicate if the object is a sub object of a parent physical object.
          type: boolean
        lastJobKey:
          description: Key of the last harvest process to update this object.
          maxLength: 255
          type: string
        patternKey:
          description: Key of the associated pattern if this is a logical entity.
          maxLength: 255
          type: string
        properties:
          additionalProperties:
            additionalProperties:
              description: The string value of the data entity property.
              type: string
            description: 'Key-value pair representing properties of a data entity scoped to a category.

              Example: `{"key1": "value1"}`

              '
            type: object
          description: 'A map of maps that contains the properties which are specific to the entity type. Each entity type

            definition defines it''s set of required and optional properties. The map keys are category names and the

            values are maps of property name to property value. Every property is contained inside of a category. Most

            entities have required properties within the "default" category. To determine the set of required and

            optional properties for an entity type, a query can be done on ''/types?type=dataEntity'' that returns a

            collection of all entity types. The appropriate entity type, which includes definitions of all of

            it''s properties, can be identified from this collection.

            Example: `{"properties": { "default": { "key1": "value1"}}}`

            '
          type: object
        realizedExpression:
          description: The expression realized after resolving qualifiers . Used in deriving this logical entity
          type: string
        timeExternal:
          description: Last modified timestamp of the object in the external system.
          format: date-time
          type: string
      type: object
    RecommendationCollection:
      description: 'Results of a get recommendation.

        '
      properties:
        count:
          description: Total number of items returned.
          minimum: 0
          type: integer
        items:
          description: Collection of recommendations.
          items:
            $ref: '#/components/schemas/RecommendationDetails'
          type: array
      required:
      - items
      type: object
    WorkRequestLog:
      description: A log message from the execution of a work request.
      properties:
        message:
          description: Human-readable log message.
          type: string
        timestamp:
          description: The time the log message was written. An [RFC3339](https://tools.ietf.org/html/rfc3339) formatted datetime string
          format: date-time
          type: string
      required:
      - message
      - timestamp
    CreateTagDetails:
      description: Properties used in tag create operations.
      properties:
        name:
          description: 'The name of the tag in the case of a free form tag.

            When linking to a glossary term, this field is not specified.

            '
          maxLength: 255
          type: string
        termKey:
          description: Unique key of the related term or null in the case of a free form tag.
          maxLength: 255
          type: string
      type: object
    UpdateTermDetails:
      description: Properties used in term update operations.
      properties:
        customPropertyMembers:
          description: The list of customized properties along with the values for this object
          items:
            $ref: '#/components/schemas/CustomPropertySetUsage'
          type: array
        description:
          description: Detailed description of the term.
          maxLength: 400
          type: string
        displayName:
          description: 'A user-friendly display name. Does not have to be unique, and it''s changeable.

            Avoid entering confidential information.

            '
          maxLength: 255
          minLength: 1
          type: string
        owner:
          description: OCID of the user who is the owner of this business terminology.
          maxLength: 255
          minLength: 1
          type: string
        parentTermKey:
          description: The parent key of the term. In the case of a root-level category only, the term would have no parent and this should be left unset.
          maxLength: 255
          type: string
        workflowStatus:
          description: Status of the approval process workflow for this business term in the glossary
          enum:
          - NEW
          - APPROVED
          - UNDER_REVIEW
          - ESCALATED
          type: string
          x-obmcs-top-level-enum: '#/definitions/TermWorkflowStatus'
      type: object
    FolderCollection:
      description: 'Results of a folders listing. Folders are external organization concept that groups data entities.

        '
      properties:
        count:
          description: Total number of items returned.
          type: integer
        items:
          description: Collection of folders.
          items:
            $ref: '#/components/schemas/FolderSummary'
          type: array
      required:
      - items
      type: object
    UpdateMetastoreDetails:
      description: Information to be updated for an existing metastore.
      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: 'Usage of predefined tag keys. These predefined keys are scoped to namespaces.

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

            '
          type: object
        displayName:
          description: Mutable name of the metastore.
          maxLength: 255
          minLength: 1
          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
      type: object
    TermCollection:
      description: 'Results of a terms listing. Terms are defined in business glossary and are used in tagging catalog objects.

        '
      properties:
        count:
          description: Total number of items returned.
          type: integer
        items:
          description: Collection of terms.
          items:
            $ref: '#/components/schemas/TermSummary'
          type: array
      required:
      - items
      type: object
    Pattern:
      description: 'A pattern is a data selector or filter which can provide a singular,

        logical entity view aggregating multiple physical data artifacts for ease of use.

        '
      properties:
        catalogId:
          description: The data catalog's OCID.
          maxLength: 255
          minLength: 1
          type: string
        checkFailureLimit:
          description: 'The maximum number of UNMATCHED files, in checkFilePathList, above which the check fails. Optional, if

            checkFilePathList is provided - but if isEnableCheckFailureLimit is set to true it is required.

            '
          type: integer
        checkFilePathList:
          description: 'List of file paths against which the pattern can be tried, as a check. This documents, for reference

            purposes, some example objects a pattern is meant to work with. If isEnableCheckFailureLimit is set to true,

            this will be run as a validation during the request, such that if the check fails the request fails. If

            isEnableCheckFailureLimit instead is set to (the default) false, a pattern will still be created or updated even

            if the check fails, with a lifecycleState of FAILED.

            '
          items:
            type: string
          type: array
        createdById:
          description: OCID of the user who created the pattern.
          maxLength: 255
          minLength: 1
          type: string
        description:
          description: Detailed description of the pattern.
          maxLength: 400
          type: string
        displayName:
          description: 'A user-friendly display name. Does not have to be unique, and it''s changeable.

            Avoid entering confidential information.

            '
          maxLength: 255
          minLength: 1
          type: string
        expression:
          description: 'Input string which drives the selection process, allowing for fine-grained control using qualifiers.

            Refer to the user documentation for details of the format and examples. A pattern cannot include both

            a prefix and an expression.

            '
          type: string
        filePathPrefix:
          description: 'Input string which drives the selection process.

            Refer to the user documentation for details of the format and examples. A pattern cannot include both

            a prefix and an expression.

            '
          type: string
        isEnableCheckFailureLimit:
          default: false
          description: 'Indicates whether the pattern check, against the checkFilePathList, will fail the request if the count of

            UNMATCHED files is above the checkFailureLimit.

            '
          type: boolean
        key:
          description: Unique pattern key that is immutable.
          maxLength: 255
          minLength: 1
          type: string
        lifecycleState:
          description: The current state of the pattern.
          enum:
          - CREATING
          - ACTIVE
          - INACTIVE
          - UPDATING
          - DELETING
          - DELETED
          - FAILED
          - MOVING
          type: string
          x-obmcs-top-level-enum: '#/definitions/LifecycleState'
        properties:
          additionalProperties:
            additionalProperties:
              description: The string value of the pattern property.
              type: string
            description: 'Key-value pair representing properties of a pattern scoped to a category.

              Example: `{"tbd"}`

              '
            type: object
          description: 'A map of maps that contains the properties which are specific to the pattern type. Each pattern type

            definition defines it''s set of required and optional properties.

            Example: `{"properties": { "default": { "tbd"}}}`

            '
          type: object
        timeCreated:
          description: 'The date and time the pattern was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339).

            Example: `2019-03-25T21:10:29.600Z`

            '
          format: date-time
          type: string
        timeUpdated:
          description: 'The last time that any change was made to the pattern. An [RFC3339](https://tools.ietf.org/html/rfc3339) formatted datetime string.

            '
          format: date-time
          type: string
        updatedById:
          description: OCID of the user who last modified the pattern.
          maxLength: 255
          minLength: 1
          type: string
      required:
      - key
      type: object
    DataAssetExportScope:
      description: "Scope of asset export, which consists of a container object (bucket, folder, schema, etc) within the asset,\nand types of child objects contained by that object to be included.\n   objectKey - Key of the container object to be exported. For example, key of schema_1.\n   exportTypeIds - Type key(s) of objects within the container object to be exported. For example, type key of table or view.\n"
      properties:
        exportTypeIds:
          description: Array of type keys selected for export.
          items:
            type: string
          maxItems: 30
          type: array
        objectKey:
          description: Unique key of the object selected for export.
          maxLength: 255
          minLength: 1
          type: string
      type: object
    ValidatePatternResult:
      description: Details regarding the validation of a pattern resource.
      properties:
        derivedLogicalEntities:
          description: Collection of logical entities derived from the pattern, as applied to a list of file paths.
          items:
            $ref: '#/components/schemas/DerivedLogicalEntities'
          type: array
        expression:
          description: The expression used in the pattern validation.
          type: string
        filePathPrefix:
          description: The prefix used in the pattern validation.
          type: string
        message:
          description: The message from the pattern validation.
          type: string
        status:
          description: The status returned from the pattern validation.
          type: string
      required:
      - status
      type: object
    Folder:
      description: 'A generic term used in the data catalog for an external organization concept used for a collection of data entities

        or processes within a data asset. This term is an internal term which models multiple external types of folder,

        such as file directories, database schemas, and so on. Some data assets, such as Object Store containers, may contain

        many levels of folders.

        '
      properties:
        businessName:
          description: Optional user friendly business name of the folder. If set, this supplements the harvested display name of the object.
          maxLength: 255
          type: string
        createdById:
          description: OCID of the user who created the folder.
          maxLength: 255
          minLength: 1
          type: string
        customPropertyMembers:
          description: The list of customized properties along with the values for this object
          items:
            $ref: '#/components/schemas/CustomPropertyGetUsage'
          type: array
        dataAssetKey:
          description: The key of the associated data asset.
          maxLength: 255
          minLength: 1
          type: string
        description:
          description: Detailed description of a folder.
          maxLength: 400
          type: string
        displayName:
          description: 'A user-friendly display name. Does not have to be unique, and it''s changeable.

            Avoid entering confidential information.

            '
          maxLength: 255
          minLength: 1
          type: string
        externalKey:
          description: Unique external key of this object in the source system.
          maxLength: 255
          minLength: 1
          type: string
        harvestStatus:
          description: Status of the object as updated by the harvest process.
          enum:
          - COMPLETE
          - ERROR
          - IN_PROGRESS
          - DEFERRED
          type: string
          x-obmcs-top-level-enum: '#/definitions/HarvestStatus'
        key:
          description: Unique folder key that is immutable.
          maxLength: 255
          minLength: 1
          type: string
        lastJobKey:
          description: The key of the last harvest process to update the metadata of this object.
          maxLength: 255
          type: string
        lifecycleDetails:
          description: 'A message describing the current state in more detail. An object not in ACTIVE state may have functional limitations,

            see service documentation for details.

            '
          maxLength: 255
          minLength: 1
          type: string
        lifecycleState:
          description: The current state of the folder.
          enum:
          - CREATING
          - ACTIVE
          - INACTIVE
          - UPDATING
          - DELETING
          - DELETED
          - FAILED
          - MOVING
          type: string
          x-obmcs-top-level-enum: '#/definitions/LifecycleState'
        objectRelationships:
          description: List of objects and their relationships to this folder.
          items:
            $ref: '#/components/schemas/ObjectRelationship'
          type: array
        objectStorageUrl:
          description: URL of the folder in the object store.
          maxLength: 2000
          minLength: 1
          type: string
        parentFolderKey:
          description: The unique key of the containing folder or null if there is no parent folder.
          maxLength: 255
          type: string
        path:
          description: Full path of the folder.
          type: string
        properties:
          additionalProperties:
            additionalProperties:
              description: The string value of the folder property.
              type: string
            description: 'Key-value pair representing properties of a folder scoped to a category.

              Example: `{"key1": "value1"}`

              '
            type: object
          description: 'A map of maps that contains the properties which are specific to the folder type. Each folder type

            definition defines it''s set of required and optional properties. The map keys are category names and the

            values are maps of property name to property value. Every property is contained inside of a category. Most

            folders have required properties within the "default" category.

            Example: `{"properties": { "default": { "key1": "value1"}}}`

            '
          type: object
        timeCreated:
          description: 'The date and time the folder was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339).

            Example: `2019-03-25T21:10:29.600Z`

            '
          format: date-time
          type: string
        timeExternal:
          description: Last modified timestamp of this object in the external system.
          format: date-time
          type: string
        timeHarvested:
          description: 'The date and time the folder was harvested, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339).

            '
          format: date-time
          type: string
        timeUpdated:
          description: 'The last time that any change was made to the folder. An [RFC3339](https://tools.ietf.org/html/rfc3339) formatted datetime string.

            '
          format: date-time
          type: string
        typeKey:
          description: The type of folder object. Type keys can be found via the '/types' endpoint.
          maxLength: 255
          minLength: 1
          type: string
        updatedById:
          description: OCID of the user who modified the folder.
          maxLength: 255
          minLength: 1
          type: string
        uri:
          description: URI to the folder instance in the API.
          type: string
      required:
      - key
      type: object
    JobLogCollection:
      description: 'Results of a job logs Listing. A job log is an audit log record inserted during the lifecycle of a job execution instance.

        '
      properties:
        count:
          description: Total number of items returned.
          type: integer
        items:
          description: Collection of Job logs.
          items:
            $ref: '#/components/schemas/JobLogSummary'
          type: array
      required:
      - items
      type: object
    Term:
      description: 'Full term definition. A defined business term in a business glossary. As well as a term definition, simple format

        rules for attributes mapping to the term (for example, the expected data type and length restrictions) may be

        stated at the term level. Nesting of terms to support a hierarchy is supported by default.

        '
      properties:
        associatedObjectCount:
          description: The number of objects tagged with this term
          type: integer
        associatedObjects:
          description: Array of objects associated to a term.
          items:
            $ref: '#/components/schemas/TermAssociatedObject'
          type: array
        createdById:
          description: OCID of the user who created the term.
          maxLength: 255
          minLength: 1
          type: string
        customPropertyMembers:
          description: The list of customized properties along with the values for this object
          items:
            $ref: '#/components/schemas/CustomPropertyGetUsage'
          type: array
        description:
          description: Detailed description of the term.
          maxLength: 400
          type: string
        displayName:
          description: 'A user-friendly display name. Does not have to be unique, and it''s changeable.

            Avoid entering confidential information.

            '
          maxLength: 255
          minLength: 1
          type: string
        glossaryKey:
          description: Unique id of the parent glossary.
          maxLength: 255
          minLength: 1
          type: string
        isAllowedToHaveChildTerms:
          default: true
          description: Indicates whether a term may contain child terms.
          type: boolean
        key:
          description: Unique term key that is immutable.
          maxLength: 255
          minLength: 1
          type: string
        lifecycleState:
          description: The current state of the term.
          enum:
          - CREATING
          - ACTIVE
          - INACTIVE
          - UPDATING
          - DELETING
          - DELETED
          - FAILED
          - MOVING
          type: string
          x-obmcs-top-level-enum: '#/definitions/LifecycleState'
        owner:
          description: OCID of the user who is the owner of this business terminology.
          maxLength: 255
          minLength: 1
          type: string
        parentTermKey:
          description: This terms parent term key. Will be null if the term has no parent term.
          maxLength: 255
          type: string
        path:
          description: Absolute path of the term.
          type: string
        timeCreated:
          description: 'The date and time the term was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339).

            Example: `2019-03-25T21:10:29.600Z`

            '
          format: date-time
          type: string
        timeUpdated:
          description: 'The last time that any change was made to the term. An [RFC3339](https://tools.ietf.org/html/rfc3339) formatted datetime string.

            '
          format: date-time
          type: string
        updatedById:
          description: OCID of the user who modified the term.
          maxLength: 255
          minLength: 1
          type: string
        uri:
          description: URI to the term instance in the API.
          type: string
        workflowStatus:
          description: Status of the approval process workflow for this business term in the glossary.
          enum:
          - NEW
          - APPROVED
          - UNDER_REVIEW
          - ESCALATED
          type: string
          x-obmcs-top-level-enum: '#/definitions/TermWorkflowStatus'
      required:
      - key
      type: object
    ParseConnectionDetails:
      description: 'Parse connections from the connection metadata and Oracle wallet file.

        An error will be returned if more than one of connectionPayload, walletSecretId or walletSecretName are present in the request.

        '
      properties:
        connectionDetail:
          $ref: '#/components/schemas/Connection'
        connectionPayload:
          description: The information used to parse the connection from the wallet file payload.
          format: byte
          type: string
        walletSecretId:
          description: OCID of the OCI Vault secret holding the Oracle wallet to parse.
          maxLength: 255
          type: string
        walletSecretName:
          description: Name of the OCI Vault secret holding the Oracle wallet to parse.
          maxLength: 255
          type: string
      type: object
    PatternSummary:
      description: 'Summary of a pattern. A pattern is a data selector or filter which can provide a singular,

        logical entity view aggregating multiple physical data artifacts for ease of use.

        '
      properties:
        catalogId:
          description: The data catalog's OCID.
          maxLength: 255
          minLength: 1
          type: string
        description:
          description: Detailed description of the pattern.
          maxLength: 400
          type: string
        displayName:
          description: 'A user-friendly display name. Does not have to be unique, and it''s changeable.

            Avoid entering confidential information.

            '
          maxLength: 255
          minLength: 1
          type: string
        expression:
          description: 'Input string which drives the selection process, allowing for fine-grained control using qualifiers.

            Refer to the user documentation for details of the format and examples. A pattern cannot include both

            a prefix and an expression.

            '
          type: string
        filePathPrefix:
          description: 'Input string which drives the selection process.

            Refer to the user documentation for details of the format and examples. A pattern cannot include both

            a prefix and an expression.

            '
          type: string
        key:
          description: Unique pattern key that is immutable.
          type: string
        lifecycleState:
          description: State of the pattern.
          enum:
          - CREATING
          - ACTIVE
          - INACTIVE
          - UPDATING
          - DELETING
          - DELETED
          - FAILED
          - MOVING
          type: string
          x-obmcs-top-level-enum: '#/definitions/LifecycleState'
        timeCreated:
          description: 'The date and time the pattern was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339).

            Example: `2019-03-25T21:10:29.600Z`

            '
          format: date-time
          type: string
      required:
      - key
      type: object
    EntitySummary:
      description: 'Summary of an data entity. A representation of data with a set of attributes, normally representing a single

        business entity. Synonymous with ''table'' or ''view'' in a database, or a single logical file structure

        that one or many files may match.

        '
      properties:
        businessName:
          description: Optional user friendly business name of the data entity. If set, this supplements the harvested display name of the object.
          maxLength: 255
          type: string
        dataAssetKey:
          description: Unique key of the parent data asset.
          maxLength: 255
          minLength: 1
          type: string
        description:
          description: Detailed description of a data entity.
          maxLength: 400
          type: string
        displayName:
          description: 'A user-friendly display name. Does not have to be unique, and it''s changeable.

            Avoid entering confidential information.

            '
          maxLength: 255
          minLength: 1
          type: string
        externalKey:
          description: Unique external key of this object in the source system.
          maxLength: 255
          minLength: 1
          type: string
        folderKey:
          description: Key of the associated folder.
          maxLength: 255
          type: string
        folderName:
          description: Name of the associated folder. This name is harvested from the source data asset when the parent folder for the entiy is harvested.
          maxLength: 255
          type: string
        isLogical:
          description: 'Property that identifies if the object is a physical object (materialized) or virtual/logical object

            defined on other objects.

            '
          type: boolean
        isPartition:
          description: Property that identifies if an object is a sub object of a physical or materialized parent object.
          type: boolean
        key:
          description: Unique data entity key that is immutable.
          maxLength: 255
          minLength: 1
          type: string
        lifecycleDetails:
          description: 'A message describing the current state in more detail. An object not in ACTIVE state may have functional limitations,

            see service documentation for details.

            '
          maxLength: 255
          minLength: 1
          type: string
        lifecycleState:
          description: State of the data entity.
          enum:
          - CREATING
          - ACTIVE
          - INACTIVE
          - UPDATING
          - DELETING
          - DELETED
          - FAILED
          - MOVING
          type: string
          x-obmcs-top-level-enum: '#/definitions/LifecycleState'
        objectStorageUrl:
          description: URL of the data entity in the object store.
          maxLength: 2000
          minLength: 1
          type: string
        path:
          description: Full path of the data entity.
          type: string
        patternKey:
          description: Key of the associated pattern if this is a logical entity.
          maxLength: 255
          type: string
        properties:
          additionalProperties:
            additionalProperties:
              description: The string value of the data entity property.
              type: string
            description: 'Key-value pair representing properties of a data entity scoped to a category.

              Example: `{"key1": "value1"}`

              '
            type: object
          description: 'A map of maps that contains the properties which are specific to the entity type. Each entity type

            definition defines it''s set of required and optional properties. The map keys are category names and the

            values are maps of property name to property value. Every property is contained inside of a category. Most

            data entities have required properties within the "default" category.

            Example: `{"properties": { "default": { "key1": "value1"}}}`

            '
          type: object
        realizedExpression:
          description: The expression realized after resolving qualifiers . Used in deriving this logical entity
          type: string
        timeCreated:
          description: 'The date and time the data entity was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339).

            Example: `2019-03-25T21:10:29.600Z`

            '
          format: date-time
          type: string
        timeUpdated:
          description: 'The last time that any change was made to the data entity. An [RFC3339](https://tools.ietf.org/html/rfc3339) formatted datetime string.

            '
          format: date-time
          type: string
        typeKey:
          description: The type of data entity object. Type keys can be found via the '/types' endpoint.
          maxLength: 255
          minLength: 1
          type: string
        updatedById:
          description: OCID of the user who updated this object in the data catalog.
          maxLength: 255
          minLength: 1
          type: string
        uri:
          description: URI to the data entity instance in the API.
          type: string
      required:
      - key
      type: object
    JobDefinitionSummary:
      description: 'A list of job definition resources. Job definitions define the harvest scope and includes the list of objects

        to be harvested along with a schedule. The list of objects is usually specified through a combination of object

        type, regular expressions, or specific names of objects and a sample size for the data harvested.

        '
      properties:
        catalogId:
          description: The data catalog's OCID.
          maxLength: 255
          minLength: 1
          type: string
        connectionKey:
          description: 'The key of the connection resource used in harvest, sampling, profiling jobs.

            '
          maxLength: 255
          minLength: 1
          type: string
        dataAssetKey:
          description: Unique key of the data asset to which this job applies, if the job involves a data asset.
          maxLength: 255
          minLength: 1
          type: string
        description:
          description: Detailed description of the job definition.
          maxLength: 400
          type: string
        displayName:
          description: 'A user-friendly display name. Does not have to be unique, and it''s changeable.

            Avoid entering confidential information.

            '
          maxLength: 255
          minLength: 1
          type: string
        glossaryKey:
          description: Unique key of the glossary to which this job applies, if the job involves a glossary.
          maxLength: 255
          minLength: 1
          type: string
        isSampleDataExtracted:
          default: true
          description: Specify if sample data to be extracted as part of this harvest.
          type: boolean
        jobExecutionState:
          description: Status of the latest job execution, such as running, paused, or completed.
          enum:
          - CREATED
          - IN_PROGRESS
          - INACTIVE
          - FAILED
          - SUCCEEDED
          - CANCELED
          - SUCCEEDED_WITH_WARNINGS
          type: string
          x-obmcs-top-level-enum: '#/definitions/JobExecutionState'
        jobType:
          description: Type of the job definition.
          enum:
          - HARVEST
          - PROFILING
          - SAMPLING
          - PREVIEW
          - IMPORT
          - EXPORT
          - IMPORT_GLOSSARY
          - EXPORT_GLOSSARY
          - INTERNAL
          - PURGE
          - IMMEDIATE
          - SCHEDULED
          - IMMEDIATE_EXECUTION
          - SCHEDULED_EXECUTION
          - SCHEDULED_EXECUTION_INSTANCE
          - ASYNC_DELETE
          - IMPORT_DATA_ASSET
          - CREATE_SCAN_PROXY
          - ASYNC_EXPORT_GLOSSARY
          - ASYNC_EXPORT_DATA_ASSET
          type: string
          x-obmcs-top-level-enum: '#/definitions/JobType'
        key:
          description: Unique key of the job definition resource that is immutable.
          maxLength: 255
          minLength: 1
          type: string
        lifecycleState:
          description: Lifecycle state of the job definition.
          enum:
          - CREATING
          - ACTIVE
          - INACTIVE
          - UPDATING
          - DELETING
          - DELETED
          - FAILED
          - MOVING
          type: string
          x-obmcs-top-level-enum: '#/definitions/LifecycleState'
        scheduleType:
          description: Type of job schedule for the latest job executed.
          enum:
          - SCHEDULED
          - IMMEDIATE
          type: string
          x-obmcs-top-level-enum: '#/definitions/JobScheduleType'
        timeCreated:
          description: 'The date and time the job definition was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339).

            Example: `2019-03-25T21:10:29.600Z`

            '
          format: date-time
          type: string
        timeLatestExecutionEnded:
          description: 'Time that the latest job execution ended or null if it hasn''t yet completed.

            An [RFC3339](https://tools.ietf.org/html/rfc3339) formatted datetime string.

            '
          format: date-time
          type: string
        timeLatestExecutionStarted:
          description: Time that the latest job execution started. An [RFC3339](https://tools.ietf.org/html/rfc3339) formatted datetime string.
          format: date-time
          type: string
        uri:
          description: URI to the job definition instance in the API.
          type: string
      required:
      - key
      type: object
    ObjectRelationship:
      description: Details regarding a specific object and its relationship to the referencing object.
      properties:
        key:
          description: Unique id of the object.
          type: string
        name:
          description: Name of the object.
          type: string
        parentKey:
          description: Key of the parent object for the resource.
          type: string
        parentPath:
          description: Full path of the parent object.
          type: string
        path:
          description: Full path of the object.
          type: string
        relationshipType:
          description: Type of relationship with the referencing object.
          type: string
        timeCreated:
          description: 'The date and time the relationship was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339).

            Example: `2019-03-25T21:10:29.600Z`

            '
          format: date-time
          type: string
        timeUpdated:
          description: 'The last time a change was made to this reference. An [RFC3339](https://tools.ietf.org/html/rfc3339) formatted datetime string.

            '
          format: date-time
          type: string
        typeKey:
          description: Type key of the object. Type keys can be found via the '/types' endpoint.
          type: string
        typeName:
          description: Type name of the object. Type names can be found via the '/types' endpoint.
          type: string
      type: object
    UpdateCatalogDetails:
      description: The information to be updated for catalog resource.
      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: 'Usage of predefined tag keys. These predefined keys are scoped to namespaces.

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

            '
          type: object
        displayName:
          description: Data catalog identifier.
          maxLength: 255
          minLength: 1
          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
      type: object
    DerivedLogicalEntities:
      description: Entities derived from the application of a pattern to a list of file paths.
      properties:
        filesInLogicalGrouping:
          description: The list of file paths that belong to the grouping of logical entity or UNMATCHED for which realizedExpression is a selector.
          items:
            type: string
          type: array
        name:
          description: The name of the derived logical entity. The group name of the unmatched files will be UNMATCHED
          type: string
        realizedExpression:
          description: The expression realized after resolving qualifiers . Used in deriving this logical entity
          type: string
      type: object
    DetachCatalogPrivateEndpointDetails:
      description: Information about the detaching the private endpoint resource from a catalog
      properties:
        catalogPrivateEndpointId:
          description: The identifier of the private endpoint to be detached from catalog resource.
          maxLength: 255
          minLength: 1
          type: string
      required:
      - catalogPrivateEndpointId
      type: object
    TypeSummary:
      description: 'Summary data catalog type information. All types are statically defined in the system and are immutable.

        It isn''t possible to create new types or update existing types via the API.

        '
      properties:
        catalogId:
          description: The data catalog's OCID.
          maxLength: 255
          minLength: 1
          type: string
        description:
          description: Detailed description of the type.
          maxLength: 400
          type: string
        key:
          description: Unique type key that is immutable.
          maxLength: 255
          minLength: 1
          type: string
        lifecycleState:
          description: State of the folder.
          enum:
          - CREATING
          - ACTIVE
          - INACTIVE
          - UPDATING
          - DELETING
          - DELETED
          - FAILED
          - MOVING
          type: string
          x-obmcs-top-level-enum: '#/definitions/LifecycleState'
        name:
          description: The immutable name of the type.
          maxLength: 255
          minLength: 1
          type: string
        parentTypeKey:
          description: Unique key of the parent type.
          maxLength: 255
          minLength: 1
          type: string
        parentTypeName:
          description: Name of the parent type.
          maxLength: 255
          minLength: 1
          type: string
        typeCategory:
          description: Indicates the category this type belongs to. For instance, data assets, connections.
          type: string
        uri:
          description: URI to the type instance in the API.
          type: string
      required:
      - key
      type: object
    ObjectStorageObjectReference:
      description: A reference to an Object Storage object.
      properties:
        bucketName:
          description: Object Storage bucket name.
          maxLength: 256
          minLength: 1
          type: string
        namespaceName:
          description: Object Storage namespace.
          minLength: 1
          type: string
        objectName:
          description: Object Storage object name.
          maxLength: 1024
          minLength: 1
          type: string
      required:
      - namespaceName
      - bucketName
      - objectName
      type: object
    CreateAttributeDetails:
      description: Properties used in attribute create operations.
      properties:
        businessName:
          description: Optional user friendly business name of the attribute. If set, this supplements the harvested display name of the object.
          maxLength: 255
          type: string
        customPropertyMembers:
          description: The list of customized properties along with the values for this object
          items:
            $ref: '#/components/schemas/CustomPropertySetUsage'
          type: array
        description:
          description: Detailed description of the attribute.
          maxLength: 400
          type: string
        displayName:
          description: 'A user-friendly display name. Does not have to be unique, and it''s changeable.

            Avoid entering confidential information.

            '
          maxLength: 255
          minLength: 1
          type: string
        externalDataType:
          description: Data type of the attribute as defined in the external system.
          type: string
        externalDatatypeEntityKey:
          description: External entity key that represents the datatype of this attribute , applicable if this attribute is a complex type.
          maxLength: 255
          minLength: 1
          type: string
        externalParentAttributeKey:
          description: External attribute key that represents the parent attribute  of this attribute , applicable if the parent attribute is of complex type.
          maxLength: 255
          minLength: 1
          type: string
        isIncrementalData:
          default: false
          description: Property that identifies if this attribute can be used as a watermark to extract incremental data.
          type: boolean
        isNullable:
          default: false
          description: Property that identifies if this attribute can be assigned null values.
          type: boolean
        length:
          description: Max allowed length of the attribute value.
          format: int64
          type: integer
        maxCollectionCount:
          description: 'The maximum count for the number of instances of a given type stored in this collection type attribute,applicable if this attribute is a complex type.

            For type specifications in systems that specify only "capacity" without upper or lower bound , this property can also be used to just mean "capacity".

            Some examples are Varray size in Oracle , Occurs Clause in Cobol , capacity in XmlSchemaObjectCollection , maxOccurs in  Xml , maxItems in Json

            '
          format: int32
          type: integer
        minCollectionCount:
          description: The minimum count for the number of instances of a given type stored in this collection type attribute,applicable if this attribute is a complex type.
          format: int32
          type: integer
        position:
          description: Position of the attribute in the record definition.
          format: int32
          type: integer
        precision:
          description: Precision of the attribute value usually applies to float data type.
          format: int32
          type: integer
        properties:
          additionalProperties:
            additionalProperties:
              description: The string value of the attribute property.
              type: string
            description: 'Key-value pair representing properties of an attribute scoped to a category.

              Example: `{"key1": "value1"}`

              '
            type: object
          description: 'A map of maps that contains the properties which are specific to the attribute type. Each attribute type

            definition defines it''s set of required and optional properties. The map keys are category names and the

            values are maps of property name to property value. Every property is contained inside of a category. Most

            attributes have required properties within the "default" category. To determine the set of required and

            optional properties for an attribute type, a query can be done on ''/types?type=attribute'' that returns a

            collection of all attribute types. The appropriate attribute type, which will include definitions of all

            of it''s properties, can be identified from this collection.

            Example: `{"properties": { "default": { "key1": "value1"}}}`

            '
          type: object
        scale:
          description: Scale of the attribute value usually applies to float data type.
          format: int32
          type: integer
        timeExternal:
          description: Last modified timestamp of this object in the external system.
          format: date-time
          type: string
        typeKey:
          description: Type key of the object. Type keys can be found via the '/types' endpoint.
          maxLength: 255
          minLength: 1
          type: string
      required:
      - displayName
      - externalDataType
      - timeExternal
      type: object
    Connection:
      description: Detailed representation of a connection to a data asset, minus any sensitive properties.
      properties:
        createdById:
          description: OCID of the user who created the connection.
          maxLength: 255
          minLength: 1
          type: string
        customPropertyMembers:
          description: The list of customized properties along with the values for this object
          items:
            $ref: '#/components/schemas/CustomPropertyGetUsage'
          type: array
        dataAssetKey:
          description: Unique key of the parent data asset.
          maxLength: 255
          minLength: 1
          type: string
        description:
          description: A description of the connection.
          maxLength: 400
          type: string
        displayName:
          description: 'A user-friendly display name. Does not have to be unique, and it''s changeable.

            Avoid entering confidential information.

            '
          maxLength: 255
          minLength: 1
          type: string
        externalKey:
          description: Unique external key of this object from the source system.
          maxLength: 255
          minLength: 1
          type: string
        isDefault:
          description: Indicates whether this connection is the default connection.
          type: boolean
        key:
          description: Unique connection key that is immutable.
          maxLength: 255
          minLength: 1
          type: string
        lifecycleState:
          description: The current state of the connection.
          enum:
          - CREATING
          - ACTIVE
          - INACTIVE
          - UPDATING
          - DELETING
          - DELETED
          - FAILED
          - MOVING
          type: string
          x-obmcs-top-level-enum: '#/definitions/LifecycleState'
        properties:
          additionalProperties:
            additionalProperties:
              description: The string value of the connection property.
              type: string
            description: 'Key-value pair representing properties of a connection scoped to a category.

              Example: `{"username": "user1"}`

              '
            type: object
          description: 'A map of maps that contains the properties which are specific to the connection type. Each connection type

            definition defines it''s set of required and optional properties. The map keys are category names and the

            values are maps of property name to property value. Every property is contained inside of a category. Most

            connections have required properties within the "default" category.

            Example: `{"properties": { "default": { "username": "user1"}}}`

            '
          type: object
        timeCreated:
          description: 'The date and time the connection was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339).

            Example: `2019-03-25T21:10:29.600Z`

            '
          format: date-time
          type: string
        timeStatusUpdated:
          description: Time that the connections status was last updated. An [RFC3339](https://tools.ietf.org/html/rfc3339) formatted datetime string.
          format: date-time
          type: string
        timeUpdated:
          description: 'The last time that any change was made to the connection. An [RFC3339](https://tools.ietf.org/html/rfc3339) formatted datetime string.

            '
          format: date-time
          type: string
        typeKey:
          description: The key of the object type. Type key's can be found via the '/types' endpoint.
          maxLength: 255
          minLength: 1
          type: string
        updatedById:
          description: OCID of the user who modified the connection.
          maxLength: 255
          minLength: 1
          type: string
        uri:
          description: URI to the connection instance in the API.
          type: string
      required:
      - key
      type: object
    FolderTagCollection:
      description: 'Results of a folders tag listing. Folder tags allow association of folder objects to business terms.

        '
      properties:
        count:
          description: Total number of items returned.
          type: integer
        items:
          description: Collection of folder tags.
          items:
            $ref: '#/components/schemas/FolderTagSummary'
          type: array
      required:
      - items
      type: object
    CustomPropertySetUsage:
      description: Details of a single custom property.
      properties:
        displayName:
          description: Name of the custom property
          type: string
        key:
          description: Unique Identifier of the attribute which is ID
          type: string
        namespaceName:
          description: Namespace name of the custom property
          type: string
        value:
          description: The custom property value
          type: string
      type: object
    AsynchronousExportDataAssetResult:
      allOf:
      - $ref: '#/components/schemas/AsynchronousExportResult'
      description: Details about the job which performs an export.
      type: object
    Glossary:
      description: 'Full glossary details. A glossary of business terms, such as ''Customer'', ''Account'', ''Contact'' , ''Address'',

        or ''Product'', with definitions, used to provide common meaning across disparate data assets. Business glossaries

        may be hierarchical where some terms may contain child terms to allow them to be used as ''taxonomies''.

        By linking data assets, data entities, and attributes to glossaries and glossary terms, the glossary can act as a

        way of organizing data catalog objects in a hierarchy to make a large number of objects more navigable and easier to

        consume. Objects in the data aatalog, such as data assets or data entities, may be linked to any level in the

        glossary, so that the glossary can be used to browse the available data according to the business model of the

        organization.

        '
      properties:
        catalogId:
          description: The data catalog's OCID.
          maxLength: 255
          minLength: 1
          type: string
        createdById:
          description: OCID of the user who created this metadata element.
          maxLength: 255
          minLength: 1
          type: string
        customPropertyMembers:
          description: The list of customized properties along with the values for this object
          items:
            $ref: '#/components/schemas/CustomPropertyGetUsage'
          type: array
        description:
          description: Detailed description of the glossary.
          maxLength: 400
          type: string
        displayName:
          description: 'A user-friendly display name. Does not have to be unique, and it''s changeable.

            Avoid entering confidential information.

            '
          maxLength: 255
          minLength: 1
          type: string
        importJobDefinitionKey:
          description: The unique key of the job definition resource that was used in the Glossary import.
          maxLength: 255
          minLength: 1
          type: string
        importJobKey:
          description: The unique key of the job policy for Glossary import.
          maxLength: 255
          minLength: 1
          type: string
        key:
          description: Unique glossary key that is immutable.
          maxLength: 255
          minLength: 1
          type: string
        latestImportJobExecutionKey:
          description: The unique key of the parent job execution for which the log resource was created.
          maxLength: 255
          minLength: 1
          type: string
        latestImportJobExecutionStatus:
          description: 'Status of the latest glossary import job execution, such as running, paused, or completed.

            This may include additional information like time import started , import file size and % of completion

            '
          type: string
        lifecycleState:
          description: The current state of the glossary.
          enum:
          - CREATING
          - ACTIVE
          - INACTIVE
          - UPDATING
          - DELETING
          - DELETED
          - FAILED
          - MOVING
          type: string
          x-obmcs-top-level-enum: '#/definitions/LifecycleState'
        owner:
          description: OCID of the user who is the owner of the glossary.
          maxLength: 255
          minLength: 1
          type: string
        timeCreated:
          description: 'The date and time the glossary was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339).

            Example: `2019-03-25T21:10:29.600Z`

            '
          format: date-time
          type: string
        timeUpdated:
          description: 'The last time that any change was made to the glossary. An [RFC3339](https://tools.ietf.org/html/rfc3339) formatted datetime string.

            '
          format: date-time
          type: string
        updatedById:
          description: OCID of the user who updated this metadata element.
          maxLength: 255
          minLength: 1
          type: string
        uri:
          description: URI to the tag instance in the API.
          type: string
        workflowStatus:
          description: Status of the approval process workflow for this business glossary.
          enum:
          - NEW
          - APPROVED
          - UNDER_REVIEW
          - ESCALATED
          type: string
          x-obmcs-top-level-enum: '#/definitions/TermWorkflowStatus'
      required:
      - key
      type: object
    DataAssetTagCollection:
      description: 'Results of a data asset tag listing. Data asset tags represent an association of a data asset to a term.

        '
      properties:
        count:
          description: Total number of items returned.
          type: integer
        items:
          description: Collection of data asset tags.
          items:
            $ref: '#/components/schemas/DataAssetTagSummary'
          type: array
      required:
      - items
      type: object
    ChangeMetastoreCompartmentDetails:
      description: Information about a change in metastore compartment.
      properties:
        compartmentId:
          description: OCID of the compartment to which the metastore should be moved.
          maxLength: 255
          minLength: 1
          type: string
      required:
      - compartmentId
      type: object
    JobMetricSummary:
      description: Job metric summary.
      properties:
        batchKey:
          description: Batch key for grouping, may be null.
          maxLength: 255
          type: string
        category:
          description: Category of this metric.
          type: string
        description:
          description: Detailed description of the metric.
          maxLength: 400
          type: string
        displayName:
          description: 'A user-friendly display name. Does not have to be unique, and it''s changeable.

            Avoid entering confidential information.

            '
          maxLength: 255
          minLength: 1
          type: string
        jobExecutionKey:
          description: The unique key of the parent job execution for which the job metric resource was created.
          maxLength: 255
          minLength: 1
          type: string
        key:
          description: Key of the job metric that is immutable.
          maxLength: 255
          minLength: 1
          type: string
        subCategory:
          description: Sub category of this metric under the category. Used for aggregating values. May be null.
          type: string
        timeCreated:
          description: 'The date and time the job metric was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339).

            Example: `2019-03-25T21:10:29.600Z`

            '
          format: date-time
          type: string
        timeInserted:
          description: 'The time the metric was logged or captured in the system where the job executed.

            An [RFC3339](https://tools.ietf.org/html/rfc3339) formatted datetime string.

            '
          format: date-time
          type: string
        unit:
          description: Unit of this metric.
          type: string
        uri:
          description: URI to the job metric instance in the API.
          type: string
        value:
          description: Value of this metric.
          type: string
      required:
      - key
      type: object
    JobDefinitionCollection:
      description: 'Results of a job definition listing. Job definitions are resources that describe the scope and type of jobs (eg: harvest, profiling, sampling) that are defined by users in the system.

        '
      properties:
        count:
          description: Total number of items returned.
          type: integer
        items:
          description: Collection of job definitions.
          items:
            $ref: '#/components/schemas/JobDefinitionSummary'
          type: array
      required:
      - items
      type: object
    UploadCredentialsDetails:
      description: Upload credential file and connection metadata.
      properties:
        connectionDetail:
          $ref: '#/components/schemas/UpdateConnectionDetails'
        credentialPayload:
          description: Information used in updating connection credentials.
          format: byte
          type: string
      required:
      - credentialPayload
      type: object
    CreateCustomPropertyDetails:
      description: Properties used in custom property create operations.
      properties:
        allowedValues:
          description: Allowed values for the custom property if any
          items:
            type: string
          type: array
        dataType:
          description: The data type of the custom property
          enum:
          - TEXT
          - RICH_TEXT
          - BOOLEAN
          - NUMBER
          - DATE
          type: string
          x-obmcs-top-level-enum: '#/definitions/CustomPropertyDataType'
        description:
          description: Detailed description of the custom property.
          maxLength: 400
          type: string
        displayName:
          description: 'A user-friendly display name. Does not have to be unique, and it''s changeable.

            Avoid entering confidential information.

            '
          maxLength: 255
          minLength: 1
          type: string
        isEditable:
          default: true
          description: If this field is a editable field
          type: boolean
        isEventEnabled:
          default: false
          description: If an OCI Event will be emitted when the custom property is modified.
          type: boolean
        isFilterable:
          default: false
          description: If this field allows to filter or create facets from UI
          type: boolean
        isHidden:
          default: false
          description: If this field is a hidden field
          type: boolean
        isHiddenInSearch:
          default: false
          description: If this field is allowed to pop in search results
          type: boolean
        isMultiValued:
          default: false
          description: If this field allows multiple values to be set
          type: boolean
        isShownInList:
          default: false
          description: If this field is displayed in a list view of applicable objects.
          type: boolean
        isSortable:
          default: false
          description: If this field allows to sort from UI
          type: boolean
        properties:
          additionalProperties:
            additionalProperties:
              description: The string value of the data asset property.
              type: string
            description: 'Key-value pair representing properties of a data asset scoped to a category.

              Example: `{"host": "host1", "port": "1521", "database": "orcl"}`

              '
            type: object
          description: 'A map of maps that contains the properties which are specific to the data asset type. Each data asset type

            definition defines it''s set of required and optional properties. The map keys are category names and the

            values are maps of property name to property value. Every property is contained inside of a category. Most

            data assets have required properties within the "default" category. To determine the set of optional and

            required properties for a data asset type, a query can be done on ''/types?type=dataAsset'' that returns a

            collection of all data asset types. The appropriate data asset type, which includes definitions of all of

            it''s properties, can be identified from this collection.

            Example: `{"properties": { "default": { "host": "host1", "port": "1521", "database": "orcl"}}}`

            '
          type: object
      required:
      - displayName
      type: object
    Entity:
      description: 'Data entity details. A representation of data with a set of attributes, normally representing a single

        business entity. Synonymous with ''table'' or ''view'' in a database, or a single logical file structure

        that one or many files may match.

        '
      properties:
        businessName:
          description: Optional user friendly business name of the data entity. If set, this supplements the harvested display name of the object.
          maxLength: 255
          type: string
        createdById:
          description: OCID of the user who created this object in the data catalog.
          maxLength: 255
          minLength: 1
          type: string
        customPropertyMembers:
          description: The list of customized properties along with the values for this object
          items:
            $ref: '#/components/schemas/CustomPropertyGetUsage'
          type: array
        dataAssetKey:
          description: Unique key of the parent data asset.
          maxLength: 255
          minLength: 1
          type: string
        description:
          description: Detailed description of a data entity.
          maxLength: 400
          type: string
        displayName:
          description: 'A user-friendly display name. Does not have to be unique, and it''s changeable.

            Avoid entering confidential information.

            '
          maxLength: 255
          minLength: 1
          type: string
        externalKey:
          description: Unique external key of this object in the source system.
          maxLength: 255
          minLength: 1
          type: string
        folderKey:
          description: Key of the associated folder.
          maxLength: 255
          type: string
        folderName:
          description: Name of the associated folder. This name is harvested from the source data asset when the parent folder for the entiy is harvested.
          maxLength: 255
          type: string
        harvestStatus:
          description: Status of the object as updated by the harvest process.
          enum:
          - COMPLETE
          - ERROR
          - IN_PROGRESS
          - DEFERRED
          type: string
          x-obmcs-top-level-enum: '#/definitions/HarvestStatus'
        isLogical:
          description: 'Property that identifies if the object is a physical object (materialized) or virtual/logical object

            defined on other objects.

            '
          type: boolean
        isPartition:
          description: Property that identifies if an object is a sub object of a physical or materialized parent object.
          type: boolean
        key:
          description: Unique data entity key that is immutable.
          maxLength: 255
          minLength: 1
          type: string
        lastJobKey:
          description: Key of the last harvest process to update this object.
          maxLength: 255
          type: string
        lifecycleDetails:
          description: 'A message describing the current state in more detail. An object not in ACTIVE state may have functional limitations,

            see service documentation for details.

            '
          maxLength: 255
          minLength: 1
          type: string
        lifecycleState:
          description: The current state of the data entity.
          enum:
          - CREATING
          - ACTIVE
          - INACTIVE
          - UPDATING
          - DELETING
          - DELETED
          - FAILED
          - MOVING
          type: string
          x-obmcs-top-level-enum: '#/definitions/LifecycleState'
        objectRelationships:
          description: List of objects and their relationships to this entity.
          items:
            $ref: '#/components/schemas/ObjectRelationship'
          type: array
        objectStorageUrl:
          description: URL of the data entity in the object store.
          maxLength: 2000
          minLength: 1
          type: string
        path:
          description: Full path of the data entity.
          type: string
        patternKey:
          description: Key of the associated pattern if this is a logical entity.
          maxLength: 255
          type: string
        properties:
          additionalProperties:
            additionalProperties:
              description: The string value of the data entity property.
              type: string
            description: 'Key-value pair representing properties of a data entity scoped to a category.

              Example: `{"key1": "value1"}`

              '
            type: object
          description: 'A map of maps that contains the properties which are specific to the entity type. Each entity type

            definition defines it''s set of required and optional properties. The map keys are category names and the

            values are maps of property name to property value. Every property is contained inside of a category. Most

            data entities have required properties within the "default" category.

            Example: `{"properties": { "default": { "key1": "value1"}}}`

            '
          type: object
        realizedExpression:
          description: The expression realized after resolving qualifiers . Used in deriving this logical entity
          type: string
        timeCreated:
          description: 'The date and time the data entity was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339).

            Example: `2019-03-25T21:10:29.600Z`

            '
          format: date-time
          type: string
        timeExternal:
          description: Last modified timestamp of this object in the external system.
          format: date-time
          type: string
        timeHarvested:
          description: 'The date and time the entity was harvested, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339).

            '
          format: date-time
          type: string
        timeStatusUpdated:
          description: Time that the data entities status was last updated. An [RFC3339](https://tools.ietf.org/html/rfc3339) formatted datetime string.
          format: date-time
          type: string
        timeUpdated:
          description: 'The last time that any change was made to the data entity. An [RFC3339](https://tools.ietf.org/html/rfc3339) formatted datetime string.

            '
          format: date-time
          type: string
        typeKey:
          description: The type of data entity object. Type key's can be found via the '/types' endpoint.
          maxLength: 255
          minLength: 1
          type: string
        updatedById:
          description: OCID of the user who updated this object in the data catalog.
          maxLength: 255
          minLength: 1
          type: string
        uri:
          description: URI to the data entity instance in the API.
          type: string
      required:
      - key
      type: object
    ChangeCatalogPrivateEndpointCompartmentDetails:
      description: Information about the change compartment for the  private endpoint resource
      properties:
        compartmentId:
          description: The identifier of the compartment where the resource should be moved.
          maxLength: 255
          minLength: 1
          type: string
      required:
      - compartmentId
      type: object
    MetastoreSummary:
      description: Summary of a metastore.
      properties:
        compartmentId:
          description: OCID of the compartment which holds the metastore.
          maxLength: 255
          minLength: 1
          type: string
        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: 'Usage of predefined tag keys. These predefined keys are scoped to namespaces.

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

            '
          type: object
        displayName:
          description: Mutable name of the metastore.
          maxLength: 255
          minLength: 1
          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
        id:
          description: The metastore's OCID.
          maxLength: 255
          minLength: 1
          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.
          maxLength: 400
          minLength: 1
          type: string
        lifecycleState:
          description: The current state of the metastore.
          enum:
          - CREATING
          - ACTIVE
          - INACTIVE
          - UPDATING
          - DELETING
          - DELETED
          - FAILED
          - MOVING
          type: string
          x-obmcs-top-level-enum: '#/definitions/LifecycleState'
        timeCreated:
          description: Time at which the metastore was created. An [RFC3339](https://tools.ietf.org/html/rfc3339) formatted datetime string.
          format: date-time
          type: string
        timeUpdated:
          description: Time at which the metastore was last modified. An [RFC3339](https://tools.ietf.org/html/rfc3339) formatted datetime string.
          format: date-time
          type: string
      required:
      - id
      - compartmentId
      type: object
    CreateTermRelationshipDetails:
      description: Properties used in term relationship create operations.
      properties:
        description:
          description: Detailed description of the term relationship usually defined at the time of creation.
          maxLength: 400
          type: string
        displayName:
          description: 'A user-friendly display name. Is changeable. The combination of ''displayName'' and ''parentTermKey''

            must be unique. Avoid entering confidential information. This is the same as ''relationshipType'' for ''termRelationship''.

            '
          maxLength: 255
          minLength: 1
          type: string
        relatedTermKey:
          description: Unique id of the related term.
          maxLength: 255
          minLength: 1
          type: string
      required:
      - displayName
      - relatedTermKey
      type: object
    AsynchronousExportResult:
      description: Details about the job which performs an export.
      properties:
        jobDefinitionKey:
          description: Unique key of the export job definition.
          maxLength: 255
          minLength: 1
          type: string
        jobDefinitionName:
          description: Display name of the export job.
          maxLength: 255
          minLength: 1
          type: string
        jobExecutionKey:
          description: Unique key of the job execution.
          maxLength: 255
          minLength: 1
          type: string
        jobKey:
          description: Unique key of the export job.
          maxLength: 255
          minLength: 1
          type: string
        sourceKey:
          description: Unique key of the object being exported.
          maxLength: 255
          minLength: 1
          type: string
      type: object
    AsynchronousExportGlossaryDetails:
      allOf:
      - $ref: '#/components/schemas/AsynchronousExportRequestDetails'
      description: Details needed by the glossary export request.
      type: object
    JobDefinition:
      description: 'Representation of a job definition resource. Job definitions define the harvest scope and includes the list

        of objects to be harvested along with a schedule. The list of objects is usually specified through a combination

        of object type, regular expressions, or specific names of objects and a sample size for the data harvested.

        '
      properties:
        catalogId:
          description: The data catalog's OCID.
          maxLength: 255
          minLength: 1
          type: string
        connectionKey:
          description: 'The key of the default connection resource to be used for harvest, sampling, profiling jobs.

            This may be overridden in each job instance.

            '
          maxLength: 255
          minLength: 1
          type: string
        createdById:
          description: OCID of the user who created this job definition.
          maxLength: 255
          minLength: 1
          type: string
        dataAssetKey:
          description: The key of the data asset for which the job is defined.
          maxLength: 255
          minLength: 1
          type: string
        description:
          description: Detailed description of the job definition.
          maxLength: 400
          type: string
        displayName:
          description: 'A user-friendly display name. Does not have to be unique, and it''s changeable.

            Avoid entering confidential information.

            '
          maxLength: 255
          minLength: 1
          type: string
        glossaryKey:
          description: Unique key of the glossary to which this job applies.
          maxLength: 255
          minLength: 1
          type: string
        internalVersion:
          description: Version of the job definition object. Used internally but can be visible to users.
          type: string
        isIncremental:
          description: Specifies if the job definition is incremental or full.
          type: boolean
        isSampleDataExtracted:
          default: true
          description: Specify if sample data to be extracted as part of this harvest.
          type: boolean
        jobExecutionState:
          description: Status of the latest job execution, such as running, paused, or completed.
          enum:
          - CREATED
          - IN_PROGRESS
          - INACTIVE
          - FAILED
          - SUCCEEDED
          - CANCELED
          - SUCCEEDED_WITH_WARNINGS
          type: string
          x-obmcs-top-level-enum: '#/definitions/JobExecutionState'
        jobType:
          description: Type of the job definition.
          enum:
          - HARVEST
          - PROFILING
          - SAMPLING
          - PREVIEW
          - IMPORT
          - EXPORT
          - IMPORT_GLOSSARY
          - EXPORT_GLOSSARY
          - INTERNAL
          - PURGE
          - IMMEDIATE
          - SCHEDULED
          - IMMEDIATE_EXECUTION
          - SCHEDULED_EXECUTION
          - SCHEDULED_EXECUTION_INSTANCE
          - ASYNC_DELETE
          - IMPORT_DATA_ASSET
          - CREATE_SCAN_PROXY
          - ASYNC_EXPORT_GLOSSARY
          - ASYNC_EXPORT_DATA_ASSET
          type: string
          x-obmcs-top-level-enum: '#/definitions/JobType'
        key:
          description: Unique key of the job definition resource that is immutable.
          maxLength: 255
          minLength: 1
          type: string
        lifecycleState:
          description: Lifecycle state of the job definition.
          enum:
          - CREATING
          - ACTIVE
          - INACTIVE
          - UPDATING
          - DELETING
          - DELETED
          - FAILED
          - MOVING
          type: string
          x-obmcs-top-level-enum: '#/definitions/LifecycleState'
        properties:
          additionalProperties:
            additionalProperties:
              description: The string value of the job definition property.
              type: string
            description: 'Key-value pair representing properties of a job definition scoped to a category.

              Example: `{"host": "host1", "port": "1521", "database": "orcl"}`

              '
            type: object
          description: 'A map of maps that contains the properties which are specific to the job type. Each job type

            definition may define it''s set of required and optional properties. The map keys are category names and the

            values are maps of property name to property value. Every property is contained inside of a category. Most

            job definitions have required properties within the "default" category.

            Example: `{"properties": { "default": { "host": "host1", "port": "1521", "database": "orcl"}}}`

            '
          type: object
        sampleDataSizeInMBs:
          default: 5
          description: Specify the sample data size in MB, specified as number of rows, for this metadata harvest.
          type: integer
        scheduleType:
          description: Type of job schedule for the latest job executed.
          enum:
          - SCHEDULED
          - IMMEDIATE
          type: string
          x-obmcs-top-level-enum: '#/definitions/JobScheduleType'
        timeCreated:
          description: 'The date and time the job definition was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339).

            Example: `2019-03-25T21:10:29.600Z`

            '
          format: date-time
          type: string
        timeLatestExecutionEnded:
          description: 'Time that the latest job execution ended or null if it hasn''t yet completed.

            An [RFC3339](https://tools.ietf.org/html/rfc3339) formatted datetime string.

            '
          format: date-time
          type: string
        timeLatestExecutionStarted:
          description: Time that the latest job execution started. An [RFC3339](https://tools.ietf.org/html/rfc3339) formatted datetime string.
          format: date-time
          type: string
        timeUpdated:
          description: The last time that any change was made to the data asset. An [RFC3339](https://tools.ietf.org/html/rfc3339) formatted datetime string.
          format: date-time
          type: string
        updatedById:
          description: OCID of the user who updated this job definition.
          maxLength: 255
          minLength: 1
          type: string
        uri:
          description: URI to the job definition instance in the API.
          type: string
      required:
      - key
      type: object
    Metastore:
      description: 'A Data Catalog Metastore provides a centralized metastore repository for use by other OCI services.

        '
      properties:
        compartmentId:
          description: OCID of the compartment which holds the metastore.
          maxLength: 255
          minLength: 1
          type: string
        defaultExternalTableLocation:
          description: 'Location under which external tables will be created by default. This references Object Storage

            using an HDFS URI format. Example: oci://bucket@namespace/sub-dir/

            '
          maxLength: 2000
          minLength: 1
          type: string
        defaultManagedTableLocation:
          description: 'Location under which managed tables will be created by default. This references Object Storage

            using an HDFS URI format. Example: oci://bucket@namespace/sub-dir/

            '
          maxLength: 2000
          minLength: 1
          type: string
        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: 'Usage of predefined tag keys. These predefined keys are scoped to namespaces.

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

            '
          type: object
        displayName:
          description: Mutable name of the metastore.
          maxLength: 255
          minLength: 1
          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
        id:
          description: The metastore's OCID.
          maxLength: 255
          minLength: 1
          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.
          maxLength: 400
          minLength: 1
          type: string
        lifecycleState:
          description: The current state of the metastore.
          enum:
          - CREATING
          - ACTIVE
          - INACTIVE
          - UPDATING
          - DELETING
          - DELETED
          - FAILED
          - MOVING
          type: string
          x-obmcs-top-level-enum: '#/definitions/LifecycleState'
        timeCreated:
          description: Time at which the metastore was created. An [RFC3339](https://tools.ietf.org/html/rfc3339) formatted datetime string.
          format: date-time
          type: string
        timeUpdated:
          description: Time at which the metastore was last modified. An [RFC3339](https://tools.ietf.org/html/rfc3339) formatted datetime string.
          format: date-time
          type: string
      required:
      - id
      - compartmentId
      - defaultManagedTableLocation
      - defaultExternalTableLocation
      type: object
    JobExecutionSummary:
      description: A list of job executions. A job execution is a unit of work being executed on behalf of a job.
      properties:
        jobKey:
          description: The unique key of the parent job.
          maxLength: 255
          minLength: 1
          type: string
        jobType:
          description: Type of the job execution.
          enum:
          - HARVEST
          - PROFILING
          - SAMPLING
          - PREVIEW
          - IMPORT
          - EXPORT
          - IMPORT_GLOSSARY
          - EXPORT_GLOSSARY
          - INTERNAL
          - PURGE
          - IMMEDIATE
          - SCHEDULED
          - IMMEDIATE_EXECUTION
          - SCHEDULED_EXECUTION
          - SCHEDULED_EXECUTION_INSTANCE
          - ASYNC_DELETE
          - IMPORT_DATA_ASSET
          - CREATE_SCAN_PROXY
          - ASYNC_EXPORT_GLOSSARY
          - ASYNC_EXPORT_DATA_ASSET
          type: string
          x-obmcs-top-level-enum: '#/definitions/JobType'
        key:
          description: Unique key of the job execution resource.
          maxLength: 255
          minLength: 1
          type: string
        lifecycleState:
          description: Status of the job execution, such as running, paused, or completed.
          enum:
          - CREATED
          - IN_PROGRESS
          - INACTIVE
          - FAILED
          - SUCCEEDED
          - CANCELED
          - SUCCEEDED_WITH_WARNINGS
          type: string
          x-obmcs-top-level-enum: '#/definitions/JobExecutionState'
        parentKey:
          description: The unique key of the parent execution or null if this job execution has no parent.
          maxLength: 255
          type: string
        scheduleInstanceKey:
          description: The unique key of the triggering external scheduler resource or null if this job execution is not externally triggered.
          maxLength: 255
          type: string
        timeCreated:
          description: 'The date and time the job execution was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339).

            Example: `2019-03-25T21:10:29.600Z`

            '
          format: date-time
          type: string
        timeEnded:
          description: 'Time that the job execution ended or null if it hasn''t yet completed.

            An [RFC3339](https://tools.ietf.org/html/rfc3339) formatted datetime string.

            '
          format: date-time
          type: string
        timeStarted:
          description: Time that job execution started. An [RFC3339](https://tools.ietf.org/html/rfc3339) formatted datetime string.
          format: date-time
          type: string
        uri:
          description: URI to the job execution instance in the API.
          type: string
      required:
      - key
      type: object
    ChangeCatalogCompartmentDetails:
      description: Information about the change compartment
      properties:
        compartmentId:
          description: The identifier of the compartment where the resource should be moved.
          maxLength: 255
          minLength: 1
          type: string
      required:
      - compartmentId
      type: object
    ObjectLineage:
      description: Lineage for an object.
      properties:
        annotations:
          additionalProperties:
            additionalProperties:
              description: The string value of the lineage annotation.
              type: string
            description: 'Key-value pair representing lineage annotations scoped to a category.

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

              '
            type: object
          description: 'A map of maps that contains additional information in explanation of the lineage returned. The map keys are

            categories of information and the values are maps of annotation names to their corresponding values.

            Every annotation is contained inside a category.

            Example: `{"annotations": { "category": { "key": "value"}}}`

            '
          maxProperties: 100
          type: object
        direction:
          description: Direction of the lineage returned.
          enum:
          - UPSTREAM
          - BOTH
          - DOWNSTREAM
          type: string
          x-obmcs-top-level-enum: '#/definitions/LineageDirection'
        level:
          description: 'Object level at which the lineage is returned.

            '
          type: integer
        objects:
          description: Set of objects that are involved in the lineage.
          items:
            $ref: '#/components/schemas/LineageObject'
          maxItems: 1000
          type: array
        relationships:
          description: Set of relationships between the objects in the 'objects' set.
          items:
            $ref: '#/components/schemas/LineageRelationship'
          maxItems: 1000
          type: array
      required:
      - level
      - direction
      type: object
    RecommendationDetails:
      description: 'Details of a recommendation.

        '
      properties:
        confidenceScore:
          description: Level of confidence, on a scale between 0 and 1, that the recommendation is applicable.
          format: float
          type: number
        properties:
          additionalProperties:
            additionalProperties:
              description: The string value of the property.
              type: string
            description: 'Key-value pair representing properties of a recommendation.

              Example: `{"key1": "value1"}`

              '
            type: object
          description: "A map of maps that contains additional properties which are specific to the associated objects.\nEach associated object defines it's set of required and optional properties.\nExample: `{\n            \"DataEntity\": {\n              \"parentId\": \"entityId\"\n            },\n            \"Term\": {\n              \"parentId\": \"glossaryId\"\n            }\n          }`\n"
          type: object
        recommendationKey:
          description: Unique identifier of the recommendation.
          maxLength: 255
          minLength: 1
          type: string
        recommendationStatus:
          description: Status of a recommendation.
          enum:
          - ACCEPTED
          - REJECTED
          - INFERRED
          type: string
          x-obmcs-top-level-enum: '#/definitions/RecommendationStatus'
        recommendationType:
          description: Type of recommendation.
          enum:
          - LINK_GLOSSARY_TERM
          type: string
          x-obmcs-top-level-enum: '#/definitions/RecommendationType'
        sourceObjectKey:
          description: Unique identifier of the source object; the one for which a recommendation is made.
          maxLength: 255
          minLength: 1
          type: string
        sourceObjectName:
          description: Name of the source object; the one for which a recommendation is made.
          maxLength: 255
          minLength: 1
          type: string
        sourceObjectType:
          description: Type of the source object; the one for which a recommendation is made.
          enum:
          - DATA_ENTITY
          - ATTRIBUTE
          - TERM
          - CATEGORY
          type: string
          x-obmcs-top-level-enum: '#/definitions/RecommendationResourceType'
        targetObjectKey:
          description: Unique identifier of the target object; the one which has been recommended.
          maxLength: 255
          minLength: 1
          type: string
        targetObjectName:
          description: Name of the target object; the one which has been recommended.
          maxLength: 255
          minLength: 1
          type: string
        targetObjectType:
          description: Type of the target object; the one which has been recommended.
          enum:
          - DATA_ENTITY
          - ATTRIBUTE
          - TERM
          - CATEGORY
          type: string
          x-obmcs-top-level-enum: '#/definitions/RecommendationResourceType'
      required:
      - recommendationKey
      - recommendationType
      - recommendationStatus
      type: object
    NamespaceCollection:
      description: 'Results of a namespaces listing. A namespace is an unique name tied to the first class object of data catalog which will be used to create a custom property

        '
      properties:
        count:
          description: Total number of items returned.
          type: integer
        items:
          description: Collection of namespace summaries
          items:
            $ref: '#/components/schemas/NamespaceSummary'
          type: array
      required:
      - items
      type: object
    SearchCriteria:
      description: 'Search Query object that allows complex search predicates that cannot be expressed through simple query params.

        '
      properties:
        dimensions:
          description: List of properties of dataObjects that needs to aggregated on for facets.
          items:
            type: string
          type: array
        facetedQuery:
          description: Query string that a dataObject is to be searched with. Used in the faceted query request
          example: '*'
          type: string
        filters:
          $ref: '#/components/schemas/FacetedSearchFilterRequest'
        query:
          description: Search query dsl that defines the query components including fields and predicates.
          type: string
        sort:
          description: Array of objects having details about sort field and order.
          items:
            $ref: '#/components/schemas/FacetedSearchSortRequest'
          type: array
      type: object
    JobLogSummary:
      description: 'A list of job execution logs.

        A job log is an audit log record inserted during the lifecycle of a job execution instance.

        There can be one or more logs for an execution instance.

        '
      properties:
        jobExecutionKey:
          description: The unique key of the parent job execution for which the log resource was created.
          maxLength: 255
          minLength: 1
          type: string
        key:
          description: Unique key of the job log that is immutable.
          maxLength: 255
          minLength: 1
          type: string
        logMessage:
          description: Message for this job log.
          type: string
        severity:
          description: Severity level for this log.
          type: string
        timeCreated:
          description: 'The date and time the job log was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339).

            Example: `2019-03-25T21:10:29.600Z`

            '
          format: date-time
          type: string
        uri:
          description: URI to the job log instance in the API.
          type: string
      required:
      - key
      type: object
    TermRelationship:
      description: 'Full term relationship definition. Business term relationship between two terms in a business glossary.

        '
      properties:
        description:
          description: Detailed description of the term relationship usually defined at the time of creation.
          maxLength: 400
          type: string
        displayName:
          description: 'A user-friendly display name. Does not have to be unique, and it''s changeable.

            Avoid entering confidential information.This is the same as relationshipType for termRelationship

            '
          maxLength: 255
          minLength: 1
          type: string
        key:
          description: Unique term relationship key that is immutable.
          maxLength: 255
          minLength: 1
          type: string
        lifecycleState:
          description: State of the term relationship.
          enum:
          - CREATING
          - ACTIVE
          - INACTIVE
          - UPDATING
          - DELETING
          - DELETED
          - FAILED
          - MOVING
          type: string
          x-obmcs-top-level-enum: '#/definitions/LifecycleState'
        parentTermDescription:
          description: Description of the parent term.
          maxLength: 400
          type: string
        parentTermDisplayName:
          description: Name of the parent term.
          maxLength: 255
          minLength: 1
          type: string
        parentTermGlossaryKey:
          description: Glossary key of the parent term.
          type: string
        parentTermKey:
          description: This relationships parent term key.
          maxLength: 255
          type: string
        parentTermPath:
          description: Full path of the parent term.
          type: string
        relatedTermDescription:
          description: Description of the related term.
          maxLength: 400
          type: string
        relatedTermDisplayName:
          description: Name of the related term.
          maxLength: 255
          minLength: 1
          type: string
        relatedTermGlossaryKey:
          description: Glossary key of the related term.
          type: string
        relatedTermKey:
          description: Unique id of the related term.
          maxLength: 255
          minLength: 1
          type: string
        relatedTermPath:
          description: Full path of the related term.
          type: string
        timeCreated:
          description: 'The date and time the term relationship was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339).

            Example: `2019-03-25T21:10:29.600Z`

            '
          format: date-time
          type: string
        uri:
          description: URI to the term relationship instance in the API.
          type: string
      required:
      - key
      type: object
    ValidatePatternDetails:
      description: Validate pattern using the expression and file list.
      properties:
        checkFailureLimit:
          description: 'The maximum number of UNMATCHED files, in checkFilePathList, above which the check fails.

            Optional, if checkFilePathList is provided.


            If provided with the request, this overrides the value which already exists as part of the pattern, if any.

            '
          type: integer
        checkFilePathList:
          description: 'List of file paths against which the pattern can be tried, as a check. This documents, for reference

            purposes, some example objects a pattern is meant to work with.


            If provided with the request,this overrides the list which already exists as part of the pattern, if any.

            '
          items:
            type: string
          type: array
        expression:
          description: 'Input string which drives the selection process, allowing for fine-grained control using qualifiers.

            Refer to the user documentation for details of the format and examples. A pattern cannot include both

            a prefix and an expression.

            '
          type: string
        filePathPrefix:
          description: 'Input string which drives the selection process.

            Refer to the user documentation for details of the format and examples. A pattern cannot include both

            a prefix and an expression.

            '
          type: string
      type: object
    Attribute:
      description: 'Details of an entity attribute. An attribute of a data entity describing an item of data,

        with a name and data type. Synonymous with ''column'' in a database.

        '
      properties:
        associatedRuleTypes:
          description: Rule types associated with attribute.
          items:
            enum:
            - PRIMARYKEY
            - FOREIGNKEY
            - UNIQUEKEY
            type: string
            x-obmcs-top-level-enum: '#/definitions/RuleType'
          type: array
        businessName:
          description: Optional user friendly business name of the attribute. If set, this supplements the harvested display name of the object.
          maxLength: 255
          type: string
        createdById:
          description: OCID of the user who created this attribute in the data catalog.
          maxLength: 255
          minLength: 1
          type: string
        customPropertyMembers:
          description: The list of customized properties along with the values for this object
          items:
            $ref: '#/components/schemas/CustomPropertyGetUsage'
          type: array
        datatypeEntityKey:
          description: Entity key that represents the datatype of this attribute , applicable if this attribute is a complex type.
          maxLength: 255
          minLength: 1
          type: string
        description:
          description: Detailed description of the attribute.
          maxLength: 400
          type: string
        displayName:
          description: 'A user-friendly display name. Does not have to be unique, and it''s changeable.

            Avoid entering confidential information.

            '
          maxLength: 255
          minLength: 1
          type: string
        entityKey:
          description: The unique key of the parent entity.
          maxLength: 255
          minLength: 1
          type: string
        externalDataType:
          description: 'Data type of the attribute as defined in the external system. Type mapping across systems can be achieved

            through term associations across domains in the ontology. The attribute can also be tagged to the datatype in

            the domain ontology to resolve any ambiguity arising from type name similarity that can occur with user

            defined types.

            '
          type: string
        externalDatatypeEntityKey:
          description: External entity key that represents the datatype of this attribute , applicable if this attribute is a complex type.
          maxLength: 255
          minLength: 1
          type: string
        externalKey:
          description: Unique external key of this attribute in the external source system.
          maxLength: 255
          minLength: 1
          type: string
        externalParentAttributeKey:
          description: External attribute key that represents the parent attribute  of this attribute , applicable if the parent attribute is of complex type.
          maxLength: 255
          minLength: 1
          type: string
        isDerivedAttribute:
          description: Whether a column is derived or not.
          type: boolean
        isIncrementalData:
          description: Property that identifies if this attribute can be used as a watermark to extract incremental data.
          type: boolean
        isNullable:
          description: Property that identifies if this attribute can be assigned null values.
          type: boolean
        key:
          description: Unique attribute key that is immutable.
          maxLength: 255
          minLength: 1
          type: string
        length:
          description: Max allowed length of the attribute value.
          format: int64
          type: integer
        lifecycleDetails:
          description: 'A message describing the current state in more detail. An object not in ACTIVE state may have functional limitations,

            see service documentation for details.

            '
          maxLength: 255
          minLength: 1
          type: string
        lifecycleState:
          description: State of the attribute.
          enum:
          - CREATING
          - ACTIVE
          - INACTIVE
          - UPDATING
          - DELETING
          - DELETED
          - FAILED
          - MOVING
          type: string
          x-obmcs-top-level-enum: '#/definitions/LifecycleState'
        maxCollectionCount:
          description: 'The maximum count for the number of instances of a given type stored in this collection type attribute,applicable if this attribute is a complex type.

            For type specifications in systems that specify only "capacity" without upper or lower bound , this property can also be used to just mean "capacity".

            Some examples are Varray size in Oracle , Occurs Clause in Cobol , capacity in XmlSchemaObjectCollection , maxOccurs in  Xml , maxItems in Json

            '
          format: int32
          type: integer
        minCollectionCount:
          description: The minimum count for the number of instances of a given type stored in this collection type attribute,applicable if this attribute is a complex type.
          format: int32
          type: integer
        objectRelationships:
          description: List of objects and their relationships to this attribute.
          items:
            $ref: '#/components/schemas/ObjectRelationship'
          type: array
        parentAttributeKey:
          description: Attribute key that represents the parent attribute of this attribute , applicable if the parent attribute is of complex datatype.
          maxLength: 255
          minLength: 1
          type: string
        path:
          description: Full path of the attribute.
          type: string
        position:
          description: Position of the attribute in the record definition.
          format: int32
          type: integer
        precision:
          description: Precision of the attribute value usually applies to float data type.
          format: int32
          type: integer
        properties:
          additionalProperties:
            additionalProperties:
              description: The string value of the attribute property.
              type: string
            description: 'Key-value pair representing properties of an attribute scoped to a category.

              Example: `{"key1": "value1"}`

              '
            type: object
          description: 'A map of maps that contains the properties which are specific to the attribute type. Each attribute type

            definition defines it''s set of required and optional properties. The map keys are category names and the

            values are maps of property name to property value. Every property is contained inside of a category. Most

            attributes have required properties within the "default" category.

            Example: `{"properties": { "default": { "key1": "value1"}}}`

            '
          type: object
        scale:
          description: Scale of the attribute value usually applies to float data type.
          format: int32
          type: integer
        timeCreated:
          description: 'The date and time the attribute was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339).

            Example: `2019-03-25T21:10:29.600Z`

            '
          format: date-time
          type: string
        timeExternal:
          description: Last modified timestamp of this object in the external system.
          format: date-time
          type: string
        timeHarvested:
          description: The date and time the attribute was harvested, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339).
          format: date-time
          type: string
        timeUpdated:
          description: 'The last time that any change was made to the attribute. An [RFC3339](https://tools.ietf.org/html/rfc3339) formatted datetime string.

            '
          format: date-time
          type: string
        typeKey:
          description: The type of the attribute. Type keys can be found via the '/types' endpoint.
          maxLength: 255
          minLength: 1
          type: string
        updatedById:
          description: OCID of the user who modified this attribute in the data catalog.
          maxLength: 255
          minLength: 1
          type: string
        uri:
          description: URI to the attribute instance in the API.
          type: string
      required:
      - key
      type: object
    CreateJobExecutionDetails:
      description: Properties for creating a new job execution.
      properties:
        dataEntityKey:
          description: The key of the associated data entity resource.
          maxLength: 255
          minLength: 1
          type: string
        errorCode:
          description: 'Error code returned from the job execution or null if job is still running or didn''t return an error.

            '
          type: string
        errorMessage:
          description: 'Error message returned from the job execution or null if job is still running or didn''t return an error.

            '
          type: string
        eventKey:
          description: 'An identifier used for log message correlation.

            '
          maxLength: 255
          type: string
        externalUrl:
          description: 'If the job is an external process, then a URL of the job for accessing this resource and its status.

            '
          type: string
        jobType:
          description: Type of the job execution.
          enum:
          - HARVEST
          - PROFILING
          - SAMPLING
          - PREVIEW
          - IMPORT
          - EXPORT
          - IMPORT_GLOSSARY
          - EXPORT_GLOSSARY
          - INTERNAL
          - PURGE
          - IMMEDIATE
          - SCHEDULED
          - IMMEDIATE_EXECUTION
          - SCHEDULED_EXECUTION
          - SCHEDULED_EXECUTION_INSTANCE
          - ASYNC_DELETE
          - IMPORT_DATA_ASSET
          - CREATE_SCAN_PROXY
          - ASYNC_EXPORT_GLOSSARY
          - ASYNC_EXPORT_DATA_ASSET
          type: string
          x-obmcs-top-level-enum: '#/definitions/JobType'
        lifecycleState:
          description: Status of the job execution, such as running, paused, or completed.
          enum:
          - CREATED
          - IN_PROGRESS
          - INACTIVE
          - FAILED
          - SUCCEEDED
          - CANCELED
          - SUCCEEDED_WITH_WARNINGS
          type: string
          x-obmcs-top-level-enum: '#/definitions/JobExecutionState'
        parentKey:
          description: The unique key of the parent execution or null if this job execution has no parent.
          maxLength: 255
          type: string
        processKey:
          description: Process identifier related to the job execution if the job is an external job.
          maxLength: 255
          type: string
        properties:
          additionalProperties:
            additionalProperties:
              description: The string value of the job execution context property.
              type: string
            description: 'Key-value pair representing properties of a job execution scoped to a category.

              Example: `{"host": "host1", "port": "1521", "database": "orcl"}`

              '
            type: object
          description: 'A map of maps that contains the execution context properties which are specific to a job execution. Each job

            execution may define it''s set of required and optional properties. The map keys are category names and the

            values are maps of property name to property value. Every property is contained inside of a category. Most

            job executions have required properties within the "default" category.

            Example: `{"properties": { "default": { "host": "host1", "port": "1521", "database": "orcl"}}}`

            '
          type: object
        scheduleInstanceKey:
          description: The unique key of the triggering external scheduler resource or null if this job execution is not externally triggered.
          maxLength: 255
          type: string
        subType:
          description: Sub-type of this job execution.
          type: string
        timeEnded:
          description: 'Time that the job execution ended or null if it hasn''t yet completed.

            An [RFC3339](https://tools.ietf.org/html/rfc3339) formatted datetime string.

            '
          format: date-time
          type: string
        timeStarted:
          description: Time that job execution started. An [RFC3339](https://tools.ietf.org/html/rfc3339) formatted datetime string.
          format: date-time
          type: string
      type: object
    ImportGlossaryDetails:
      description: Import glossary from the contents of the glossary definition file.
      properties:
        glossaryFileContents:
          description: The file contents used for the import of glossary.
          format: byte
          type: string
      type: object
    ConnectionCollection:
      description: 'Results of a connections listing. Each member of the result is a summary representation of a connection to a data asset.

        '
      properties:
        count:
          description: Total number of items returned.
          type: integer
        items:
          description: Collection of connection summaries.
          items:
            $ref: '#/components/schemas/ConnectionSummary'
          type: array
      required:
      - items
      type: object
    FolderTagSummary:
      allOf:
      - $ref: '#/components/schemas/BaseTagSummary'
      - properties:
          folderKey:
            description: The unique key of the parent folder.
            maxLength: 255
            minLength: 1
            type: string
        type: object
      description: Summary of a folder tag.
      type: object
    UpdateGlossaryDetails:
      description: Properties used in glossary update operations.
      properties:
        customPropertyMembers:
          description: The list of customized properties along with the values for this object
          items:
            $ref: '#/components/schemas/CustomPropertySetUsage'
          type: array
        description:
          description: Detailed description of the glossary.
          maxLength: 400
          type: string
        displayName:
          description: 'A user-friendly display name. Does not have to be unique, and it''s changeable.

            Avoid entering confidential information.

            '
          maxLength: 255
          minLength: 1
          type: string
        owner:
          description: OCID of the user who is the owner of the glossary.
          maxLength: 255
          minLength: 1
          type: string
        workflowStatus:
          description: Status of the approval process workflow for this business glossary.
          enum:
          - NEW
          - APPROVED
          - UNDER_REVIEW
          - ESCALATED
          type: string
          x-obmcs-top-level-enum: '#/definitions/TermWorkflowStatus'
      type: object
    PropertyDefinition:
      description: Details of a single type property.
      properties:
        isRequired:
          description: Whether instances of the type are required to set this property.
          type: boolean
        isUpdatable:
          description: Indicates if this property value can be updated.
          type: boolean
        name:
          description: Name of the property.
          maxLength: 255
          minLength: 1
          type: string
        type:
          description: The properties value type.
          maxLength: 255
          minLength: 1
          type: string
      type: object
    ValidateConnectionDetails:
      description: Validate connection from the connection metadata or oracle wallet file.
      properties:
        connectionDetail:
          $ref: '#/components/schemas/CreateConnectionDetails'
        connectionPayload:
          description: The information used to validate the connection.
          format: byte
          type: string
      type: object
    CatalogPrivateEndpoint:
      description: A private network reverse connection creates a connection from service to customer subnet over a private network.
      properties:
        attachedCatalogs:
          description: The list of catalogs using the private reverse connection endpoint
          items:
            type: string
          type: array
        compartmentId:
          description: Compartment Identifier.
          type: string
        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: 'Usage of predefined tag keys. These predefined keys are scoped to namespaces.

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

            '
          type: object
        displayName:
          description: Private Reverse Connection Endpoint display name
          maxLength: 255
          minLength: 1
          type: string
        dnsZones:
          description: 'List of DNS zones to be used by the data assets to be harvested.

            Example: custpvtsubnet.oraclevcn.com for data asset: db.custpvtsubnet.oraclevcn.com

            '
          items:
            maxLength: 253
            minLength: 1
            type: string
          maxItems: 30
          minItems: 1
          type: array
        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
        id:
          description: Unique identifier that is immutable
          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.
          maxLength: 255
          minLength: 1
          type: string
        lifecycleState:
          description: The current state of the private endpoint resource.
          enum:
          - CREATING
          - ACTIVE
          - INACTIVE
          - UPDATING
          - DELETING
          - DELETED
          - FAILED
          - MOVING
          type: string
          x-obmcs-top-level-enum: '#/definitions/LifecycleState'
        securityAttributes:
          additionalProperties:
            additionalProperties:
              description: 'Attribute value and mode. Only the String type is supported for value. Mode is currently always "enforce".


                Example: `{"value": "42", "mode": "enforce"}`

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


              Example: `{"MaxEgressCount": {"value": "42", "mode": "enforce"}}`

              '
            type: object
          description: 'Security attributes 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: `{"Oracle-ZPR": {"MaxEgressCount": {"value": "42", "mode": "enforce"}}}`

            '
          type: object
        subnetId:
          description: Subnet Identifier
          type: string
        timeCreated:
          description: The time the private endpoint was created. An [RFC3339](https://tools.ietf.org/html/rfc3339) formatted datetime string.
          format: date-time
          type: string
        timeUpdated:
          description: The time the private endpoint was updated. An [RFC3339](https://tools.ietf.org/html/rfc3339) formatted datetime string.
          format: date-time
          type: string
      required:
      - id
      - compartmentId
      - subnetId
      - dnsZones
      type: object
    AttributeSummary:
      description: Summary of an entity attribute.
      properties:
        associatedRuleTypes:
          description: Rule types associated with attribute.
          items:
            enum:
            - PRIMARYKEY
            - FOREIGNKEY
            - UNIQUEKEY
            type: string
            x-obmcs-top-level-enum: '#/definitions/RuleType'
          type: array
        businessName:
          description: Optional user friendly business name of the attribute. If set, this supplements the harvested display name of the object.
          maxLength: 255
          type: string
        customPropertyMembers:
          description: The list of customized properties along with the values for this object
          items:
            $ref: '#/components/schemas/CustomPropertyGetUsage'
          type: array
        datatypeEntityKey:
          description: Entity key that represents the datatype of this attribute , applicable if this attribute is a complex type.
          maxLength: 255
          minLength: 1
          type: string
        description:
          description: Detailed description of the attribute.
          maxLength: 400
          type: string
        displayName:
          description: 'A user-friendly display name. Does not have to be unique, and it''s changeable.

            Avoid entering confidential information.

            '
          maxLength: 255
          minLength: 1
          type: string
        entityKey:
          description: The unique key of the parent entity.
          maxLength: 255
          minLength: 1
          type: string
        externalDataType:
          description: Data type of the attribute as defined in the external source system.
          type: string
        externalDatatypeEntityKey:
          description: External entity key that represents the datatype of this attribute , applicable if this attribute is a complex type.
          maxLength: 255
          minLength: 1
          type: string
        externalKey:
          description: Unique external key of this attribute in the external source system.
          maxLength: 255
          minLength: 1
          type: string
        externalParentAttributeKey:
          description: External attribute key that represents the parent attribute  of this attribute , applicable if the parent attribute is of complex type.
          maxLength: 255
          minLength: 1
          type: string
        isDerivedAttribute:
          description: Whether a column is derived or not.
          type: boolean
        isNullable:
          description: Property that identifies if this attribute can be assigned null values.
          type: boolean
        key:
          description: Unique attribute key that is immutable.
          maxLength: 255
          minLength: 1
          type: string
        length:
          description: Max allowed length of the attribute value.
          format: int64
          type: integer
        lifecycleDetails:
          description: 'A message describing the current state in more detail. An object not in ACTIVE state may have functional limitations,

            see service documentation for details.

            '
          maxLength: 255
          minLength: 1
          type: string
        lifecycleState:
          description: State of the attribute.
          enum:
          - CREATING
          - ACTIVE
          - INACTIVE
          - UPDATING
          - DELETING
          - DELETED
          - FAILED
          - MOVING
          type: string
          x-obmcs-top-level-enum: '#/definitions/LifecycleState'
        maxCollectionCount:
          description: 'The maximum count for the number of instances of a given type stored in this collection type attribute,applicable if this attribute is a complex type.

            For type specifications in systems that specify only "capacity" without upper or lower bound , this property can also be used to just mean "capacity".

            Some examples are Varray size in Oracle , Occurs Clause in Cobol , capacity in XmlSchemaObjectCollection , maxOccurs in  Xml , maxItems in Json

            '
          format: int32
          type: integer
        minCollectionCount:
          description: The minimum count for the number of instances of a given type stored in this collection type attribute,applicable if this attribute is a complex type.
          format: int32
          type: integer
        parentAttributeKey:
          description: Attribute key that represents the parent attribute of this attribute , applicable if the parent attribute is of complex datatype.
          maxLength: 255
          minLength: 1
          type: string
        path:
          description: Full path of the attribute.
          type: string
        position:
          description: Position of the attribute in the record definition.
          format: int32
          type: integer
        precision:
          description: Precision of the attribute value usually applies to float data type.
          format: int32
          type: integer
        properties:
          additionalProperties:
            additionalProperties:
              description: The string value of the attribute property.
              type: string
            description: 'Key-value pair representing properties of an attribute scoped to a category.

              Example: `{"key1": "value1"}`

              '
            type: object
          description: 'A map of maps that contains the properties which are specific to the attribute type. Each attribute type

            definition defines it''s set of required and optional properties. The map keys are category names and the

            values are maps of property name to property value. Every property is contained inside of a category. Most

            attributes have required properties within the "default" category.

            Example: `{"properties": { "default": { "key1": "value1"}}}`

            '
          type: object
        scale:
          description: Scale of the attribute value usually applies to float data type.
          format: int32
          type: integer
        timeCreated:
          description: 'The date and time the attribute was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339).

            Example: `2019-03-25T21:10:29.600Z`

            '
          format: date-time
          type: string
        timeUpdated:
          description: 'The last time that any change was made to the attribute. An [RFC3339](https://tools.ietf.org/html/rfc3339) formatted datetime string.

            '
          format: date-time
          type: string
        typeKey:
          description: The type of the attribute. Type keys can be found via the '/types' endpoint.
          maxLength: 255
          minLength: 1
          type: string
        uri:
          description: URI to the attribute instance in the API.
          type: string
      required:
      - key
      type: object
    ObjectLineageRequestDetails:
      description: Details needed by a lineage fetch request.
      properties:
        direction:
          description: Direction of the lineage returned.
          enum:
          - UPSTREAM
          - BOTH
          - DOWNSTREAM
          type: string
          x-obmcs-top-level-enum: '#/definitions/LineageDirection'
        intraLineageObjectKey:
          description: 'Unique object key for which intra-lineage needs to be fetched. Only drill-down lineage corresponding

            to the object whose object key is passed is returned.

            '
          maxLength: 255
          minLength: 1
          type: string
        isIntraLineage:
          default: false
          description: 'Intra-lineages are drill down lineages. This field indicates whether all intra-lineages need to be

            expanded inline in the lineage returned.

            '
          type: boolean
        level:
          description: 'Object level at which the lineage is returned.

            '
          type: integer
      type: object
  responses:
    DefaultError:
      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 [ETags for Optimistic Concurrency Control](/iaas/Content/API/Concepts/usingapi.htm#eleven).

        '
      type: string
    opc-next-page:
      description: 'Retrieves the next page of results. When this header appears in the response, additional pages of results remain. See [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).

        '
      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: 'The OCID of the asynchronous request. Use [GetWorkRequest](/api/#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this OCID to track the status of the asynchronous request.

        '
      type: string
    retry-after:
      description: 'A non-negative integer representing the number of seconds the client should wait

        before polling this endpoint again.

        '
      type: integer
    securityAttributes:
      additionalProperties:
        additionalProperties:
          description: 'Attribute value and mode. Only the String type is supported for value. Mode is currently always "enforce".


            Example: `{"value": "42", "mode": "enforce"}`

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


          Example: `{"MaxEgressCount": {"value": "42", "mode": "enforce"}}`

          '
        type: object
      description: 'Security attributes 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: `{"Oracle-ZPR": {"MaxEgressCount": {"value": "42", "mode": "enforce"}}}`

        '
      type: object
x-oracle-package: com.oracle.pic.dcat
x-splat:
  authzSource: zprv1