Link existing requirements to a control | Comp AI API

Link existing requirements to a control in Comp AI. Manage controls, map them to policies, tasks, framework requirements, and evidence document types.

POST /v1/controls/{id}/requirements/link

Link existing requirements to a control

cURL

curl --request POST \
  --url https://api.trycomp.ai/v1/controls/{id}/requirements/link \
  --header 'Content-Type: application/json' \
  --data '
{
  "requirements": [
    {
      "frameworkInstanceId": "<string>",
      "requirementId": "<string>",
      "customRequirementId": "<string>"
    }
  ]
}
'

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    requirements: [
      {
        frameworkInstanceId: '<string>',
        requirementId: '<string>',
        customRequirementId: '<string>'
      }
    ]
  })
};

fetch('https://api.trycomp.ai/v1/controls/{id}/requirements/link', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.trycomp.ai/v1/controls/{id}/requirements/link"

payload = { "requirements": [
        {
            "frameworkInstanceId": "<string>",
            "requirementId": "<string>",
            "customRequirementId": "<string>"
        }
    ] }
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

Path Parameters

id · string · required

Body

application/json

requirements · object[] · required

Requirement + framework instance pairs to link

Show child attributes

Response

201 - undefined