Adobe Suite Dataset Enablement API

openapi: 3.2.0
info:
  title: Orchestrated campaigns extension for datasets Dataset…
  version: 1.0.0
  description: Use these APIs to validate or enable the **Orchestrated Campaign extension** on a **dataset**, making it available for use with **Orchestrated Campaigns** in **Adobe Journey Optimizer**.
servers:
- url: https://platform.adobe.io/ajo/relational
- url: https://platform-stage.adobe.io/ajo/relational
security:
- imsUserToken: []
tags:
- name: DatasetEnablement
paths:
  /modeler/datasets/{datasetId}/extensions/validation:
    get:
      operationId: validateOrchestratedCampaignExtensionOnDataset
      tags:
      - DatasetEnablement
      summary: Validate if Orchestrated Campaign extension can be applied on a dataset
      description: 'This API validates if the Orchestrated Campaign extension can be applied on a dataset.

        It checks if the dataset meets the following criteria:

        - Dataset must be associated with a model-based schema.

        - Dataset must not be a System dataset or a Profile-enabled dataset.

        - Schema behavior must be set to record. (Schemas with behavior **timeseries** are not supported.)

        - Schema must define both a primary key and a version descriptor.

        - Dataset must be of CDC (Change Data Capture) type.

        - Orchestrated Campaign extension is not enabled on the dataset or in progress.'
      security:
      - imsUserToken: []
      parameters:
      - $ref: '#/components/parameters/x-api-key'
      - $ref: '#/components/parameters/datasetId'
      - $ref: '#/components/parameters/x-gw-ims-org-id'
      - $ref: '#/components/parameters/x-request-id'
      - $ref: '#/components/parameters/x-sandbox-name'
      responses:
        '200':
          description: Dataset validated successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/datasetValidationResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorResponse'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorResponse'
        '500':
          description: Internal Server Error. An unexpected error occurred.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorResponse'
  /modeler/datasets/extensions/enablement:
    post:
      operationId: enableOrchestratedCampaignExtensionOnDataset
      tags:
      - DatasetEnablement
      summary: Enable Orchestrated Campaign extension for datasets
      description: 'Currently, this API supports enabling Orchestrated Campaign extension for only one dataset at a time.

        - This is an asynchronous API that performs multiple tasks in the background.

        - To check the latest status, use the provided `jobId` and call Get Dataset Extension Enablement Job Status API.

        - Alternatively, to check the status of the extension on dataset, fetch the dataset details with `datasetId` using Datasets APIs to check the extension status.

        - The response will contain the `jobId` of the enablement request.'
      security:
      - imsUserToken: []
      parameters:
      - $ref: '#/components/parameters/x-api-key'
      - $ref: '#/components/parameters/x-gw-ims-org-id'
      - $ref: '#/components/parameters/x-sandbox-name'
      - $ref: '#/components/parameters/x-request-id'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/datasetJobRequest'
      responses:
        201:
          description: Dataset enablement requests created successfully.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/datasetJobResponse'
        400:
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorResponse'
        401:
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorResponse'
        403:
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorResponse'
        500:
          description: 'Internal Server Error: An unexpected error occurred.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorResponse'
  /modeler/datasets/extensions/enablement/jobs/{jobId}:
    get:
      operationId: getDatasetExtensionEnablementJobStatus
      tags:
      - DatasetEnablement
      summary: Get the status of a dataset extension enablement job
      security:
      - imsUserToken: []
      parameters:
      - $ref: '#/components/parameters/x-api-key'
      - $ref: '#/components/parameters/x-gw-ims-org-id'
      - $ref: '#/components/parameters/x-sandbox-name'
      - $ref: '#/components/parameters/x-request-id'
      - in: path
        name: jobId
        schema:
          type: string
        required: true
        description: Job Id of the dataset enablement request
      responses:
        '200':
          description: Dataset enablement job status retrieved successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/datasetJobResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorResponse'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorResponse'
        '500':
          description: 'Internal Server Error: An unexpected error occurred.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorResponse'
components:
  parameters:
    x-sandbox-name:
      name: x-sandbox-name
      in: header
      description: Filter on platform sandbox name.
      required: true
      schema:
        type: string
    x-request-id:
      name: x-request-id
      in: header
      description: A unique string to identify the request, MUST be unique for each request.
      required: false
      schema:
        type: string
    x-gw-ims-org-id:
      name: x-gw-ims-org-id
      in: header
      description: Your Identity Management Services (IMS) Organization ID.
      required: true
      schema:
        type: string
    x-api-key:
      name: x-api-key
      in: header
      description: Specific API key for your unique Journey Orchestration configuration {API_KEY}
      required: true
      schema:
        type: string
    datasetId:
      name: datasetId
      in: path
      description: Dataset Id on which Campaign Orchestration Extension needs to be validated or enabled
      required: true
      schema:
        type: string
  schemas:
    errorResponse:
      type: object
      properties:
        type:
          type: string
          description: the error type
          example: http://ns.adobe.com/aep/errors/CJMDMS-100169-400
        title:
          type: string
          description: the error title
          example: Extension already enabled on dataset
        path:
          type: string
          description: the error path
          example: /modeler/datasets/extensions/enablement
        dynamicErrorAttributes:
          type: object
          additionalProperties:
            type: string
          description: 'Key-value pairs containing context-specific attributes for the error.   The keys are dynamic and vary depending on the error scenario.   For example, it may include identifiers like `datasetId`, `sandboxId`, or other metadata.

            '
          example:
            dataset: 68af1be6244b7fbda18ed348
        status:
          description: the error status
          type: integer
          example: 400
        errorMessage:
          type: string
          example: The orchestrated campaign extension is already enabled on dataset 68af1be6244b7fbda18ed348.
        unixTimeStampMs:
          type: integer
          description: the unix timestamp in milliseconds
          example: 1719436800000
        code:
          type: string
          description: the error code
          example: CJMDMS-100193-400
    datasetValidationResponse:
      type: object
      properties:
        datasetId:
          type: string
          description: Dataset id that was validated or enabled
        datasetName:
          type: string
          description: Name of the dataset
        extensionSupported:
          type: boolean
          description: Whether the extension is supported for the dataset
          example: true
    datasetJobRequest:
      type: object
      required:
      - datasetIds
      properties:
        datasetIds:
          type: array
          description: IDs of the datasets to be enabled for Campaign Orchestration Extension
          items:
            type: string
          example:
          - dataset1
    datasetJobResponse:
      type: object
      properties:
        jobId:
          type: string
          format: uuid
          description: Job id for tracking the dataset extension enablement request
        datasetId:
          type: string
          description: Dataset id that was validated or enabled
        datasetName:
          type: string
          description: Name of the dataset
        jobStatus:
          type: string
          enum:
          - PENDING
          - IN_PROGRESS
          - COMPLETED
          - FAILED
          - TIMEOUT
          description: Status of the job
        jobState:
          type: string
          enum:
          - VALIDATED
          - ACKNOWLEDGED
          - DDL_APPLIED
          - DATA_COPIED
          description: Current state of the job
        submittedBy:
          type: string
          description: The IMS user ID of who submitted the dataset updation request.
          example: A5562A9C64003F290A495E88@fa9b251563ec3409495eab.e
        submittedAtEpochMilli:
          type: integer
          description: The initial updated time in UTC, formatted in ISO 8601.
          example: 1719436800000
        modifiedAtEpochMilli:
          type: integer
          description: The last update time in UTC, formatted in ISO 8601.
          example: 1719436800000
  securitySchemes:
    imsUserToken:
      type: http
      scheme: bearer
      bearerFormat: JWT