openapi: 3.2.0
info:
  title: Platform - Inventory Inventory Relationships V2 API
  version: '1.0'
  contact:
    name: OneTrust Support
    url: https://my.onetrust.com/s/contactsupport
  license:
    name: Apache 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0
  description: The Inventory APIs are used to manage relationships and link data within the inventory.
servers:
- url: https://{hostname}
  variables:
    hostname:
      default: hostname
      description: The OneTrust hostname such as app.onetrust.com, app-eu.onetrust.com, app-de.onetrust.com, app-uk.onetrust.com, app-apac.onetrust.com, trial.onetrust.com, or uat.onetrust.com.
tags:
- name: Inventory Relationships V2
  description: The Inventory Relationships V2 APIs are used to manage V2 inventory relationships.
  externalDocs:
    description: OpenAPI 3.1.0 - Download Definition
    url: https://developer.onetrust.com/onetrust/openapi/platform-inventory.json
paths:
  /api/inventory-linking/v1/contextual-entities/inventory/{inventoryId}/pages:
    post:
      operationId: listAllInventoryRelationshipsUsingPOST
      summary: Get List of Relationships
      description: Use this API to get all relationships for an Inventory.
      tags:
      - Inventory Relationships V2
      x-onetrust:
        spec-label: https://developer.onetrust.com/onetrust/openapi/platform-inventory.json
      parameters:
      - name: inventoryId
        in: path
        description: Inventory ID for which to retrieve contextual links
        required: true
        schema:
          type: string
          format: uuid
        example: 2aa71ead-0c9a-416a-8471-bdfb67c8d113
      - name: page
        in: query
        description: Page number (0-based)
        schema:
          type: integer
          default: 0
          minimum: 0
      - name: size
        in: query
        description: Page size (number of records per page)
        schema:
          type: integer
          default: 20
          maximum: 100
          minimum: 1
      - name: sort
        in: query
        description: 'Sorting criteria in the format: property(,asc|desc). Default sort order is ascending. Multiple sort parameters are supported.'
        schema:
          type: string
          example: createdDate,desc
          enum:
          - name,asc
          - name,desc
          - createdDate,asc
          - createdDate,desc
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EntityListRequest'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BaseContextualEntityInformation'
        '400':
          description: Bad Request
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '429':
          description: "Too Many Requests. \nFor more information, see [API Rate Limits](https://developer.onetrust.com/onetrust/reference/rate-limits-overview)."
          headers:
            Retry-After:
              schema:
                description: The number of seconds after which requests will be allowed again.
                format: int32
            ot-period:
              schema:
                description: The unit of time for which the rate limit applies
                enum:
                - HOUR
                - MINUTE
            ot-ratelimit-event-id:
              schema:
                description: The unique identifier for the rate-limiting event.
                format: uuid
            ot-request-made:
              schema:
                description: The number of requests made within the specified period.
                format: int32
            ot-requests-allowed:
              schema:
                description: The number of requests allowed within the specified period.
                format: int32
        '500':
          description: Internal Server Error
      security:
      - OAUTH2:
        - INVENTORY
        - INVENTORY_READ
        - INVENTORY_WRITE
  /api/inventory-linking/v1/contextual-entities/{contextualLinkId}/contextual-entity-types/names/{entityTypeName}:
    put:
      operationId: updateInventoryRelationsUsingEntityTypeName_1
      summary: Update Relationship by Type Name
      description: Use this API to modify a contextual link between two entities.
      tags:
      - Inventory Relationships V2
      x-onetrust:
        spec-label: https://developer.onetrust.com/onetrust/openapi/platform-inventory.json
      parameters:
      - name: entityTypeName
        in: path
        description: Entity type name
        required: true
        schema:
          type: string
          enum:
          - Data Transfer
          - Representative
          - Sale of Data
          - Destination Or Access
          - Processor
          - Related
          - Controller
          - Collection
          - Storage Or Processing
          - Recipient Of Sale
          - SubProcessor
          - Product Or Service Provider
          - Joint Controller
          - DirectParentChild
          maxLength: 50
          minLength: 1
        example: Data Transfer
      - name: contextualLinkId
        in: path
        description: Contextual Link Identifier to be updated
        required: true
        schema:
          type: string
          format: uuid
        example: 4C09BF9A-38AA-45A9-87BA-77596525849E
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ContextualLinkUpdateRequest'
      responses:
        '200':
          description: Relationship successfully updated
        '400':
          description: Bad Request
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '429':
          description: "Too Many Requests. \nFor more information, see [API Rate Limits](https://developer.onetrust.com/onetrust/reference/rate-limits-overview)."
          headers:
            Retry-After:
              schema:
                description: The number of seconds after which requests will be allowed again.
                format: int32
            ot-period:
              schema:
                description: The unit of time for which the rate limit applies
                enum:
                - HOUR
                - MINUTE
            ot-ratelimit-event-id:
              schema:
                description: The unique identifier for the rate-limiting event.
                format: uuid
            ot-request-made:
              schema:
                description: The number of requests made within the specified period.
                format: int32
            ot-requests-allowed:
              schema:
                description: The number of requests allowed within the specified period.
                format: int32
        '500':
          description: Internal Server Error
      security:
      - OAUTH2:
        - INVENTORY
        - INVENTORY_WRITE
  ? /api/inventory-linking/v1/contextual-entities/{contextualLinkId}/contextual-entity-types/names/{entityTypeName}/data-elements
  : put:
      operationId: linkOrUnlinkInventoryRelationshipsUsingRelationshipUsingPUT_1
      summary: Link or Unlink Personal Data to Relationship by Type Name
      description: Use this API to link or Unlink the personal data to a relationship.
      tags:
      - Inventory Relationships V2
      x-onetrust:
        spec-label: https://developer.onetrust.com/onetrust/openapi/platform-inventory.json
      parameters:
      - name: entityTypeName
        in: path
        description: Entity type name
        required: true
        schema:
          type: string
          maxLength: 50
          minLength: 1
        example: vendors
      - name: contextualLinkId
        in: path
        description: Contextual Link Identifier
        required: true
        schema:
          type: string
          format: uuid
        example: 4C09BF9A-38AA-45A9-87BA-77596525849E
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/PersonalDataLinkRequest'
            example:
            - dataElementId: f2229953-b4b5-4042-8cb9-b78038cc4c46
              dataSubjectTypeId: a1b2c3d4-e5f6-4042-8cb9-b78038cc4c46
      responses:
        '201':
          description: Personal data elements successfully linked or unlinked
        '400':
          description: Bad Request
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '429':
          description: "Too Many Requests. \nFor more information, see [API Rate Limits](https://developer.onetrust.com/onetrust/reference/rate-limits-overview)."
          headers:
            Retry-After:
              schema:
                description: The number of seconds after which requests will be allowed again.
                format: int32
            ot-period:
              schema:
                description: The unit of time for which the rate limit applies
                enum:
                - HOUR
                - MINUTE
            ot-ratelimit-event-id:
              schema:
                description: The unique identifier for the rate-limiting event.
                format: uuid
            ot-request-made:
              schema:
                description: The number of requests made within the specified period.
                format: int32
            ot-requests-allowed:
              schema:
                description: The number of requests allowed within the specified period.
                format: int32
        '500':
          description: Internal Server Error
      security:
      - OAUTH2:
        - INVENTORY
        - INVENTORY_WRITE
  ? /api/inventory-linking/v1/contextual-entities/{contextualLinkId}/contextual-entity-types/names/{entityTypeName}/data-elements/pages
  : post:
      operationId: getPersonalDataForRelationshipsUsingPOST_1
      summary: Get Personal Data for Relationship by Type Name
      description: Use this API to get Personal Data for a Relationship.
      tags:
      - Inventory Relationships V2
      x-onetrust:
        spec-label: https://developer.onetrust.com/onetrust/openapi/platform-inventory.json
      parameters:
      - name: contextualLinkId
        in: path
        description: Contextual Entity Id
        required: true
        schema:
          type: string
          format: uuid
        example: 2aa71ead-0c9a-416a-8471-bdfb67c8d113
      - name: entityTypeName
        in: path
        description: Entity type name
        required: true
        schema:
          type: string
          maxLength: 50
          minLength: 1
        example: vendors
      - name: page
        in: query
        description: Page number (0-based)
        schema:
          type: integer
          default: 0
          minimum: 0
      - name: size
        in: query
        description: Page size (number of records per page)
        schema:
          type: integer
          default: 20
          maximum: 100
          minimum: 1
      - name: sort
        in: query
        description: 'Sorting criteria in the format: property(,asc|desc). Default sort order is ascending.'
        schema:
          type: string
          example: createdDate,desc
          enum:
          - name,asc
          - name,desc
          - createdDate,asc
          - createdDate,desc
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/SearchCriteria'
            example:
              filters:
              - field: status
                operator: EQ
                value:
                - active
              - field: createdDate
                operator: BETWEEN
                date:
                  from: '2025-01-01'
                  to: '2025-12-31'
              fullText: John Doe
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/PersonalDataDetailedResponse'
        '400':
          description: Bad Request
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '429':
          description: "Too Many Requests. \nFor more information, see [API Rate Limits](https://developer.onetrust.com/onetrust/reference/rate-limits-overview)."
          headers:
            Retry-After:
              schema:
                description: The number of seconds after which requests will be allowed again.
                format: int32
            ot-period:
              schema:
                description: The unit of time for which the rate limit applies
                enum:
                - HOUR
                - MINUTE
            ot-ratelimit-event-id:
              schema:
                description: The unique identifier for the rate-limiting event.
                format: uuid
            ot-request-made:
              schema:
                description: The number of requests made within the specified period.
                format: int32
            ot-requests-allowed:
              schema:
                description: The number of requests allowed within the specified period.
                format: int32
        '500':
          description: Internal Server Error
      security:
      - OAUTH2:
        - INVENTORY
        - INVENTORY_READ
  /api/inventory-linking/v1/contextual-entities/{contextualLinkId}/contextual-entity-types/{entityTypeId}:
    put:
      operationId: updateInventoryRelationsUsingEntityTypeName
      summary: Update Relationship by Type ID
      description: Use this API to modify a contextual link between two entities.
      tags:
      - Inventory Relationships V2
      x-onetrust:
        spec-label: https://developer.onetrust.com/onetrust/openapi/platform-inventory.json
      parameters:
      - name: entityTypeId
        in: path
        description: Entity type identifier
        required: true
        schema:
          type: string
          format: uuid
        example: 2aa71ead-0c9a-416a-8471-bdfb67c8d113
      - name: contextualLinkId
        in: path
        description: Contextual Link Identifier to be updated
        required: true
        schema:
          type: string
          format: uuid
        example: 4C09BF9A-38AA-45A9-87BA-77596525849E
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ContextualLinkUpdateRequest'
      responses:
        '200':
          description: Relationship successfully updated
        '400':
          description: Bad Request
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '429':
          description: "Too Many Requests. \nFor more information, see [API Rate Limits](https://developer.onetrust.com/onetrust/reference/rate-limits-overview)."
          headers:
            Retry-After:
              schema:
                description: The number of seconds after which requests will be allowed again.
                format: int32
            ot-period:
              schema:
                description: The unit of time for which the rate limit applies
                enum:
                - HOUR
                - MINUTE
            ot-ratelimit-event-id:
              schema:
                description: The unique identifier for the rate-limiting event.
                format: uuid
            ot-request-made:
              schema:
                description: The number of requests made within the specified period.
                format: int32
            ot-requests-allowed:
              schema:
                description: The number of requests allowed within the specified period.
                format: int32
        '500':
          description: Internal Server Error
      security:
      - OAUTH2:
        - INVENTORY
        - INVENTORY_WRITE
  /api/inventory-linking/v1/contextual-entities/{contextualLinkId}/contextual-entity-types/{entityTypeId}/data-elements:
    put:
      operationId: linkOrUnlinkInventoryRelationshipsUsingRelationshipUsingPUT
      summary: Link or Unlink Personal Data to Relationship by Type ID
      description: Use this API to link or Unlink the personal data to a relationship.
      tags:
      - Inventory Relationships V2
      x-onetrust:
        spec-label: https://developer.onetrust.com/onetrust/openapi/platform-inventory.json
      parameters:
      - name: entityTypeId
        in: path
        description: Entity type Identifier
        required: true
        schema:
          type: string
          format: uuid
        example: 2aa71ead-0c9a-416a-8471-bdfb67c8d113
      - name: contextualLinkId
        in: path
        description: Contextual Link Identifier
        required: true
        schema:
          type: string
          format: uuid
        example: 4C09BF9A-38AA-45A9-87BA-77596525849E
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/PersonalDataLinkRequest'
            example:
            - dataElementId: f2229953-b4b5-4042-8cb9-b78038cc4c46
              dataSubjectTypeId: a1b2c3d4-e5f6-4042-8cb9-b78038cc4c46
      responses:
        '201':
          description: Personal data elements successfully linked or unlinked
        '400':
          description: Bad Request
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '429':
          description: "Too Many Requests. \nFor more information, see [API Rate Limits](https://developer.onetrust.com/onetrust/reference/rate-limits-overview)."
          headers:
            Retry-After:
              schema:
                description: The number of seconds after which requests will be allowed again.
                format: int32
            ot-period:
              schema:
                description: The unit of time for which the rate limit applies
                enum:
                - HOUR
                - MINUTE
            ot-ratelimit-event-id:
              schema:
                description: The unique identifier for the rate-limiting event.
                format: uuid
            ot-request-made:
              schema:
                description: The number of requests made within the specified period.
                format: int32
            ot-requests-allowed:
              schema:
                description: The number of requests allowed within the specified period.
                format: int32
        '500':
          description: Internal Server Error
      security:
      - OAUTH2:
        - INVENTORY
        - INVENTORY_WRITE
  ? /api/inventory-linking/v1/contextual-entities/{contextualLinkId}/contextual-entity-types/{entityTypeId}/data-elements/pages
  : post:
      operationId: getPersonalDataForRelationshipsUsingPOST
      summary: Get Personal Data for Relationship by Type ID
      description: Use this API to get Personal Data for a Relationship.
      tags:
      - Inventory Relationships V2
      x-onetrust:
        spec-label: https://developer.onetrust.com/onetrust/openapi/platform-inventory.json
      parameters:
      - name: contextualLinkId
        in: path
        description: Contextual Entity Id
        required: true
        schema:
          type: string
          format: uuid
        example: 2aa71ead-0c9a-416a-8471-bdfb67c8d113
      - name: entityTypeId
        in: path
        description: Entity type Identifier
        required: true
        schema:
          type: string
          format: uuid
        example: 2aa71ead-0c9a-416a-8471-bdfb67c8d113
      - name: page
        in: query
        description: Page number (0-based)
        schema:
          type: integer
          default: 0
          minimum: 0
      - name: size
        in: query
        description: Page size (number of records per page)
        schema:
          type: integer
          default: 20
          maximum: 100
          minimum: 1
      - name: sort
        in: query
        description: 'Sorting criteria in the format: property(,asc|desc). Default sort order is ascending.'
        schema:
          type: string
          example: createdDate,desc
          enum:
          - name,asc
          - name,desc
          - createdDate,asc
          - createdDate,desc
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/SearchCriteria'
            example:
              filters:
              - field: status
                operator: EQ
                value:
                - active
              - field: createdDate
                operator: BETWEEN
                date:
                  from: '2025-01-01'
                  to: '2025-12-31'
              fullText: John Doe
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/PersonalDataDetailedResponse'
        '400':
          description: Bad Request
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '429':
          description: "Too Many Requests. \nFor more information, see [API Rate Limits](https://developer.onetrust.com/onetrust/reference/rate-limits-overview)."
          headers:
            Retry-After:
              schema:
                description: The number of seconds after which requests will be allowed again.
                format: int32
            ot-period:
              schema:
                description: The unit of time for which the rate limit applies
                enum:
                - HOUR
                - MINUTE
            ot-ratelimit-event-id:
              schema:
                description: The unique identifier for the rate-limiting event.
                format: uuid
            ot-request-made:
              schema:
                description: The number of requests made within the specified period.
                format: int32
            ot-requests-allowed:
              schema:
                description: The number of requests allowed within the specified period.
                format: int32
        '500':
          description: Internal Server Error
      security:
      - OAUTH2:
        - INVENTORY
        - INVENTORY_READ
  /api/inventory-linking/v1/inventories/relations:
    post:
      operationId: createInventoryRelationsUsingPOST
      summary: Create Relationship
      description: Use this API to create a bidirectional link between an inventory and one or more other inventories.
      tags:
      - Inventory Relationships V2
      x-onetrust:
        spec-label: https://developer.onetrust.com/onetrust/openapi/platform-inventory.json
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/LinkRequestDto'
      responses:
        '201':
          description: Relationship created successfully
          content:
            application/json:
              schema:
                type: string
                format: uuid
        '400':
          description: Bad Request
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '429':
          description: "Too Many Requests. \nFor more information, see [API Rate Limits](https://developer.onetrust.com/onetrust/reference/rate-limits-overview)."
          headers:
            Retry-After:
              schema:
                description: The number of seconds after which requests will be allowed again.
                format: int32
            ot-period:
              schema:
                description: The unit of time for which the rate limit applies
                enum:
                - HOUR
                - MINUTE
            ot-ratelimit-event-id:
              schema:
                description: The unique identifier for the rate-limiting event.
                format: uuid
            ot-request-made:
              schema:
                description: The number of requests made within the specified period.
                format: int32
            ot-requests-allowed:
              schema:
                description: The number of requests allowed within the specified period.
                format: int32
        '500':
          description: Internal Server Error
      security:
      - OAUTH2:
        - INVENTORY
        - INVENTORY_WRITE
  /api/inventory-linking/v1/relationship-types/names/{relationshipTypeName}/relationship/{relationshipId}:
    get:
      operationId: getInventoryRelationshipUsingRelationshipTypeName_1
      summary: Get Relationship by Type Name
      description: Use this API to get relationship details created between entities.
      tags:
      - Inventory Relationships V2
      x-onetrust:
        spec-label: https://developer.onetrust.com/onetrust/openapi/platform-inventory.json
      parameters:
      - name: relationshipTypeName
        in: path
        description: Relationship Type Name
        required: true
        schema:
          type: string
          example: Data Transfer
          enum:
          - Data Transfer
          - Representative
          - Sale of Data
          - Destination Or Access
          - Processor
          - Related
          - Controller
          - Collection
          - Storage Or Processing
          - Recipient Of Sale
          - SubProcessor
          - Product Or Service Provider
          - Joint Controller
          - DirectParentChild
      - name: relationshipId
        in: path
        description: Relationship Identifier
        required: true
        schema:
          type: string
          format: uuid
          example: 4C09BF9A-38AA-45A9-87BA-77596525849E
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RelationshipInformation'
        '400':
          description: Bad Request
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '429':
          description: "Too Many Requests. \nFor more information, see [API Rate Limits](https://developer.onetrust.com/onetrust/reference/rate-limits-overview)."
          headers:
            Retry-After:
              schema:
                description: The number of seconds after which requests will be allowed again.
                format: int32
            ot-period:
              schema:
                description: The unit of time for which the rate limit applies
                enum:
                - HOUR
                - MINUTE
            ot-ratelimit-event-id:
              schema:
                description: The unique identifier for the rate-limiting event.
                format: uuid
            ot-request-made:
              schema:
                description: The number of requests made within the specified period.
                format: int32
            ot-requests-allowed:
              schema:
                description: The number of requests allowed within the specified period.
                format: int32
        '500':
          description: Internal Server Error
      security:
      - OAUTH2:
        - INVENTORY
        - INVENTORY_READ
        - INVENTORY_WRITE
    delete:
      operationId: deleteInventoryRelationsUsingRelationshipTypeName_1
      summary: Delete Relationship by Type Name
      description: Use this API to remove a contextual link between two entities.
      tags:
      - Inventory Relationships V2
      x-onetrust:
        spec-label: https://developer.onetrust.com/onetrust/openapi/platform-inventory.json
      parameters:
      - name: relationshipTypeName
        in: path
        description: Relationship type name
        required: true
        schema:
          type: string
          example: Data Transfer
          enum:
          - Data Transfer
          - Representative
          - Sale of Data
          - Destination Or Access
          - Processor
          - Related
          - Controller
          - Collection
          - Storage Or Processing
          - Recipient Of Sale
          - SubProcessor
          - Product Or Service Provider
          - Joint Controller
          - DirectParentChild
      - name: relationshipId
        in: path
        description: Relationship Identifier
        required: true
        schema:
          type: string
          format: uuid
          example: 4C09BF9A-38AA-45A9-87BA-77596525849E
      responses:
        '204':
          description: No Content
        '400':
          description: Bad Request
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '429':
          description: "Too Many Requests. \nFor more information, see [API Rate Limits](https://developer.onetrust.com/onetrust/reference/rate-limits-overview)."
          headers:
            Retry-After:
              schema:
                description: The number of seconds after which requests will be allowed again.
                format: int32
            ot-period:
              schema:
                description: The unit of time for which the rate limit applies
                enum:
                - HOUR
                - MINUTE
            ot-ratelimit-event-id:
              schema:
                description: The unique identifier for the rate-limiting event.
                format: uuid
            ot-request-made:
              schema:
                description: The number of requests made within the specified period.
                format: int32
            ot-requests-allowed:
              schema:
                description: The number of requests allowed within the specified period.
                format: int32
        '500':
          description: Internal Server Error
      security:
      - OAUTH2:
        - INVENTORY
        - INVENTORY_WRITE
  /api/inventory-linking/v1/relationship-types/{relationshipTypeId}/relationship/{relationshipId}:
    get:
      operationId: getInventoryRelationshipUsingRelationshipTypeName
      summary: Get Relationship by Type ID
      description: Use this API to get relationship details created between entities.
      tags:
      - Inventory Relationships V2
      x-onetrust:
        spec-label: https://developer.onetrust.com/onetrust/openapi/platform-inventory.json
      parameters:
      - name: relationshipTypeId
        in: path
        description: Relationship type id
        required: true
        schema:
          type: string
          format: uuid
          example: 2aa71ead-0c9a-416a-8471-bdfb67c8d113
      - name: relationshipId
        in: path
        description: Relationship Identifier
        required: true
        schema:
          type: string
          format: uuid
          example: 4C09BF9A-38AA-45A9-87BA-77596525849E
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RelationshipInformation'
        '400':
          description: Bad Request
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '429':
          description: "Too Many Requests. \nFor more information, see [API Rate Limits](https://developer.onetrust.com/onetrust/reference/rate-limits-overview)."
          headers:
            Retry-After:
              schema:
                description: The number of seconds after which requests will be allowed again.
                format: int32
            ot-period:
              schema:
                description: The unit of time for which the rate limit applies
                enum:
                - HOUR
                - MINUTE
            ot-ratelimit-event-id:
              schema:
                description: The unique identifier for the rate-limiting event.
                format: uuid
            ot-request-made:
              schema:
                description: The number of requests made within the specified period.
                format: int32
            ot-requests-allowed:
              schema:
                description: The number of requests allowed within the specified period.
                format: int32
        '500':
          description: Internal Server Error
      security:
      - OAUTH2:
        - INVENTORY
        - INVENTORY_READ
        - INVENTORY_WRITE
    delete:
      operationId: deleteInventoryRelationsUsingRelationshipTypeName
      summary: Delete Relationship by Type ID
      description: Use this API to remove a contextual link between two entities.
      tags:
      - Inventory Relationships V2
      x-onetrust:
        spec-label: https://developer.onetrust.com/onetrust/openapi/platform-inventory.json
      parameters:
      - name: relationshipTypeId
        in: path
        description: Relationship type Identifier
        required: true
        schema:
          type: string
          format: uuid
          example: 2aa71ead-0c9a-416a-8471-bdfb67c8d113
      - name: relationshipId
        in: path
        description: Relationship Identifier
        required: true
        schema:
          type: string
          format: uuid
          example: 4C09BF9A-38AA-45A9-87BA-77596525849E
      responses:
        '204':
          description: No Content
        '400':
          description: Bad Request
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '429':
          description: "Too Many Requests. \nFor more information, see [API Rate Limits](https://developer.onetrust.com/onetrust/reference/rate-limits-overview)."
          headers:
            Retry-After:
              schema:
                description: The number of seconds after which requests will be allowed again.
                format: int32
            ot-period:
              schema:
                description: The unit of time for which the rate limit applies
                enum:
                - HOUR
                - MINUTE
            ot-ratelimit-event-id:
              schema:
                description: The unique identifier for the rate-limiting event.
                format: uuid
            ot-request-made:
              schema:
                description: The number of requests made within the specified period.
                format: int32
            ot-requests-allowed:
              schema:
                description: The number of requests allowed within the specified period.
                format: int32
        '500':
          description: Internal Server Error
      security:
      - OAUTH2:
        - INVENTORY
        - INVENTORY_WRITE
components:
  schemas:
    PersonalDataDetailedResponse:
      type: object
      properties:
        dataElement:
          $ref: '#/components/schemas/BasePersonalDataResponse'
        dataCategories:
          type: array
          items:
            $ref: '#/components/schemas/BasePersonalDataResponse'
        dataClassifications:
          type: array
          items:
            $ref: '#/components/schemas/BasePersonalDataResponse'
        dataSubjectType:
          $ref: '#/components/schemas/BasePersonalDataResponse'
        source:
          type: string
        dateLinked:
          type: string
          format: date-time
    FilterInformation:
      type: object
      properties:
        field:
          type: string
        operator:
          type: string
          enum:
          - EQ
          - EQUAL_TO
          - IN_BETWEEN
        value:
          type: array
          items:
            type: string
        date:
          $ref: '#/components/schemas/DateDto'
      required:
      - field
    BaseContextualEntityInformation:
      type: object
      properties:
        id:
          type: string
          format: uuid
        number:
          type: integer
          format: int64
        sourceEntityType:
          $ref: '#/components/schemas/ObjectReference'
        targetEntityType:
          $ref: '#/components/schemas/ObjectReference'
        source:
          $ref: '#/components/schemas/InventoryIdentifier'
        target:
          $ref: '#/components/schemas/InventoryIdentifier'
        processingActivity:
          $ref: '#/components/schemas/InventoryIdentifier'
        contextEntityType:
          $ref: '#/components/schemas/ObjectReference'
        relationshipTypeDetail:
          $ref: '#/components/schemas/RelationshipType'
        pendingForReview:
          type: boolean
        contextual:
          type: boolean
    ContextualLinkUpdateRequest:
      type: object
      properties:
        processingActivityId:
          description: Processing Activity Id
          type: string
          format: uuid
          example: f2229953-b4b5-4042-8cb9-b78038cc4c46
        attributes:
          type: object
          additionalProperties:
            type: array
            items:
              $ref: '#/components/schemas/AttributeValueInformation'
          writeOnly: true
    DateDto:
      type: object
      properties:
        fromDateValue:
          type: string
        toDateValue:
          type: string
    EntityListRequest:
      type: object
      properties:
        context:
          description: User-defined context for the current request
          $ref: '#/components/schemas/ContextInformation'
        queryRequest:
          description: Query request containing search criteria and organization context
          $ref: '#/components/schemas/EntityQueryRequest'
        requestedFields:
          description: Field request specifying which fields to include in the response
          $ref: '#/components/schemas/EntityFieldRequest'
      example:
        queryRequest:
          criteria:
            filters:
            - fieldName: name
              operator: contains
              value: OneTrust
            - fieldName: entityStatus
              operator: equals
              value: Active
            searchQuery: gdpr
            sort:
            - fieldName: lastModifiedTimestamp
              direction: DESC
          organizationTraversalStrategy: ancestors_and_descendants
          requestedOrganizationId: f2229953-b4b5-4042-8cb9-b78038cc4c46
          queryAction: ListEntity
        requestedFields:
          includeStandardFields: true
          includeCustomFields: true
          includeAuditFields: false
          specificStandardFields:
          - name
          - entityNumber
          - createdBy
          specificCustomFields:
          - vendor_tier
          - risk_score
    EntityQueryRequest:
      type: object
      properties:
        criteria:
          description: The criteria used to search for entities, including filters, full-text search, and sorting
          example:
            filters:
            - fieldName: name
              operator: contains
              value: OneTrust
            searchQuery: privacy
            sort:
            - fieldName: lastModifiedTimestamp
              direction: DESC
          $ref: '#/components/schemas/AttributeQueryCriteria'
        organizationTraversalStrategy:
          description: 'The strategy for fetching entities across related organizations. Default: null (no organization traversal applicable)'
          type: string
          example: ancestors_and_descendants
          enum:
          - ancestors_and_descendants
          - descendants
          - all
        requestedOrganizationId:
          description: The overridden requested organization identifier. If supplied, would be used instead of request context organization
          type: string
          format: uuid
          example: f2229953-b4b5-4042-8cb9-b78038cc4c46
        queryAction:
          description: The query action specifies the source of the API call and allows a service to apply a predicate
          type: string
          example: ListEntity
      example:
        criteria:
          filters:
          - fieldName: name
            operator: contains
            value: OneTrust
          - fieldName: entityStatus
            operator: equals
            value: Active
          - fieldName: lastModifiedTimestamp
            operator: greaterThan
            value: '2024-01-01T00:00:00Z'
          searchQuery: privacy
          sort:
          - fieldName: lastModifiedTimestamp
            direction: DESC
        organizationTraversalStrategy: ancestors_and_descendants
        requestedOrganizationId: f2229953-b4b5-4042-8cb9-b78038cc4c46
        queryAction: ListEntity
    EntityIdAndType:
      type: object
      properties:
        id:
          description: Entity id
          type: string
          format: uuid
          example: f2229953-b4b5-4042-8cb9-b78038cc4c46
        type:
          description: Entity type
          type: string
          enum:
          - assets
          - processing-activities
          - vendors
          - entities
          - data-elements
          - data-subjects
      required:
      - id
      - type
    AttributeValueInformation:
      type: object
      properties:
        id:
          description: Unique identifier for the attribute option
          type: string
          format: uuid
          example: a34ccec7-1ec0-4d65-9075-bdd0d923f1d1
        value:
          description: Attribute value
          type: string
          example: Text Value
        valueKey:
          description: Translation key used for localizing the value
          type: string
          example: attribute.option.valueKey
        colorCode:
          description: Color code associated with the option. Used for score-based attributes.
          type: string
          example: red
        optionSelectionValue:
          description: Selection score value linked to the option. Used for score-based or numerical-based attributes.
          type: string
          example: '3.5'
        displayLabel:
          description: Display name for the option, used for external attributes managed by other systems
          type: string
          example: United State | San Francisco
        associatedAttributeValueInformation:
          description: Associated attribute option information
          type: array
          items:
            $ref: '#/components/schemas/AssociatedAttributeValueInformation'
        disabled:
          description: Indicates whether this attribute option is currently disabled.
          type: boolean
          example: false
          default: 'false'
      required:
      - value
    RelationshipInformation:
      type: object
      properties:
        id:
          description: Relationship ID
          type: string
          format: uuid
          example: 4c09bf9a-38aa-45a9-87ba-77596525849e
        number:
          description: Relationship Number
          type: integer
          format: int64
          example: 12345
        type:
          description: Relationship Type
          example:
            id: 2aa71ead-0c9a-416a-8471-bdfb67c8d113
            name: Data Transfer
            nameKey: data_transfer
            seeded: true
            schemaName: inventory_linking
            moduleName: inventory
            forwardRelationshipLabel:
              name: sends data to
              isContextual: true
              nameKey: sends_data_to
            reverseRelationshipLabel:
              name: receives data from
              isContextual: true
              nameKey: receives_data_from
          $ref: '#/components/schemas/RelationshipTypeInformation'
        deleteType:
          description: Relationship Delete Type
          type: string
          example: SOFT
          enum:
          - HARD
          - SOFT
          - NONE
        isContextual:
          description: Is Contextual
          type: boolean
          example: true
        status:
          description: Relationship Status
          type: string
          example: APPROVED
          enum:
          - APPROVED
          - REJECTED
          - PENDING_REVIEW
          - NONE
        attributes:
          type: object
          additionalProperties:
            type: object
          writeOnly: true
      example:
        id: 4c09bf9a-38aa-45a9-87ba-77596525849e
        number: 12345
        type:
          id: 2aa71ead-0c9a-416a-8471-bdfb67c8d113
          name: Data Transfer
          nameKey: data_transfer
          seeded: true
          schemaName: inventory_linking
          moduleName: inventory
          forwardRelationshipLabel:
            name: sends data to
            isContextual: true
            nameKey: sends_data_to
          reverseRelationshipLabel:
            name: receives data from
            isContextual: true
            nameKey: receives_data_from
        deleteType: SOFT
        isContextual: true
        status: APPROVED
        attributes:
          dataTransferType: Cross-Border
          dataTransferDate: '2025-07-21'
          dataTransferPurpose: Business Operations
    LinkRequestDto:
      type: object
      properties:
        sourceInventory:
          description: Associated Source Entity Instance for given Entity Type
          example:
            id: f2229953-b4b5-4042-8cb9-b78038cc4c46
            type: assets
          $ref: '#/components/schemas/EntityIdAndType'
        targetInventory:
          description: Associated Target Entity Instance for given Entity Type
          example:
            id: f2229953-b4b5-4042-8cb9-b78038cc4c46
            type: assets
          $ref: '#/components/schemas/EntityIdAndType'
        contextProcess:
          description: Associated Source Entity Instance for given Entity Type
          example:
            id: f2229953-b4b5-4042-8cb9-b78038cc4c46
            name: PA Name
          $ref: '#/components/schemas/BasicEntityIdAndName'
        attributes:
          description: Custom Attributes based on schema defined for given link type
          type: object
          example:
            textAttributeName:
            - value: Text
            optionBasedAttributeName:
            - id: f2229953-b4b5-4042-8cb9-b78038cc4c46
          additionalProperties:
            type: array
            items:
              $ref: '#/components/schemas/AttributeValueInformation'
        linkTypeName:
          description: Link type identifier
          type: string
          example:
            linkTypeName: Data Transfer
        linkTypeLabel:
          description: Link type label
          type: string
          example:
            linkTypeLabel: Sends Data To
      required:
      - linkTypeLabel
      - linkTypeName
      - sourceInventory
      - targetInventory
    RelationshipTypeInformation:
      type: object
      properties:
        id:
          description: Relationship type ID
          type: string
          format: uuid
          example: 2aa71ead-0c9a-416a-8471-bdfb67c8d113
        name:
          description: Relationship type name
          type: string
          example: Data Transfer
        nameKey:
          description: Relationship type name key
          type: string
          example: data_transfer
        seeded:
          description: Whether the relationship type is seeded
          type: boolean
          example: true
        schemaName:
          description: Schema name
          type: string
          example: inventory_linking
        moduleName:
          description: Module name
          type: string
          example: inventory
        forwardRelationshipLabel:
          description: Forward relationship label information
          example:
            name: sends data to
            isContextual: true
            nameKey: sends_data_to
          $ref: '#/components/schemas/RelationshipLabelInformation'
        reverseRelationshipLabel:
          description: Reverse relationship label information
          example:
            name: receives data from
            isContextual: true
            nameKey: receives_data_from
          $ref: '#/components/schemas/RelationshipLabelInformation'
      example:
        id: 2aa71ead-0c9a-416a-8471-bdfb67c8d113
        name: Data Transfer
        nameKey: data_transfer
        seeded: true
        schemaName: inventory_linking
        moduleName: inventory
        forwardRelationshipLabel:
          name: sends data to
          isContextual: true
          nameKey: sends_data_to
        reverseRelationshipLabel:
          name: receives data from
          isContextual: true
          nameKey: receives_data_from
    PersonalDataLinkRequest:
      type: object
      properties:
        dataElementId:
          description: ID of the data element to link/unlink
          type: string
          format: uuid
          example: f2229953-b4b5-4042-8cb9-b78038cc4c46
        dataSubjectTypeId:
          description: ID of the data subject type to link/unlink
          type: string
          format: uuid
          example: a1b2c3d4-e5f6-4042-8cb9-b78038cc4c46
      example:
        dataElementId: f2229953-b4b5-4042-8cb9-b78038cc4c46
        dataSubjectTypeId: a1b2c3d4-e5f6-4042-8cb9-b78038cc4c46
    RelationshipLabelInformation:
      type: object
      properties:
        name:
          description: Relationship label name
          type: string
          example: sends data to
        isContextual:
          description: Flag to identify if relationship type is direct parent child or contextual
          type: boolean
          example: true
        nameKey:
          description: Relationship label name key
          type: string
          example: sends_data_to
      example:
        name: sends data to
        isContextual: true
        nameKey: sends_data_to
    EntityFieldRequest:
      type: object
      properties:
        fields:
          description: The requested non-base fields.
          type: array
          items:
            type: string
          example:
          - textAttributeField1
          - singleSelectAttributeField1
        mode:
          description: The mode based on which required non-base fields would be selected.
          type: string
          default: select_all
          enum:
          - select_all
          - ignore_all
          - specific
        includeSelectedFullTextSearchFields:
          description: The full text search mode would only includes passed "fields" of Text/Date/NumericalText/DateTime response type.
          type: boolean
          example: true
        overriddenSearchFields:
          description: The caller can override search (system) fields which need to included.
          type: array
          items:
            type: string
          example:
          - name
      required:
      - mode
    RelationshipType:
      type: object
      properties:
        id:
          description: RelationshipType ID
          type: string
          format: uuid
        name:
          description: RelationshipType Name
          type: string
        nameKey:
          description: RelationshipType NameKey
          type: string
    ContextInformation:
      type: object
      properties:
        parameters:
          additionalProperties:
            type: object
          type: object
    AttributePredicate:
      type: object
      properties:
        field:
          description: The field name used to filter results.
          type: string
        operator:
          description: The relationship that must be met between the field and value.
          type: string
          enum:
          - EQUAL_TO
          - NOT_EQUAL_TO
          - GREATER_THAN
          - GREATER_THAN_EQUAL_TO
          - LESS_THAN
          - LESS_THAN_EQUAL_TO
          - BETWEEN
        value:
          description: "The field value used to filter results. If filtering for a range of values, this would be the start of the range and should be used in conjunction with the `toValue` parameter. \nExamples by type: UUID = 'e68d49c4-f11f-4cd9-8f1b-0be8ef945b8f', LocalDate = '2023-01-01', OffsetDateTime = '2023-01-01T00:00:00Z', String = 'Closed', Number = 8"
          type: object
          oneOf:
          - type: string
            format: uuid
          - type: string
            format: date
          - type: string
            format: date-time
          - type: string
          - type: number
        toValue:
          description: "The field value for the end of the range. This field should be used in conjunction with the `value` parameter. \nExamples by type: LocalDate = '2023-01-01', OffsetDateTime = '2023-01-01T00:00:00Z', String = 'Closed', Number = 8"
          type: object
          oneOf:
          - type: string
            format: date
          - type: string
            format: date-time
          - type: string
          - type: number
      required:
      - field
    BasicEntityIdAndName:
      type: object
      properties:
        id:
          description: Entity identifier
          type: string
          format: uuid
          example: f2229953-b4b5-4042-8cb9-b78038cc4c46
        name:
          description: Entity name
          type: string
          example: Sample Entity Name
    SearchCriteria:
      type: object
      properties:
        filters:
          type: array
          items:
            $ref: '#/components/schemas/FilterInformation'
          uniqueItems: true
        searchText:
          type: string
        blank:
          type: boolean
    BasePersonalDataResponse:
      type: object
      properties:
        id:
          type: string
          format: uuid
        name:
          type: string
        nameKey:
          type: string
        description:
          type: string
        descriptionKey:
          type: string
      required:
      - id
      - name
      - nameKey
    InventoryIdentifier:
      type: object
      properties:
        id:
          type: string
          format: uuid
        name:
          type: string
        organization:
          $ref: '#/components/schemas/ObjectReference'
        inventoryType:
          type: string
        identifierKey:
          type: string
    AssociatedAttributeValueInformation:
      type: object
      properties:
        id:
          description: Unique identifier for the attribute option
          type: string
          format: uuid
          example: a34ccec7-1ec0-4d65-9075-bdd0d923f1d1
        value:
          description: Attribute value
          type: string
          example: Text Value
        valueKey:
          description: Translation key used for localizing the value
          type: string
          example: attribute.option.valueKey
        colorCode:
          description: Color code associated with the option. Used for score-based attributes.
          type: string
          example: red
      required:
      - value
    ObjectReference:
      type: object
      properties:
        id:
          type: string
          format: uuid
        value:
          type: string
        valueKey:
          type: string
    AttributeQueryCriteria:
      type: object
      properties:
        filters:
          description: The fields and values used to filter results.
          type: array
          items:
            $ref: '#/components/schemas/AttributePredicate'
          uniqueItems: true
        fullText:
          description: The key terms for the search criteria.
          type: string
  securitySchemes:
    OAUTH2:
      type: oauth2
      flows:
        clientCredentials:
          tokenUrl: https://{hostname}/api/access/v1/oauth/token
          scopes:
            INVENTORY: Inventory scope for external systems
x-onetrust:
  spec-label: OpenAPI 3.1.0
x-readme:
  explorer-enabled: false
  proxy-enabled: false
  metrics-enabled: false