API docs by Redocly

CISO Assistant API — Resilience (0.7.0)

Download OpenAPI specification:

CISO Assistant - API Documentation for automating all your GRC needs

asset-assessments

resilience_asset_assessments_list

Override the list method to inject optimized data into the serializer context.

Authorizations:
knoxApiToken
query Parameters
asset
Array of strings <uuid> [ items <uuid > ]
bia
Array of strings <uuid> [ items <uuid > ]
id
Array of strings <uuid> [ items <uuid > ]

Multiple values may be separated by commas.

limit
integer

Number of results to return per page.

offset
integer

The initial index from which to return the results.

ordering
string

Which field to use when ordering the results.

search
string

A search term.

Responses

Response samples

Content type
application/json
{
  • "count": 123,
  • "next": "http://api.example.org/accounts/?offset=400&limit=100",
  • "previous": "http://api.example.org/accounts/?offset=200&limit=100",
  • "results": [
    ]
}

resilience_asset_assessments_create

Authorizations:
knoxApiToken
Request Body schema:
required
is_published
boolean (Published)
recovery_documented
boolean
recovery_tested
boolean
recovery_targets_met
boolean
observation
string or null
folder
string <uuid>
asset
required
string <uuid>
bia
required
string <uuid>
dependencies
Array of strings <uuid> [ items <uuid > ]
associated_controls
Array of strings <uuid> [ items <uuid > ]
evidences
Array of strings <uuid> [ items <uuid > ]

Responses

Request samples

Content type
{
  • "is_published": true,
  • "recovery_documented": true,
  • "recovery_tested": true,
  • "recovery_targets_met": true,
  • "observation": "string",
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
  • "asset": "5a841cf2-3786-47ad-8831-36ccea9ed096",
  • "bia": "231b8138-f3ec-4eab-9c22-c654750b0647",
  • "dependencies": [
    ],
  • "associated_controls": [
    ],
  • "evidences": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "is_published": true,
  • "recovery_documented": true,
  • "recovery_tested": true,
  • "recovery_targets_met": true,
  • "observation": "string",
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
  • "asset": "5a841cf2-3786-47ad-8831-36ccea9ed096",
  • "bia": "231b8138-f3ec-4eab-9c22-c654750b0647",
  • "dependencies": [
    ],
  • "associated_controls": [
    ],
  • "evidences": [
    ]
}

resilience_asset_assessments_retrieve

Return a single object with unauthorized related fields masked.

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this asset assessment.

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "str": "string",
  • "bia": "string",
  • "asset": "string",
  • "asset_ref_id": "string",
  • "asset_folder": "string",
  • "children_assets": [
    ],
  • "folder": "string",
  • "dependencies": [
    ],
  • "evidences": [
    ],
  • "associated_controls": [
    ],
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "is_published": true,
  • "recovery_documented": true,
  • "recovery_tested": true,
  • "recovery_targets_met": true,
  • "observation": "string"
}

resilience_asset_assessments_update

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this asset assessment.

Request Body schema:
required
is_published
boolean (Published)
recovery_documented
boolean
recovery_tested
boolean
recovery_targets_met
boolean
observation
string or null
folder
string <uuid>
asset
required
string <uuid>
bia
required
string <uuid>
dependencies
Array of strings <uuid> [ items <uuid > ]
associated_controls
Array of strings <uuid> [ items <uuid > ]
evidences
Array of strings <uuid> [ items <uuid > ]

Responses

Request samples

Content type
{
  • "is_published": true,
  • "recovery_documented": true,
  • "recovery_tested": true,
  • "recovery_targets_met": true,
  • "observation": "string",
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
  • "asset": "5a841cf2-3786-47ad-8831-36ccea9ed096",
  • "bia": "231b8138-f3ec-4eab-9c22-c654750b0647",
  • "dependencies": [
    ],
  • "associated_controls": [
    ],
  • "evidences": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "is_published": true,
  • "recovery_documented": true,
  • "recovery_tested": true,
  • "recovery_targets_met": true,
  • "observation": "string",
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
  • "asset": "5a841cf2-3786-47ad-8831-36ccea9ed096",
  • "bia": "231b8138-f3ec-4eab-9c22-c654750b0647",
  • "dependencies": [
    ],
  • "associated_controls": [
    ],
  • "evidences": [
    ]
}

resilience_asset_assessments_partial_update

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this asset assessment.

Request Body schema:
is_published
boolean (Published)
recovery_documented
boolean
recovery_tested
boolean
recovery_targets_met
boolean
observation
string or null
folder
string <uuid>
asset
string <uuid>
bia
string <uuid>
dependencies
Array of strings <uuid> [ items <uuid > ]
associated_controls
Array of strings <uuid> [ items <uuid > ]
evidences
Array of strings <uuid> [ items <uuid > ]

Responses

Request samples

Content type
{
  • "is_published": true,
  • "recovery_documented": true,
  • "recovery_tested": true,
  • "recovery_targets_met": true,
  • "observation": "string",
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
  • "asset": "5a841cf2-3786-47ad-8831-36ccea9ed096",
  • "bia": "231b8138-f3ec-4eab-9c22-c654750b0647",
  • "dependencies": [
    ],
  • "associated_controls": [
    ],
  • "evidences": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "is_published": true,
  • "recovery_documented": true,
  • "recovery_tested": true,
  • "recovery_targets_met": true,
  • "observation": "string",
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
  • "asset": "5a841cf2-3786-47ad-8831-36ccea9ed096",
  • "bia": "231b8138-f3ec-4eab-9c22-c654750b0647",
  • "dependencies": [
    ],
  • "associated_controls": [
    ],
  • "evidences": [
    ]
}

resilience_asset_assessments_destroy

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this asset assessment.

Responses

resilience_asset_assessments_cascade_info_retrieve

Cascade preview:

  • deleted: objects actually deleted by cascade
  • affected: objects not deleted but whose relationships will be removed (through rows, SET_NULL, local links)
Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this asset assessment.

Responses

resilience_asset_assessments_dependency_graph_retrieve

Returns graph data for visualizing asset dependencies. Includes nodes grouped by folder and links between parent-child assets. Only includes assets that are viewable by the current user.

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this asset assessment.

Responses

resilience_asset_assessments_metrics_retrieve

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this asset assessment.

Responses

resilience_asset_assessments_object_retrieve

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this asset assessment.

Responses

resilience_asset_assessments_quali_impact_retrieve

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this asset assessment.

Responses

resilience_asset_assessments_risk_matrix_retrieve

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this asset assessment.

Responses

resilience_asset_assessments_batch_action_create

Perform a batch action on multiple objects. Uses the IAM-filtered queryset and serializers to respect permissions and validation, mirroring the standard partial_update / destroy flows.

Payload: { "action": "delete"|"change_field"|"change_m2m"|"change_folder", "ids": [...], "field": "", "value": ... }

Authorizations:
knoxApiToken

Responses

business-impact-analysis

resilience_business_impact_analysis_list

Override the list method to inject optimized data into the serializer context.

Authorizations:
knoxApiToken
query Parameters
authors
Array of strings <uuid> [ items <uuid > ]
folder
Array of strings <uuid> [ items <uuid > ]
id
Array of strings <uuid> [ items <uuid > ]

Multiple values may be separated by commas.

limit
integer

Number of results to return per page.

offset
integer

The initial index from which to return the results.

ordering
string

Which field to use when ordering the results.

perimeter
Array of strings <uuid> [ items <uuid > ]
perimeter__folder
Array of strings <uuid> [ items <uuid > ]
risk_matrix
Array of strings <uuid> [ items <uuid > ]
search
string

A search term.

status
Array of strings or null
Items Enum: "deprecated" "done" "in_progress" "in_review" "planned"
  • planned - Planned
  • in_progress - In progress
  • in_review - In review
  • done - Done
  • deprecated - Deprecated

Responses

Response samples

Content type
application/json
{
  • "count": 123,
  • "next": "http://api.example.org/accounts/?offset=400&limit=100",
  • "previous": "http://api.example.org/accounts/?offset=200&limit=100",
  • "results": [
    ]
}

resilience_business_impact_analysis_create

Authorizations:
knoxApiToken
Request Body schema:
required
is_published
boolean (Published)
name
required
string <= 200 characters
description
string or null
eta
string or null <date>
due_date
string or null <date>
version
string or null <= 100 characters

Version of the compliance assessment (eg. 1.0, 2.0, etc.)

(Status6d9Enum (string or null)) or (BlankEnum (any or null)) or (NullEnum (any or null))
observation
string or null
is_locked
boolean or null
folder
string <uuid>
perimeter
string or null <uuid>
risk_matrix
required
string <uuid>
reviewers
Array of strings <uuid> [ items <uuid > ]
authors
Array of strings <uuid> [ items <uuid > ]

Responses

Request samples

Content type
{
  • "is_published": true,
  • "name": "string",
  • "description": "string",
  • "eta": "2019-08-24",
  • "due_date": "2019-08-24",
  • "version": "string",
  • "status": "planned",
  • "observation": "string",
  • "is_locked": true,
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
  • "perimeter": "bf619ff5-f1a2-4505-92b9-0c56e7a44b98",
  • "risk_matrix": "d6be139d-8169-4642-9d1a-53f73ea1eead",
  • "reviewers": [
    ],
  • "authors": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "is_published": true,
  • "name": "string",
  • "description": "string",
  • "eta": "2019-08-24",
  • "due_date": "2019-08-24",
  • "version": "string",
  • "status": "planned",
  • "observation": "string",
  • "is_locked": true,
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
  • "perimeter": "bf619ff5-f1a2-4505-92b9-0c56e7a44b98",
  • "risk_matrix": "d6be139d-8169-4642-9d1a-53f73ea1eead",
  • "reviewers": [
    ],
  • "authors": [
    ]
}

resilience_business_impact_analysis_retrieve

Return a single object with unauthorized related fields masked.

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this business impact analysis.

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "path": "string",
  • "perimeter": "string",
  • "authors": [
    ],
  • "reviewers": [
    ],
  • "folder": "string",
  • "str": "string",
  • "risk_matrix": "string",
  • "validation_flows": [
    ],
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "is_published": true,
  • "name": "string",
  • "description": "string",
  • "eta": "2019-08-24",
  • "due_date": "2019-08-24",
  • "version": "string",
  • "status": "planned",
  • "observation": "string",
  • "is_locked": true
}

resilience_business_impact_analysis_update

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this business impact analysis.

Request Body schema:
required
is_published
boolean (Published)
name
required
string <= 200 characters
description
string or null
eta
string or null <date>
due_date
string or null <date>
version
string or null <= 100 characters

Version of the compliance assessment (eg. 1.0, 2.0, etc.)

(Status6d9Enum (string or null)) or (BlankEnum (any or null)) or (NullEnum (any or null))
observation
string or null
is_locked
boolean or null
folder
string <uuid>
perimeter
string or null <uuid>
risk_matrix
required
string <uuid>
reviewers
Array of strings <uuid> [ items <uuid > ]
authors
Array of strings <uuid> [ items <uuid > ]

Responses

Request samples

Content type
{
  • "is_published": true,
  • "name": "string",
  • "description": "string",
  • "eta": "2019-08-24",
  • "due_date": "2019-08-24",
  • "version": "string",
  • "status": "planned",
  • "observation": "string",
  • "is_locked": true,
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
  • "perimeter": "bf619ff5-f1a2-4505-92b9-0c56e7a44b98",
  • "risk_matrix": "d6be139d-8169-4642-9d1a-53f73ea1eead",
  • "reviewers": [
    ],
  • "authors": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "is_published": true,
  • "name": "string",
  • "description": "string",
  • "eta": "2019-08-24",
  • "due_date": "2019-08-24",
  • "version": "string",
  • "status": "planned",
  • "observation": "string",
  • "is_locked": true,
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
  • "perimeter": "bf619ff5-f1a2-4505-92b9-0c56e7a44b98",
  • "risk_matrix": "d6be139d-8169-4642-9d1a-53f73ea1eead",
  • "reviewers": [
    ],
  • "authors": [
    ]
}

resilience_business_impact_analysis_partial_update

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this business impact analysis.

Request Body schema:
is_published
boolean (Published)
name
string <= 200 characters
description
string or null
eta
string or null <date>
due_date
string or null <date>
version
string or null <= 100 characters

Version of the compliance assessment (eg. 1.0, 2.0, etc.)

(Status6d9Enum (string or null)) or (BlankEnum (any or null)) or (NullEnum (any or null))
observation
string or null
is_locked
boolean or null
folder
string <uuid>
perimeter
string or null <uuid>
risk_matrix
string <uuid>
reviewers
Array of strings <uuid> [ items <uuid > ]
authors
Array of strings <uuid> [ items <uuid > ]

Responses

Request samples

Content type
{
  • "is_published": true,
  • "name": "string",
  • "description": "string",
  • "eta": "2019-08-24",
  • "due_date": "2019-08-24",
  • "version": "string",
  • "status": "planned",
  • "observation": "string",
  • "is_locked": true,
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
  • "perimeter": "bf619ff5-f1a2-4505-92b9-0c56e7a44b98",
  • "risk_matrix": "d6be139d-8169-4642-9d1a-53f73ea1eead",
  • "reviewers": [
    ],
  • "authors": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "is_published": true,
  • "name": "string",
  • "description": "string",
  • "eta": "2019-08-24",
  • "due_date": "2019-08-24",
  • "version": "string",
  • "status": "planned",
  • "observation": "string",
  • "is_locked": true,
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
  • "perimeter": "bf619ff5-f1a2-4505-92b9-0c56e7a44b98",
  • "risk_matrix": "d6be139d-8169-4642-9d1a-53f73ea1eead",
  • "reviewers": [
    ],
  • "authors": [
    ]
}

resilience_business_impact_analysis_destroy

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this business impact analysis.

Responses

resilience_business_impact_analysis_build_table_retrieve

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this business impact analysis.

Responses

resilience_business_impact_analysis_cascade_info_retrieve

Cascade preview:

  • deleted: objects actually deleted by cascade
  • affected: objects not deleted but whose relationships will be removed (through rows, SET_NULL, local links)
Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this business impact analysis.

Responses

resilience_business_impact_analysis_metrics_retrieve

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this business impact analysis.

Responses

resilience_business_impact_analysis_object_retrieve

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this business impact analysis.

Responses

resilience_business_impact_analysis_xlsx_retrieve

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this business impact analysis.

Responses

resilience_business_impact_analysis_batch_action_create

Perform a batch action on multiple objects. Uses the IAM-filtered queryset and serializers to respect permissions and validation, mirroring the standard partial_update / destroy flows.

Payload: { "action": "delete"|"change_field"|"change_m2m"|"change_folder", "ids": [...], "field": "", "value": ... }

Authorizations:
knoxApiToken

Responses

resilience_business_impact_analysis_export_csv_retrieve

Authorizations:
knoxApiToken

Responses

resilience_business_impact_analysis_export_xlsx_retrieve

Authorizations:
knoxApiToken

Responses

resilience_business_impact_analysis_status_retrieve

Authorizations:
knoxApiToken

Responses

escalation-thresholds

resilience_escalation_thresholds_list

Override the list method to inject optimized data into the serializer context.

Authorizations:
knoxApiToken
query Parameters
asset_assessment
Array of strings <uuid> [ items <uuid > ]
id
Array of strings <uuid> [ items <uuid > ]

Multiple values may be separated by commas.

limit
integer

Number of results to return per page.

offset
integer

The initial index from which to return the results.

ordering
string

Which field to use when ordering the results.

quali_impact
integer
search
string

A search term.

Responses

Response samples

Content type
application/json
{
  • "count": 123,
  • "next": "http://api.example.org/accounts/?offset=400&limit=100",
  • "previous": "http://api.example.org/accounts/?offset=200&limit=100",
  • "results": [
    ]
}

resilience_escalation_thresholds_create

Authorizations:
knoxApiToken
Request Body schema:
required
is_published
boolean (Published)
point_in_time
required
integer <int64> [ -9223372036854776000 .. 9223372036854776000 ]
quali_impact
integer <int64> [ -9223372036854776000 .. 9223372036854776000 ]
quanti_impact
number <double>
quanti_impact_unit
string (QuantiImpactUnitEnum)
Enum: "people" "currency" "records" "man_hours" "data_gb" "gu"
  • people - People
  • currency - Currency
  • records - Records
  • man_hours - Man-hours
  • data_gb - Data (GB)
  • gu - Generic Unit
justification
string or null
folder
string <uuid>
asset_assessment
required
string <uuid>
qualifications
Array of strings <uuid> [ items <uuid > ]

Responses

Request samples

Content type
{
  • "is_published": true,
  • "point_in_time": -9223372036854776000,
  • "quali_impact": -9223372036854776000,
  • "quanti_impact": 0.1,
  • "quanti_impact_unit": "people",
  • "justification": "string",
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
  • "asset_assessment": "8b445794-2f9d-4c52-a4c9-beda87150311",
  • "qualifications": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "is_published": true,
  • "point_in_time": -9223372036854776000,
  • "quali_impact": -9223372036854776000,
  • "quanti_impact": 0.1,
  • "quanti_impact_unit": "people",
  • "justification": "string",
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
  • "asset_assessment": "8b445794-2f9d-4c52-a4c9-beda87150311",
  • "qualifications": [
    ]
}

resilience_escalation_thresholds_retrieve

Return a single object with unauthorized related fields masked.

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this escalation threshold.

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "asset_assessment": "string",
  • "folder": "string",
  • "name": "string",
  • "qualifications": [
    ],
  • "get_human_pit": null,
  • "quali_impact": null,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "is_published": true,
  • "point_in_time": -9223372036854776000,
  • "quanti_impact": 0.1,
  • "quanti_impact_unit": "people",
  • "justification": "string"
}

resilience_escalation_thresholds_update

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this escalation threshold.

Request Body schema:
required
is_published
boolean (Published)
point_in_time
required
integer <int64> [ -9223372036854776000 .. 9223372036854776000 ]
quali_impact
integer <int64> [ -9223372036854776000 .. 9223372036854776000 ]
quanti_impact
number <double>
quanti_impact_unit
string (QuantiImpactUnitEnum)
Enum: "people" "currency" "records" "man_hours" "data_gb" "gu"
  • people - People
  • currency - Currency
  • records - Records
  • man_hours - Man-hours
  • data_gb - Data (GB)
  • gu - Generic Unit
justification
string or null
folder
string <uuid>
asset_assessment
required
string <uuid>
qualifications
Array of strings <uuid> [ items <uuid > ]

Responses

Request samples

Content type
{
  • "is_published": true,
  • "point_in_time": -9223372036854776000,
  • "quali_impact": -9223372036854776000,
  • "quanti_impact": 0.1,
  • "quanti_impact_unit": "people",
  • "justification": "string",
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
  • "asset_assessment": "8b445794-2f9d-4c52-a4c9-beda87150311",
  • "qualifications": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "is_published": true,
  • "point_in_time": -9223372036854776000,
  • "quali_impact": -9223372036854776000,
  • "quanti_impact": 0.1,
  • "quanti_impact_unit": "people",
  • "justification": "string",
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
  • "asset_assessment": "8b445794-2f9d-4c52-a4c9-beda87150311",
  • "qualifications": [
    ]
}

resilience_escalation_thresholds_partial_update

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this escalation threshold.

Request Body schema:
is_published
boolean (Published)
point_in_time
integer <int64> [ -9223372036854776000 .. 9223372036854776000 ]
quali_impact
integer <int64> [ -9223372036854776000 .. 9223372036854776000 ]
quanti_impact
number <double>
quanti_impact_unit
string (QuantiImpactUnitEnum)
Enum: "people" "currency" "records" "man_hours" "data_gb" "gu"
  • people - People
  • currency - Currency
  • records - Records
  • man_hours - Man-hours
  • data_gb - Data (GB)
  • gu - Generic Unit
justification
string or null
folder
string <uuid>
asset_assessment
string <uuid>
qualifications
Array of strings <uuid> [ items <uuid > ]

Responses

Request samples

Content type
{
  • "is_published": true,
  • "point_in_time": -9223372036854776000,
  • "quali_impact": -9223372036854776000,
  • "quanti_impact": 0.1,
  • "quanti_impact_unit": "people",
  • "justification": "string",
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
  • "asset_assessment": "8b445794-2f9d-4c52-a4c9-beda87150311",
  • "qualifications": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "is_published": true,
  • "point_in_time": -9223372036854776000,
  • "quali_impact": -9223372036854776000,
  • "quanti_impact": 0.1,
  • "quanti_impact_unit": "people",
  • "justification": "string",
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
  • "asset_assessment": "8b445794-2f9d-4c52-a4c9-beda87150311",
  • "qualifications": [
    ]
}

resilience_escalation_thresholds_destroy

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this escalation threshold.

Responses

resilience_escalation_thresholds_cascade_info_retrieve

Cascade preview:

  • deleted: objects actually deleted by cascade
  • affected: objects not deleted but whose relationships will be removed (through rows, SET_NULL, local links)
Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this escalation threshold.

Responses

resilience_escalation_thresholds_object_retrieve

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this escalation threshold.

Responses

resilience_escalation_thresholds_quali_impact_retrieve

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this escalation threshold.

Responses

resilience_escalation_thresholds_risk_matrix_retrieve

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this escalation threshold.

Responses

resilience_escalation_thresholds_batch_action_create

Perform a batch action on multiple objects. Uses the IAM-filtered queryset and serializers to respect permissions and validation, mirroring the standard partial_update / destroy flows.

Payload: { "action": "delete"|"change_field"|"change_m2m"|"change_folder", "ids": [...], "field": "", "value": ... }

Authorizations:
knoxApiToken

Responses

resilience_escalation_thresholds_quant_unit_retrieve

Authorizations:
knoxApiToken

Responses