v1

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

Link Controls

Use this API to link an existing control to one or multiple related controls in the Controls Library.

post/api/controls/v1/links/bulk

Request body

linkTypeNameKeystring required

Specifies the relationship type key

parametersobject

Custom Parameters for domain specific processing

Example request

{
  "source": {
    "id": "1a2b3c4e-5f6g-7h8i-9j0k-1l2m3n4o5p6q",
    "type": "Control",
    "name": "Information security policy",
    "orgGroupId": "1a2b3c4e-5f6g-7h8i-9j0k-1l2m3n4o5pe3"
  },
  "destinations": [
    {
      "id": "1a2b3c4e-5f6g-7h8i-9j0k-1l2m3n4o5p6q",
      "type": "Control",
      "name": "Information security policy",
      "orgGroupId": "1a2b3c4e-5f6g-7h8i-9j0k-1l2m3n4o5pe3"
    }
  ],
  "linkTypeNameKey": "RelatedControl"
}

Response

Created

idstring uuid

Link Information Identifier

sourceIdstring uuid

Link Information Source Identifier

sourceTypestring

Link Information Source Type

destinationIdstring uuid

Link Information Destination Identifier

destinationTypestring

Link Information Destination Type

destinationNamestring

Link Information Destination Name

destinationOrgGroupIdstring uuid

Link Information Destination Organization Group Identifier