This API returns all Business processes in the Hub.
| Method | GET | ||
| Content-Type | application/json | ||
| URL | api/hub/external-integration/business-processes | ||
Body | Required JSON Parameters | ||
Name | Value | Description | |
| Page | Integer | Results page you want to retrieve (0...N) | |
| Size | Integer | Number of records per page | |
| Sort | As I desc | Sorting criteria in the format: | |
| Sample Curl Request | curl -X GET --header 'Accept: application/json' --header 'Authorization: Bearer <Auth Token> ' /api/hub/business-processes' | ||
| Success Response | Code: 200 | ||
| Sample Success Response | { "content": [ { "accountId": "string", "additionalDataElements": [ { "categoryId": "string", "categoryName": "string", "custom": true, "dataElement": "string", "dataElementCategory": "string", "id": "string", "identifier": "string", "name": "string", "type": "Confidential" } ], "additionalProcessingPurposes": [ "string" ], "contact": { "address": "string", "city": "string", "email": "string", "fullName": "string", "location": { "countryName": "string", "countryRegionName": "string", "countryThreeLetterCode": "string", "countryTwoLetterCode": "string", "globalRegionName": "string", "provinceName": "string", "provinceShortValue": "string", "stateName": "string", "stateShortValue": "string" }, "phone": "string", "role": "string", "zip": "string" }, "created": "2020-08-07T23:20:28.904Z", "dataFlowDataElements": [ { "categoryId": "string", "categoryName": "string", "custom": true, "dataElement": "string", "dataElementCategory": "string", "id": "string", "identifier": "string", "name": "string", "type": "Confidential" } ], "dataFlowProcessingPurposes": [ "string" ], "dataRecipients": [ { "category": "string", "dataRecipientLocations": [ { "countryName": "string", "countryRegionName": "string", "countryThreeLetterCode": "string", "countryTwoLetterCode": "string", "globalRegionName": "string", "provinceName": "string", "provinceShortValue": "string", "stateName": "string", "stateShortValue": "string" } ], "dataRecipientType": "string" } ], "dataRetention": { "dataRetentionType": "Days", "description": "string", "summary": "string", "type": "string", "value": "string" }, "dataSubjectVolumeName": "string", "dataSubjects": [ { "category": "string", "dataSubjectLocations": [ { "countryName": "string", "countryRegionName": "string", "countryThreeLetterCode": "string", "countryTwoLetterCode": "string", "globalRegionName": "string", "provinceName": "string", "provinceShortValue": "string", "stateName": "string", "stateShortValue": "string" } ], "dataSubjectType": "string" } ], "department": "string", "description": "string", "externalDataSource": "string", "externalId": "string", "identifier": "string", "internalId": "string", "itSystems": [ { "accountId": "string", "contact": { "address": "string", "city": "string", "email": "string", "fullName": "string", "location": { "countryName": "string", "countryRegionName": "string", "countryThreeLetterCode": "string", "countryTwoLetterCode": "string", "globalRegionName": "string", "provinceName": "string", "provinceShortValue": "string", "stateName": "string", "stateShortValue": "string" }, "phone": "string", "role": "string", "zip": "string" }, "created": "2020-08-07T23:20:28.904Z", "dataElementObjects": [ { "categoryId": "string", "categoryName": "string", "custom": true, "dataElement": "string", "dataElementCategory": "string", "id": "string", "identifier": "string", "name": "string", "type": "Confidential" } ], "dataElements": [ "string" ], "dataRetention": { "dataRetentionType": "Days", "description": "string", "summary": "string", "type": "string", "value": "string" }, "dataSubjectTypes": [ { "category": "string", "dataSubjectLocations": [ { "countryName": "string", "countryRegionName": "string", "countryThreeLetterCode": "string", "countryTwoLetterCode": "string", "globalRegionName": "string", "provinceName": "string", "provinceShortValue": "string", "stateName": "string", "stateShortValue": "string" } ], "dataSubjectType": "string" } ], "dataSubjectVolumeName": "string", "description": "string", "externalDataSource": "string", "externalId": "string", "identifier": "string", "internalId": "string", "locations": [ { "countryName": "string", "countryRegionName": "string", "countryThreeLetterCode": "string", "countryTwoLetterCode": "string", "globalRegionName": "string", "provinceName": "string", "provinceShortValue": "string", "stateName": "string", "stateShortValue": "string" } ], "name": "string", "notes": "string", "ownedBy": "string", "ownerId": "string", "processingPurposes": [ "string" ], "tags": [ { "groupName": "string", "values": [ "string" ] } ] } ], "locations": [ { "countryName": "string", "countryRegionName": "string", "countryThreeLetterCode": "string", "countryTwoLetterCode": "string", "globalRegionName": "string", "provinceName": "string", "provinceShortValue": "string", "stateName": "string", "stateShortValue": "string" } ], "name": "string", "notes": "string", "otherSecurityControl": "string", "ownerId": "string", "owningCompanyEntity": "string", "processingPurposeLegalBases": [ { "legalBasis": "string", "processingPurpose": "string" } ], "role": "DATA_CONTROLLER", "securityControls": [ "string" ], "status": "string", "tags": [ { "groupName": "string", "values": [ "string" ] } ] } ], "empty": true, "first": true, "last": true, "number": 0, "numberOfElements": 0, "pageable": { "offset": 0, "pageNumber": 0, "pageSize": 0, "paged": true, "sort": { "empty": true, "sorted": true, "unsorted": true }, "unpaged": true }, "size": 0, "sort": { "empty": true, "sorted": true, "unsorted": true }, "totalElements": 0, "totalPages": 0 } | ||
| Error Response | Code: 400 Bad Request Code: 401 Unauthorized Code: 403 Forbidden Code: 404 Not Found | ||