Search

Retrieve Business Process Using Internal ID

This API call returns a single Business Process based on the Internal ID passed.

MethodGET
Content-Typeapplication/json
URLapi/hub/external-integration/business-processes/internal-id/[internal-
id]

 

Body

Required Query Parameters

Name

Value

Description

internalIdStringInternal ID
PageIntegerResults page you want to retrieve (0...N)
SizeIntegerNumber of records per page
SortAs I descSorting criteria in the format:
Sample Curl Requestcurl -X GET --header 'Accept: application/json' --header
'Authorization: Bearer <Auth Token> '
/api/hub/business-processes/internal-id/[internal-id]'
Success ResponseCode: 200
Response Content

{
.    "internalId": "uuid",
.    "name": "string",
.    "notes": "string",
.    "description": "string",
.    "identifier": "string",
.    "accountId": "uuid",
.    "created": "timestamp",
.    "externalId": "string",
.    "externalDataSource": "string",
.    "locations": [
.        {

             "countryName": "string",
.            "countryTwoLetterCode": "string",
.            "countryThreeLetterCode": "string",
.            "countryRegionName": "string",
.            "globalRegionName": "string",
             "stateName": "string",
             "stateShortValue": "string",
             "provinceName": "string",
             "provinceShortValue": "string"
         }
.    ],
.    "tags": [
.       {
.            "groupName": "string",
             "tagValues": [
                  {
                     "value": "string",
                     "externalId": "string"
                   }
               ]
          }
.    ],
.    "dataRetention": {
.        "value": "string",
.        "description": "string",
.        "summary": "string",
.        "dataRetentionType": "enum: Days, Weeks, Months, Years, Other"
.   },
.   "status": "string",
.   "dataSubjectVolumeName": "string",
.   "securityControls": [
.       "string"
.   ],
.   "otherSecurityControl": "string",
.   "processingPurposeLegalBases": [
.        {
            "processingPurpose": "string",
            "legalBasis": "string"
         }
.    ],
.    "businessProcessOwners": [
.        {
              "department": "string",
              "role": "enum: see Company Roles in Appendix",
              "owningCompanyEntity": "string",
              "owningCompanyEntityId": "uuid",
              "ownerContact": {
                   "fullName": "string",
                   "email": "string",
                   "phone": "string",
                   "address": "string",
                   "city": "string",
                   "location": {
                       "countryName": "string",
                       "countryTwoLetterCode": "string",
                       "countryThreeLetterCode": "string",
                       "countryRegionName": "string",
                       "globalRegionName": "string",
                       "stateName": "string",
                       "stateShortValue": "string",
                       "provinceName": "string",
                       "provinceShortValue": "string"
                    },
                    "zip": "string",
                    "role": "enum: see Contact Roles in Appendix"
              }
          }
     ],
.    "aiUsed": "enum: YES,NO,UNKNOWN,INCOMPLETE",
.    "aiNotes": "string",
.    "dataSubjects": [
         {
             "identifier": "string",
             "dataSubjectType": "string",
             "category": "string",
             "dataSubjectLocations": [
                  {
                       "countryName": "string",
                       "countryTwoLetterCode": "string",
                       "countryThreeLetterCode": "string",
                       "countryRegionName": "string",
                       "globalRegionName": "string",
                       "stateName": "string",
                       "stateShortValue": "string",
                       "provinceName": "string",
                       "provinceShortValue": "string"
                   }
              ]
         }
     ],
.    "dataRecipients": [
          {
             "identifier": "string",
             "category": "string",
             "dataRecipientType": "string",
             "dataRecipientLocations": [
                 {
                     "countryName": "string",
                     "countryTwoLetterCode": "string",
                     "countryThreeLetterCode": "string",
                     "countryRegionName": "string",
                     "globalRegionName": "string",
                     "stateName": "string",
                     "stateShortValue": "string",
                     "provinceName": "string",
                     "provinceShortValue": "string"
                  }
             ]
          }
      ],
.     "itSystems": [
         {
            "internalId": "uuid",
            "name": "string",
            "notes": "string",
            "description": "string",
            "identifier": "string",
            "accountId": "uuid",
            "created": "timestamp",
            "ownerIds": [
                "string"
             ],
             "externalId": "string",
             "externalDataSource": "string",
             "locations": [
                {
                   "countryName": "string",
                   "countryTwoLetterCode": "string",
                   "countryThreeLetterCode": "string",
                   "countryRegionName": "string",
                   "globalRegionName": "string",
                   "stateName": "string",
                   "stateShortValue": "string",
                   "provinceName": "string",
                   "provinceShortValue": "string"
                }
            ],
            "tags": [
                {
                   "groupName": "string",
                   "tagValues": [
                       {
                           "value": "string",
                           "externalId": "string"
                        }
                    ]
                  }
              ],
              "dataRetention": {
                    "value": "string",
                    "description": "string",
                    "summary": "string",
                    "dataRetentionType": "Days"
              },
              "ownedBy": "string",
              "ownedById": "uuid",
              "dataSubjectVolumeName": "string",
              "dataSubjectTypes": [
                   {
                      "identifier": "string",
                      "dataSubjectType": "string",
                      "category": "string",
                      "dataSubjectLocations": [
                           {
                              "countryName": "string",
                              "countryTwoLetterCode": "string",
                              "countryThreeLetterCode": "string",
                              "countryRegionName": "string",
                              "globalRegionName": "string",
                              "stateName": "string",
                              "stateShortValue": "string",
                              "provinceName": "string",
                              "provinceShortValue": "string"
                           }
                      ]
                  }
              ],
              "dataElementObjects": [
                  {
                     "identifier": "string",
                     "dataElement": "string",
                     "dataElementCategory": "string"
                   }
                ],
                "processingPurposeObjects": [
                   {
                      "identifier": "string",
                      "processingPurpose": "string",
                      "processingPurposeCategory": "string"
                    }
                 ],
                 "aiUsed": "enum: YES,NO,UNKNOWN,INCOMPLETE",
                 "aiNotes": "string",
                 "website": "string"
                     }
                  ],
                  "risk": {
                  "calculatedRisk": "MEDIUM",
                  "userEvaluatedRisk": null,
                  "inherentRisk": "MEDIUM_REVIEW",
                  "residualRisk": null,
                  "inherentRiskSeverity": 1,
                  "inherentRiskLikelihood": 3
         }
}

Error Response

Code: 400 Bad Request

Code: 401 Unauthorized

Code: 403 Forbidden

Code: 404 Not Found