curl --request POST \
--url https://api.trycomp.ai/v1/isms/documents/{id}/registers/{register} \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"name": "<string>",
"memberId": "<string>"
}
'const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({name: '<string>', memberId: '<string>'})
};
fetch('https://api.trycomp.ai/v1/isms/documents/{id}/registers/{register}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.trycomp.ai/v1/isms/documents/{id}/registers/{register}"
payload = {
"name": "<string>",
"memberId": "<string>"
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)Create a row in an ISMS register | Comp AI API
Create a row in an ISMS register in Comp AI. Build and maintain the ISO 27001 ISMS document set — scope, leadership commitment, context, interested parties.
curl --request POST \
--url https://api.trycomp.ai/v1/isms/documents/{id}/registers/{register} \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"name": "<string>",
"memberId": "<string>"
}
'const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({name: '<string>', memberId: '<string>'})
};
fetch('https://api.trycomp.ai/v1/isms/documents/{id}/registers/{register}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.trycomp.ai/v1/isms/documents/{id}/registers/{register}"
payload = {
"name": "<string>",
"memberId": "<string>"
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)Authorizations
API key for authentication
Path Parameters
Which ISMS register the row belongs to.
context-issues, interested-parties, requirements, objectives, roles, role-assignments, metrics, measurements, audits, audit-controls, audit-findings, reviews, review-inputs, review-actions, communications, obligations, key-records, approved-software, nonconformities, business-processes, continuity-playbooks, continuity-contacts, recovery-systems Body
Register row fields (per-register; validated at runtime by zod)
internal, external, recurring, milestone, legal, regulatory, contractual, standard Milestone objectives only: due date (YYYY-MM-DD)
not_started, on_track, at_risk, met, planned, in_progress, complete, open, closed, action_complete, verified_and_closed in_house, external, training_planned education, training, experience, combination percent, count, days, hours, minutes Defaults to 'text'. 'structured' requires targetOperator, targetValue and unit.
structured, text at_least, at_most, exactly Deprecated: objectives now take their numbers from a metric, not the reverse.
Measurements: the metric being recorded. Objectives: the metric the objective inherits its target, cadence and status from (recurring objectives only).
First day of the covered period (YYYY-MM-DD), aligned to the metric cadence
conform, substantially_conform, not_yet_conform, suitable, adequate, effective conformity_confirmed, nonconformity_raised, observation_raised, not_sampled nc_major, nc_minor, ofi, observation, minor_nonconformity, major_nonconformity, improvement_opportunity Attendees frozen at selection (members picked from People)
Show child attributes
Show child attributes
internal, external ISMS role accountable when no member is assigned (e.g. spo, top_management, internal_auditor)
on_joining, on_publication, as_it_happens, monthly, quarterly, annually, on_request, within_statutory_deadline, if_needed, on_joining_and_annually, after_each_audit, on_onboarding_and_as_needed, per_audit_cycle email, slack_or_teams, company_meeting, trust_centre, comp_ai_portal, training_platform, written_notice External rows only: the body name, reporting route and any reference number (A.5.5)
automatic, annually, on_change, on_change_or_annually, on_offboarding, not_rotated Only kept when rotation is not_rotated
ISMS role that holds the key when no member is named (e.g. spo)
Free-text access holder, for answers no picker can express (e.g. "Each individual")
Links the row to a vendor; the name then renders live
end_user_devices, production_systems, both, cloud_service commercial, open_source, free_tier, internal Date the entry was raised (YYYY-MM-DD); defaults to today
internal_audit, external_audit, incident, management_review, control_or_task_failure, customer_or_vendor_issue, other The immediate fix, as opposed to the corrective action
process_not_defined, process_defined_but_not_followed, no_owner_assigned, lack_of_awareness_or_training, tooling_or_system_gap, resource_constraint, one_off_human_error What stops the nonconformity recurring
How effectiveness was confirmed
x >= 0Response
Register row created
Was this page helpful?