Create a row in an ISMS register

Authorizations

X-API-Key

string

header

required

API key for authentication

Path Parameters

string

required

string

required

Body

application/json

kind

enum<string>

Available options:

internal,

external,

recurring,

milestone

category

string

description

string

effect

string

name

string

needsExpectations

string

interestedPartyId

string

partyName

string

requirement

string

treatment

string

objective

string

target

string

ownerMemberId

string

cadence

string

plan

string

measurementMethod

string

targetDate

string | null

Milestone objectives only: due date (YYYY-MM-DD)

status

enum<string>

Available options:

not_started,

on_track,

at_risk,

met,

planned,

in_progress,

complete,

open,

closed

responsibilities

string

authorities

string

authorityGrantedBy

string

requiredCompetence

string

auditRoute

enum<string> | null

Available options:

in_house,

external,

training_planned

auditRouteMemberId

string | null

auditFirmName

string | null

auditEvidenceRef

string | null

auditCourse

string | null

auditDueDate

string | null

roleId

string

memberId

string

basisOfCompetence

enum<string> | null

Available options:

education,

training,

experience,

combination

evidenceRetained

string | null

gap

string | null

remediationAction

string | null

remediationDueDate

string | null

whatIsMeasured

string

method

string

monitorMemberId

string | null

analyzeMemberId

string | null

unit

enum<string> | null

Available options:

percent,

count,

days,

hours,

minutes

targetKind

enum<string>

Defaults to 'text'. 'structured' requires targetOperator, targetValue and unit.

Available options:

structured,

text

targetOperator

enum<string> | null

Available options:

at_least,

at_most,

exactly

targetValue

number | null

objectiveId

string | null

Deprecated: objectives now take their numbers from a metric, not the reverse.

isActive

boolean

metricId

string | null

Measurements: the metric being recorded. Objectives: the metric the objective inherits its target, cadence and status from (recurring objectives only).

periodStart

string

First day of the covered period (YYYY-MM-DD), aligned to the metric cadence

value

string

note

string | null

scope

string

criteria

string

auditorName

string | null

plannedStartDate

string | null

plannedEndDate

string | null

conclusionVerdict

enum<string> | null

Available options:

conform,

substantially_conform,

not_yet_conform,

suitable,

adequate,

effective

conclusionNotes

string | null

signoffAuditorName

string | null

signoffAuditorDate

string | null

signoffSpoName

string | null

signoffSpoDate

string | null

signoffTopMgmtName

string | null

signoffTopMgmtDate

string | null

auditId

string

controlRef

string

whatWasTested

string

whereToFind

string

result

enum<string> | null

Available options:

conformity_confirmed,

nonconformity_raised,

observation_raised,

not_sampled

notes

string | null

type

enum<string>

Available options:

nc_major,

nc_minor,

ofi,

observation

controlId

string | null

clauseOrControl

string | null

dueDate

string | null

closureEvidence

string | null

meetingDate

string | null

chairName

string | null

attendees

object[]

Attendees frozen at selection (members picked from People)

Show child attributes

decisionsText

string | null

changesText

string | null

signoffChairName

string | null

signoffChairDate

string | null

reviewId

string

inputRef

string

whatItCovers

string

discussionNotes

string | null

discussed

boolean

position

integer

Required range: x >= 0

Response

200

Overview

Reference

Create a row in an ISMS register | Comp AI API

Authorizations

Path Parameters

Body

Response