Retrieve IT System Using Internal ID

This API returns Company Affiliate for the Internal ID provided.

MethodGET
Content-Typeapplication/json
URLapi/hub/external-integration/it-systems/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/it-systems/internal-id/[internal-id]'
Success ResponseCode: 200
Response Content{
     "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": "enum: Days, Weeks, Months, Years, Other"
       },
       "contacts": [
          { 
             "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"
             }
      ],
      "ownedBy": "string",
      "ownedById": "uuid",
      "dataSubjectVolumeName": "string",
      "externalContacts": [
          {
            "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"
           }
      ],
      "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"
                  }
                ]
            }
      ],
      "dataRecipientTypes": [
           {
              "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"
                   }
                 ]
              }
      ],
      "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