-
Notifications
You must be signed in to change notification settings - Fork 2
Reference Generated MCP Tools Context
Input schemas for the 126 context tools. The index of every module is in mcp-tools.md; a live server answers the same thing authoritatively through the tools/list JSON-RPC method.
List the lifecycle transitions the caller may perform on a activity from its current state.
Requires context.activity.read.
| Parameter | Type | Required | Description |
|---|---|---|---|
id |
string |
yes | UUID of the object |
Create or upsert multiple activitys in one call (max 500). Non-atomic: valid items are applied even if others fail. Pass 'match_on' (a list of field names, e.g. ["name"]) to make the call idempotent: each item whose match_on values already exist is UPDATED in place instead of duplicated, so a failed import can be safely replayed. Returns per-item status (created / updated / error) with created, updated and error counts.
Requires context.activity.create.
| Parameter | Type | Required | Description |
|---|---|---|---|
items |
array |
yes | Array of activity objects to create or upsert (max 500). |
match_on |
array |
- | Optional business key: list of writable field names used to find an existing record (e.g. ["name"]). When an item matches, it is updated; otherwise it is created. Omit for create-only behaviour. Many-to-many fields are not allowed. |
Create or upsert multiple expectations in one call (max 500). Non-atomic: valid items are applied even if others fail. Pass 'match_on' (a list of field names, e.g. ["name"]) to make the call idempotent: each item whose match_on values already exist is UPDATED in place instead of duplicated, so a failed import can be safely replayed. Returns per-item status (created / updated / error) with created, updated and error counts.
Requires context.expectation.create.
| Parameter | Type | Required | Description |
|---|---|---|---|
items |
array |
yes | Array of expectation objects to create or upsert (max 500). |
match_on |
array |
- | Optional business key: list of writable field names used to find an existing record (e.g. ["name"]). When an item matches, it is updated; otherwise it is created. Omit for create-only behaviour. Many-to-many fields are not allowed. |
Create or upsert multiple indicator measurements in one call (max 500). Non-atomic: valid items are applied even if others fail. Pass 'match_on' (a list of field names, e.g. ["name"]) to make the call idempotent: each item whose match_on values already exist is UPDATED in place instead of duplicated, so a failed import can be safely replayed. Returns per-item status (created / updated / error) with created, updated and error counts.
Requires context.indicator.create.
| Parameter | Type | Required | Description |
|---|---|---|---|
items |
array |
yes | Array of indicator measurement objects to create or upsert (max 500). |
match_on |
array |
- | Optional business key: list of writable field names used to find an existing record (e.g. ["name"]). When an item matches, it is updated; otherwise it is created. Omit for create-only behaviour. Many-to-many fields are not allowed. |
Create or upsert multiple indicators in one call (max 500). Non-atomic: valid items are applied even if others fail. Pass 'match_on' (a list of field names, e.g. ["name"]) to make the call idempotent: each item whose match_on values already exist is UPDATED in place instead of duplicated, so a failed import can be safely replayed. Returns per-item status (created / updated / error) with created, updated and error counts.
Requires context.indicator.create.
| Parameter | Type | Required | Description |
|---|---|---|---|
items |
array |
yes | Array of indicator objects to create or upsert (max 500). |
match_on |
array |
- | Optional business key: list of writable field names used to find an existing record (e.g. ["name"]). When an item matches, it is updated; otherwise it is created. Omit for create-only behaviour. Many-to-many fields are not allowed. |
Create or upsert multiple issues in one call (max 500). Non-atomic: valid items are applied even if others fail. Pass 'match_on' (a list of field names, e.g. ["name"]) to make the call idempotent: each item whose match_on values already exist is UPDATED in place instead of duplicated, so a failed import can be safely replayed. Returns per-item status (created / updated / error) with created, updated and error counts.
Requires context.issue.create.
| Parameter | Type | Required | Description |
|---|---|---|---|
items |
array |
yes | Array of issue objects to create or upsert (max 500). |
match_on |
array |
- | Optional business key: list of writable field names used to find an existing record (e.g. ["name"]). When an item matches, it is updated; otherwise it is created. Omit for create-only behaviour. Many-to-many fields are not allowed. |
Create or upsert multiple objectives in one call (max 500). Non-atomic: valid items are applied even if others fail. Pass 'match_on' (a list of field names, e.g. ["name"]) to make the call idempotent: each item whose match_on values already exist is UPDATED in place instead of duplicated, so a failed import can be safely replayed. Returns per-item status (created / updated / error) with created, updated and error counts.
Requires context.objective.create.
| Parameter | Type | Required | Description |
|---|---|---|---|
items |
array |
yes | Array of objective objects to create or upsert (max 500). |
match_on |
array |
- | Optional business key: list of writable field names used to find an existing record (e.g. ["name"]). When an item matches, it is updated; otherwise it is created. Omit for create-only behaviour. Many-to-many fields are not allowed. |
Create or upsert multiple responsibilitys in one call (max 500). Non-atomic: valid items are applied even if others fail. Pass 'match_on' (a list of field names, e.g. ["name"]) to make the call idempotent: each item whose match_on values already exist is UPDATED in place instead of duplicated, so a failed import can be safely replayed. Returns per-item status (created / updated / error) with created, updated and error counts.
Requires context.role.create.
| Parameter | Type | Required | Description |
|---|---|---|---|
items |
array |
yes | Array of responsibility objects to create or upsert (max 500). |
match_on |
array |
- | Optional business key: list of writable field names used to find an existing record (e.g. ["name"]). When an item matches, it is updated; otherwise it is created. Omit for create-only behaviour. Many-to-many fields are not allowed. |
Create or upsert multiple roles in one call (max 500). Non-atomic: valid items are applied even if others fail. Pass 'match_on' (a list of field names, e.g. ["name"]) to make the call idempotent: each item whose match_on values already exist is UPDATED in place instead of duplicated, so a failed import can be safely replayed. Returns per-item status (created / updated / error) with created, updated and error counts.
Requires context.role.create.
| Parameter | Type | Required | Description |
|---|---|---|---|
items |
array |
yes | Array of role objects to create or upsert (max 500). |
match_on |
array |
- | Optional business key: list of writable field names used to find an existing record (e.g. ["name"]). When an item matches, it is updated; otherwise it is created. Omit for create-only behaviour. Many-to-many fields are not allowed. |
Create or upsert multiple scopes in one call (max 500). Non-atomic: valid items are applied even if others fail. Pass 'match_on' (a list of field names, e.g. ["name"]) to make the call idempotent: each item whose match_on values already exist is UPDATED in place instead of duplicated, so a failed import can be safely replayed. Returns per-item status (created / updated / error) with created, updated and error counts.
Requires context.scope.create.
| Parameter | Type | Required | Description |
|---|---|---|---|
items |
array |
yes | Array of scope objects to create or upsert (max 500). |
match_on |
array |
- | Optional business key: list of writable field names used to find an existing record (e.g. ["name"]). When an item matches, it is updated; otherwise it is created. Omit for create-only behaviour. Many-to-many fields are not allowed. |
Create or upsert multiple sites in one call (max 500). Non-atomic: valid items are applied even if others fail. Pass 'match_on' (a list of field names, e.g. ["name"]) to make the call idempotent: each item whose match_on values already exist is UPDATED in place instead of duplicated, so a failed import can be safely replayed. Returns per-item status (created / updated / error) with created, updated and error counts.
Requires context.site.create.
| Parameter | Type | Required | Description |
|---|---|---|---|
items |
array |
yes | Array of site objects to create or upsert (max 500). |
match_on |
array |
- | Optional business key: list of writable field names used to find an existing record (e.g. ["name"]). When an item matches, it is updated; otherwise it is created. Omit for create-only behaviour. Many-to-many fields are not allowed. |
Create or upsert multiple stakeholders in one call (max 500). Non-atomic: valid items are applied even if others fail. Pass 'match_on' (a list of field names, e.g. ["name"]) to make the call idempotent: each item whose match_on values already exist is UPDATED in place instead of duplicated, so a failed import can be safely replayed. Returns per-item status (created / updated / error) with created, updated and error counts.
Requires context.stakeholder.create.
| Parameter | Type | Required | Description |
|---|---|---|---|
items |
array |
yes | Array of stakeholder objects to create or upsert (max 500). |
match_on |
array |
- | Optional business key: list of writable field names used to find an existing record (e.g. ["name"]). When an item matches, it is updated; otherwise it is created. Omit for create-only behaviour. Many-to-many fields are not allowed. |
Create or upsert multiple swot analysiss in one call (max 500). Non-atomic: valid items are applied even if others fail. Pass 'match_on' (a list of field names, e.g. ["name"]) to make the call idempotent: each item whose match_on values already exist is UPDATED in place instead of duplicated, so a failed import can be safely replayed. Returns per-item status (created / updated / error) with created, updated and error counts.
Requires context.swot.create.
| Parameter | Type | Required | Description |
|---|---|---|---|
items |
array |
yes | Array of swot analysis objects to create or upsert (max 500). |
match_on |
array |
- | Optional business key: list of writable field names used to find an existing record (e.g. ["name"]). When an item matches, it is updated; otherwise it is created. Omit for create-only behaviour. Many-to-many fields are not allowed. |
Create or upsert multiple swot items in one call (max 500). Non-atomic: valid items are applied even if others fail. Pass 'match_on' (a list of field names, e.g. ["name"]) to make the call idempotent: each item whose match_on values already exist is UPDATED in place instead of duplicated, so a failed import can be safely replayed. Returns per-item status (created / updated / error) with created, updated and error counts.
Requires context.swot.create.
| Parameter | Type | Required | Description |
|---|---|---|---|
items |
array |
yes | Array of swot item objects to create or upsert (max 500). |
match_on |
array |
- | Optional business key: list of writable field names used to find an existing record (e.g. ["name"]). When an item matches, it is updated; otherwise it is created. Omit for create-only behaviour. Many-to-many fields are not allowed. |
Create or upsert multiple swot strategys in one call (max 500). Non-atomic: valid items are applied even if others fail. Pass 'match_on' (a list of field names, e.g. ["name"]) to make the call idempotent: each item whose match_on values already exist is UPDATED in place instead of duplicated, so a failed import can be safely replayed. Returns per-item status (created / updated / error) with created, updated and error counts.
Requires context.swot.create.
| Parameter | Type | Required | Description |
|---|---|---|---|
items |
array |
yes | Array of swot strategy objects to create or upsert (max 500). |
match_on |
array |
- | Optional business key: list of writable field names used to find an existing record (e.g. ["name"]). When an item matches, it is updated; otherwise it is created. Omit for create-only behaviour. Many-to-many fields are not allowed. |
Create a new activity
Requires context.activity.create.
| Parameter | Type | Required | Description |
|---|---|---|---|
name |
string |
yes | name |
description |
string |
- | Description (HTML rich text) |
type |
string |
yes | Activity type. |
criticality |
string |
yes | Criticality level. |
owner_id |
string |
yes | UUID of the activity owner (user) |
status |
string |
- | Activity status. |
parent_activity_id |
string |
- | Parent activity UUID (must share at least one scope). |
scope_ids |
array |
- | List of scope UUIDs this activity belongs to (RG-01). |
related_stakeholder_ids |
array |
- | Stakeholders involved in this activity. |
related_objective_ids |
array |
- | Objectives this activity contributes to. |
linked_essential_asset_ids |
array |
- | Essential assets supporting this activity (uses the reverse manager of EssentialAsset.related_activities). |
created_at |
string |
- | Optional ISO 8601 date-time to preserve from a legacy system on bulk import (e.g. 2023-05-12T09:00:00Z). Requires the 'system.data_import.override_dates' permission; ignored without it. |
updated_at |
string |
- | Optional ISO 8601 date-time to preserve from a legacy system on bulk import (e.g. 2023-05-12T09:00:00Z). Requires the 'system.data_import.override_dates' permission; ignored without it. |
Create a new expectation
Requires context.expectation.create.
| Parameter | Type | Required | Description |
|---|---|---|---|
description |
string |
yes | Description (HTML rich text) |
type |
string |
yes | Expectation type. |
priority |
string |
yes | Priority level. |
stakeholder_id |
string |
yes | stakeholder_id |
created_at |
string |
- | Optional ISO 8601 date-time to preserve from a legacy system on bulk import (e.g. 2023-05-12T09:00:00Z). Requires the 'system.data_import.override_dates' permission; ignored without it. |
updated_at |
string |
- | Optional ISO 8601 date-time to preserve from a legacy system on bulk import (e.g. 2023-05-12T09:00:00Z). Requires the 'system.data_import.override_dates' permission; ignored without it. |
Create a new indicator
Requires context.indicator.create.
| Parameter | Type | Required | Description |
|---|---|---|---|
name |
string |
yes | name |
description |
string |
- | Description (HTML rich text) |
indicator_type |
string |
yes | Indicator type. |
collection_method |
string |
- | Data collection method. |
format |
string |
yes | Indicator format. |
unit |
string |
- | unit |
expected_level |
string |
- | expected_level |
critical_threshold_operator |
string |
- | Critical threshold operator. |
critical_threshold_value |
string |
- | critical_threshold_value |
critical_threshold_min |
string |
- | critical_threshold_min |
critical_threshold_max |
string |
- | critical_threshold_max |
review_frequency |
string |
yes | Review frequency. |
first_review_date |
string |
yes | First review date (ISO 8601, e.g. 2026-06-30). Required. |
status |
string |
- | Indicator status. |
is_internal |
boolean |
- | Whether this is an internal predefined indicator. |
internal_source |
string |
- | Predefined indicator source (only for internal indicators). |
internal_source_parameter |
string |
- | internal_source_parameter |
owner_id |
string |
- | UUID of the user accountable for measuring and reviewing this indicator. |
scope_ids |
array |
- | Scopes this indicator belongs to. |
linked_objective_ids |
array |
- | Objectives this indicator measures progress against (ISO 27001 §6.2 / §9.1). |
linked_requirement_ids |
array |
- | Compliance requirements this indicator measures the satisfaction of. |
created_at |
string |
- | Optional ISO 8601 date-time to preserve from a legacy system on bulk import (e.g. 2023-05-12T09:00:00Z). Requires the 'system.data_import.override_dates' permission; ignored without it. |
updated_at |
string |
- | Optional ISO 8601 date-time to preserve from a legacy system on bulk import (e.g. 2023-05-12T09:00:00Z). Requires the 'system.data_import.override_dates' permission; ignored without it. |
Create a new indicator measurement
Requires context.indicator.create.
| Parameter | Type | Required | Description |
|---|---|---|---|
indicator_id |
string |
yes | UUID of the indicator this measurement belongs to (required). |
value |
string |
yes | Measured value (number or boolean as string). |
recorded_at |
string |
- | Measurement timestamp (ISO 8601). Defaults to the current time if omitted; backdate historical measurements by passing an earlier datetime. |
recorded_by_id |
string |
- | UUID of the user recording the measurement. |
notes |
string |
- | Free-form notes. |
Create a new issue
Requires context.issue.create.
| Parameter | Type | Required | Description |
|---|---|---|---|
name |
string |
yes | name |
description |
string |
- | Description (HTML rich text) |
type |
string |
yes | Issue type. |
category |
string |
yes | Issue category. |
impact_level |
string |
yes | Impact level. |
trend |
string |
- | Issue trend over time. |
source |
string |
- | Where the issue was identified (PESTEL workshop, audit, etc.). |
review_date |
string |
- | Next review date (YYYY-MM-DD). |
status |
string |
- | Issue status. |
scope_ids |
array |
- | List of scope UUIDs this issue belongs to (RG-01). |
related_stakeholder_ids |
array |
- | List of stakeholder UUIDs related to this issue. |
created_at |
string |
- | Optional ISO 8601 date-time to preserve from a legacy system on bulk import (e.g. 2023-05-12T09:00:00Z). Requires the 'system.data_import.override_dates' permission; ignored without it. |
updated_at |
string |
- | Optional ISO 8601 date-time to preserve from a legacy system on bulk import (e.g. 2023-05-12T09:00:00Z). Requires the 'system.data_import.override_dates' permission; ignored without it. |
Create a new objective
Requires context.objective.create.
| Parameter | Type | Required | Description |
|---|---|---|---|
name |
string |
yes | name |
description |
string |
- | Description (HTML rich text) |
category |
string |
yes | Objective category. |
type |
string |
yes | Objective type. |
target_value |
string |
- | Target value (free-form, e.g. '95%' or '< 30 days') |
current_value |
string |
- | Current value (free-form, same format as target_value) |
unit |
string |
- | Unit of measure (e.g. '%', 'days') |
measurement_method |
string |
- | How the objective is measured. |
measurement_frequency |
string |
- | How often the objective is measured. |
status |
string |
- | Objective status. To set 'achieved' you must also pass progress_percentage=100. |
progress_percentage |
integer |
- | Progress percentage (0-100). Required to be 100 when status=achieved. |
target_date |
string |
- | Target date (ISO 8601, e.g. 2025-12-31) |
owner_id |
string |
yes | UUID of the objective owner (user) |
parent_objective_id |
string |
- | Parent objective UUID (for objective hierarchies). |
review_date |
string |
- | Next review date (ISO 8601). |
scope_ids |
array |
- | List of scope UUIDs this objective belongs to (RG-01). |
related_issue_ids |
array |
- | List of issue UUIDs addressed by this objective. |
related_stakeholder_ids |
array |
- | List of stakeholder UUIDs related to this objective. |
created_at |
string |
- | Optional ISO 8601 date-time to preserve from a legacy system on bulk import (e.g. 2023-05-12T09:00:00Z). Requires the 'system.data_import.override_dates' permission; ignored without it. |
updated_at |
string |
- | Optional ISO 8601 date-time to preserve from a legacy system on bulk import (e.g. 2023-05-12T09:00:00Z). Requires the 'system.data_import.override_dates' permission; ignored without it. |
Create a new responsibility
Requires context.role.create.
| Parameter | Type | Required | Description |
|---|---|---|---|
role_id |
string |
yes | role_id |
description |
string |
yes | Description (HTML rich text) |
raci_type |
string |
yes | RACI responsibility type. |
related_activity_id |
string |
- | related_activity_id |
created_at |
string |
- | Optional ISO 8601 date-time to preserve from a legacy system on bulk import (e.g. 2023-05-12T09:00:00Z). Requires the 'system.data_import.override_dates' permission; ignored without it. |
updated_at |
string |
- | Optional ISO 8601 date-time to preserve from a legacy system on bulk import (e.g. 2023-05-12T09:00:00Z). Requires the 'system.data_import.override_dates' permission; ignored without it. |
Create a new role
Requires context.role.create.
| Parameter | Type | Required | Description |
|---|---|---|---|
name |
string |
yes | name |
description |
string |
- | Description (HTML rich text) |
type |
string |
yes | Role type. |
is_mandatory |
boolean |
- | Whether this role is mandatory (enables the 'mandatory role without assigned user' compliance alert). |
source_standard |
string |
- | Standard or regulation that requires this role (e.g. 'ISO 27001:2022 §5.3'). |
status |
string |
- | Role status. |
scope_ids |
array |
- | List of scope UUIDs this role belongs to (RG-01). |
assigned_user_ids |
array |
- | UUIDs of users assigned to this role. |
created_at |
string |
- | Optional ISO 8601 date-time to preserve from a legacy system on bulk import (e.g. 2023-05-12T09:00:00Z). Requires the 'system.data_import.override_dates' permission; ignored without it. |
updated_at |
string |
- | Optional ISO 8601 date-time to preserve from a legacy system on bulk import (e.g. 2023-05-12T09:00:00Z). Requires the 'system.data_import.override_dates' permission; ignored without it. |
Create a new scope
Requires context.scope.create.
| Parameter | Type | Required | Description |
|---|---|---|---|
name |
string |
yes | name |
description |
string |
- | Description (HTML rich text) |
icon |
string |
- | Bootstrap Icons class (e.g. bi-building, bi-globe). |
boundaries |
string |
- | Boundaries and exclusions (HTML rich text) |
justification_exclusions |
string |
- | Justification for exclusions (HTML rich text) |
geographic_scope |
string |
- | Geographic scope (HTML rich text) |
organizational_scope |
string |
- | Organizational scope (HTML rich text) |
technical_scope |
string |
- | Technical scope (HTML rich text) |
effective_date |
string |
- | Effective date (ISO 8601, e.g. 2025-01-15) |
review_date |
string |
- | Review date (ISO 8601, e.g. 2025-06-15) |
parent_scope_id |
string |
- | UUID of the parent scope (for nested perimeters). |
manager_ids |
array |
- | List of user UUIDs to assign as scope managers. |
included_site_ids |
array |
- | Sites explicitly included in this scope. |
excluded_site_ids |
array |
- | Sites explicitly excluded from this scope. |
created_at |
string |
- | Optional ISO 8601 date-time to preserve from a legacy system on bulk import (e.g. 2023-05-12T09:00:00Z). Requires the 'system.data_import.override_dates' permission; ignored without it. |
updated_at |
string |
- | Optional ISO 8601 date-time to preserve from a legacy system on bulk import (e.g. 2023-05-12T09:00:00Z). Requires the 'system.data_import.override_dates' permission; ignored without it. |
Create a new site
Requires context.site.create.
| Parameter | Type | Required | Description |
|---|---|---|---|
name |
string |
yes | name |
description |
string |
- | Description (HTML rich text) |
type |
string |
- | Site type. |
address |
string |
- | address |
parent_site_id |
string |
- | UUID of the parent site (for site hierarchies). Cycles are rejected. |
scope_ids |
array |
- | Scopes this site belongs to. |
created_at |
string |
- | Optional ISO 8601 date-time to preserve from a legacy system on bulk import (e.g. 2023-05-12T09:00:00Z). Requires the 'system.data_import.override_dates' permission; ignored without it. |
updated_at |
string |
- | Optional ISO 8601 date-time to preserve from a legacy system on bulk import (e.g. 2023-05-12T09:00:00Z). Requires the 'system.data_import.override_dates' permission; ignored without it. |
Create a new stakeholder
Requires context.stakeholder.create.
| Parameter | Type | Required | Description |
|---|---|---|---|
name |
string |
yes | name |
description |
string |
- | Description (HTML rich text) |
type |
string |
yes | Stakeholder type. |
category |
string |
yes | Stakeholder category. |
contact_name |
string |
- | contact_name |
contact_email |
string |
- | contact_email |
contact_phone |
string |
- | contact_phone |
influence_level |
string |
yes | Influence level. |
interest_level |
string |
yes | Interest level. |
review_date |
string |
- | review_date |
status |
string |
- | Stakeholder status. |
scope_ids |
string |
- | scope_ids |
created_at |
string |
- | Optional ISO 8601 date-time to preserve from a legacy system on bulk import (e.g. 2023-05-12T09:00:00Z). Requires the 'system.data_import.override_dates' permission; ignored without it. |
updated_at |
string |
- | Optional ISO 8601 date-time to preserve from a legacy system on bulk import (e.g. 2023-05-12T09:00:00Z). Requires the 'system.data_import.override_dates' permission; ignored without it. |
Record formal feedback from an interested party (ISO 27001:2022 clause 9.3.2.e).
Requires context.stakeholder_feedback.create.
| Parameter | Type | Required | Description |
|---|---|---|---|
stakeholder_id |
string |
yes | |
channel |
string |
- | survey|meeting|complaint|email|audit|incident|other |
received_date |
string |
yes | |
subject |
string |
yes | |
content |
string |
yes | |
sentiment |
string |
- | |
severity |
string |
- | |
status |
string |
- | |
response |
string |
- | |
scope_ids |
array |
- |
Create a new swot analysis
Requires context.swot.create.
| Parameter | Type | Required | Description |
|---|---|---|---|
name |
string |
yes | name |
description |
string |
- | Description (HTML rich text) |
analysis_date |
string |
yes | Analysis date in ISO 8601 format (e.g. 2025-06-15) |
review_date |
string |
- | Next review date (ISO 8601). |
scope_ids |
array |
- | List of scope UUIDs this SWOT belongs to (RG-01). |
created_at |
string |
- | Optional ISO 8601 date-time to preserve from a legacy system on bulk import (e.g. 2023-05-12T09:00:00Z). Requires the 'system.data_import.override_dates' permission; ignored without it. |
updated_at |
string |
- | Optional ISO 8601 date-time to preserve from a legacy system on bulk import (e.g. 2023-05-12T09:00:00Z). Requires the 'system.data_import.override_dates' permission; ignored without it. |
Create a new swot item
Requires context.swot.create.
| Parameter | Type | Required | Description |
|---|---|---|---|
quadrant |
string |
yes | SWOT quadrant. |
description |
string |
yes | Description (HTML rich text) |
impact_level |
string |
- | Impact level. |
order |
string |
- | order |
swot_analysis_id |
string |
yes | UUID of the parent SWOT analysis |
related_issue_ids |
array |
- | Issues this item connects to. |
related_objective_ids |
array |
- | Objectives this item informs. |
created_at |
string |
- | Optional ISO 8601 date-time to preserve from a legacy system on bulk import (e.g. 2023-05-12T09:00:00Z). Requires the 'system.data_import.override_dates' permission; ignored without it. |
updated_at |
string |
- | Optional ISO 8601 date-time to preserve from a legacy system on bulk import (e.g. 2023-05-12T09:00:00Z). Requires the 'system.data_import.override_dates' permission; ignored without it. |
Create a new swot strategy
Requires context.swot.create.
| Parameter | Type | Required | Description |
|---|---|---|---|
quadrant |
string |
yes | Strategy quadrant. |
description |
string |
yes | Description (HTML rich text) |
order |
string |
- | order |
swot_analysis_id |
string |
yes | UUID of the parent SWOT analysis |
created_at |
string |
- | Optional ISO 8601 date-time to preserve from a legacy system on bulk import (e.g. 2023-05-12T09:00:00Z). Requires the 'system.data_import.override_dates' permission; ignored without it. |
updated_at |
string |
- | Optional ISO 8601 date-time to preserve from a legacy system on bulk import (e.g. 2023-05-12T09:00:00Z). Requires the 'system.data_import.override_dates' permission; ignored without it. |
Create a tag
Requires context.scope.create.
| Parameter | Type | Required | Description |
|---|---|---|---|
name |
string |
yes | |
color |
string |
- |
Delete a activity
Requires context.activity.delete.
| Parameter | Type | Required | Description |
|---|---|---|---|
id |
string |
yes | UUID of the object |
Delete a expectation
Requires context.expectation.delete.
| Parameter | Type | Required | Description |
|---|---|---|---|
id |
string |
yes | UUID of the object |
Delete a indicator
Requires context.indicator.delete.
| Parameter | Type | Required | Description |
|---|---|---|---|
id |
string |
yes | UUID of the object |
Delete a indicator measurement
Requires context.indicator.delete.
| Parameter | Type | Required | Description |
|---|---|---|---|
id |
string |
yes | UUID of the object |
Delete a issue
Requires context.issue.delete.
| Parameter | Type | Required | Description |
|---|---|---|---|
id |
string |
yes | UUID of the object |
Delete a objective
Requires context.objective.delete.
| Parameter | Type | Required | Description |
|---|---|---|---|
id |
string |
yes | UUID of the object |
Delete a responsibility
Requires context.role.delete.
| Parameter | Type | Required | Description |
|---|---|---|---|
id |
string |
yes | UUID of the object |
Delete a role
Requires context.role.delete.
| Parameter | Type | Required | Description |
|---|---|---|---|
id |
string |
yes | UUID of the object |
Delete a scope
Requires context.scope.delete.
| Parameter | Type | Required | Description |
|---|---|---|---|
id |
string |
yes | UUID of the object |
Delete a site
Requires context.site.delete.
| Parameter | Type | Required | Description |
|---|---|---|---|
id |
string |
yes | UUID of the object |
Delete a stakeholder
Requires context.stakeholder.delete.
| Parameter | Type | Required | Description |
|---|---|---|---|
id |
string |
yes | UUID of the object |
Delete a swot analysis
Requires context.swot.delete.
| Parameter | Type | Required | Description |
|---|---|---|---|
id |
string |
yes | UUID of the object |
Delete a swot item
Requires context.swot.delete.
| Parameter | Type | Required | Description |
|---|---|---|---|
id |
string |
yes | UUID of the object |
Delete a swot strategy
Requires context.swot.delete.
| Parameter | Type | Required | Description |
|---|---|---|---|
id |
string |
yes | UUID of the object |
Delete a tag
Requires context.scope.delete.
| Parameter | Type | Required | Description |
|---|---|---|---|
id |
string |
yes | UUID of the object |
List the lifecycle transitions the caller may perform on a expectation from its current state.
Requires context.expectation.read.
| Parameter | Type | Required | Description |
|---|---|---|---|
id |
string |
yes | UUID of the object |
Get a activity by ID
Requires context.activity.read.
| Parameter | Type | Required | Description |
|---|---|---|---|
id |
string |
yes | UUID of the object |
Return the change history of a activity: field-level diffs, approval events and lifecycle transitions (with comments where recorded) merged into one reverse-chronological timeline.
Requires context.activity.read.
| Parameter | Type | Required | Description |
|---|---|---|---|
id |
string |
yes | UUID of the activity |
limit |
integer |
- | Max entries (default 100, max 500). |
offset |
integer |
- | Entries to skip (pagination). |
Get a expectation by ID
Requires context.expectation.read.
| Parameter | Type | Required | Description |
|---|---|---|---|
id |
string |
yes | UUID of the object |
Return the change history of a expectation: field-level diffs, approval events and lifecycle transitions (with comments where recorded) merged into one reverse-chronological timeline.
Requires context.expectation.read.
| Parameter | Type | Required | Description |
|---|---|---|---|
id |
string |
yes | UUID of the expectation |
limit |
integer |
- | Max entries (default 100, max 500). |
offset |
integer |
- | Entries to skip (pagination). |
Get a indicator by ID
Requires context.indicator.read.
| Parameter | Type | Required | Description |
|---|---|---|---|
id |
string |
yes | UUID of the object |
Return the change history of a indicator: field-level diffs, approval events and lifecycle transitions (with comments where recorded) merged into one reverse-chronological timeline.
Requires context.indicator.read.
| Parameter | Type | Required | Description |
|---|---|---|---|
id |
string |
yes | UUID of the indicator |
limit |
integer |
- | Max entries (default 100, max 500). |
offset |
integer |
- | Entries to skip (pagination). |
Get a indicator measurement by ID
Requires context.indicator.read.
| Parameter | Type | Required | Description |
|---|---|---|---|
id |
string |
yes | UUID of the object |
Get a issue by ID
Requires context.issue.read.
| Parameter | Type | Required | Description |
|---|---|---|---|
id |
string |
yes | UUID of the object |
Return the change history of a issue: field-level diffs, approval events and lifecycle transitions (with comments where recorded) merged into one reverse-chronological timeline.
Requires context.issue.read.
| Parameter | Type | Required | Description |
|---|---|---|---|
id |
string |
yes | UUID of the issue |
limit |
integer |
- | Max entries (default 100, max 500). |
offset |
integer |
- | Entries to skip (pagination). |
Get a objective by ID
Requires context.objective.read.
| Parameter | Type | Required | Description |
|---|---|---|---|
id |
string |
yes | UUID of the object |
Return the change history of a objective: field-level diffs, approval events and lifecycle transitions (with comments where recorded) merged into one reverse-chronological timeline.
Requires context.objective.read.
| Parameter | Type | Required | Description |
|---|---|---|---|
id |
string |
yes | UUID of the objective |
limit |
integer |
- | Max entries (default 100, max 500). |
offset |
integer |
- | Entries to skip (pagination). |
Get a responsibility by ID
Requires context.role.read.
| Parameter | Type | Required | Description |
|---|---|---|---|
id |
string |
yes | UUID of the object |
Return the change history of a responsibility: field-level diffs, approval events and lifecycle transitions (with comments where recorded) merged into one reverse-chronological timeline.
Requires context.role.read.
| Parameter | Type | Required | Description |
|---|---|---|---|
id |
string |
yes | UUID of the responsibility |
limit |
integer |
- | Max entries (default 100, max 500). |
offset |
integer |
- | Entries to skip (pagination). |
Get a role by ID
Requires context.role.read.
| Parameter | Type | Required | Description |
|---|---|---|---|
id |
string |
yes | UUID of the object |
Return the change history of a role: field-level diffs, approval events and lifecycle transitions (with comments where recorded) merged into one reverse-chronological timeline.
Requires context.role.read.
| Parameter | Type | Required | Description |
|---|---|---|---|
id |
string |
yes | UUID of the role |
limit |
integer |
- | Max entries (default 100, max 500). |
offset |
integer |
- | Entries to skip (pagination). |
Get a scope by ID
Requires context.scope.read.
| Parameter | Type | Required | Description |
|---|---|---|---|
id |
string |
yes | UUID of the object |
Return the change history of a scope: field-level diffs, approval events and lifecycle transitions (with comments where recorded) merged into one reverse-chronological timeline.
Requires context.scope.read.
| Parameter | Type | Required | Description |
|---|---|---|---|
id |
string |
yes | UUID of the scope |
limit |
integer |
- | Max entries (default 100, max 500). |
offset |
integer |
- | Entries to skip (pagination). |
Get a site by ID
Requires context.site.read.
| Parameter | Type | Required | Description |
|---|---|---|---|
id |
string |
yes | UUID of the object |
Return the change history of a site: field-level diffs, approval events and lifecycle transitions (with comments where recorded) merged into one reverse-chronological timeline.
Requires context.site.read.
| Parameter | Type | Required | Description |
|---|---|---|---|
id |
string |
yes | UUID of the site |
limit |
integer |
- | Max entries (default 100, max 500). |
offset |
integer |
- | Entries to skip (pagination). |
Get a stakeholder by ID
Requires context.stakeholder.read.
| Parameter | Type | Required | Description |
|---|---|---|---|
id |
string |
yes | UUID of the object |
Return the change history of a stakeholder: field-level diffs, approval events and lifecycle transitions (with comments where recorded) merged into one reverse-chronological timeline.
Requires context.stakeholder.read.
| Parameter | Type | Required | Description |
|---|---|---|---|
id |
string |
yes | UUID of the stakeholder |
limit |
integer |
- | Max entries (default 100, max 500). |
offset |
integer |
- | Entries to skip (pagination). |
Get a swot analysis by ID
Requires context.swot.read.
| Parameter | Type | Required | Description |
|---|---|---|---|
id |
string |
yes | UUID of the object |
Return the change history of a swot analysis: field-level diffs, approval events and lifecycle transitions (with comments where recorded) merged into one reverse-chronological timeline.
Requires context.swot.read.
| Parameter | Type | Required | Description |
|---|---|---|---|
id |
string |
yes | UUID of the swot analysis |
limit |
integer |
- | Max entries (default 100, max 500). |
offset |
integer |
- | Entries to skip (pagination). |
Get a swot item by ID
Requires context.swot.read.
| Parameter | Type | Required | Description |
|---|---|---|---|
id |
string |
yes | UUID of the object |
Return the change history of a swot item: field-level diffs, approval events and lifecycle transitions (with comments where recorded) merged into one reverse-chronological timeline.
Requires context.swot.read.
| Parameter | Type | Required | Description |
|---|---|---|---|
id |
string |
yes | UUID of the swot item |
limit |
integer |
- | Max entries (default 100, max 500). |
offset |
integer |
- | Entries to skip (pagination). |
Get a swot strategy by ID
Requires context.swot.read.
| Parameter | Type | Required | Description |
|---|---|---|---|
id |
string |
yes | UUID of the object |
Return the change history of a swot strategy: field-level diffs, approval events and lifecycle transitions (with comments where recorded) merged into one reverse-chronological timeline.
Requires context.swot.read.
| Parameter | Type | Required | Description |
|---|---|---|---|
id |
string |
yes | UUID of the swot strategy |
limit |
integer |
- | Max entries (default 100, max 500). |
offset |
integer |
- | Entries to skip (pagination). |
List the lifecycle transitions the caller may perform on a indicator from its current state.
Requires context.indicator.read.
| Parameter | Type | Required | Description |
|---|---|---|---|
id |
string |
yes | UUID of the object |
List the lifecycle transitions the caller may perform on a issue from its current state.
Requires context.issue.read.
| Parameter | Type | Required | Description |
|---|---|---|---|
id |
string |
yes | UUID of the object |
List activitys with optional search and filters
Requires context.activity.read.
| Parameter | Type | Required | Description |
|---|---|---|---|
search |
string |
- | Text search query |
limit |
integer |
- | Max items to return (default 25, max 100) |
offset |
integer |
- | Offset for pagination |
type |
string |
- | Filter by type |
criticality |
string |
- | Filter by criticality |
status |
string |
- | Filter by status |
List expectations with optional search and filters
Requires context.expectation.read.
| Parameter | Type | Required | Description |
|---|---|---|---|
search |
string |
- | Text search query |
limit |
integer |
- | Max items to return (default 25, max 100) |
offset |
integer |
- | Offset for pagination |
stakeholder_id |
string |
- | Filter by stakeholder_id |
type |
string |
- | Filter by type |
List indicator measurements with optional search and filters
Requires context.indicator.read.
| Parameter | Type | Required | Description |
|---|---|---|---|
search |
string |
- | Text search query |
limit |
integer |
- | Max items to return (default 25, max 100) |
offset |
integer |
- | Offset for pagination |
indicator_id |
string |
- | Filter by indicator_id |
List indicators with optional search and filters
Requires context.indicator.read.
| Parameter | Type | Required | Description |
|---|---|---|---|
search |
string |
- | Text search query |
limit |
integer |
- | Max items to return (default 25, max 100) |
offset |
integer |
- | Offset for pagination |
indicator_type |
string |
- | Filter by indicator_type |
status |
string |
- | Filter by status |
format |
string |
- | Filter by format |
collection_method |
string |
- | Filter by collection_method |
List issues with optional search and filters
Requires context.issue.read.
| Parameter | Type | Required | Description |
|---|---|---|---|
search |
string |
- | Text search query |
limit |
integer |
- | Max items to return (default 25, max 100) |
offset |
integer |
- | Offset for pagination |
type |
string |
- | Filter by type |
category |
string |
- | Filter by category |
impact_level |
string |
- | Filter by impact_level |
status |
string |
- | Filter by status |
List objectives with optional search and filters
Requires context.objective.read.
| Parameter | Type | Required | Description |
|---|---|---|---|
search |
string |
- | Text search query |
limit |
integer |
- | Max items to return (default 25, max 100) |
offset |
integer |
- | Offset for pagination |
category |
string |
- | Filter by category |
type |
string |
- | Filter by type |
status |
string |
- | Filter by status |
List responsibilitys with optional search and filters
Requires context.role.read.
| Parameter | Type | Required | Description |
|---|---|---|---|
search |
string |
- | Text search query |
limit |
integer |
- | Max items to return (default 25, max 100) |
offset |
integer |
- | Offset for pagination |
role_id |
string |
- | Filter by role_id |
raci_type |
string |
- | Filter by raci_type |
List roles with optional search and filters
Requires context.role.read.
| Parameter | Type | Required | Description |
|---|---|---|---|
search |
string |
- | Text search query |
limit |
integer |
- | Max items to return (default 25, max 100) |
offset |
integer |
- | Offset for pagination |
type |
string |
- | Filter by type |
status |
string |
- | Filter by status |
List scopes with optional search and filters
Requires context.scope.read.
| Parameter | Type | Required | Description |
|---|---|---|---|
search |
string |
- | Text search query |
limit |
integer |
- | Max items to return (default 25, max 100) |
offset |
integer |
- | Offset for pagination |
workflow_state |
string |
- | Filter by workflow_state |
parent_scope_id |
string |
- | Filter by parent_scope_id |
List sites with optional search and filters
Requires context.site.read.
| Parameter | Type | Required | Description |
|---|---|---|---|
search |
string |
- | Text search query |
limit |
integer |
- | Max items to return (default 25, max 100) |
offset |
integer |
- | Offset for pagination |
type |
string |
- | Filter by type |
workflow_state |
string |
- | Filter by workflow_state |
parent_site_id |
string |
- | Filter by parent_site_id |
List formal stakeholder feedback (ISO 27001:2022 clause 9.3.2.e).
Requires context.stakeholder_feedback.read.
| Parameter | Type | Required | Description |
|---|---|---|---|
stakeholder_id |
string |
- | |
status |
string |
- | |
limit |
integer |
- | |
offset |
integer |
- |
List stakeholders with optional search and filters
Requires context.stakeholder.read.
| Parameter | Type | Required | Description |
|---|---|---|---|
search |
string |
- | Text search query |
limit |
integer |
- | Max items to return (default 25, max 100) |
offset |
integer |
- | Offset for pagination |
type |
string |
- | Filter by type |
category |
string |
- | Filter by category |
status |
string |
- | Filter by status |
List swot analysiss with optional search and filters
Requires context.swot.read.
| Parameter | Type | Required | Description |
|---|---|---|---|
search |
string |
- | Text search query |
limit |
integer |
- | Max items to return (default 25, max 100) |
offset |
integer |
- | Offset for pagination |
workflow_state |
string |
- | Filter by workflow_state |
List swot items with optional search and filters
Requires context.swot.read.
| Parameter | Type | Required | Description |
|---|---|---|---|
search |
string |
- | Text search query |
limit |
integer |
- | Max items to return (default 25, max 100) |
offset |
integer |
- | Offset for pagination |
swot_analysis_id |
string |
- | Filter by swot_analysis_id |
quadrant |
string |
- | Filter by quadrant |
List swot strategys with optional search and filters
Requires context.swot.read.
| Parameter | Type | Required | Description |
|---|---|---|---|
search |
string |
- | Text search query |
limit |
integer |
- | Max items to return (default 25, max 100) |
offset |
integer |
- | Offset for pagination |
swot_analysis_id |
string |
- | Filter by swot_analysis_id |
quadrant |
string |
- | Filter by quadrant |
List all tags
Requires context.scope.read.
| Parameter | Type | Required | Description |
|---|---|---|---|
search |
string |
- | |
limit |
integer |
- | Max items to return (default 25, max 100) |
offset |
integer |
- | Offset for pagination |
List the lifecycle transitions the caller may perform on a objective from its current state.
Requires context.objective.read.
| Parameter | Type | Required | Description |
|---|---|---|---|
id |
string |
yes | UUID of the object |
List the lifecycle transitions the caller may perform on a role from its current state.
Requires context.role.read.
| Parameter | Type | Required | Description |
|---|---|---|---|
id |
string |
yes | UUID of the object |
List the lifecycle transitions the caller may perform on a scope from its current state.
Requires context.scope.read.
| Parameter | Type | Required | Description |
|---|---|---|---|
id |
string |
yes | UUID of the object |
List the lifecycle transitions the caller may perform on a site from its current state.
Requires context.site.read.
| Parameter | Type | Required | Description |
|---|---|---|---|
id |
string |
yes | UUID of the object |
List the lifecycle transitions the caller may perform on a stakeholder from its current state.
Requires context.stakeholder.read.
| Parameter | Type | Required | Description |
|---|---|---|---|
id |
string |
yes | UUID of the object |
List the lifecycle transitions the caller may perform on a swot analysis from its current state.
Requires context.swot.read.
| Parameter | Type | Required | Description |
|---|---|---|---|
id |
string |
yes | UUID of the object |
List the lifecycle transitions the caller may perform on a swot item from its current state.
Requires context.swot.read.
| Parameter | Type | Required | Description |
|---|---|---|---|
id |
string |
yes | UUID of the object |
List the lifecycle transitions the caller may perform on a swot strategy from its current state.
Requires context.swot.read.
| Parameter | Type | Required | Description |
|---|---|---|---|
id |
string |
yes | UUID of the object |
Change the lifecycle state of a activity (e.g. draft -> pending -> validated -> archived). The transition is validated against the entity's workflow: required permission, mandatory comment, and side effects (owner notification on submit, validation stamping).
Requires context.activity.read.
| Parameter | Type | Required | Description |
|---|---|---|---|
id |
string |
yes | UUID of the activity |
target_state |
string |
yes | Target lifecycle state code (see _allowed_transitions). |
comment |
string |
- | Comment, mandatory for transitions that require one. |
Change the lifecycle state of a expectation (e.g. draft -> pending -> validated -> archived). The transition is validated against the entity's workflow: required permission, mandatory comment, and side effects (owner notification on submit, validation stamping).
Requires context.expectation.read.
| Parameter | Type | Required | Description |
|---|---|---|---|
id |
string |
yes | UUID of the expectation |
target_state |
string |
yes | Target lifecycle state code (see _allowed_transitions). |
comment |
string |
- | Comment, mandatory for transitions that require one. |
Change the lifecycle state of a indicator (e.g. draft -> pending -> validated -> archived). The transition is validated against the entity's workflow: required permission, mandatory comment, and side effects (owner notification on submit, validation stamping).
Requires context.indicator.read.
| Parameter | Type | Required | Description |
|---|---|---|---|
id |
string |
yes | UUID of the indicator |
target_state |
string |
yes | Target lifecycle state code (see _allowed_transitions). |
comment |
string |
- | Comment, mandatory for transitions that require one. |
Change the lifecycle state of a issue (e.g. draft -> pending -> validated -> archived). The transition is validated against the entity's workflow: required permission, mandatory comment, and side effects (owner notification on submit, validation stamping).
Requires context.issue.read.
| Parameter | Type | Required | Description |
|---|---|---|---|
id |
string |
yes | UUID of the issue |
target_state |
string |
yes | Target lifecycle state code (see _allowed_transitions). |
comment |
string |
- | Comment, mandatory for transitions that require one. |
Change the lifecycle state of a objective (e.g. draft -> pending -> validated -> archived). The transition is validated against the entity's workflow: required permission, mandatory comment, and side effects (owner notification on submit, validation stamping).
Requires context.objective.read.
| Parameter | Type | Required | Description |
|---|---|---|---|
id |
string |
yes | UUID of the objective |
target_state |
string |
yes | Target lifecycle state code (see _allowed_transitions). |
comment |
string |
- | Comment, mandatory for transitions that require one. |
Change the lifecycle state of a role (e.g. draft -> pending -> validated -> archived). The transition is validated against the entity's workflow: required permission, mandatory comment, and side effects (owner notification on submit, validation stamping).
Requires context.role.read.
| Parameter | Type | Required | Description |
|---|---|---|---|
id |
string |
yes | UUID of the role |
target_state |
string |
yes | Target lifecycle state code (see _allowed_transitions). |
comment |
string |
- | Comment, mandatory for transitions that require one. |
Change the lifecycle state of a scope (e.g. draft -> pending -> validated -> archived). The transition is validated against the entity's workflow: required permission, mandatory comment, and side effects (owner notification on submit, validation stamping).
Requires context.scope.read.
| Parameter | Type | Required | Description |
|---|---|---|---|
id |
string |
yes | UUID of the scope |
target_state |
string |
yes | Target lifecycle state code (see _allowed_transitions). |
comment |
string |
- | Comment, mandatory for transitions that require one. |
Change the lifecycle state of a site (e.g. draft -> pending -> validated -> archived). The transition is validated against the entity's workflow: required permission, mandatory comment, and side effects (owner notification on submit, validation stamping).
Requires context.site.read.
| Parameter | Type | Required | Description |
|---|---|---|---|
id |
string |
yes | UUID of the site |
target_state |
string |
yes | Target lifecycle state code (see _allowed_transitions). |
comment |
string |
- | Comment, mandatory for transitions that require one. |
Change the lifecycle state of a stakeholder (e.g. draft -> pending -> validated -> archived). The transition is validated against the entity's workflow: required permission, mandatory comment, and side effects (owner notification on submit, validation stamping).
Requires context.stakeholder.read.
| Parameter | Type | Required | Description |
|---|---|---|---|
id |
string |
yes | UUID of the stakeholder |
target_state |
string |
yes | Target lifecycle state code (see _allowed_transitions). |
comment |
string |
- | Comment, mandatory for transitions that require one. |
Change the lifecycle state of a swot analysis (e.g. draft -> pending -> validated -> archived). The transition is validated against the entity's workflow: required permission, mandatory comment, and side effects (owner notification on submit, validation stamping).
Requires context.swot.read.
| Parameter | Type | Required | Description |
|---|---|---|---|
id |
string |
yes | UUID of the swot analysis |
target_state |
string |
yes | Target lifecycle state code (see _allowed_transitions). |
comment |
string |
- | Comment, mandatory for transitions that require one. |
Change the lifecycle state of a swot item (e.g. draft -> pending -> validated -> archived). The transition is validated against the entity's workflow: required permission, mandatory comment, and side effects (owner notification on submit, validation stamping).
Requires context.swot.read.
| Parameter | Type | Required | Description |
|---|---|---|---|
id |
string |
yes | UUID of the swot item |
target_state |
string |
yes | Target lifecycle state code (see _allowed_transitions). |
comment |
string |
- | Comment, mandatory for transitions that require one. |
Change the lifecycle state of a swot strategy (e.g. draft -> pending -> validated -> archived). The transition is validated against the entity's workflow: required permission, mandatory comment, and side effects (owner notification on submit, validation stamping).
Requires context.swot.read.
| Parameter | Type | Required | Description |
|---|---|---|---|
id |
string |
yes | UUID of the swot strategy |
target_state |
string |
yes | Target lifecycle state code (see _allowed_transitions). |
comment |
string |
- | Comment, mandatory for transitions that require one. |
Update an existing activity
Requires context.activity.update.
| Parameter | Type | Required | Description |
|---|---|---|---|
id |
string |
yes | UUID of the object to update |
name |
string |
- | name |
description |
string |
- | Description (HTML rich text) |
type |
string |
- | Activity type. |
criticality |
string |
- | Criticality level. |
owner_id |
string |
- | UUID of the activity owner (user) |
status |
string |
- | Activity status. |
parent_activity_id |
string |
- | Parent activity UUID (must share at least one scope). |
scope_ids |
array |
- | List of scope UUIDs this activity belongs to (RG-01). |
related_stakeholder_ids |
array |
- | Stakeholders involved in this activity. |
related_objective_ids |
array |
- | Objectives this activity contributes to. |
linked_essential_asset_ids |
array |
- | Essential assets supporting this activity (uses the reverse manager of EssentialAsset.related_activities). |
Update an existing expectation
Requires context.expectation.update.
| Parameter | Type | Required | Description |
|---|---|---|---|
id |
string |
yes | UUID of the object to update |
description |
string |
- | Description (HTML rich text) |
type |
string |
- | Expectation type. |
priority |
string |
- | Priority level. |
stakeholder_id |
string |
- | stakeholder_id |
Update an existing indicator
Requires context.indicator.update.
| Parameter | Type | Required | Description |
|---|---|---|---|
id |
string |
yes | UUID of the object to update |
name |
string |
- | name |
description |
string |
- | Description (HTML rich text) |
indicator_type |
string |
- | Indicator type. |
collection_method |
string |
- | Data collection method. |
format |
string |
- | Indicator format. |
unit |
string |
- | unit |
expected_level |
string |
- | expected_level |
critical_threshold_operator |
string |
- | Critical threshold operator. |
critical_threshold_value |
string |
- | critical_threshold_value |
critical_threshold_min |
string |
- | critical_threshold_min |
critical_threshold_max |
string |
- | critical_threshold_max |
review_frequency |
string |
- | Review frequency. |
first_review_date |
string |
- | First review date (ISO 8601, e.g. 2026-06-30). Required. |
status |
string |
- | Indicator status. |
is_internal |
boolean |
- | Whether this is an internal predefined indicator. |
internal_source |
string |
- | Predefined indicator source (only for internal indicators). |
internal_source_parameter |
string |
- | internal_source_parameter |
owner_id |
string |
- | UUID of the user accountable for measuring and reviewing this indicator. |
scope_ids |
array |
- | Scopes this indicator belongs to. |
linked_objective_ids |
array |
- | Objectives this indicator measures progress against (ISO 27001 §6.2 / §9.1). |
linked_requirement_ids |
array |
- | Compliance requirements this indicator measures the satisfaction of. |
Update an existing indicator measurement
Requires context.indicator.update.
| Parameter | Type | Required | Description |
|---|---|---|---|
id |
string |
yes | UUID of the object to update |
indicator_id |
string |
- | UUID of the indicator this measurement belongs to (required). |
value |
string |
- | Measured value (number or boolean as string). |
recorded_at |
string |
- | Measurement timestamp (ISO 8601). Defaults to the current time if omitted; backdate historical measurements by passing an earlier datetime. |
recorded_by_id |
string |
- | UUID of the user recording the measurement. |
notes |
string |
- | Free-form notes. |
Update an existing issue
Requires context.issue.update.
| Parameter | Type | Required | Description |
|---|---|---|---|
id |
string |
yes | UUID of the object to update |
name |
string |
- | name |
description |
string |
- | Description (HTML rich text) |
type |
string |
- | Issue type. |
category |
string |
- | Issue category. |
impact_level |
string |
- | Impact level. |
trend |
string |
- | Issue trend over time. |
source |
string |
- | Where the issue was identified (PESTEL workshop, audit, etc.). |
review_date |
string |
- | Next review date (YYYY-MM-DD). |
status |
string |
- | Issue status. |
scope_ids |
array |
- | List of scope UUIDs this issue belongs to (RG-01). |
related_stakeholder_ids |
array |
- | List of stakeholder UUIDs related to this issue. |
Update an existing objective
Requires context.objective.update.
| Parameter | Type | Required | Description |
|---|---|---|---|
id |
string |
yes | UUID of the object to update |
name |
string |
- | name |
description |
string |
- | Description (HTML rich text) |
category |
string |
- | Objective category. |
type |
string |
- | Objective type. |
target_value |
string |
- | Target value (free-form, e.g. '95%' or '< 30 days') |
current_value |
string |
- | Current value (free-form, same format as target_value) |
unit |
string |
- | Unit of measure (e.g. '%', 'days') |
measurement_method |
string |
- | How the objective is measured. |
measurement_frequency |
string |
- | How often the objective is measured. |
status |
string |
- | Objective status. To set 'achieved' you must also pass progress_percentage=100. |
progress_percentage |
integer |
- | Progress percentage (0-100). Required to be 100 when status=achieved. |
target_date |
string |
- | Target date (ISO 8601, e.g. 2025-12-31) |
owner_id |
string |
- | UUID of the objective owner (user) |
parent_objective_id |
string |
- | Parent objective UUID (for objective hierarchies). |
review_date |
string |
- | Next review date (ISO 8601). |
scope_ids |
array |
- | List of scope UUIDs this objective belongs to (RG-01). |
related_issue_ids |
array |
- | List of issue UUIDs addressed by this objective. |
related_stakeholder_ids |
array |
- | List of stakeholder UUIDs related to this objective. |
Update an existing responsibility
Requires context.role.update.
| Parameter | Type | Required | Description |
|---|---|---|---|
id |
string |
yes | UUID of the object to update |
role_id |
string |
- | role_id |
description |
string |
- | Description (HTML rich text) |
raci_type |
string |
- | RACI responsibility type. |
related_activity_id |
string |
- | related_activity_id |
Update an existing role
Requires context.role.update.
| Parameter | Type | Required | Description |
|---|---|---|---|
id |
string |
yes | UUID of the object to update |
name |
string |
- | name |
description |
string |
- | Description (HTML rich text) |
type |
string |
- | Role type. |
is_mandatory |
boolean |
- | Whether this role is mandatory (enables the 'mandatory role without assigned user' compliance alert). |
source_standard |
string |
- | Standard or regulation that requires this role (e.g. 'ISO 27001:2022 §5.3'). |
status |
string |
- | Role status. |
scope_ids |
array |
- | List of scope UUIDs this role belongs to (RG-01). |
assigned_user_ids |
array |
- | UUIDs of users assigned to this role. |
Update an existing scope
Requires context.scope.update.
| Parameter | Type | Required | Description |
|---|---|---|---|
id |
string |
yes | UUID of the object to update |
name |
string |
- | name |
description |
string |
- | Description (HTML rich text) |
icon |
string |
- | Bootstrap Icons class (e.g. bi-building, bi-globe). |
boundaries |
string |
- | Boundaries and exclusions (HTML rich text) |
justification_exclusions |
string |
- | Justification for exclusions (HTML rich text) |
geographic_scope |
string |
- | Geographic scope (HTML rich text) |
organizational_scope |
string |
- | Organizational scope (HTML rich text) |
technical_scope |
string |
- | Technical scope (HTML rich text) |
effective_date |
string |
- | Effective date (ISO 8601, e.g. 2025-01-15) |
review_date |
string |
- | Review date (ISO 8601, e.g. 2025-06-15) |
parent_scope_id |
string |
- | UUID of the parent scope (for nested perimeters). |
manager_ids |
array |
- | List of user UUIDs to assign as scope managers. |
included_site_ids |
array |
- | Sites explicitly included in this scope. |
excluded_site_ids |
array |
- | Sites explicitly excluded from this scope. |
Update an existing site
Requires context.site.update.
| Parameter | Type | Required | Description |
|---|---|---|---|
id |
string |
yes | UUID of the object to update |
name |
string |
- | name |
description |
string |
- | Description (HTML rich text) |
type |
string |
- | Site type. |
address |
string |
- | address |
parent_site_id |
string |
- | UUID of the parent site (for site hierarchies). Cycles are rejected. |
scope_ids |
array |
- | Scopes this site belongs to. |
Update an existing stakeholder
Requires context.stakeholder.update.
| Parameter | Type | Required | Description |
|---|---|---|---|
id |
string |
yes | UUID of the object to update |
name |
string |
- | name |
description |
string |
- | Description (HTML rich text) |
type |
string |
- | Stakeholder type. |
category |
string |
- | Stakeholder category. |
contact_name |
string |
- | contact_name |
contact_email |
string |
- | contact_email |
contact_phone |
string |
- | contact_phone |
influence_level |
string |
- | Influence level. |
interest_level |
string |
- | Interest level. |
review_date |
string |
- | review_date |
status |
string |
- | Stakeholder status. |
scope_ids |
string |
- | scope_ids |
Update an existing swot analysis
Requires context.swot.update.
| Parameter | Type | Required | Description |
|---|---|---|---|
id |
string |
yes | UUID of the object to update |
name |
string |
- | name |
description |
string |
- | Description (HTML rich text) |
analysis_date |
string |
- | Analysis date in ISO 8601 format (e.g. 2025-06-15) |
review_date |
string |
- | Next review date (ISO 8601). |
scope_ids |
array |
- | List of scope UUIDs this SWOT belongs to (RG-01). |
Update an existing swot item
Requires context.swot.update.
| Parameter | Type | Required | Description |
|---|---|---|---|
id |
string |
yes | UUID of the object to update |
quadrant |
string |
- | SWOT quadrant. |
description |
string |
- | Description (HTML rich text) |
impact_level |
string |
- | Impact level. |
order |
string |
- | order |
swot_analysis_id |
string |
- | UUID of the parent SWOT analysis |
related_issue_ids |
array |
- | Issues this item connects to. |
related_objective_ids |
array |
- | Objectives this item informs. |
Update an existing swot strategy
Requires context.swot.update.
| Parameter | Type | Required | Description |
|---|---|---|---|
id |
string |
yes | UUID of the object to update |
quadrant |
string |
- | Strategy quadrant. |
description |
string |
- | Description (HTML rich text) |
order |
string |
- | order |
swot_analysis_id |
string |
- | UUID of the parent SWOT analysis |
Built from docs/ at v0.36.0. Edits made here are overwritten by the next release : open a pull request against the source instead.
- Administration
- Ask Cairn
- Assets and suppliers
- Compliance
- The dashboard
- Finding your way
- Getting started
- Incidents
- How records move
- Organisational context
- Reports and management review
- Risks
- Trust Center
- Architecture
- Configuration
- Contributing
- The documentation system
- Installation
- Internationalisation
- Operations
- Release process
- Security
- Testing
- Adding an assistant provider
- Adding a dashboard widget
- Adding a domain entity
- Declaring a lifecycle
- Adding an MCP tool
- Adding a REST endpoint
- Adding a report
- Interface conventions
- Dashboard widgets
- Lifecycles
- MCP tools
- MCP tool parameters : Assets
- MCP tool parameters : Compliance
- MCP tool parameters : Governance and context
- MCP tool parameters : General
- MCP tool parameters : Incidents
- MCP tool parameters : Reports and management review
- MCP tool parameters : Risks
- MCP tool parameters : System and administration
- MCP tool parameters : Trust Center
- Management commands
- Models
- Permissions
- REST endpoints
- Environment variables
- MCP server
- REST API
- Assistant module (Ask Cairn)
- Module 0: User Management and Access Control
- Module 1: Context and Organization
- Module 2: Asset Management
- Module 3: Compliance
- Module 4: Risk Management
- Module 4 bis - EBIOS Risk Manager
- Module 5 : Trust Center
- Module 6 : Security Incident Management
- Management review : ISO 27001:2022 compliance (clause 9.3)