Adobe Experience Platform API

swagger: '2.0'
info:
  version: '1.0'
  title: Schema Registry API
  description: >- 
    Use the Schema Registry API to access the Schema Library within Adobe Experience Platform. The registry provides a user interface and RESTful API from which all available library resources are accessible. 
    Programmatically manage all schemas and related Experience Data Model (XDM) resources available to you within Platform. This includes those defined by Adobe, Experience Platform partners, and vendors whose applications you use.
  
    * **Related documentation**:
      * [XDM documentation](http://www.adobe.com/go/xdm-home-en)
    
    * **Visualize API calls with Postman (a free, third-party software)**:
      * [Schema Registry API Postman collection on GitHub](https://github.com/adobe/experience-platform-postman-samples/blob/master/apis/experience-platform/Schema%20Registry%20API.postman_collection.json)
      * [Video guide for creating the Postman environment](https://video.tv.adobe.com/v/28832)
      * [Steps for importing environments and collections in Postman](https://learning.getpostman.com/docs/postman/collection_runs/using_environments_in_collection_runs/)
  
    * **API paths**:
      * PLATFORM Gateway URL: https://<span>platform.adobe.io
      * Base path for this API: /data/foundation/schemaregistry
      * Example of a complete path for making a call to "/stats": https://<span>platform.adobe.io/data/foundation/schemaregistry/stats
    
    * **Required headers**:
      * All calls require the headers `Authorization`, `x-gw-ims-org-id`, and `x-api-key`. For more information on how to obtain these values, see the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).
      * All resources in Experience Platform are isolated to specific virtual sandboxes. All requests to Platform APIs require the header `x-sandbox-name` whose value is the all-lowercase name of the sandbox the operation will take place in (for example, "prod"). See the [sandboxes overview](https://adobe.com/go/sandbox-overview-en) for more information.
      * All GET requests to the Schema Registry require an `Accept` header to determine what data is returned by the system. See the [section on `Accept` headers](https://experienceleague.adobe.com/docs/experience-platform/xdm/api/getting-started.html?lang=en#accept) in the Schema Registry developer guide for more information.
      * All requests with a payload in the request body (such as POST, PUT, and PATCH calls) must include the header `Content-Type` with a value of `application/json`.

    - **API error handling**:
      * Refer to the Experience Platform API troubleshooting guide for [FAQs](https://experienceleague.adobe.com/docs/experience-platform/landing/troubleshooting.html#faq), [API status codes](https://experienceleague.adobe.com/docs/experience-platform/landing/troubleshooting.html#api-status-codes), and [request header errors](https://experienceleague.adobe.com/docs/experience-platform/landing/troubleshooting.html#request-header-errors).

basePath: /data/foundation/schemaregistry
host: platform.adobe.io
tags:
  - name: "Stats"
    description: Returns {TENANT_ID} along with information regarding IMS Org usage of the Schema Registry such as resource counts, recently created resources, and class usage.
  - name: "Schemas"
    description: Schemas provide an abstract definition of a real-world object along with constraints and expectations that can be applied and used to validate data.
  - name: "Behaviors"
    description: Behaviors define the nature of data that a schema describes. Each XDM class must reference a specific behavior, which all schemas that employ that class will inherit. Schemas that inherit the "record" behavior provide information about the attributes of a subject, while those that inherit the "time-series" behavior provide a snapshot of the system at the time an action was taken by a record subject.
  - name: "Classes"
    description: Classes define behavioral aspects of the data within the schema and describe the smallest number of common properties contained in all schemas that implement the same class.
  - name: "Field groups"
    description: A field group is a reusable component that defines one or more fields to implement certain functions within a schema based on a compatible class.
  - name: "Data types"
    description: Data types are used as reference field types in classes or schemas to define complex types. Data types may define multiple sub-fields providing a consistent multi-field structure.
  - name: "Descriptors"
    description: Schema descriptors are tenant-level metadata used to provide interpretive details on how data based on certain schemas may relate or interact with one another.
  - name: "Unions"
    description: Union schemas aggregate the fields of all schemas that implement the same class (such as ExperienceEvent or Profile) into a single schema. They are used by Real-time Customer Profile to merge data together to form a "single source of truth" for an individual.
  - name: "Export/Import"
    description: The Schema Registry API allows you to transfer and share XDM resources between sandboxes and IMS Organizations. For any schema, field group, or data type, you can generate an export payload containing the structure of the resource and any dependent resources. This payload can then be used to import the resource into a destination sandbox and IMS Org.
  - name: "Sample data"
    description: You can generate sample data for any specified schema within the Schema Library. The response object returned can then be used as the source of dataset ingestion.
  - name: "Audit log"
    description: The Schema Registry maintains a log of all the changes that have occurred to a resource (class, field group, data type, or schema) between different updates.
  - name: "Mixins (deprecated)"
    description: '"Mixin" is the former term for a field group. The /mixins endpoints are deprecated and only maintained as legacy endpoints. For new implementations, please use the /fieldgroups endpoint instead.'
consumes:
  - application/json
produces:
  - application/json
paths:
  '/stats':
    parameters:
      - $ref: '#/parameters/authorization'
      - $ref: '#/parameters/x-api-key'
      - $ref: '#/parameters/x-gw-ims-org-id'
      - $ref: '#/parameters/x-sandbox-name'
    get:
      tags:
      - "Stats"
      summary: Retrieve your tenant ID and other usage information related to the Schema Registry.
      operationId: retrieveStats
      produces:
        - application/json
      responses:
        200:
          x-summary: "Success"
          description: A successful response returns your tenant ID and Schema Registry usage information.
          schema: 
            '$ref': '#/definitions/statsResponse'
        '400':
          x-summary: "Bad formatting"
          description: The request payload was incorrectly formatted. Check your payload formatting before trying again.
        
  '/{CONTAINER_ID}/fieldgroups':
    get:
      tags:
      - "Field groups"
      summary: List field groups
      description: >-
        Retrieve a list of field groups within the specified container.

        >**NOTE**: For more information on using this operation, see the [field groups endpoint guide](https://experienceleague.adobe.com/docs/experience-platform/xdm/api/field-groups.html) on Experience League.
      operationId: listFieldGroups
      produces:
        - application/json
      parameters:
        - $ref: '#/parameters/containerIdList'
        - $ref: '#/parameters/authorization'
        - $ref: '#/parameters/x-api-key'
        - $ref: '#/parameters/x-gw-ims-org-id'
        - $ref: '#/parameters/x-sandbox-name'
        - $ref: '#/parameters/acceptListing'
        - $ref: '#/parameters/property'
        - $ref: '#/parameters/orderBy'
        - $ref: '#/parameters/start'
        - $ref: '#/parameters/limit'
      responses:
        200:
          x-summary: "Success"
          description: A successful response returns all field groups in the specified container.
          schema:
            $ref: '#/definitions/listFieldGroupsResponse'
        '400':
          x-summary: "Bad formatting"
          description: The `Accept` header is invalid or missing. Ensure that you are providing a valid `Accept` header for a listing call with no version supplied (e.g. `application/vnd.adobe.xed-id+json`) before trying again.
          schema:
           $ref: '#/definitions/acceptErrorList' 
        
  '/{CONTAINER_ID}/fieldgroups/{FIELD_GROUP_ID}':
    get:
      tags:
      - "Field groups"
      parameters:
      - $ref: '#/parameters/containerIdLookup'
      - name: FIELD_GROUP_ID
        description: The `meta:altId` or URL-encoded `$id` of the field group you want to look up.
        required: true
        in: path
        type: string
      - $ref: '#/parameters/authorization'
      - $ref: '#/parameters/x-api-key'
      - $ref: '#/parameters/x-gw-ims-org-id'
      - $ref: '#/parameters/x-sandbox-name'
      - $ref: '#/parameters/accept'
      summary: Retrieve a field group
      description: >-
        >**NOTE**: For more information on using this operation, see the [field groups endpoint guide](https://experienceleague.adobe.com/docs/experience-platform/xdm/api/field-groups.html) on Experience League.
      operationId: retrieveFieldGroup
      produces:
        - application/json
      responses:
        200:
          x-summary: "Success"
          description: A successful response returns the details of the field group.
          schema:
            $ref: '#/definitions/lookupFieldGroupResponse'
        '400':
          x-summary: "Bad formatting"
          description: The `Accept` header is invalid or missing. Ensure that you are providing a valid accept header for a lookup call including a version number (e.g. `application/vnd.adobe.xed+json;version=1`) before trying again.
          schema:
            $ref: '#/definitions/acceptErrorLookup'
        
  '/tenant/fieldgroups':
    post:
      tags:
      - "Field groups"
      summary: Create a custom field group
      description: >-
        >**NOTE**: For more information on using this operation, see the [field groups endpoint guide](https://experienceleague.adobe.com/docs/experience-platform/xdm/api/field-groups.html) on Experience League.
      operationId: createFieldGroup
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - $ref: '#/parameters/authorization'
        - $ref: '#/parameters/x-api-key'
        - $ref: '#/parameters/x-gw-ims-org-id'
        - $ref: '#/parameters/x-sandbox-name'
        - $ref: '#/parameters/content-type'        
        - $ref: '#/parameters/fieldGroupPayload'
      responses:
        201:
          x-summary: "Success"
          description: A successful response returns the details of the field group.
          schema:
            $ref: '#/definitions/createFieldGroupResponse'
        '400':
          x-summary: "Bad formatting"
          description: The request payload was incorrectly formatted. Check your payload formatting before trying again.
        
  '/tenant/fieldgroups/{FIELD_GROUP_ID}':
    put:
      tags:
      - "Field groups"
      summary: Update a custom field group
      description: >-
        A PUT request essentially re-writes the field group, therefore the request body must include all fields required to create (POST) a field group. This is especially useful when updating a lot of information in the field group at once.



        >**NOTE**: For more information on using this operation, see the [field groups endpoint guide](https://experienceleague.adobe.com/docs/experience-platform/xdm/api/field-groups.html) on Experience League.
      operationId: updateFieldGroup
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - name: FIELD_GROUP_ID
          description: The `meta:altId` or URL-encoded `$id` of the field group you want to update.
          required: true
          in: path
          type: string
        - $ref: '#/parameters/authorization'
        - $ref: '#/parameters/x-api-key'
        - $ref: '#/parameters/x-gw-ims-org-id'
        - $ref: '#/parameters/x-sandbox-name'
        - $ref: '#/parameters/content-type'
        - $ref: '#/parameters/replaceFieldGroupPayload'
      responses:
        200:
          x-summary: "Success"
          description: A successful response returns the details of the updated field group.
          schema:
            $ref: '#/definitions/updateFieldGroupResponse'
        '400':
          x-summary: "Bad formatting"
          description: The request payload was incorrectly formatted. Check your payload formatting before trying again.
        
    patch:
      tags:
      - "Field groups"
      summary: Update a custom field group
      description: >-
        You can use this endpoint to update one or more attributes of your custom field group.

        The Schema Registry supports all standard JSON Patch operations, including `add`, `remove`, and `replace`, to allow you to modify or update resources you have defined.
        
        
        >**NOTE**: For more information on JSON Patch, including all available operations, please refer to the [the official JSON Patch specification](https://datatracker.ietf.org/doc/html/rfc6902).
        >
        >For more information on using this operation, see the [field groups endpoint guide](https://experienceleague.adobe.com/docs/experience-platform/xdm/api/field-groups.html) on Experience League.
      operationId: patchFieldGroup
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - name: FIELD_GROUP_ID
          description: The `meta:altId` or URL-encoded `$id` of the field group you want to update.
          required: true
          in: path
          type: string
        - $ref: '#/parameters/authorization'
        - $ref: '#/parameters/x-api-key'
        - $ref: '#/parameters/x-gw-ims-org-id'
        - $ref: '#/parameters/x-sandbox-name'
        - $ref: '#/parameters/content-type'
        - $ref: '#/parameters/patchFieldGroupPayload'
      responses:
        200:
          x-summary: "Success"
          description: A successful response returns the details of the updated field group.
          schema:
            $ref: '#/definitions/patchFieldGroupResponse'
        '400':
          x-summary: "Bad formatting"
          description: The request payload was incorrectly formatted. Check your payload formatting before trying again.
        
    delete:
      tags:
      - "Field groups"
      summary: Delete a custom field group
      description: >-
        You can remove an existing field group through a DELETE request. A successful deletion returns an empty response body and HTTP status 204 (No Content).


        >**NOTE**: For more information on using this operation, see the [field groups endpoint guide](https://experienceleague.adobe.com/docs/experience-platform/xdm/api/field-groups.html) on Experience League.
      operationId: removeFieldGroup
      parameters:
        - name: FIELD_GROUP_ID
          description: The `meta:altId` or URL-encoded `$id` of the field group you want to delete.
          required: true
          in: path
          type: string
        - $ref: '#/parameters/authorization'
        - $ref: '#/parameters/x-api-key'
        - $ref: '#/parameters/x-gw-ims-org-id'
        - $ref: '#/parameters/x-sandbox-name'
      responses:
        204:
          x-summary: "No content"
          description: A successful response returns an empty response body and HTTP status 204 (No Content), indicating that the field group has been deleted.
  '/{CONTAINER_ID}/schemas':
    get:
      tags:
      - "Schemas"
      summary: List schemas
      description: >-
        You can list schemas within the global or tenant container by performing a GET request. To help filter results, the Schema Registry supports the use of query parameters when listing resources.


        >**NOTE**: For more information on using this operation, see the [schemas endpoint guide](https://experienceleague.adobe.com/docs/experience-platform/xdm/api/schemas.html) on Experience League.
      operationId: listSchemas
      produces:
        - application/json
      parameters:
        - $ref: '#/parameters/containerIdList'
        - $ref: '#/parameters/authorization'
        - $ref: '#/parameters/x-api-key'
        - $ref: '#/parameters/x-gw-ims-org-id'
        - $ref: '#/parameters/x-sandbox-name'
        - $ref: '#/parameters/acceptListing'
        - $ref: '#/parameters/property'
        - $ref: '#/parameters/orderBy'
        - $ref: '#/parameters/start'
        - $ref: '#/parameters/limit'
      responses:
        200:
          x-summary: "Success"
          description: A successful response returns a list of all schemas in the container with format dependent on the `Accept` header.
          schema:
            $ref: '#/definitions/listSchemasResponse'
        '400':
          x-summary: "Bad formatting"
          description: The `Accept` header is invalid or missing. Ensure that you are providing a valid `Accept` header for a listing call with no version supplied (e.g. `application/vnd.adobe.xed-id+json`) before trying again.
          schema:
           $ref: '#/definitions/acceptErrorList' 
        
  '/{CONTAINER_ID}/schemas/{SCHEMA_ID}':
    get:
      tags:
      - "Schemas"
      parameters:
      - $ref: '#/parameters/containerIdLookup'
      - $ref: '#/parameters/SCHEMA_ID'
      - $ref: '#/parameters/authorization'
      - $ref: '#/parameters/x-api-key'
      - $ref: '#/parameters/x-gw-ims-org-id'
      - $ref: '#/parameters/x-sandbox-name'
      - $ref: '#/parameters/accept'
      summary: Retrieve a schema
      description: >-
        >**NOTE**: For more information on using this operation, see the [schemas endpoint guide](https://experienceleague.adobe.com/docs/experience-platform/xdm/api/schemas.html) on Experience League.
      operationId: retrieveSchema
      produces:
        - application/json
      responses:
        200:
          x-summary: "Success"
          description: A successful response returns the details of the schema.
          schema:
            $ref: '#/definitions/lookupSchemaResponse'
        '400':
          x-summary: "Bad formatting"
          description: The request payload was incorrectly formatted. Check your payload formatting before trying again.
        404:
          x-summary: "Not found"
          description: The resource is not found.
        '406':
          x-summary: "Invalid Accept format"
          description: The specified `Accept` format/version is not available for this resource.
        
  '/tenant/schemas':
    post:
      tags:
      - "Schemas"
      summary: Create a custom schema
      description: >-
        >**NOTE**: For more information on using this operation, see the [schemas endpoint guide](https://experienceleague.adobe.com/docs/experience-platform/xdm/api/schemas.html) on Experience League.
      operationId: createSchema
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - $ref: '#/parameters/authorization'
        - $ref: '#/parameters/x-api-key'
        - $ref: '#/parameters/x-gw-ims-org-id'
        - $ref: '#/parameters/x-sandbox-name'
        - $ref: '#/parameters/content-type'
        - $ref: '#/parameters/createSchemaPayload'
      responses:
        201:
          x-summary: "Success"
          description: A successful response returns the details of the newly created schema.
          schema: 
            '$ref': '#/definitions/createSchemaResponse'
        '400':
          x-summary: "Bad formatting"
          description: The request payload was incorrectly formatted. Check your payload formatting before trying again.
        
  '/tenant/schemas/{SCHEMA_ID}':
    put:
      tags:
      - "Schemas"
      summary: Update a custom schema
      description: >-
        A PUT request essentially re-writes the schema, therefore the request body must include all fields required to create (POST) a schema. This is especially useful when updating a lot of information in the schema at once.


        >**NOTE**: For more information on using this operation, see the [schemas endpoint guide](https://experienceleague.adobe.com/docs/experience-platform/xdm/api/schemas.html) on Experience League.
      operationId: updateSchema
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - $ref: '#/parameters/SCHEMA_ID'
        - $ref: '#/parameters/authorization'
        - $ref: '#/parameters/x-api-key'
        - $ref: '#/parameters/x-gw-ims-org-id'
        - $ref: '#/parameters/x-sandbox-name'
        - $ref: '#/parameters/content-type'
        - $ref: '#/parameters/replaceSchemaPayload'
      responses:
        200:
          x-summary: "Success"
          description: A successful response returns JSON schema with updated attributes.
          schema: 
            '$ref': '#/definitions/updateSchemaResponse'
        '400':
          x-summary: "Bad formatting"
          description: The request payload was incorrectly formatted. Check your payload formatting before trying again.
        
    patch:
      tags:
        - "Schemas"
      summary: Update one or more attributes of a custom schema
      description: >-
        You can use this endpoint to update one or more attributes of the custom schema.

        
        The Schema Registry supports all standard JSON Patch operations, including `add`, `remove`, and `replace`. For more information on JSON Patch, including all available operations, please refer to the [the official JSON Patch specification](https://datatracker.ietf.org/doc/html/rfc6902).


        >**NOTE**: For more information on using this operation, see the [schemas endpoint guide](https://experienceleague.adobe.com/docs/experience-platform/xdm/api/schemas.html) on Experience League.
      operationId: patchSchema
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - $ref: '#/parameters/SCHEMA_ID'
        - $ref: '#/parameters/authorization'
        - $ref: '#/parameters/x-api-key'
        - $ref: '#/parameters/x-gw-ims-org-id'
        - $ref: '#/parameters/x-sandbox-name'
        - $ref: '#/parameters/content-type'
        - $ref: '#/parameters/patchPayload'
      responses:
        200:
          x-summary: "Success"
          description: A successful response returns JSON schema with updated attributes.
          schema:
            $ref: '#/definitions/patchSchemaResponse'
        '400':
          x-summary: "Bad formatting"
          description: The request payload was incorrectly formatted. Check your payload formatting before trying again.
        
   
    delete:
      tags:
      - "Schemas"
      summary: Delete a custom schema
      description: >-
        You can remove an existing schema by performing a DELETE request. A successful deletion returns an empty response body and HTTP status 204 (No Content).


        >**NOTE**: For more information on using this operation, see the [schemas endpoint guide](https://experienceleague.adobe.com/docs/experience-platform/xdm/api/schemas.html) on Experience League.
      operationId: deleteSchema
      parameters:
        - $ref: '#/parameters/SCHEMA_ID'
        - $ref: '#/parameters/authorization'
        - $ref: '#/parameters/x-api-key'
        - $ref: '#/parameters/x-gw-ims-org-id'
        - $ref: '#/parameters/x-sandbox-name'
      responses:
        204:
          x-summary: "No content"
          description: A successful response returns an empty response body and HTTP status 204 (No Content), indicating that the schema has been deleted.
        404:
          x-summary: "Not found"
          description: The resource is not found.
        "500":
          x-summary: "Internal server error"
          description: "There was an internal server error. Try the request again in a few minutes, and contact Adobe Support if the problem persists."
  '/global/behaviors':
    get:
      tags:
        - "Behaviors"
      summary: List behaviors
      description: >-
        >**NOTE**: For more information on using this operation, see the [behaviors endpoint guide](https://experienceleague.adobe.com/docs/experience-platform/xdm/api/behaviors.html) on Experience League.
      operationId: listBehaviors
      produces:
        - application/json
      parameters:
        - $ref: '#/parameters/authorization'
        - $ref: '#/parameters/x-api-key'
        - $ref: '#/parameters/x-gw-ims-org-id'
        - $ref: '#/parameters/x-sandbox-name'
        - $ref: '#/parameters/acceptListing'
      responses:
        200:
          x-summary: "Success"
          description: A successful response returns all behaviors in the global container.
          schema:
            allOf:
              - $ref: '#/definitions/listResponse'
            example:
              "results":
                - "$id": "https://ns.adobe.com/xdm/data/record"
                  "meta:altId": "_xdm.data.record"
                  "version": "1.16.4"
                  "title": "Record Schema"
                - "$id": "https://ns.adobe.com/xdm/data/adhoc"
                  "meta:altId": "_xdm.data.adhoc"
                  "version": "1.16.4"
                  "title": "Ad Hoc Schema"
                - "$id": "https://ns.adobe.com/xdm/data/time-series"
                  "meta:altId": "_xdm.data.time-series"
                  "version": "1.16.4"
                  "title": "Time-series Schema"
              "_page":
                "orderby": "updated"
                "next": null
                "count": 3
              "_links":
                "next": null
        '400':
          x-summary: "Bad formatting"
          description: The `Accept` header is invalid or missing. Ensure that you are providing a valid `Accept` header for a listing call with no version supplied (e.g. `application/vnd.adobe.xed-id+json`) before trying again.
          schema:
           $ref: '#/definitions/acceptErrorList' 
  '/global/behaviors/{BEHAVIOR_ID}':
    get:
      tags:
        - "Behaviors"
      summary: Retrieve a behavior
      description: >-
        >**NOTE**: For more information on using this operation, see the [behaviors endpoint guide](https://experienceleague.adobe.com/docs/experience-platform/xdm/api/behaviors.html) on Experience League.
      operationId: retrieveBehavior
      produces:
        - application/json
      parameters:
        - $ref: '#/parameters/BEHAVIOR_ID'
        - $ref: '#/parameters/authorization'
        - $ref: '#/parameters/x-api-key'
        - $ref: '#/parameters/x-gw-ims-org-id'
        - $ref: '#/parameters/x-sandbox-name'
        - $ref: '#/parameters/accept'
      responses:
        200:
          x-summary: "Success"
          description: A successful response returns the details of the behavior specified in the request path.
          schema:
            $ref: '#/definitions/singleBehaviorResponse'
        '400':
          x-summary: "Bad formatting"
          description: The `Accept` header is invalid or missing. Ensure that you are providing a valid accept header for a lookup call including a version number (e.g. `application/vnd.adobe.xed+json;version=1`) before trying again.
          schema:
            $ref: '#/definitions/acceptErrorLookup'
  '/{CONTAINER_ID}/mixins':
    get:
      tags:
      - "Mixins (deprecated)"
      summary: List all mixins
      description: >-
        **NOTE**: This endpoint is deprecated. For future implementations, please use the [equivalent operation](#operation/listFieldGroups) for the field groups endpoint instead.
      deprecated: true
      operationId: listMixins
      produces:
        - application/json
      parameters:
        - $ref: '#/parameters/containerIdList'
        - $ref: '#/parameters/authorization'
        - $ref: '#/parameters/x-api-key'
        - $ref: '#/parameters/x-gw-ims-org-id'
        - $ref: '#/parameters/x-sandbox-name'
        - $ref: '#/parameters/acceptListing'
        - $ref: '#/parameters/property'
        - $ref: '#/parameters/orderBy'
        - $ref: '#/parameters/start'
        - $ref: '#/parameters/limit'
      responses:
        200:
          x-summary: "Success"
          description: A successful response returns all mixins in the specified container.
          schema:
            $ref: '#/definitions/listFieldGroupsResponse'
        '400':
          x-summary: "Bad formatting"
          description: The request payload was incorrectly formatted. Check your payload formatting before trying again.
        
  '/{CONTAINER_ID}/mixins/{MIXIN_ID}':
    get:
      tags:
      - "Mixins (deprecated)"
      parameters:
      - $ref: '#/parameters/containerIdLookup'
      - $ref: '#/parameters/MIXIN_ID'
      - $ref: '#/parameters/authorization'
      - $ref: '#/parameters/x-api-key'
      - $ref: '#/parameters/x-gw-ims-org-id'
      - $ref: '#/parameters/x-sandbox-name'
      - $ref: '#/parameters/accept'
      summary: Retrieve a mixin
      deprecated: true
      description: >-
        **NOTE**: This endpoint is deprecated. For future implementations, please use the [equivalent operation](#operation/retrieveFieldGroup) for the field groups endpoint instead.
      operationId: lookupMixin
      produces:
        - application/json
      responses:
        200:
          x-summary: "Success"
          description: A successful response returns the details of the mixin.
          schema:
            $ref: '#/definitions/lookupFieldGroupResponse'
        404:
          x-summary: "Not found"
          description: The resource is not found.
        '406':
          x-summary: "Invalid Accept format"
          description: The specified `Accept` format/version is not available for this resource.
        
  '/tenant/mixins':
    post:
      tags:
      - "Mixins (deprecated)"
      summary: Create a new custom mixin
      description: >-
        **NOTE**: This endpoint is deprecated. For future implementations, please use the [equivalent operation](#operation/createFieldGroup) for the field groups endpoint instead.
      deprecated: true
      operationId: createMixin
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - $ref: '#/parameters/authorization'
        - $ref: '#/parameters/x-api-key'
        - $ref: '#/parameters/x-gw-ims-org-id'
        - $ref: '#/parameters/x-sandbox-name'
        - $ref: '#/parameters/content-type'        
        - $ref: '#/parameters/fieldGroupPayload'
      responses:
        201:
          x-summary: "Success"
          description: A successful response returns the details of the mixin.
          schema:
            $ref: '#/definitions/createFieldGroupResponse'
        '400':
          x-summary: "Bad formatting"
          description: The request payload was incorrectly formatted. Check your payload formatting before trying again.
        
  '/tenant/mixins/{MIXIN_ID}':
    put:
      tags:
      - "Mixins (deprecated)"
      summary: Update a custom mixin
      deprecated: true
      description: >-
        **NOTE**: This endpoint is deprecated. For future implementations, please use the [equivalent operation](#operation/updateFieldGroup) for the field groups endpoint instead.
      operationId: replaceMixin
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - $ref: '#/parameters/MIXIN_ID'
        - $ref: '#/parameters/authorization'
        - $ref: '#/parameters/x-api-key'
        - $ref: '#/parameters/x-gw-ims-org-id'
        - $ref: '#/parameters/x-sandbox-name'
        - $ref: '#/parameters/content-type'
        - $ref: '#/parameters/replaceFieldGroupPayload'
      responses:
        200:
          x-summary: "Success"
          description: A successful response returns the details of the updated mixin.
        '400':
          x-summary: "Bad formatting"
          description: The request payload was incorrectly formatted. Check your payload formatting before trying again.
        
    patch:
      tags:
      - "Mixins (deprecated)"
      summary: Update custom mixin
      deprecated: true
      description: >-
        **NOTE**: This endpoint is deprecated. For future implementations, please use the [equivalent operation](#operation/patchFieldGroup) for the field groups endpoint instead.
      operationId: updateMixin
      consumes:
   

# --- truncated at 32 KB (209 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/adobe-suite/refs/heads/main/openapi/adobe-suite-aep-schema-registry-openapi.yaml