Update Control Implementation

put

https://{hostname}/api/controls/v1/control-implementations/{guid}

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.

Path Params

guid

uuid

required

ID of the control entity implementation.

Body Params

status

string

enum

required

deprecated

New status of implemented control.

Allowed:

effectiveness

string

enum

deprecated

Effectiveness of implemented control.

Allowed:

effectivenessId

uuid

Identifier of the effectiveness associated with control implementation.

note

string

Notes on implemented control.

deadline

date

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

controlOwnerId

uuid

deprecated

Identifier (UUID) of the owner of control implementation.

maturityId

uuid

Identifier of the maturity associated with control implementation.

statusId

uuid

Identifier of the control implementation Status.

attributes

object

Custom Attributes of control implementation.

controlOwnerIds

array of uuids

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

controlOwnerIds

controlApproverIds

array of uuids

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

controlApproverIds

implementationCategoryId

uuid

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

implementationDescription

string

length between 0 and 3000

Description of the control implementation.

implementationGuidance

string

Implementation Guidance of the control Implementation.

implementationName

string

length between 0 and 300

The name of the control Implementation.

controlOwners

array of objects

List of owners of control implementation.

controlOwners

implementationCategoryName

string

The name of the category tied to the control Implementation.

Responses

400

Bad Request

401

Unauthorized

403

Forbidden

500

Internal Server Error

200OK

429Too Many Requests. For more information, see API Rate Limits.