Add/Remove Business Process IT System Entities by External ID

Overview Endpoint Reference Responses

Overview

The PUT /api/hub/external-integration/business-processes/external-id/{externalId}/it-system-entities endpoint assigns a complete list of IT Systems to a Business Process, identified by the Business Process's External ID. This is a full replacement — IT Systems not included in the request body are removed, and any missing ones are added.

⚠ Important: This operation replaces the entire IT System assignment for the Business Process. Any IT Systems currently assigned but not included in the request body will be removed.

What you can do

✓Assign a full set of IT Systems to a Business Process in a single call, replacing any prior assignments

✓Receive the resulting data flow entity structure including IT System nodes, data subject nodes, data elements, processing purposes, and transfer relationships

Prerequisites

✓A valid OAuth 2.0 bearer token

✓An existing Business Process External ID (externalId)

Endpoint Reference

Method

PUT

Content-Type

application/json

URL

api/hub/external-integration/business-processes/external-id/{externalId}/it-system-entities

Required Path Parameters

Name	Value	Description
`externalId`	String	The External ID of the Business Process to assign IT Systems to.

Request Body

A JSON array of IT System UUIDs to assign to the Business Process.

["uuid", "uuid", ...]

Sample curl Request

curl -X PUT \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer <Auth Token>' \
  --header 'Content-Type: application/json' \
  --data '["uuid"]' \
  'api/hub/business-processes/external-id/{externalId}/it-system-entities'

Responses

Success Response

Code: 201

{
  "entityId": "uuid",
  "entityName": "string",
  "dataElements": [
    {
      "identifier": "string",
      "dataElement": "string",
      "dataElementCategory": "string"
    }
  ],
  "processingPurposes": [
    {
      "identifier": "string",
      "processingPurpose": "string",
      "processingPurposeCategory": "string"
    }
  ],
  "itSystemNodes": [
    {
      "nodeId": "uuid",
      "entityId": "uuid",
      "entityName": "string",
      "locationIds": [
        "string"
      ],
      "dataElementIds": [
        "uuid"
      ],
      "processingPurposeIds": [
        "uuid"
      ],
      "dstToItDataTransfers": [
        {
          "saleOfData": boolean,
          "sourceNodeId": "uuid",
          "targetNodeId": "uuid",
          "dataElementIds": [
            "uuid"
          ],
          "processingPurposeIds": [
            "uuid"
          ],
          "locationIds": [
            "string"
          ]
        }
      ],
      "itToDrtDataTransfers": [
        {
          "saleOfData": boolean,
          "sourceNodeId": "uuid",
          "targetNodeId": "uuid",
          "dataElementIds": [
            "uuid"
          ],
          "processingPurposeIds": [
            "uuid"
          ],
          "locationIds": [
            "string"
          ]
        }
      ],
      "itToItDataTransfers": [
        {
          "saleOfData": boolean,
          "sourceNodeId": "uuid",
          "targetNodeId": "uuid",
          "dataElementIds": [
            "uuid"
          ],
          "processingPurposeIds": [
            "uuid"
          ],
          "locationIds": [
            "string"
          ]
        }
      ]
    }
  ],
  "dataSubjectNodes": [
    {
      "nodeId": "uuid",
      "entityId": "uuid",
      "entityName": "string",
      "locationIds": [
        "string"
      ],
      "dataElementIds": [
        "uuid"
      ],
      "processingPurposeIds": [
        "uuid"
      ]
    }
  ],
  "hostingLocation": [
    {
      "countryName": "string",
      "countryTwoLetterCode": "string",
      "countryThreeLetterCode": "string",
      "countryRegionName": "string",
      "globalRegionName": "string",
      "stateName": "string",
      "stateShortValue": "string",
      "provinceName": "string",
      "provinceShortValue": "string"
    }
  ]
}

Error Responses

Code: 400 Bad Request

Code: 401 Unauthorized

Code: 403 Forbidden

Code: 404 Not Found

TrustArc · Hub API — PUT /api/hub/external-integration/business-processes/external-id/{externalId}/it-system-entities · support.trustarc.com

Search

Add/Remove Business Process IT System Entities by External ID