Sign in

v1

latestOpenAPI 3.1.0Apache 2.02026-07-245981,1853.0 MB
Control Implementations

Update Control Implementation

Use this API to update the attributes of a specific control implementation.

🗒 Things to Know

  • The Update Control API can be used to update the attributes of a control in the Controls Library.
put/api/controls/v1/control-implementations/{guid}

Path parameters

guidstring uuid required

ID of the control entity implementation.

Request body

status'Pending' | 'Implemented' | 'NotDoing' | 'Retired' required

New status of implemented control.

effectiveness'Effective' | 'Ineffective' | 'Planned'

Effectiveness of implemented control.

effectivenessIdstring uuid

Identifier of the effectiveness associated with control implementation.

notestring

Notes on implemented control.

deadlinestring date

Deadline associated with the control implementation. Format (yyyy-MM-dd).

controlOwnerIdstring uuid

Identifier (UUID) of the owner of control implementation.

maturityIdstring uuid

Identifier of the maturity associated with control implementation.

statusIdstring uuid

Identifier of the control implementation Status.

attributesobject

Custom Attributes of control implementation.

controlOwnerIdsstring[]

List of Identifier (UUID) of the owners of control implementation.

controlApproverIdsstring[]

List of Identifier (UUID) of the approver of control implementation.

implementationCategoryIdstring uuid

The identifier of the category tied to the control Implementation. Optional if no category needed or if category name provided.

implementationDescriptionstring

Description of the control implementation.

implementationGuidancestring

Implementation Guidance of the control Implementation.

implementationNamestring

The name of the control Implementation.

implementationCategoryNamestring

The name of the category tied to the control Implementation.

Example request

{
  "status": "Pending",
  "effectiveness": "Ineffective",
  "effectivenessId": "123e4567-e89b-12d3-a456-426614174123",
  "note": "Testing Control",
  "deadline": "2019-01-01",
  "controlOwnerId": "123e4567-e89b-12d3-a456-426614174000",
  "maturityId": "123e4567-e89b-12d3-a456-426614174000",
  "statusId": "123e4567-e89b-12d3-a456-426614174000",
  "attributes": {
    "attributeTextValue.value1": [
      {
        "id": "4e9ac165-7304-4c6e-a207-d32f22f4808b",
        "value": "2020-11-12",
        "valueKey": "OneTrustApp.CONTROLS.Control.Attributes.866e5e2d-916f-4ab7-b16f-448c9b44e815"
      }
    ]
  },
  "controlOwnerIds": [
    "123e4567-e89b-12d3-a456-426614174000",
    "456a4567-e89b-12d3-123e-426614174001",
    "123e4567-e89b-12d3-a456-426614174002"
  ],
  "controlApproverIds": [
    "123e4567-e89b-12d3-a456-426614174000",
    "456a4567-e89b-12d3-123e-426614174001",
    "123e4567-e89b-12d3-a456-426614174002"
  ],
  "implementationCategoryId": "123e4567-e89b-12d3-a456-426614174000",
  "implementationDescription": "Testing Control Implementation",
  "implementationGuidance": "Testing Control guidance",
  "implementationName": "Control Implementation",
  "controlOwners": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "User1"
    }
  ],
  "implementationCategoryName": "Implementation Custom Category"
}

Response

OK

idstring uuid required

GUID of Control Implementation.

numberinteger required

Numeric identifier for Control Implementation.

organizationIdstring uuid required

The identifier (GUID) of the organization implementation.

orgGroupNamestring required

Organization name with which control implementation is created.

status'Pending' | 'Implemented' | 'NotDoing' | 'Suggested' required

The status of the control.

suggestion'Suggested' | 'Accepted' | 'Rejected'

The suggestion status of the control. Used by Athena.

effectiveness'Effective' | 'Ineffective' | 'Planned'

The effectiveness of the control.

notestring

Notes used for the control. This is free text to contain any additional details which may be needed.

deadlinestring date

The deadline for the control.

createdBystring uuid

The user or operation the control was created by.

createDtstring date-time

The date on which the control implementation was created.

lastModifiedBystring uuid

The user or process the control was last modified by (GUID).

lastModifiedDatestring date-time

The date the control was last modified.

controlObjectivesCountinteger

count of total control objectives linked.

attributesobject

Implemented Custom Attributes.

deleteType'SOFT'

Control implementation delete type.

controlImplementationNamestring

Control Implementation Name of the implemented control.

controlImplementationDescriptionstring

Control Implementation Description of the implemented control.

controlImplementationGuidancestring

Control Implementation Guidance of the implemented control.

controlImplementationCategoryIdstring uuid

Control Implementation Category of the implemented control.

controlImplementationCategoryNamestring

Control Implementation Category Name of the implemented control.

controlImplementationCategoryNameKeystring

Control Implementation Name of the implemented control.

controlImplementationOriginstring

Control Implementation Origin of the implemented control.

externalImplementationURLstring

External ImplementationURL of the implemented control.

externalControlImplementationboolean

is this an external control implementation.

duplicateEvidenceTaskImplPresentboolean

Duplicate evidence task implementation present.

hasMoreThanOneInvLinksboolean

Implementation has more than one inventory links.

inventoriesCountinteger

Related inventories count.

risksCountinteger

Related risks count.

Example response

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "number": 123,
  "organizationId": "123e4567-e89b-12d3-a456-426614174000",
  "orgGroupName": "Organization1",
  "primaryEntity": {
    "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
  },
  "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",
  "suggestion": "Suggested",
  "effectiveness": "Effective",
  "effectivenessInfo": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "Entity Name",
    "nameKey": "EntityName"
  },
  "note": "Testing control value",
  "deadline": "2020-11-05",
  "maturity": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "Entity Name",
    "nameKey": "EntityName"
  },
  "statusInfo": {
    "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": "1a2b3c4e-5f6g-7h8i-9j0k-1l2m3n4o5p6q",
  "createDt": "2020-11-05T22:01:21.200+00:00",
  "lastModifiedBy": "123e4567-e89b-12d3-a456-426614174001",
  "lastModifiedDate": "2020-11-05T22:01:21.200+00:0",
  "controlObjectivesCount": 4,
  "entityLinks": [
    {
      "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
    }
  ],
  "workflow": {
    "id": "1a2b3c4e-5f6g-7h8i-9j0k-1l2m3n4o5p6q",
    "name": "Entity Name",
    "nameKey": "EntityNameKey"
  },
  "workflowStage": {
    "id": "1a2b3c4e-5f6g-7h8i-9j0k-1l2m3n4o5p6q",
    "name": "Entity Name",
    "nameKey": "EntityNameKey",
    "currentStageApprovers": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174003",
        "firstName": "John",
        "lastName": "Doe",
        "approvedTimeStamp": "2020-11-05T22:01:21.200+00:00",
        "status": "approved"
      }
    ]
  },
  "deleteType": "SOFT",
  "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,
  "duplicateEvidenceTaskImplPresent": true,
  "hasMoreThanOneInvLinks": true,
  "inventoriesCount": 3,
  "risksCount": 1
}