Adobe Suite Datasets API

Datasets are the building blocks for data transformation and tracking in Catalog Service.

Operations 10

GET /dataSets Retrieve a list of datasets #
POST /dataSets Create a new dataset #
GET /dataSets/{DATASET_ID} Look up a dataset #
PUT /dataSets/{DATASET_ID} Update a dataset #
DELETE /dataSets/{DATASET_ID} Delete a dataset #
PATCH /dataSets/{DATASET_ID} Update a dataset's attributes #
GET /dataSets/{id}/credentials Retrieve a dataset's credentials #
GET /datasets/{DATASET_ID}/labels Retrieve data usage labels for a specific dataset #
PUT /datasets/{DATASET_ID}/labels Update the data usage labels for a specific dataset #
POST /datasets/{DATASET_ID}/labels Add data usage labels to a specific dataset #

Documentation

📖
Documentation
https://developer.adobe.com/photoshop/api/docs/
📖
Authentication
https://developer.adobe.com/developer-console/docs/guides/authentication/
📖
Documentation
https://developer.adobe.com/lightroom/api/docs/
📖
Documentation
https://developer.adobe.com/illustrator/api/docs/
📖
Documentation
https://developer.adobe.com/indesign/docs/
📖
Documentation
https://developer.adobe.com/document-services/docs/overview/pdf-services-api/
📖
Documentation
https://developer.adobe.com/document-services/docs/overview/pdf-extract-api/
📖
GettingStarted
https://developer.adobe.com/document-services/docs/overview/pdf-extract-api/gettingstarted/
📖
Documentation
https://developer.adobe.com/document-services/docs/overview/pdf-accessibility-auto-tag-api/
📖
Documentation
https://developer.adobe.com/analytics-apis/docs/
📖
APIReference
https://developer.adobe.com/analytics-apis/docs/2.0/
📖
Documentation
https://developer.adobe.com/firefly-services/docs/
📖
APIReference
https://developer.adobe.com/firefly-services/docs/api/
📖
Documentation
https://developer.adobe.com/audio-video-firefly-services/
📖
GettingStarted
https://developer.adobe.com/audio-video-firefly-services/getting-started/
📖
Documentation
https://developer.adobe.com/creative-cloud-libraries/docs/
📖
APIReference
https://developer.adobe.com/creative-cloud-libraries/docs/api/
📖
Documentation
https://developer.adobe.com/express/embed-sdk/docs/guides/
📖
APIReference
https://developer.adobe.com/express/embed-sdk/docs/v4/
📖
GettingStarted
https://developer.adobe.com/express/embed-sdk/docs/guides/quickstart/
📖
Documentation
https://developer.adobe.com/experience-platform-apis/
📖
GettingStarted
https://experienceleague.adobe.com/en/docs/experience-platform/landing/platform-apis/api-guide
📖
Documentation
https://developer.adobe.com/marketo-apis/
📖
Authentication
https://experienceleague.adobe.com/en/docs/marketo-developer/marketo/rest/authentication
📖
Documentation
https://developer.adobe.com/commerce/docs/
📖
GettingStarted
https://developer.adobe.com/commerce/webapi/get-started/
📖
Documentation
https://developer.adobe.com/experience-cloud/cloud-manager/
📖
Documentation
https://developer.adobe.com/journey-optimizer-apis/
📖
Documentation
https://developer.adobe.com/workfront-apis/
📖
Documentation
https://developer.adobe.com/firefly-services/docs/substance3d/
📖
Documentation
https://developer.adobe.com/data-collection-apis/
📖
Documentation
https://developer.adobe.com/adobe-status/
📖
Documentation
https://developer.adobe.com/vip-marketplace/

Specifications

Other Resources

🔗
Pricing
https://developer.adobe.com/document-services/pricing/
🔗
SDKs
https://developer.adobe.com/document-services/docs/overview/pdf-services-api/sdks/
🔗
ReleaseNotes
https://developer.adobe.com/document-services/docs/overview/pdf-services-api/releasenotes
🔗
Guides
https://developer.adobe.com/analytics-apis/docs/2.0/guides/
🔗
Guides
https://developer.adobe.com/firefly-services/docs/guides/
🔗
Usage Notes
https://developer.adobe.com/audio-video-firefly-services/getting_started/usage/
🔗
Overview
https://developer.adobe.com/creative-cloud-libraries/docs/overview/
🔗
Integration Guide
https://developer.adobe.com/creative-cloud-libraries/docs/integrate/
🔗
API Fundamentals
https://experienceleague.adobe.com/en/docs/experience-platform/landing/platform-apis/api-fundamentals
🔗
Developer Guide
https://experienceleague.adobe.com/en/docs/marketo-developer/marketo/home
🔗
REST API
https://experienceleague.adobe.com/en/docs/marketo-developer/marketo/rest/rest-api
🔗
REST API
https://developer.adobe.com/commerce/webapi/rest/
🔗
GraphQL API
https://developer.adobe.com/commerce/webapi/graphql-api/
🔗
REST API Reference
https://developer.adobe.com/commerce/webapi/reference/rest/paas/
🔗
GraphQL
https://raw.githubusercontent.com/api-evangelist/adobe-suite/refs/heads/main/graphql/adobe-suite-graphql.md
🔗
Webhooks
https://developer.adobe.com/experience-cloud/cloud-manager/guides/getting-started/create-event-integration/
🔗
StatusPage
https://status.adobe.com/

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/adobe-suite-datasets-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no email required.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

adobe-suite-datasets-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Adobe Suite Datasets API
  version: '1.0'
  description: 'Operations tagged Datasets across 2 of this provider''s published API definitions: adobe-suite-aep-catalog-openapi.yaml, adobe-suite-aep-dataset-service-openapi.yaml. Each path carries the servers of the definition it was published in.'
servers:
- url: //{environment}.adobe.io/data/foundation/catalog
  variables:
    environment:
      default: platform
      enum:
      - platform
      - platform-stage
- url: //{environment}.adobe.io/data/foundation/dataset
  variables:
    environment:
      default: platform
      enum:
      - platform
      - platform-stage
tags:
- name: Datasets
  description: Datasets are the building blocks for data transformation and tracking in Catalog Service.
paths:
  /dataSets:
    get:
      tags:
      - Datasets
      summary: Retrieve a list of datasets
      description: This request lets you retrieve a list of datasets which are the building blocks for data transformation and tracking in Catalog Service.
      operationId: listDatasets
      parameters:
      - $ref: '#/components/parameters/authorization'
      - $ref: '#/components/parameters/x-api-key'
      - $ref: '#/components/parameters/x-gw-ims-org-id'
      - $ref: '#/components/parameters/x-sandbox-name'
      - $ref: '#/components/parameters/accept-encoding'
      - name: version
        in: query
        description: Filter by Semantic version of the account. Updated when the object is modified.
        schema:
          type: string
      - name: created
        in: query
        description: Filter by the Unix timestamp (in milliseconds) when this object was persisted.
        schema:
          type: integer
          format: int64
      - name: updated
        in: query
        description: Filter by the Unix timestamp (in milliseconds) for the time of last modification.
        schema:
          type: integer
          format: int64
      - name: createdClient
        in: query
        description: Filter by the ID of the IMS client that created this object.
        schema:
          type: string
      - name: createdUser
        in: query
        description: Filter by the ID of the user who created this object.
        schema:
          type: string
      - name: updatedUser
        in: query
        description: Filter by the ID of the user who changed this object.
        schema:
          type: string
      - name: name
        in: query
        description: Filter on the name of the dataset.
        schema:
          type: string
      - name: description
        in: query
        description: Filter on the description of the dataset.
        schema:
          type: string
      - name: enableErrorDiagnostics
        in: query
        description: A field that provides the ability to opt in to generating diagnostic files for the errors while ingesting data.
        schema:
          type: boolean
      - name: orderBy
        in: query
        description: Sort parameter and direction for sorting the response. Ex. orderBy=asc:created,updated. This was previously called sort.
        schema:
          type: string
      - $ref: '#/components/parameters/limit'
      - name: start
        in: query
        description: Specifies the offset of the pages of results. To get the first page of results, set the value to `start=0`.
        schema:
          type: integer
          default: 0
      - name: property
        in: query
        description: Regex used to filter objects in the response.
        schema:
          type: string
      - name: properties
        in: query
        description: A comma separated allowlist of top-level object properties to be returned in the response. Used to cut down the number of properties and amount of data returned in the response bodies.
        schema:
          type: string
      - name: tags
        in: query
        description: Filter response by the specified tags.
        schema:
          type: string
      responses:
        200:
          description: A list of datasets is returned.
          content:
            application/json:
              schema:
                type: object
                additionalProperties:
                  $ref: '#/components/schemas/dataSetResponse'
              example:
                5ab540d0864cf0267448ead4:
                  version: 1.0.0
                  imsOrg: 4F3BB22C5631222A7F000101@AdobeOrg
                  name: Acme accounts dataset - 1521827915638
                  created: 1521828048923
                  updated: 1521828208046
                  createdClient: platform_foundation_catalog
                  createdUser: platform_foundation_catalog@AdobeID
                  updatedUser: platform_foundation_catalog@AdobeID
                  tags:
                    foo:
                    - bar
                    - foos
                    - ball
                    adobe/touchpoint/appliedTransformations:
                    - CLUSTERED:FOO
                  viewId: 5ab54170864cf0267448ead5
                  basePath: s3://bar/ball/baz
                  files: '@/dataSetFiles?dataSetId=5ab540d0864cf0267448ead4'
                  observableSchema: {}
        400:
          description: A bad request.
          content: {}
        403:
          description: Access is forbidden.
          content: {}
        404:
          description: The datasets are not found.
          content: {}
        500:
          description: An internal server error has ocurred.
          content: {}
        default:
          description: An unexpected error has ocurred.
          content: {}
    post:
      tags:
      - Datasets
      summary: Create a new dataset
      description: This request creates a new dataset.
      operationId: createDataset
      parameters:
      - $ref: '#/components/parameters/authorization'
      - $ref: '#/components/parameters/x-api-key'
      - $ref: '#/components/parameters/x-gw-ims-org-id'
      - $ref: '#/components/parameters/x-sandbox-name'
      - $ref: '#/components/parameters/accept-encoding'
      - $ref: '#/components/parameters/content-type'
      requestBody:
        description: Information about the new dataset you are creating.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/dataSetRequest'
            examples:
              Enable for Profile:
                summary: Enable a dataset for Profile
                value:
                  name: Profile-enabled sample dataset
                  description: This is a sample dataset that is enabled for Profile.
                  schemaRef:
                    id: https://ns.adobe.com/{TENANT_ID}/schemas/31670881463308a46f7d2cb09762715
                    contentType: application/vnd.adobe.xed-full-notext+json; version=1
                  tags:
                    unifiedIdentity:
                    - 'enabled: true'
                    unifiedProfile:
                    - 'enabled: true'
                    - 'isUpsert: true'
        required: true
      responses:
        201:
          description: The dataset has been successfully created.
          headers:
            Location:
              description: The URI of the newly created resource.
              schema:
                type: string
          content:
            application/json:
              schema:
                type: array
                items:
                  type: string
        400:
          description: A bad request.
          content: {}
        403:
          description: Access is forbidden.
          content: {}
        500:
          description: An internal server error has ocurred.
          content: {}
        default:
          description: An unexpected error has ocurred.
          content: {}
      x-codegen-request-body-name: dataSet
    servers:
    - url: //{environment}.adobe.io/data/foundation/catalog
      variables:
        environment:
          default: platform
          enum:
          - platform
          - platform-stage
  /dataSets/{DATASET_ID}:
    get:
      tags:
      - Datasets
      summary: Look up a dataset
      description: This request allows you to retrieve a dataset using the {DATASET_ID}.
      operationId: retrieveDataset
      parameters:
      - $ref: '#/components/parameters/dataset_id'
      - $ref: '#/components/parameters/authorization'
      - $ref: '#/components/parameters/x-api-key'
      - $ref: '#/components/parameters/x-gw-ims-org-id'
      - $ref: '#/components/parameters/x-sandbox-name'
      - $ref: '#/components/parameters/accept-encoding'
      - name: properties
        in: query
        description: A comma separated allowlist of top-level object properties to be returned in the response. Used to cut down the number of properties and amount of data returned in the response bodies.
        schema:
          type: string
      responses:
        200:
          description: The dataset for the specified dataset ID is returned.
          content:
            application/json:
              schema:
                type: object
                additionalProperties:
                  $ref: '#/components/schemas/dataSetResponse'
              example:
                5ab540d0864cf0267448ead4:
                  version: 1.0.0
                  imsOrg: 4F3BB22C5631222A7F000101@AdobeOrg
                  name: Acme accounts dataset - 1521827915638
                  enableErrorDiagnostics: true
                  created: 1521828048923
                  updated: 1521828208046
                  createdClient: platform_foundation_catalog
                  createdUser: 4F3BB22C5631222A7F000101@AdobeOrg
                  updatedUser: platform_foundation_catalog@AdobeID
                  tags:
                    foo:
                    - bar
                    - foos
                    - ball
                    adobe/touchpoint/appliedTransformations:
                    - CLUSTERED:FOO
                  viewId: 5ab54170864cf0267448ead5
                  basePath: s3://bar/ball/baz
                  files: '@/dataSetFiles?dataSetId=5ab540d0864cf0267448ead4'
                  observableSchema: {}
        400:
          description: A bad request.
          content: {}
        403:
          description: Access is forbidden.
          content: {}
        404:
          description: The dataset was not found.
          content: {}
        500:
          description: An internal server error has ocurred.
          content: {}
        default:
          description: An unexpected error has ocurred.
          content: {}
    put:
      tags:
      - Datasets
      summary: Update a dataset
      description: This request allows you to update a specific dataset. The dataset that requires updating can be retrieved using the {DATASET_ID}.
      operationId: putDataset
      parameters:
      - $ref: '#/components/parameters/dataset_id'
      - $ref: '#/components/parameters/authorization'
      - $ref: '#/components/parameters/x-api-key'
      - $ref: '#/components/parameters/x-gw-ims-org-id'
      - $ref: '#/components/parameters/x-sandbox-name'
      - $ref: '#/components/parameters/accept-encoding'
      - $ref: '#/components/parameters/if-none-match'
      - $ref: '#/components/parameters/content-type'
      requestBody:
        description: Data set field(s) to be updated.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/dataSetRequest'
        required: true
      responses:
        200:
          description: Array[ @/dataSets/dataSetId ]
          content:
            application/json:
              schema:
                type: array
                items:
                  type: string
        400:
          description: A bad request.
          content: {}
        403:
          description: Access is forbidden.
          content: {}
        500:
          description: An internal server error has ocurred.
          content: {}
        default:
          description: An unexpected error has ocurred.
          content: {}
      x-codegen-request-body-name: dataSet
    delete:
      tags:
      - Datasets
      summary: Delete a dataset
      description: This request deletes a dataset using the {DATASET_ID}.
      operationId: deleteDataset
      parameters:
      - $ref: '#/components/parameters/dataset_id'
      - $ref: '#/components/parameters/authorization'
      - $ref: '#/components/parameters/x-api-key'
      - $ref: '#/components/parameters/x-gw-ims-org-id'
      - $ref: '#/components/parameters/x-sandbox-name'
      - $ref: '#/components/parameters/accept-encoding'
      responses:
        200:
          description: Array[ @/dataSets/dataSetId ]
          content:
            application/json:
              schema:
                type: array
                items:
                  type: string
        400:
          description: A bad request.
          content: {}
        403:
          description: Access is forbidden.
          content: {}
        500:
          description: An internal server error has ocurred.
          content: {}
        default:
          description: An unexpected error has ocurred.
          content: {}
    patch:
      tags:
      - Datasets
      summary: Update a dataset's attributes
      description: This request allows you to update specified attributes of an existing DataSetView.
      operationId: patchDataset
      parameters:
      - $ref: '#/components/parameters/dataset_id'
      - $ref: '#/components/parameters/authorization'
      - $ref: '#/components/parameters/x-api-key'
      - $ref: '#/components/parameters/x-gw-ims-org-id'
      - $ref: '#/components/parameters/x-sandbox-name'
      - $ref: '#/components/parameters/accept-encoding'
      - $ref: '#/components/parameters/if-none-match'
      - $ref: '#/components/parameters/content-type'
      requestBody:
        description: Dataset field(s) to be updated.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/dataSetRequest'
          application/json-patch+json:
            schema:
              $ref: '#/components/schemas/dataSetRequest'
            examples:
              Update a dataset to be Profile-enabled:
                summary: Update a dataset to be Profile-enabled
                value:
                - op: add
                  path: /tags/unifiedProfile
                  value:
                  - enabled:true
                  - isUpsert:true
                - op: add
                  path: /tags/unifiedIdentity
                  value:
                  - enabled:true
        required: true
      responses:
        200:
          description: Array[ @/dataSets/dataSetId ]
          content:
            application/json:
              schema:
                type: array
                items:
                  type: string
        400:
          description: A bad request.
          content: {}
        403:
          description: Access is forbidden.
          content: {}
        404:
          description: Not found
          content: {}
        500:
          description: An internal server error has ocurred.
          content: {}
        default:
          description: An unexpected error has ocurred.
          content: {}
      x-codegen-request-body-name: dataSet
    servers:
    - url: //{environment}.adobe.io/data/foundation/catalog
      variables:
        environment:
          default: platform
          enum:
          - platform
          - platform-stage
  /dataSets/{id}/credentials:
    get:
      tags:
      - Datasets
      summary: Retrieve a dataset's credentials
      description: This request fetches credentials for the requested dataset ID.
      operationId: retrieveDatasetCredentials
      parameters:
      - name: id
        in: path
        description: Object ID
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/authorization'
      - $ref: '#/components/parameters/x-api-key'
      - $ref: '#/components/parameters/x-gw-ims-org-id'
      - $ref: '#/components/parameters/x-sandbox-name'
      - $ref: '#/components/parameters/x-user-token'
      - $ref: '#/components/parameters/accept-encoding'
      - name: batchId
        in: query
        description: If wishing to write, the batchId used during writing. Required for building a stage path.
        schema:
          type: string
      responses:
        200:
          description: Credential object given dataSet.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/dataSetCredentials'
        400:
          description: A bad request.
          content: {}
        403:
          description: Access is forbidden.
          content: {}
        500:
          description: An internal server error has ocurred.
          content: {}
        default:
          description: An unexpected error has ocurred.
          content: {}
      deprecated: true
    servers:
    - url: //{environment}.adobe.io/data/foundation/catalog
      variables:
        environment:
          default: platform
          enum:
          - platform
          - platform-stage
  /datasets/{DATASET_ID}/labels:
    get:
      tags:
      - Datasets
      summary: Retrieve data usage labels for a specific dataset
      description: 'You can use this endpoint to retrieve data usage labels for a specified dataset.

        >**NOTE**: See the tutorial on [managing labels for datasets using APIs](https://experienceleague.adobe.com/docs/experience-platform/data-governance/labels/dataset-api.html) for more information on using this endpoint.'
      operationId: retrieveDatasetLabels
      parameters:
      - name: DATASET_ID
        in: path
        description: The ID of an existing dataset. Dataset IDs can be retrieved using the [Catalog Service API](https://www.adobe.io/apis/experienceplatform/home/api-reference.html#!acpdr/swagger-specs/catalog.yaml).
        required: true
        schema:
          type: string
      - name: Authorization
        in: header
        description: The access token which can be copied from your Experience Platform integration, prefixed with "Bearer". For more information on how to obtain this value, visit the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).
        required: true
        schema:
          type: string
      - name: x-api-key
        in: header
        description: The API key which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).
        required: true
        schema:
          type: string
      - name: x-gw-ims-org-id
        in: header
        description: The Organization ID which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).
        required: true
        schema:
          type: string
      - name: x-sandbox-name
        in: header
        description: The name of the sandbox in which the operation will take place. See the [sandboxes overview documentation](https://adobe.com/go/sandbox-overview-en) for more information.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: The data usage labels for the specified dataset were retrieved.
          x-summary: Data usage labels retrieved
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LabelPayload'
        '404':
          description: The labels entity was not found. If the dataset indicated in the request path does not have any existing labels applied, this error will occur.
          x-summary: Labels entity not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundError'
    put:
      tags:
      - Datasets
      summary: Update the data usage labels for a specific dataset
      description: "You can use this endpoint to update the data usage labels for a specified dataset or fields.\n\n >**NOTE**: You can entirely remove a dataset's labels by providing an empty list for the `labels` parameter. It is not mandatory for a dataset to retain any labels. See the tutorial on [managing labels for datasets using APIs](https://experienceleague.adobe.com/docs/experience-platform/data-governance/labels/dataset-api.html) for more information on using this endpoint."
      operationId: updateDatasetLabels
      parameters:
      - name: DATASET_ID
        in: path
        description: The ID of an existing dataset. Dataset IDs can be retrieved using the [Catalog Service API](https://www.adobe.io/apis/experienceplatform/home/api-reference.html#!acpdr/swagger-specs/catalog.yaml).
        required: true
        schema:
          type: string
      - name: Authorization
        in: header
        description: The access token which can be copied from your Experience Platform integration, prefixed with "Bearer". For more information on how to obtain this value, visit the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).
        required: true
        schema:
          type: string
      - name: x-api-key
        in: header
        description: The API key which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).
        required: true
        schema:
          type: string
      - name: x-gw-ims-org-id
        in: header
        description: The Organization ID which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).
        required: true
        schema:
          type: string
      - name: x-sandbox-name
        in: header
        description: The name of the sandbox in which the operation will take place. See the [sandboxes overview documentation](https://adobe.com/go/sandbox-overview-en) for more information.
        required: true
        schema:
          type: string
      - name: Content-Type
        in: header
        description: The media type being sent in the request payload. The required value for calls to the Dataset Service API is `application/json`.
        required: true
        schema:
          type: string
      - name: If-Match
        in: header
        description: The version of the dataset entity to compare against. As a requirement for all PUT and DELETE requests for dataset labels, the call will only update the dataset entity if the "If-Match" string matches that of the "etag" header that is returned in all responses from the Dataset Service API.
        required: true
        schema:
          type: string
      requestBody:
        content:
          '*/*':
            schema:
              $ref: '#/components/schemas/LabelPayload'
        required: false
      responses:
        '200':
          description: The data usage labels were successfully updated.
          x-summary: Data usage labels updated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LabelPayload'
        '404':
          description: The labels entity was not found.
          x-summary: Labels entity not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundError'
        '409':
          description: A data usage policy violation has occurred.
          x-summary: Data usage policy violation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictError'
      x-codegen-request-body-name: body
    post:
      tags:
      - Datasets
      summary: Add data usage labels to a specific dataset
      description: 'This endpoint has been deprecated. You can use this endpoint to add data usage labels to a specified dataset or fields.

        >**NOTE**: See the tutorial on [managing labels for datasets using APIs](https://experienceleague.adobe.com/docs/experience-platform/data-governance/labels/dataset-api.html) for more information on using this endpoint.'
      operationId: addDatasetLabels
      parameters:
      - name: DATASET_ID
        in: path
        description: The ID of an existing dataset. Dataset IDs can be retrieved using the [Catalog Service API](https://www.adobe.io/apis/experienceplatform/home/api-reference.html#!acpdr/swagger-specs/catalog.yaml).
        required: true
        schema:
          type: string
      - name: Authorization
        in: header
        description: The access token which can be copied from your Experience Platform integration, prefixed with "Bearer". For more information on how to obtain this value, visit the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).
        required: true
        schema:
          type: string
      - name: x-api-key
        in: header
        description: The API key which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).
        required: true
        schema:
          type: string
      - name: x-gw-ims-org-id
        in: header
        description: The Organization ID which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).
        required: true
        schema:
          type: string
      - name: x-sandbox-name
        in: header
        description: The name of the sandbox in which the operation will take place. See the [sandboxes overview documentation](https://adobe.com/go/sandbox-overview-en) for more information.
        required: true
        schema:
          type: string
      - name: Content-Type
        in: header
        description: The media type being sent in the request payload. The required value for calls to the Dataset Service API is `application/json`.
        required: true
        schema:
          type: string
      requestBody:
        content:
          '*/*':
            schema:
              $ref: '#/components/schemas/LabelPayload'
        required: false
      responses:
        '201':
          description: The data usage labels were successfully added.
          x-summary: Data usage labels added
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LabelPayload'
        '403':
          description: The labels entity already exists. Use a PUT request instead.
          x-summary: Labels entity already exists
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenError'
        '409':
          description: A data usage policy violation has occurred.
          x-summary: Data usage policy violation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictError'
      x-codegen-request-body-name: body
      deprecated: true
    servers:
    - url: //{environment}.adobe.io/data/foundation/dataset
      variables:
        environment:
          default: platform
          enum:
          - platform
          - platform-stage
components:
  schemas:
    dataSetResponse:
      type: object
      properties:
        version:
          type: string
          description: The Semantic version of the dataset. Updated when the dataset is modified.
          readOnly: true
          example: 1.0.3
        imsOrg:
          type: string
          description: The owning organization identifier.
          example: 4F3BB22C5631222A7F000101@AdobeOrg
        name:
          type: string
          description: A descriptive, human-readable name for this dataset.
          example: Acme accounts dataset - 1521827915638
        description:
          type: string
          description: A longer text description of the dataset.
          example: A dataset for accounts held by Acme.
        created:
          type: integer
          description: The Unix timestamp (in milliseconds) when this dataset was persisted.
          format: int64
          readOnly: true
          example: 1658499154836
        updated:
          type: integer
          description: The Unix timestamp (in milliseconds) for the time of last modification.
          format: int64
          readOnly: true
          example: 1658499238628
        createdClient:
          type: string
          description: The ID of the IMS client that created this Batch.
          readOnly: true
          example: platform_foundation_catalog
        createdUser:
          type: string
          description: The ID of the user who created this object.
          readOnly: true
          example: platform_foundation_catalog@AdobeID
        updatedUser:
          type: string
          description: The ID of the user who changed this object.
          readOnly: true
          example: platform_foundation_catalog@AdobeID
        viewId:
          type: string
          description: The ID for associated dataset view.
          example: 5ab54170864cf0267448ead5
        observableSchema:
          type: object
          properties: {}
          description: observableSchema stores a JSON Schema object that is a valid subset (including the null case) of the XDM model specified by `schemaRef`.
        basePath:
          type: string
          description: Fully qualified base path for all dataset files associated with this view. For views cached in a database (HBase or Cassandra), supply a templatized DSN.
          readOnly: true
          example: s3://bar/ball/baz
        fileDescription:
          type: object
          properties:
            format:
              $ref: '#/components/schemas/format'
            delimiters:
              type: array
              description: Characters used to separate fields.
              items:
                maxLength: 1
                type: string
            quotes:
              type: array
              description: ''
              items:
                type: string
            escapes:
              type: array
              description: ''
              items:
                type: string
            nullMarkers:
              type: array
              description: ''
              items:
                type: string
            header:
              type: boolean
              description: ''
            charset:
              type: string
              description: The character encoding of the files.
              enum:
              - US-ASCII
              - UTF-8
              - ISO-8859-1
              - ''
          description: Metadata describing the dataset files associated with this DatasetView.
        schema:
          type: string
          description: This is the uri for the XDM model
          example: null
        schemaRef:
          $ref: '#/components/schemas/schemaRef'
        files:
          type: string
          description: Associated files for given dataset in following string format dataSets/{dataSetId}/views/{dataSetViewId}/files. By using query parameter 'expansion=files', this object can be requested as part of response.
          example: dataSets/605dbe4e89b61819495e4dff/views/5cc6a9b60d4a5914b7940a7f/
        tags:
          type: object
          additionalProperties:
            type: array
            items:
              type: string
            example: platform_dataset
          description: Tags are values associated with a particular object, these are generally used by external systems for marking an object in a way that it understands. Normally tags are not used for internal Catalog business logic
          example: adobe/platform/table
        lastBatchId:
          type: string
          description: The ID of the last batch that modified the data set (only modified by Siphon batch ingest).
          example: 62a31e96ba86e52a2f729a8d
        lastBatchStatus:
          $ref: '#/components/schemas/batchStatus'
        las

# --- truncated at 32 KB (50 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/adobe-suite/refs/heads/main/openapi/adobe-suite-datasets-api-openapi.yml