Add a Business Process IT System Entity Record by External ID

Overview Endpoint Reference Responses

Overview

The POST /api/hub/external-integration/business-processes/external-id/{externalId}/it-system-entity/{itSystemId} endpoint adds an existing IT System to an existing Business Process, identified by the Business Process's External ID and the IT System's ID.

What you can do

✓Link an existing IT System to an existing Business Process using the Business Process External ID and the IT System ID

✓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)

✓An existing IT System ID (itSystemId)

Endpoint Reference

Method

POST

Content-Type

application/json

URL

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

Required Path Parameters

Name	Value	Description
externalId	String	The External ID of the Business Process to add the IT System to.
itSystemId	String	The ID of the IT System to add to the Business Process.

Sample curl Request

curl -X POST \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer <Auth Token>' \
  'api/hub/business-processes/external-id/{externalId}/it-system-entity/{itSystemId}'

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 — POST /api/hub/external-integration/business-processes/external-id/{externalId}/it-system-entity/{itSystemId}  ·  support.trustarc.com