openapi: 3.2.0
info:
  description: A description of the ReferenceService API. in progress
  title: Generative AI Service NL2SQL Get Enrichment Job API
  version: '20260325'
  x-provenance:
    method: harvested
    first_party: true
    publisher: Oracle
    source: https://docs.oracle.com/en-us/iaas/api/specs/2292d191d8e507557733c33ec3b7902d15322d28c171d878ef5fb0bce8ef272e.yaml
    harvested: '2026-08-04'
    note: Published by Oracle as the contract for the Generative AI Service NL2SQL 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/2292d191d8e507557733c33ec3b7902d15322d28c171d878ef5fb0bce8ef272e.yaml
    what: the harvested document for Generative AI Service NL2SQL API
servers:
- url: http://127.0.0.1/20260325
- url: https://127.0.0.1/20260325
tags:
- name: getEnrichmentJob
paths:
  /semanticStores/{semanticStoreId}/enrichmentJobs/{enrichmentJobId}:
    get:
      description: 'Gets an EnrichmentJob by identifier.

        '
      operationId: GetEnrichmentJob
      parameters:
      - $ref: '#/components/parameters/semanticStoreIdPathParam'
      - $ref: '#/components/parameters/enrichmentJobIdPathParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: The EnrichmentJob is retrieved successfully.
          headers:
            etag:
              description: 'For optimistic concurrency control. See `if-match`.

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

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

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EnrichmentJob'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Gets an enrichment job by identifier
      tags:
      - getEnrichmentJob
components:
  parameters:
    enrichmentJobIdPathParam:
      description: The OCID of the enrichment job
      in: path
      name: enrichmentJobId
      required: true
      schema:
        type: string
    RequestIdHeader:
      description: The client request ID for tracing.
      in: header
      name: opc-request-id
      schema:
        type: string
    semanticStoreIdPathParam:
      description: The OCID of the semantic store
      in: path
      name: semanticStoreId
      required: true
      schema:
        type: string
  schemas:
    EnrichmentJobConfiguration:
      description: 'An EnrichmentJobConfiguration describes the database objects that will be targeted by an EnrichmentJob, as described by the job''s type.

        '
      discriminator:
        propertyName: enrichmentJobType
      properties:
        enrichmentJobType:
          description: Enrichment job type
          enum:
          - FULL_BUILD
          - PARTIAL_BUILD
          - DELTA_REFRESH
          type: string
          x-obmcs-top-level-enum: '#/definitions/EnrichmentJobType'
      required:
      - enrichmentJobType
      type: object
    EnrichmentJob:
      description: 'Object representing to EnrichmentJob.

        ocidEntityType: generativeaiEnrichmentJob

        adLocality: regional

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

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

            '
          type: object
        description:
          description: An optional description of the EnrichmentJob.
          maxLength: 400
          minLength: 1
          type: string
          x-default-description: 'null'
        displayName:
          description: A user-friendly display name. It does not have to be unique and can be modified. Avoid entering confidential information.
          maxLength: 255
          minLength: 1
          type: string
        enrichmentJobConfiguration:
          $ref: '#/components/schemas/EnrichmentJobConfiguration'
        enrichmentJobType:
          description: Enrichment job type. Currently supported Full Build (All supported objects in a given schema) and Partial Build (Selected tables and/or supported objects in a given schema).
          enum:
          - FULL_BUILD
          - PARTIAL_BUILD
          - DELTA_REFRESH
          type: string
          x-obmcs-top-level-enum: '#/definitions/EnrichmentJobType'
        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.
          type: string
        lifecycleDetails:
          description: A message describing the current state in more detail that can provide actionable information.
          type: string
        lifecycleState:
          description: The lifecycleState of GenerateSqlJob.
          enum:
          - ACCEPTED
          - IN_PROGRESS
          - FAILED
          - SUCCEEDED
          - CANCELING
          - CANCELED
          type: string
          x-obmcs-top-level-enum: '#/definitions/LifecycleState'
        percentComplete:
          description: The percentage of the enrichment job that has been completed.
          format: float
          maximum: 100
          minimum: 0
          type: number
        semanticStoreId:
          description: Owning SemanticStore [OCID](/iaas/Content/General/Concepts/identifiers.htm) for an EnrichmentJob.
          maxLength: 255
          minLength: 1
          type: string
        systemTags:
          additionalProperties:
            additionalProperties:
              type: object
            type: object
          description: 'System tags for this resource. Each key is predefined and scoped to a namespace.

            Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`

            '
          type: object
        timeAccepted:
          description: The date and time that the enrichment job was accepted in the format of an RFC3339 datetime string.
          format: date-time
          type: string
        timeFinished:
          description: The date and time that the enrichment job was finished in the format of an RFC3339 datetime string.
          format: date-time
          type: string
        timeStarted:
          description: The date and time that the enrichment job was started in the format of an RFC3339 datetime string.
          format: date-time
          type: string
      required:
      - id
      - semanticStoreId
      - enrichmentJobType
      - enrichmentJobConfiguration
      - timeAccepted
      - lifecycleDetails
      - lifecycleState
      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
  responses:
    default:
      description: Unknown Error
      headers:
        opc-request-id:
          description: 'Unique Oracle-assigned identifier for the request. If you need to contact

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

            '
          schema:
            type: string
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
x-anchors:
  x-headers:
    etag:
      description: 'For optimistic concurrency control. See `if-match`.

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

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

        subsequent GET request to get the next batch of items.

        '
      type: string
    opc-prev-page:
      description: 'For list pagination. When this header appears in the response, previous pages of results remain. For

        important details about how pagination works, 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: 'Unique Oracle-assigned identifier for the asynchronous work. You can use this to query its status.

        '
      type: string
  x-properties:
    definedTags:
      additionalProperties:
        additionalProperties:
          type: object
        type: object
      description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.

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

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

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

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

        Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`

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