Adobe Experience Cloud Datasets API

openapi: 3.2.0
info:
  title: Adobe Experience Cloud Adobe Experience Platform Datasets API
  description: The Adobe Experience Platform API provides RESTful access to the core services of Adobe Experience Platform, including data ingestion, unified profile management, identity resolution, dataset management, schema registry, query service, and segmentation. It enables developers to build and manage real-time customer profiles, ingest batch and streaming data, define XDM schemas, and orchestrate data workflows programmatically.
  version: 1.0.0
  contact:
    name: Adobe Developer
    url: https://developer.adobe.com/experience-platform-apis/
  license:
    name: Proprietary
    url: https://www.adobe.com/legal/terms.html
servers:
- url: https://platform.adobe.io
  description: Adobe Experience Platform Production API
security:
- bearerAuth: []
- apiKey: []
tags:
- name: Datasets
  description: Operations for managing datasets in the Data Lake
paths:
  /data/foundation/catalog/dataSets:
    get:
      operationId: listDatasets
      summary: Adobe Experience Platform Adobe Experience Cloud List Datasets
      description: Returns a list of datasets registered in the Data Catalog for the current sandbox. Each dataset includes its name, schema reference, creation date, and status.
      tags:
      - Datasets
      parameters:
      - $ref: '#/components/parameters/sandboxHeader'
      - name: limit
        in: query
        schema:
          type: integer
          default: 20
      - name: start
        in: query
        schema:
          type: string
      responses:
        '200':
          description: A list of datasets.
          content:
            application/json:
              schema:
                type: object
                additionalProperties:
                  $ref: '#/components/schemas/Dataset'
              examples:
                listDatasets200Example:
                  summary: Default listDatasets 200 response
                  x-microcks-default: true
                  value: {}
        '401':
          description: Authentication credentials are missing or invalid.
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    post:
      operationId: createDataset
      summary: Adobe Experience Platform Adobe Experience Cloud Create a Dataset
      description: Creates a new dataset in the Data Catalog. The request body must include a name and a reference to an existing XDM schema. Optionally configure tags, file format, and ingestion settings.
      tags:
      - Datasets
      parameters:
      - $ref: '#/components/parameters/sandboxHeader'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DatasetInput'
            examples:
              createDatasetRequestExample:
                summary: Default createDataset request
                x-microcks-default: true
                value:
                  name: Example Name
                  description: example
                  schemaRef:
                    id: abc123
                    contentType: standard
      responses:
        '201':
          description: Dataset created successfully.
          headers:
            Location:
              description: URI of the newly created dataset.
              schema:
                type: string
        '400':
          description: Invalid dataset definition.
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /data/foundation/catalog/dataSets/{datasetId}:
    get:
      operationId: getDataset
      summary: Adobe Experience Platform Adobe Experience Cloud Get a Dataset
      description: Retrieves the metadata and configuration for a single dataset by its dataset ID.
      tags:
      - Datasets
      parameters:
      - $ref: '#/components/parameters/sandboxHeader'
      - name: datasetId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Dataset details returned successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Dataset'
              examples:
                getDataset200Example:
                  summary: Default getDataset 200 response
                  x-microcks-default: true
                  value:
                    name: Example Name
                    schemaRef:
                      id: abc123
                      contentType: standard
                    fileDescription:
                      format: example
                    created: '2025-03-15T14:30:00Z'
                    updated: '2025-03-15T14:30:00Z'
                    status: active
        '404':
          description: Dataset not found.
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    delete:
      operationId: deleteDataset
      summary: Adobe Experience Platform Adobe Experience Cloud Delete a Dataset
      description: Deletes a dataset and all associated batches from the Data Catalog. This action cannot be undone.
      tags:
      - Datasets
      parameters:
      - $ref: '#/components/parameters/sandboxHeader'
      - name: datasetId
        in: path
        required: true
        schema:
          type: string
      responses:
        '204':
          description: Dataset deleted successfully.
        '404':
          description: Dataset not found.
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  schemas:
    DatasetInput:
      type: object
      required:
      - name
      - schemaRef
      properties:
        name:
          type: string
        description:
          type: string
        schemaRef:
          type: object
          required:
          - id
          - contentType
          properties:
            id:
              type: string
            contentType:
              type: string
    Dataset:
      type: object
      properties:
        name:
          type: string
        schemaRef:
          type: object
          properties:
            id:
              type: string
            contentType:
              type: string
        fileDescription:
          type: object
          properties:
            format:
              type: string
        created:
          type: string
          format: date-time
        updated:
          type: string
          format: date-time
        status:
          type: string
  parameters:
    sandboxHeader:
      name: x-sandbox-name
      in: header
      required: true
      description: The name of the sandbox to operate in.
      schema:
        type: string
        default: prod
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
    apiKey:
      type: apiKey
      in: header
      name: x-api-key