Sign in
Control Implementations

Get List of Control Implementations by Entity

Use this API to retrieve a list of all control implementations by entity, such as by assets, processing activities, legal entities, risks, and vendors.

post/api/controls/v1/entities/{entityId}/control-implementations/pages

Path parameters

entityIdstring uuid required

ID of the entity. This value can be obtained using Get Control Implementation API.

Query parameters

pageinteger

Results page to be retrieved (0..N)

sizeinteger

Number of records per page

sort'number,asc' | 'number,desc' | 'entityName,asc' | 'entityName,desc' | 'entityType,asc' | 'entityType,desc' | 'controlIdentifier,asc' | 'controlIdentifier,desc' | 'controlName,asc' | 'controlName,desc' | 'frameworkName,asc' | 'frameworkName,desc' | 'categoryName,asc' | 'categoryName,desc' | 'effectiveness,asc' | 'effectiveness,desc' | 'maturityName,asc' | 'maturityName,desc' | 'status,asc' | 'status,desc' | 'primaryEntityName,asc' | 'primaryEntityName,desc' | 'primaryEntityType,asc' | 'primaryEntityType,desc' | 'createdDate,asc' | 'createdDate,desc' | 'lastModifiedDate,asc' | 'lastModifiedDate,desc'

Sorting criteria in the format: property(,asc|desc). Default sort order is ascending

Request body

TechRiskComplianceITRiskManagementSearchCriteriaInformation required— unresolved $ref

Response

OK

emptyboolean

The flag to check if the entity is empty or not.

firstboolean

The flag to check if the entity is first entity or not.

lastboolean

The flag to check if the entity is last entity or not.

numberinteger

The number associated with the result.

numberOfElementsinteger

Total number of elements in the result.

totalPagesinteger

Total number of pages in the result list.

totalElementsinteger

Total number of elements in the result.

sizeinteger

Size of the result list.

Example response

{
  "content": [
    {
      "id": "1a2b3c4e-5f6g-7h8i-9j0k-1l2m3n4o5p6q",
      "implementationId": "1a2b3c4e-5f6g-7h8i-9j0k-1l2m3n4o5p6q",
      "number": 1,
      "organizationId": "1a2b3c4e-5f6g-7h8i-9j0k-1l2m3n4o5p6q",
      "control": {
        "id": "1a2b3c4e-5f6g-7h8i-9j0k-1l2m3n4o5p6q",
        "identifier": "A.5.1.1",
        "name": "Control Name",
        "description": "Test Controls for Privacy",
        "orgGroupId": "1a2b3c4e-5f6g-7h8i-9j0k-1l2m3n4o5p6q",
        "orgGroupName": "ABC Corp",
        "frameworkId": "1a2b3c4e-5f6g-7h8i-9j0k-1l2m3n4o5p6q",
        "categoryId": "1a2b3c4e-5f6g-7h8i-9j0k-1l2m3n4o5p6q",
        "categoryName": "Privacy",
        "categoryNameKey": "ControlName",
        "frameworkName": "Framework 123",
        "implementationGuidance": "Implementation guidance of the control requirement."
      },
      "status": "Implemented",
      "statusInfo": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "name": "Entity Name",
        "nameKey": "EntityName"
      },
      "effectiveness": "Effective",
      "effectivenessInfo": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "name": "Entity Name",
        "nameKey": "EntityName"
      },
      "note": "Testing Control",
      "deadline": "2019-01-01",
      "maturity": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "name": "Entity Name",
        "nameKey": "EntityName"
      },
      "owner": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "name": "Entity Name",
        "nameKey": "EntityName"
      },
      "owners": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "name": "Entity Name",
          "nameKey": "EntityName"
        }
      ],
      "approvers": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "name": "Entity Name",
          "nameKey": "EntityName"
        }
      ],
      "createdBy": "123e4567-e89b-12d3-a456-426614174000",
      "createDt": "2019-01-01",
      "lastModifiedBy": "123e4567-e89b-12d3-a456-426614174000",
      "lastModifiedDate": "2019-01-01",
      "suggestion": "Suggested",
      "entity": {
        "id": "1ab2fff0-cb80-b560-99a1-4a3b527f61f5",
        "name": "Asset 305",
        "type": "Risks",
        "controlEntityType": {
          "id": "1a2b3c4e-5f6g-7h8i-9j0k-1l2m3n4o5p6q",
          "label": "Assets",
          "translationKey": "Assets",
          "moduleName": "DataMapping",
          "seeded": true
        },
        "organizationId": "1ab2fff0-cb80-b560-99a1-4a3b527f61f5",
        "relationshipLabel": "IMPLEMENTED_ON",
        "isPrimary": true
      },
      "controlImplementationName": "Control Implementation name",
      "controlImplementationDescription": "Control Implementation Description",
      "controlImplementationGuidance": "Control Implementation Guidance",
      "controlImplementationCategoryId": "Control Implementation Category Id",
      "controlImplementationCategoryName": "Control Category Name",
      "controlImplementationCategoryNameKey": "Control Category Name Key",
      "controlImplementationOrigin": "Control Implementation Origin",
      "externalImplementationURL": "Control Implementation Link",
      "externalControlImplementation": true,
      "relatedEntities": [
        {
          "id": "1a2b3c4e-5f6g-7h8i-9j0k-1l2m3n4o5p6q",
          "sourceId": "1a2b3c4e-5f6g-7h8i-9j0k-1l2m3n4o5p6q",
          "sourceName": "Control name",
          "sourceType": "Control",
          "targetId": "1a2b3c4e-5f6g-7h8i-9j0k-1l2m3n4o5pe3",
          "targetName": "Asset124",
          "targetType": "Assets",
          "organizationId": "1a2b3c4e-5f6g-7h8i-9j0k-1l2m3n4o5p6q",
          "label": "LEVERAGED_BY"
        }
      ],
      "inventoriesCount": 3,
      "risksCount": 1
    }
  ],
  "first": true,
  "numberOfElements": 20,
  "pageable": {
    "pageSize": 20,
    "paged": true,
    "sort": {
      "sorted": true
    }
  },
  "sort": {
    "sorted": true
  },
  "totalPages": 5,
  "totalElements": 50,
  "size": 20
}

Changes