API docs by Redocly

CISO Assistant API — Compliance (0.7.0)

Download OpenAPI specification:

CISO Assistant - API Documentation for automating all your GRC needs

answers

answers_list

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

Authorizations:
knoxApiToken
query Parameters
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.

question
Array of strings <uuid> [ items <uuid > ]
requirement_assessment
Array of strings <uuid> [ items <uuid > ]
search
string

A search term.

Responses

Response samples

Content type
application/json
{}

answers_create

API endpoint for Answer CRUD.

Authorizations:
knoxApiToken
Request Body schema:
required
selected_choices
Array of strings <uuid> [ items <uuid > ]
is_published
boolean (Published)
value
any or null
folder
string <uuid>
requirement_assessment
required
string <uuid>
question
required
string <uuid>

Responses

Request samples

Content type
{
  • "selected_choices": [
    ],
  • "is_published": true,
  • "value": null,
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
  • "requirement_assessment": "15f5e242-5dd6-4e67-85f4-ee93baa21aa7",
  • "question": "52e6ce92-a2b6-4a3d-81f8-86da89a41cab"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "selected_choices": [
    ],
  • "is_published": true,
  • "value": null,
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
  • "requirement_assessment": "15f5e242-5dd6-4e67-85f4-ee93baa21aa7",
  • "question": "52e6ce92-a2b6-4a3d-81f8-86da89a41cab"
}

answers_retrieve

Return a single object with unauthorized related fields masked.

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Answer.

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "folder": "string",
  • "selected_choices": [
    ],
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "is_published": true,
  • "value": null,
  • "requirement_assessment": "15f5e242-5dd6-4e67-85f4-ee93baa21aa7",
  • "question": "52e6ce92-a2b6-4a3d-81f8-86da89a41cab"
}

answers_update

API endpoint for Answer CRUD.

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Answer.

Request Body schema:
required
selected_choices
Array of strings <uuid> [ items <uuid > ]
is_published
boolean (Published)
value
any or null
folder
string <uuid>
requirement_assessment
required
string <uuid>
question
required
string <uuid>

Responses

Request samples

Content type
{
  • "selected_choices": [
    ],
  • "is_published": true,
  • "value": null,
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
  • "requirement_assessment": "15f5e242-5dd6-4e67-85f4-ee93baa21aa7",
  • "question": "52e6ce92-a2b6-4a3d-81f8-86da89a41cab"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "selected_choices": [
    ],
  • "is_published": true,
  • "value": null,
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
  • "requirement_assessment": "15f5e242-5dd6-4e67-85f4-ee93baa21aa7",
  • "question": "52e6ce92-a2b6-4a3d-81f8-86da89a41cab"
}

answers_partial_update

API endpoint for Answer CRUD.

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Answer.

Request Body schema:
selected_choices
Array of strings <uuid> [ items <uuid > ]
is_published
boolean (Published)
value
any or null
folder
string <uuid>
requirement_assessment
string <uuid>
question
string <uuid>

Responses

Request samples

Content type
{
  • "selected_choices": [
    ],
  • "is_published": true,
  • "value": null,
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
  • "requirement_assessment": "15f5e242-5dd6-4e67-85f4-ee93baa21aa7",
  • "question": "52e6ce92-a2b6-4a3d-81f8-86da89a41cab"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "selected_choices": [
    ],
  • "is_published": true,
  • "value": null,
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
  • "requirement_assessment": "15f5e242-5dd6-4e67-85f4-ee93baa21aa7",
  • "question": "52e6ce92-a2b6-4a3d-81f8-86da89a41cab"
}

answers_destroy

API endpoint for Answer CRUD.

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Answer.

Responses

answers_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 Answer.

Responses

answers_object_retrieve

API endpoint for Answer CRUD.

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Answer.

Responses

answers_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

campaigns

campaigns_list

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

Authorizations:
knoxApiToken
query Parameters
folder
Array of strings <uuid> [ items <uuid > ]
frameworks
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.

perimeters
Array of strings <uuid> [ items <uuid > ]
search
string

A search term.

status
Array of strings or null
Items Enum: "deprecated" "done" "draft" "in_progress" "in_review"
  • draft - Draft
  • 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": [
    ]
}

campaigns_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>
(CampaignWriteStatusEnum (string or null)) or (BlankEnum (any or null)) or (NullEnum (any or null))
selected_implementation_groups
any or null
start_date
string or null <date>
folder
string <uuid>
frameworks
required
Array of strings <uuid> [ items <uuid > ]
perimeters
required
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",
  • "status": "draft",
  • "selected_implementation_groups": null,
  • "start_date": "2019-08-24",
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
  • "frameworks": [
    ],
  • "perimeters": [
    ]
}

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",
  • "status": "draft",
  • "selected_implementation_groups": null,
  • "start_date": "2019-08-24",
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
  • "frameworks": [
    ],
  • "perimeters": [
    ]
}

campaigns_retrieve

Return a single object with unauthorized related fields masked.

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Campaign.

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "folder": "string",
  • "compliance_assessments": [
    ],
  • "perimeters": [
    ],
  • "frameworks": [
    ],
  • "status": "string",
  • "framework": "string",
  • "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",
  • "selected_implementation_groups": null,
  • "start_date": "2019-08-24"
}

campaigns_update

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Campaign.

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>
(CampaignWriteStatusEnum (string or null)) or (BlankEnum (any or null)) or (NullEnum (any or null))
selected_implementation_groups
any or null
start_date
string or null <date>
folder
string <uuid>
frameworks
required
Array of strings <uuid> [ items <uuid > ]
perimeters
required
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",
  • "status": "draft",
  • "selected_implementation_groups": null,
  • "start_date": "2019-08-24",
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
  • "frameworks": [
    ],
  • "perimeters": [
    ]
}

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",
  • "status": "draft",
  • "selected_implementation_groups": null,
  • "start_date": "2019-08-24",
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
  • "frameworks": [
    ],
  • "perimeters": [
    ]
}

campaigns_partial_update

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Campaign.

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>
(CampaignWriteStatusEnum (string or null)) or (BlankEnum (any or null)) or (NullEnum (any or null))
selected_implementation_groups
any or null
start_date
string or null <date>
folder
string <uuid>
frameworks
Array of strings <uuid> [ items <uuid > ]
perimeters
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",
  • "status": "draft",
  • "selected_implementation_groups": null,
  • "start_date": "2019-08-24",
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
  • "frameworks": [
    ],
  • "perimeters": [
    ]
}

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",
  • "status": "draft",
  • "selected_implementation_groups": null,
  • "start_date": "2019-08-24",
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
  • "frameworks": [
    ],
  • "perimeters": [
    ]
}

campaigns_destroy

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Campaign.

Responses

campaigns_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 Campaign.

Responses

campaigns_metrics_retrieve

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Campaign.

Responses

campaigns_object_retrieve

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Campaign.

Responses

campaigns_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

campaigns_status_retrieve

Authorizations:
knoxApiToken

Responses

compliance-assessments

compliance_assessments_list

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

Authorizations:
knoxApiToken
query Parameters
assets
Array of strings <uuid> [ items <uuid > ]
authors
Array of strings <uuid> [ items <uuid > ]
campaign
Array of strings <uuid> [ items <uuid > ]
ebios_rm_studies
Array of strings <uuid> [ items <uuid > ]
evidences
Array of strings <uuid> [ items <uuid > ]
extended_result_enabled
boolean
folder
Array of strings <uuid> [ items <uuid > ]
framework
Array of strings <uuid> [ items <uuid > ]
genericcollection
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.

name
string
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 > ]
ref_id
string
reviewers
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
{}

compliance_assessments_create

API endpoint that allows compliance assessments to be viewed or edited.

Authorizations:
knoxApiToken
Request Body schema:
required
baseline
string or null <uuid>
ebios_rm_studies
Array of strings or null <uuid> [ items <uuid > ]
create_applied_controls_from_suggestions
boolean
Default: false
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
selected_implementation_groups
any or null
ref_id
string or null (Reference id) <= 100 characters
min_score
integer or null <int64> (Minimum score) [ -9223372036854776000 .. 9223372036854776000 ]
max_score
integer or null <int64> (Maximum score) [ -9223372036854776000 .. 9223372036854776000 ]
scores_definition
any or null (Score definition)
scoring_enabled
boolean
show_documentation_score
boolean
computed_outcome
any or null
extended_result_enabled
boolean
progress_status_enabled
boolean
field_visibility
any

Override visibility per field for this assessment. Overrides framework defaults.

score_calculation_method
string (ScoreCalculationMethodEnum)
Enum: "average" "sum" "average_of_averages"
  • average - Average
  • sum - Sum
  • average_of_averages - Average of averages
auto_sync
boolean (Automatic sync to actions)
folder
string <uuid>
perimeter
string or null <uuid>
framework
required
string <uuid>
campaign
string or null <uuid>
reviewers
Array of strings <uuid> [ items <uuid > ]
authors
Array of strings <uuid> [ items <uuid > ]
assets
Array of strings <uuid> (Related assets) [ items <uuid > ]

Assets related to the compliance assessment

evidences
Array of strings <uuid> [ items <uuid > ]

Evidences related to the compliance assessment

Responses

Request samples

Content type
{
  • "baseline": "c9104f3c-7e91-40bc-9d1b-074af8772699",
  • "ebios_rm_studies": [
    ],
  • "create_applied_controls_from_suggestions": false,
  • "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,
  • "selected_implementation_groups": null,
  • "ref_id": "string",
  • "min_score": -9223372036854776000,
  • "max_score": -9223372036854776000,
  • "scores_definition": null,
  • "scoring_enabled": true,
  • "show_documentation_score": true,
  • "computed_outcome": null,
  • "extended_result_enabled": true,
  • "progress_status_enabled": true,
  • "field_visibility": null,
  • "score_calculation_method": "average",
  • "auto_sync": true,
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
  • "perimeter": "bf619ff5-f1a2-4505-92b9-0c56e7a44b98",
  • "framework": "f8e83382-f416-4030-8f7d-44ded7ba7596",
  • "campaign": "684930b2-6fb6-45bf-bf18-d3b774256120",
  • "reviewers": [
    ],
  • "authors": [
    ],
  • "assets": [
    ],
  • "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,
  • "name": "string",
  • "description": "string",
  • "eta": "2019-08-24",
  • "due_date": "2019-08-24",
  • "version": "string",
  • "status": "planned",
  • "observation": "string",
  • "is_locked": true,
  • "selected_implementation_groups": null,
  • "ref_id": "string",
  • "min_score": -9223372036854776000,
  • "max_score": -9223372036854776000,
  • "scores_definition": null,
  • "scoring_enabled": true,
  • "show_documentation_score": true,
  • "computed_outcome": null,
  • "extended_result_enabled": true,
  • "progress_status_enabled": true,
  • "field_visibility": null,
  • "score_calculation_method": "average",
  • "auto_sync": true,
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
  • "perimeter": "bf619ff5-f1a2-4505-92b9-0c56e7a44b98",
  • "framework": "f8e83382-f416-4030-8f7d-44ded7ba7596",
  • "campaign": "684930b2-6fb6-45bf-bf18-d3b774256120",
  • "reviewers": [
    ],
  • "authors": [
    ],
  • "assets": [
    ],
  • "evidences": [
    ]
}

compliance_assessments_retrieve

Return a single object with unauthorized related fields masked.

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Compliance assessment.

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "path": "string",
  • "perimeter": "string",
  • "authors": [
    ],
  • "reviewers": [
    ],
  • "folder": "string",
  • "campaign": "string",
  • "framework": "string",
  • "selected_implementation_groups": "string",
  • "progress": "string",
  • "answers_progress": "string",
  • "assets": [
    ],
  • "evidences": [
    ],
  • "validation_flows": [
    ],
  • "scores_definition": "string",
  • "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,
  • "ref_id": "string",
  • "min_score": -9223372036854776000,
  • "max_score": -9223372036854776000,
  • "scoring_enabled": true,
  • "show_documentation_score": true,
  • "computed_outcome": null,
  • "extended_result_enabled": true,
  • "progress_status_enabled": true,
  • "field_visibility": null,
  • "score_calculation_method": "average",
  • "auto_sync": true
}

compliance_assessments_update

API endpoint that allows compliance assessments to be viewed or edited.

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Compliance assessment.

Request Body schema:
required
baseline
string or null <uuid>
ebios_rm_studies
Array of strings or null <uuid> [ items <uuid > ]
create_applied_controls_from_suggestions
boolean
Default: false
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
selected_implementation_groups
any or null
ref_id
string or null (Reference id) <= 100 characters
min_score
integer or null <int64> (Minimum score) [ -9223372036854776000 .. 9223372036854776000 ]
max_score
integer or null <int64> (Maximum score) [ -9223372036854776000 .. 9223372036854776000 ]
scores_definition
any or null (Score definition)
scoring_enabled
boolean
show_documentation_score
boolean
computed_outcome
any or null
extended_result_enabled
boolean
progress_status_enabled
boolean
field_visibility
any

Override visibility per field for this assessment. Overrides framework defaults.

score_calculation_method
string (ScoreCalculationMethodEnum)
Enum: "average" "sum" "average_of_averages"
  • average - Average
  • sum - Sum
  • average_of_averages - Average of averages
auto_sync
boolean (Automatic sync to actions)
folder
string <uuid>
perimeter
string or null <uuid>
framework
required
string <uuid>
campaign
string or null <uuid>
reviewers
Array of strings <uuid> [ items <uuid > ]
authors
Array of strings <uuid> [ items <uuid > ]
assets
Array of strings <uuid> (Related assets) [ items <uuid > ]

Assets related to the compliance assessment

evidences
Array of strings <uuid> [ items <uuid > ]

Evidences related to the compliance assessment

Responses

Request samples

Content type
{
  • "baseline": "c9104f3c-7e91-40bc-9d1b-074af8772699",
  • "ebios_rm_studies": [
    ],
  • "create_applied_controls_from_suggestions": false,
  • "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,
  • "selected_implementation_groups": null,
  • "ref_id": "string",
  • "min_score": -9223372036854776000,
  • "max_score": -9223372036854776000,
  • "scores_definition": null,
  • "scoring_enabled": true,
  • "show_documentation_score": true,
  • "computed_outcome": null,
  • "extended_result_enabled": true,
  • "progress_status_enabled": true,
  • "field_visibility": null,
  • "score_calculation_method": "average",
  • "auto_sync": true,
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
  • "perimeter": "bf619ff5-f1a2-4505-92b9-0c56e7a44b98",
  • "framework": "f8e83382-f416-4030-8f7d-44ded7ba7596",
  • "campaign": "684930b2-6fb6-45bf-bf18-d3b774256120",
  • "reviewers": [
    ],
  • "authors": [
    ],
  • "assets": [
    ],
  • "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,
  • "name": "string",
  • "description": "string",
  • "eta": "2019-08-24",
  • "due_date": "2019-08-24",
  • "version": "string",
  • "status": "planned",
  • "observation": "string",
  • "is_locked": true,
  • "selected_implementation_groups": null,
  • "ref_id": "string",
  • "min_score": -9223372036854776000,
  • "max_score": -9223372036854776000,
  • "scores_definition": null,
  • "scoring_enabled": true,
  • "show_documentation_score": true,
  • "computed_outcome": null,
  • "extended_result_enabled": true,
  • "progress_status_enabled": true,
  • "field_visibility": null,
  • "score_calculation_method": "average",
  • "auto_sync": true,
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
  • "perimeter": "bf619ff5-f1a2-4505-92b9-0c56e7a44b98",
  • "framework": "f8e83382-f416-4030-8f7d-44ded7ba7596",
  • "campaign": "684930b2-6fb6-45bf-bf18-d3b774256120",
  • "reviewers": [
    ],
  • "authors": [
    ],
  • "assets": [
    ],
  • "evidences": [
    ]
}

compliance_assessments_partial_update

API endpoint that allows compliance assessments to be viewed or edited.

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Compliance assessment.

Request Body schema:
baseline
string or null <uuid>
ebios_rm_studies
Array of strings or null <uuid> [ items <uuid > ]
create_applied_controls_from_suggestions
boolean
Default: false
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
selected_implementation_groups
any or null
ref_id
string or null (Reference id) <= 100 characters
min_score
integer or null <int64> (Minimum score) [ -9223372036854776000 .. 9223372036854776000 ]
max_score
integer or null <int64> (Maximum score) [ -9223372036854776000 .. 9223372036854776000 ]
scores_definition
any or null (Score definition)
scoring_enabled
boolean
show_documentation_score
boolean
computed_outcome
any or null
extended_result_enabled
boolean
progress_status_enabled
boolean
field_visibility
any

Override visibility per field for this assessment. Overrides framework defaults.

score_calculation_method
string (ScoreCalculationMethodEnum)
Enum: "average" "sum" "average_of_averages"
  • average - Average
  • sum - Sum
  • average_of_averages - Average of averages
auto_sync
boolean (Automatic sync to actions)
folder
string <uuid>
perimeter
string or null <uuid>
framework
string <uuid>
campaign
string or null <uuid>
reviewers
Array of strings <uuid> [ items <uuid > ]
authors
Array of strings <uuid> [ items <uuid > ]
assets
Array of strings <uuid> (Related assets) [ items <uuid > ]

Assets related to the compliance assessment

evidences
Array of strings <uuid> [ items <uuid > ]

Evidences related to the compliance assessment

Responses

Request samples

Content type
{
  • "baseline": "c9104f3c-7e91-40bc-9d1b-074af8772699",
  • "ebios_rm_studies": [
    ],
  • "create_applied_controls_from_suggestions": false,
  • "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,
  • "selected_implementation_groups": null,
  • "ref_id": "string",
  • "min_score": -9223372036854776000,
  • "max_score": -9223372036854776000,
  • "scores_definition": null,
  • "scoring_enabled": true,
  • "show_documentation_score": true,
  • "computed_outcome": null,
  • "extended_result_enabled": true,
  • "progress_status_enabled": true,
  • "field_visibility": null,
  • "score_calculation_method": "average",
  • "auto_sync": true,
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
  • "perimeter": "bf619ff5-f1a2-4505-92b9-0c56e7a44b98",
  • "framework": "f8e83382-f416-4030-8f7d-44ded7ba7596",
  • "campaign": "684930b2-6fb6-45bf-bf18-d3b774256120",
  • "reviewers": [
    ],
  • "authors": [
    ],
  • "assets": [
    ],
  • "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,
  • "name": "string",
  • "description": "string",
  • "eta": "2019-08-24",
  • "due_date": "2019-08-24",
  • "version": "string",
  • "status": "planned",
  • "observation": "string",
  • "is_locked": true,
  • "selected_implementation_groups": null,
  • "ref_id": "string",
  • "min_score": -9223372036854776000,
  • "max_score": -9223372036854776000,
  • "scores_definition": null,
  • "scoring_enabled": true,
  • "show_documentation_score": true,
  • "computed_outcome": null,
  • "extended_result_enabled": true,
  • "progress_status_enabled": true,
  • "field_visibility": null,
  • "score_calculation_method": "average",
  • "auto_sync": true,
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
  • "perimeter": "bf619ff5-f1a2-4505-92b9-0c56e7a44b98",
  • "framework": "f8e83382-f416-4030-8f7d-44ded7ba7596",
  • "campaign": "684930b2-6fb6-45bf-bf18-d3b774256120",
  • "reviewers": [
    ],
  • "authors": [
    ],
  • "assets": [
    ],
  • "evidences": [
    ]
}

compliance_assessments_destroy

API endpoint that allows compliance assessments to be viewed or edited.

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Compliance assessment.

Responses

compliance_assessments_action_plan_list

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>
query Parameters
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": [
    ]
}

compliance_assessments_action_plan_budget_overview_list

Mixin that computes budget aggregation over an applied controls queryset.

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>
query Parameters
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": [
    ]
}

compliance_assessments_action_plan_csv_retrieve

API endpoint that allows compliance assessments to be viewed or edited.

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Compliance assessment.

Responses

compliance_assessments_action_plan_pdf_retrieve

API endpoint that allows compliance assessments to be viewed or edited.

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Compliance assessment.

Responses

compliance_assessments_action_plan_xlsx_retrieve

API endpoint that allows compliance assessments to be viewed or edited.

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Compliance assessment.

Responses

compliance_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 Compliance assessment.

Responses

compliance_assessments_comparable_audits_retrieve

Get list of compliance assessments that can be compared with this one (same framework, user has view permission, excludes current audit)

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Compliance assessment.

Responses

compliance_assessments_compare_retrieve

Compare two compliance assessments that use the same framework

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Compliance assessment.

Responses

compliance_assessments_compliance_assessment_csv_retrieve

API endpoint that allows compliance assessments to be viewed or edited.

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Compliance assessment.

Responses

compliance_assessments_compliance_timeline_retrieve

Returns compliance metrics over time from HistoricalMetric snapshots.

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Compliance assessment.

Responses

compliance_assessments_controls_coverage_retrieve

Controls coverage analysis for this compliance assessment.

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Compliance assessment.

Responses

compliance_assessments_donut_data_retrieve

API endpoint that allows compliance assessments to be viewed or edited.

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Compliance assessment.

Responses

compliance_assessments_evidence_coverage_retrieve

Evidence coverage analysis — direct (on RA) and indirect (via applied controls).

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Compliance assessment.

Responses

compliance_assessments_evidences_list_list

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>
query Parameters
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
{}

compliance_assessments_exceptions_summary_retrieve

Security exceptions summary for this compliance assessment.

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Compliance assessment.

Responses

compliance_assessments_export_retrieve

API endpoint that allows compliance assessments to be viewed or edited.

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Compliance assessment.

Responses

compliance_assessments_frameworks_retrieve

API endpoint that allows compliance assessments to be viewed or edited.

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Compliance assessment.

Responses

compliance_assessments_global_score_retrieve

Returns the global score of the compliance assessment

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Compliance assessment.

Responses

compliance_assessments_implementation_groups_breakdown_retrieve

Breakdown of compliance results by implementation group.

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Compliance assessment.

Responses

compliance_assessments_is_auditee_retrieve

Returns whether the current user is an auditee for this compliance assessment.

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Compliance assessment.

Responses

compliance_assessments_mailing_create

API endpoint that allows compliance assessments to be viewed or edited.

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Compliance assessment.

Responses

compliance_assessments_object_retrieve

API endpoint that allows compliance assessments to be viewed or edited.

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Compliance assessment.

Responses

compliance_assessments_progress_ts_retrieve

API endpoint that allows compliance assessments to be viewed or edited.

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Compliance assessment.

Responses

compliance_assessments_quality_check_retrieve_2

Returns the quality check of a specific assessment

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Compliance assessment.

Responses

compliance_assessments_requirements_list_retrieve

Returns the list of requirement assessments for the different audit modes

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Compliance assessment.

Responses

compliance_assessments_section_compliance_retrieve

Aggregates compliance results and scores per top-level requirement group.

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Compliance assessment.

Responses

compliance_assessments_soa_retrieve

Returns the requirement tree enriched with applied controls and optionally linked risk scenarios, for Statement of Applicability generation.

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Compliance assessment.

Responses

compliance_assessments_suggestions_applied_controls_retrieve

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

Responses

compliance_assessments_suggestions_applied_controls_create

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

Responses

compliance_assessments_syncToActions_retrieve

API endpoint that allows compliance assessments to be viewed or edited.

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Compliance assessment.

Responses

compliance_assessments_syncToActions_create

API endpoint that allows compliance assessments to be viewed or edited.

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Compliance assessment.

Responses

compliance_assessments_threats_metrics_retrieve

API endpoint that allows compliance assessments to be viewed or edited.

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Compliance assessment.

Responses

compliance_assessments_tree_retrieve

API endpoint that allows compliance assessments to be viewed or edited.

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Compliance assessment.

Responses

compliance_assessments_update_requirement_create

API endpoint that allows compliance assessments to be viewed or edited.

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Compliance assessment.

Responses

compliance_assessments_word_report_retrieve

Word report generation (Exec)

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Compliance assessment.

Responses

compliance_assessments_xlsx_retrieve

API endpoint that allows compliance assessments to be viewed or edited.

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Compliance assessment.

Responses

compliance_assessments_analytics_retrieve

Returns compliance analytics data grouped by framework and domain

Authorizations:
knoxApiToken

Responses

compliance_assessments_auditee_dashboard_retrieve

Returns per-assignment progress data for the auditee's dashboard.

Authorizations:
knoxApiToken

Responses

compliance_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

compliance_assessments_per_status_retrieve

API endpoint that allows compliance assessments to be viewed or edited.

Authorizations:
knoxApiToken

Responses

compliance_assessments_quality_check_retrieve

Returns the quality check of every compliance assessment

Authorizations:
knoxApiToken

Responses

compliance_assessments_score_calculation_method_retrieve

API endpoint that allows compliance assessments to be viewed or edited.

Authorizations:
knoxApiToken

Responses

compliance_assessments_status_retrieve

API endpoint that allows compliance assessments to be viewed or edited.

Authorizations:
knoxApiToken

Responses

question-choices

question_choices_list

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

Authorizations:
knoxApiToken
query Parameters
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.

question
Array of strings <uuid> [ items <uuid > ]
search
string

A search term.

urn
string

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": [
    ]
}

question_choices_create

API endpoint for QuestionChoice CRUD.

Authorizations:
knoxApiToken
Request Body schema:
required
is_published
boolean (Published)
urn
string or null <= 255 characters
ref_id
string or null (Reference ID) <= 100 characters
value
string or null
annotation
string or null
add_score
integer or null <int64> [ -9223372036854776000 .. 9223372036854776000 ]
compute_result
string or null <= 100 characters
order
integer <int64> [ -9223372036854776000 .. 9223372036854776000 ]
description
string or null
color
string or null <= 50 characters
select_implementation_groups
any or null
translations
any or null
folder
string <uuid>
question
required
string <uuid>

Responses

Request samples

Content type
{
  • "is_published": true,
  • "urn": "string",
  • "ref_id": "string",
  • "value": "string",
  • "annotation": "string",
  • "add_score": -9223372036854776000,
  • "compute_result": "string",
  • "order": -9223372036854776000,
  • "description": "string",
  • "color": "string",
  • "select_implementation_groups": null,
  • "translations": null,
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
  • "question": "52e6ce92-a2b6-4a3d-81f8-86da89a41cab"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "is_published": true,
  • "urn": "string",
  • "ref_id": "string",
  • "value": "string",
  • "annotation": "string",
  • "add_score": -9223372036854776000,
  • "compute_result": "string",
  • "order": -9223372036854776000,
  • "description": "string",
  • "color": "string",
  • "select_implementation_groups": null,
  • "translations": null,
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
  • "question": "52e6ce92-a2b6-4a3d-81f8-86da89a41cab"
}

question_choices_retrieve

Return a single object with unauthorized related fields masked.

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Question choice.

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "folder": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "is_published": true,
  • "urn": "string",
  • "ref_id": "string",
  • "value": "string",
  • "annotation": "string",
  • "add_score": -9223372036854776000,
  • "compute_result": "string",
  • "order": -9223372036854776000,
  • "description": "string",
  • "color": "string",
  • "select_implementation_groups": null,
  • "translations": null,
  • "question": "52e6ce92-a2b6-4a3d-81f8-86da89a41cab"
}

question_choices_update

API endpoint for QuestionChoice CRUD.

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Question choice.

Request Body schema:
required
is_published
boolean (Published)
urn
string or null <= 255 characters
ref_id
string or null (Reference ID) <= 100 characters
value
string or null
annotation
string or null
add_score
integer or null <int64> [ -9223372036854776000 .. 9223372036854776000 ]
compute_result
string or null <= 100 characters
order
integer <int64> [ -9223372036854776000 .. 9223372036854776000 ]
description
string or null
color
string or null <= 50 characters
select_implementation_groups
any or null
translations
any or null
folder
string <uuid>
question
required
string <uuid>

Responses

Request samples

Content type
{
  • "is_published": true,
  • "urn": "string",
  • "ref_id": "string",
  • "value": "string",
  • "annotation": "string",
  • "add_score": -9223372036854776000,
  • "compute_result": "string",
  • "order": -9223372036854776000,
  • "description": "string",
  • "color": "string",
  • "select_implementation_groups": null,
  • "translations": null,
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
  • "question": "52e6ce92-a2b6-4a3d-81f8-86da89a41cab"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "is_published": true,
  • "urn": "string",
  • "ref_id": "string",
  • "value": "string",
  • "annotation": "string",
  • "add_score": -9223372036854776000,
  • "compute_result": "string",
  • "order": -9223372036854776000,
  • "description": "string",
  • "color": "string",
  • "select_implementation_groups": null,
  • "translations": null,
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
  • "question": "52e6ce92-a2b6-4a3d-81f8-86da89a41cab"
}

question_choices_partial_update

API endpoint for QuestionChoice CRUD.

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Question choice.

Request Body schema:
is_published
boolean (Published)
urn
string or null <= 255 characters
ref_id
string or null (Reference ID) <= 100 characters
value
string or null
annotation
string or null
add_score
integer or null <int64> [ -9223372036854776000 .. 9223372036854776000 ]
compute_result
string or null <= 100 characters
order
integer <int64> [ -9223372036854776000 .. 9223372036854776000 ]
description
string or null
color
string or null <= 50 characters
select_implementation_groups
any or null
translations
any or null
folder
string <uuid>
question
string <uuid>

Responses

Request samples

Content type
{
  • "is_published": true,
  • "urn": "string",
  • "ref_id": "string",
  • "value": "string",
  • "annotation": "string",
  • "add_score": -9223372036854776000,
  • "compute_result": "string",
  • "order": -9223372036854776000,
  • "description": "string",
  • "color": "string",
  • "select_implementation_groups": null,
  • "translations": null,
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
  • "question": "52e6ce92-a2b6-4a3d-81f8-86da89a41cab"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "is_published": true,
  • "urn": "string",
  • "ref_id": "string",
  • "value": "string",
  • "annotation": "string",
  • "add_score": -9223372036854776000,
  • "compute_result": "string",
  • "order": -9223372036854776000,
  • "description": "string",
  • "color": "string",
  • "select_implementation_groups": null,
  • "translations": null,
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
  • "question": "52e6ce92-a2b6-4a3d-81f8-86da89a41cab"
}

question_choices_destroy

API endpoint for QuestionChoice CRUD.

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Question choice.

Responses

question_choices_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 Question choice.

Responses

question_choices_object_retrieve

API endpoint for QuestionChoice CRUD.

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Question choice.

Responses

question_choices_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

questions

questions_list

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

Authorizations:
knoxApiToken
query Parameters
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.

requirement_node
Array of strings <uuid> [ items <uuid > ]
search
string

A search term.

type
Array of strings
Items Enum: "boolean" "date" "multiple_choice" "number" "text" "unique_choice"
  • text - Text
  • number - Number
  • boolean - Boolean
  • unique_choice - Unique choice
  • multiple_choice - Multiple choice
  • date - Date
urn
string

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": [
    ]
}

questions_create

API endpoint for Question CRUD.

Authorizations:
knoxApiToken
Request Body schema:
required
is_published
boolean (Published)
urn
required
string <= 255 characters
ref_id
string or null (Reference ID) <= 100 characters
text
string or null
annotation
string or null
type
string (Type19fEnum)
Enum: "text" "number" "boolean" "unique_choice" "multiple_choice" "date"
  • text - Text
  • number - Number
  • boolean - Boolean
  • unique_choice - Unique choice
  • multiple_choice - Multiple choice
  • date - Date
config
any or null
depends_on
any or null
order
integer <int64> [ -9223372036854776000 .. 9223372036854776000 ]
weight
integer <int64> [ -9223372036854776000 .. 9223372036854776000 ]
translations
any or null
folder
string <uuid>
requirement_node
required
string <uuid>

Responses

Request samples

Content type
{
  • "is_published": true,
  • "urn": "string",
  • "ref_id": "string",
  • "text": "string",
  • "annotation": "string",
  • "type": "text",
  • "config": null,
  • "depends_on": null,
  • "order": -9223372036854776000,
  • "weight": -9223372036854776000,
  • "translations": null,
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
  • "requirement_node": "9213ac24-053a-46fc-a745-bdcec00527e5"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "is_published": true,
  • "urn": "string",
  • "ref_id": "string",
  • "text": "string",
  • "annotation": "string",
  • "type": "text",
  • "config": null,
  • "depends_on": null,
  • "order": -9223372036854776000,
  • "weight": -9223372036854776000,
  • "translations": null,
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
  • "requirement_node": "9213ac24-053a-46fc-a745-bdcec00527e5"
}

questions_retrieve

Return a single object with unauthorized related fields masked.

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Question.

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "folder": "string",
  • "choices": [
    ],
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "is_published": true,
  • "urn": "string",
  • "ref_id": "string",
  • "text": "string",
  • "annotation": "string",
  • "type": "text",
  • "config": null,
  • "depends_on": null,
  • "order": -9223372036854776000,
  • "weight": -9223372036854776000,
  • "translations": null,
  • "requirement_node": "9213ac24-053a-46fc-a745-bdcec00527e5"
}

questions_update

API endpoint for Question CRUD.

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Question.

Request Body schema:
required
is_published
boolean (Published)
urn
required
string <= 255 characters
ref_id
string or null (Reference ID) <= 100 characters
text
string or null
annotation
string or null
type
string (Type19fEnum)
Enum: "text" "number" "boolean" "unique_choice" "multiple_choice" "date"
  • text - Text
  • number - Number
  • boolean - Boolean
  • unique_choice - Unique choice
  • multiple_choice - Multiple choice
  • date - Date
config
any or null
depends_on
any or null
order
integer <int64> [ -9223372036854776000 .. 9223372036854776000 ]
weight
integer <int64> [ -9223372036854776000 .. 9223372036854776000 ]
translations
any or null
folder
string <uuid>
requirement_node
required
string <uuid>

Responses

Request samples

Content type
{
  • "is_published": true,
  • "urn": "string",
  • "ref_id": "string",
  • "text": "string",
  • "annotation": "string",
  • "type": "text",
  • "config": null,
  • "depends_on": null,
  • "order": -9223372036854776000,
  • "weight": -9223372036854776000,
  • "translations": null,
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
  • "requirement_node": "9213ac24-053a-46fc-a745-bdcec00527e5"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "is_published": true,
  • "urn": "string",
  • "ref_id": "string",
  • "text": "string",
  • "annotation": "string",
  • "type": "text",
  • "config": null,
  • "depends_on": null,
  • "order": -9223372036854776000,
  • "weight": -9223372036854776000,
  • "translations": null,
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
  • "requirement_node": "9213ac24-053a-46fc-a745-bdcec00527e5"
}

questions_partial_update

API endpoint for Question CRUD.

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Question.

Request Body schema:
is_published
boolean (Published)
urn
string <= 255 characters
ref_id
string or null (Reference ID) <= 100 characters
text
string or null
annotation
string or null
type
string (Type19fEnum)
Enum: "text" "number" "boolean" "unique_choice" "multiple_choice" "date"
  • text - Text
  • number - Number
  • boolean - Boolean
  • unique_choice - Unique choice
  • multiple_choice - Multiple choice
  • date - Date
config
any or null
depends_on
any or null
order
integer <int64> [ -9223372036854776000 .. 9223372036854776000 ]
weight
integer <int64> [ -9223372036854776000 .. 9223372036854776000 ]
translations
any or null
folder
string <uuid>
requirement_node
string <uuid>

Responses

Request samples

Content type
{
  • "is_published": true,
  • "urn": "string",
  • "ref_id": "string",
  • "text": "string",
  • "annotation": "string",
  • "type": "text",
  • "config": null,
  • "depends_on": null,
  • "order": -9223372036854776000,
  • "weight": -9223372036854776000,
  • "translations": null,
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
  • "requirement_node": "9213ac24-053a-46fc-a745-bdcec00527e5"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "is_published": true,
  • "urn": "string",
  • "ref_id": "string",
  • "text": "string",
  • "annotation": "string",
  • "type": "text",
  • "config": null,
  • "depends_on": null,
  • "order": -9223372036854776000,
  • "weight": -9223372036854776000,
  • "translations": null,
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
  • "requirement_node": "9213ac24-053a-46fc-a745-bdcec00527e5"
}

questions_destroy

API endpoint for Question CRUD.

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Question.

Responses

questions_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 Question.

Responses

questions_object_retrieve

API endpoint for Question CRUD.

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Question.

Responses

questions_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

requirement-assessments

requirement_assessments_list

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

Authorizations:
knoxApiToken
query Parameters
applied_controls
Array of strings <uuid> [ items <uuid > ]
compliance_assessment
Array of strings <uuid> [ items <uuid > ]
compliance_assessment__assets__ref_id
string
compliance_assessment__perimeter
Array of strings <uuid> [ items <uuid > ]
compliance_assessment__perimeter__name
string
compliance_assessment__ref_id
string
evidences
Array of strings <uuid> [ items <uuid > ]
extended_result
Array of strings or null
Items Enum: "good_practice" "major_nonconformity" "minor_nonconformity" "observation_sensitive_point" "opportunity_for_improvement"
  • major_nonconformity - Major nonconformity
  • minor_nonconformity - Minor nonconformity
  • observation_sensitive_point - Observation / sensitive point
  • opportunity_for_improvement - Opportunity for improvement
  • good_practice - Good practice
folder
Array of strings <uuid> [ items <uuid > ]
folder__name
string
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.

requirement__assessable
boolean
requirement__urn
string
result
Array of strings
Items Enum: "compliant" "non_compliant" "not_applicable" "not_assessed" "partially_compliant"
  • not_assessed - Not assessed
  • partially_compliant - Partially compliant
  • non_compliant - Non-compliant
  • compliant - Compliant
  • not_applicable - Not applicable
search
string

A search term.

security_exceptions
Array of strings <uuid> [ items <uuid > ]

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": [
    ]
}

requirement_assessments_create

API endpoint that allows requirement assessments to be viewed or edited.

Authorizations:
knoxApiToken
Request Body schema:
required
answers
any
is_published
boolean (Published)
eta
string or null <date>
due_date
string or null <date>
status
string (StatusB56Enum)
Enum: "to_do" "in_progress" "in_review" "done"
  • to_do - To do
  • in_progress - In progress
  • in_review - In review
  • done - Done
result
string (ResultEnum)
Enum: "not_assessed" "partially_compliant" "non_compliant" "compliant" "not_applicable"
  • not_assessed - Not assessed
  • partially_compliant - Partially compliant
  • non_compliant - Non-compliant
  • compliant - Compliant
  • not_applicable - Not applicable
(ExtendedResultEnum (string or null)) or (BlankEnum (any or null)) or (NullEnum (any or null))
is_scored
boolean
score
integer or null <int64> [ -9223372036854776000 .. 9223372036854776000 ]
documentation_score
integer or null <int64> [ -9223372036854776000 .. 9223372036854776000 ]
observation
string or null
selected
boolean
mapping_inference
any
folder
string <uuid>
compliance_assessment
required
string <uuid>
evidences
Array of strings <uuid> [ items <uuid > ]
applied_controls
Array of strings <uuid> [ items <uuid > ]
security_exceptions
Array of strings <uuid> [ items <uuid > ]

Responses

Request samples

Content type
{
  • "answers": null,
  • "is_published": true,
  • "eta": "2019-08-24",
  • "due_date": "2019-08-24",
  • "status": "to_do",
  • "result": "not_assessed",
  • "extended_result": "major_nonconformity",
  • "is_scored": true,
  • "score": -9223372036854776000,
  • "documentation_score": -9223372036854776000,
  • "observation": "string",
  • "selected": true,
  • "mapping_inference": null,
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
  • "compliance_assessment": "6bd85a47-43f6-4d11-a20e-028ab89fe81d",
  • "evidences": [
    ],
  • "applied_controls": [
    ],
  • "security_exceptions": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "requirement": "a4691efb-1eb6-47d6-aa05-5aae2c5079c1",
  • "is_published": true,
  • "eta": "2019-08-24",
  • "due_date": "2019-08-24",
  • "status": "to_do",
  • "result": "not_assessed",
  • "extended_result": "major_nonconformity",
  • "is_scored": true,
  • "score": -9223372036854776000,
  • "documentation_score": -9223372036854776000,
  • "observation": "string",
  • "selected": true,
  • "mapping_inference": null,
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
  • "compliance_assessment": "6bd85a47-43f6-4d11-a20e-028ab89fe81d",
  • "evidences": [
    ],
  • "applied_controls": [
    ],
  • "security_exceptions": [
    ]
}

requirement_assessments_retrieve

Return a single object with unauthorized related fields masked.

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Requirement assessment.

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "description": "string",
  • "evidences": [
    ],
  • "compliance_assessment": "string",
  • "folder": "string",
  • "perimeter": "string",
  • "assessable": true,
  • "requirement": {
    },
  • "security_exceptions": [
    ],
  • "is_locked": true,
  • "applied_controls": [
    ],
  • "answers": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "is_published": true,
  • "eta": "2019-08-24",
  • "due_date": "2019-08-24",
  • "status": "to_do",
  • "result": "not_assessed",
  • "extended_result": "major_nonconformity",
  • "is_scored": true,
  • "score": -9223372036854776000,
  • "documentation_score": -9223372036854776000,
  • "observation": "string",
  • "selected": true,
  • "mapping_inference": null
}

requirement_assessments_update

API endpoint that allows requirement assessments to be viewed or edited.

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Requirement assessment.

Request Body schema:
required
answers
any
is_published
boolean (Published)
eta
string or null <date>
due_date
string or null <date>
status
string (StatusB56Enum)
Enum: "to_do" "in_progress" "in_review" "done"
  • to_do - To do
  • in_progress - In progress
  • in_review - In review
  • done - Done
result
string (ResultEnum)
Enum: "not_assessed" "partially_compliant" "non_compliant" "compliant" "not_applicable"
  • not_assessed - Not assessed
  • partially_compliant - Partially compliant
  • non_compliant - Non-compliant
  • compliant - Compliant
  • not_applicable - Not applicable
(ExtendedResultEnum (string or null)) or (BlankEnum (any or null)) or (NullEnum (any or null))
is_scored
boolean
score
integer or null <int64> [ -9223372036854776000 .. 9223372036854776000 ]
documentation_score
integer or null <int64> [ -9223372036854776000 .. 9223372036854776000 ]
observation
string or null
selected
boolean
mapping_inference
any
folder
string <uuid>
compliance_assessment
required
string <uuid>
evidences
Array of strings <uuid> [ items <uuid > ]
applied_controls
Array of strings <uuid> [ items <uuid > ]
security_exceptions
Array of strings <uuid> [ items <uuid > ]

Responses

Request samples

Content type
{
  • "answers": null,
  • "is_published": true,
  • "eta": "2019-08-24",
  • "due_date": "2019-08-24",
  • "status": "to_do",
  • "result": "not_assessed",
  • "extended_result": "major_nonconformity",
  • "is_scored": true,
  • "score": -9223372036854776000,
  • "documentation_score": -9223372036854776000,
  • "observation": "string",
  • "selected": true,
  • "mapping_inference": null,
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
  • "compliance_assessment": "6bd85a47-43f6-4d11-a20e-028ab89fe81d",
  • "evidences": [
    ],
  • "applied_controls": [
    ],
  • "security_exceptions": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "requirement": "a4691efb-1eb6-47d6-aa05-5aae2c5079c1",
  • "is_published": true,
  • "eta": "2019-08-24",
  • "due_date": "2019-08-24",
  • "status": "to_do",
  • "result": "not_assessed",
  • "extended_result": "major_nonconformity",
  • "is_scored": true,
  • "score": -9223372036854776000,
  • "documentation_score": -9223372036854776000,
  • "observation": "string",
  • "selected": true,
  • "mapping_inference": null,
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
  • "compliance_assessment": "6bd85a47-43f6-4d11-a20e-028ab89fe81d",
  • "evidences": [
    ],
  • "applied_controls": [
    ],
  • "security_exceptions": [
    ]
}

requirement_assessments_partial_update

API endpoint that allows requirement assessments to be viewed or edited.

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Requirement assessment.

Request Body schema:
answers
any
is_published
boolean (Published)
eta
string or null <date>
due_date
string or null <date>
status
string (StatusB56Enum)
Enum: "to_do" "in_progress" "in_review" "done"
  • to_do - To do
  • in_progress - In progress
  • in_review - In review
  • done - Done
result
string (ResultEnum)
Enum: "not_assessed" "partially_compliant" "non_compliant" "compliant" "not_applicable"
  • not_assessed - Not assessed
  • partially_compliant - Partially compliant
  • non_compliant - Non-compliant
  • compliant - Compliant
  • not_applicable - Not applicable
(ExtendedResultEnum (string or null)) or (BlankEnum (any or null)) or (NullEnum (any or null))
is_scored
boolean
score
integer or null <int64> [ -9223372036854776000 .. 9223372036854776000 ]
documentation_score
integer or null <int64> [ -9223372036854776000 .. 9223372036854776000 ]
observation
string or null
selected
boolean
mapping_inference
any
folder
string <uuid>
compliance_assessment
string <uuid>
evidences
Array of strings <uuid> [ items <uuid > ]
applied_controls
Array of strings <uuid> [ items <uuid > ]
security_exceptions
Array of strings <uuid> [ items <uuid > ]

Responses

Request samples

Content type
{
  • "answers": null,
  • "is_published": true,
  • "eta": "2019-08-24",
  • "due_date": "2019-08-24",
  • "status": "to_do",
  • "result": "not_assessed",
  • "extended_result": "major_nonconformity",
  • "is_scored": true,
  • "score": -9223372036854776000,
  • "documentation_score": -9223372036854776000,
  • "observation": "string",
  • "selected": true,
  • "mapping_inference": null,
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
  • "compliance_assessment": "6bd85a47-43f6-4d11-a20e-028ab89fe81d",
  • "evidences": [
    ],
  • "applied_controls": [
    ],
  • "security_exceptions": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "requirement": "a4691efb-1eb6-47d6-aa05-5aae2c5079c1",
  • "is_published": true,
  • "eta": "2019-08-24",
  • "due_date": "2019-08-24",
  • "status": "to_do",
  • "result": "not_assessed",
  • "extended_result": "major_nonconformity",
  • "is_scored": true,
  • "score": -9223372036854776000,
  • "documentation_score": -9223372036854776000,
  • "observation": "string",
  • "selected": true,
  • "mapping_inference": null,
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
  • "compliance_assessment": "6bd85a47-43f6-4d11-a20e-028ab89fe81d",
  • "evidences": [
    ],
  • "applied_controls": [
    ],
  • "security_exceptions": [
    ]
}

requirement_assessments_destroy

API endpoint that allows requirement assessments to be viewed or edited.

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Requirement assessment.

Responses

requirement_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 Requirement assessment.

Responses

requirement_assessments_object_retrieve

API endpoint that allows requirement assessments to be viewed or edited.

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Requirement assessment.

Responses

requirement_assessments_suggestions_applied_controls_retrieve

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

Responses

requirement_assessments_suggestions_applied_controls_create

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

Responses

requirement_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

requirement_assessments_extended_result_retrieve

API endpoint that allows requirement assessments to be viewed or edited.

Authorizations:
knoxApiToken

Responses

requirement_assessments_per_status_retrieve

API endpoint that allows requirement assessments to be viewed or edited.

Authorizations:
knoxApiToken

Responses

requirement_assessments_result_retrieve

API endpoint that allows requirement assessments to be viewed or edited.

Authorizations:
knoxApiToken

Responses

requirement_assessments_status_retrieve

API endpoint that allows requirement assessments to be viewed or edited.

Authorizations:
knoxApiToken

Responses

requirement_assessments_to_review_retrieve

API endpoint that allows requirement assessments to be viewed or edited.

Authorizations:
knoxApiToken

Responses

requirement_assessments_todo_retrieve

API endpoint that allows requirement assessments to be viewed or edited.

Authorizations:
knoxApiToken

Responses

requirement_assessments_updatables_retrieve

API endpoint that allows requirement assessments to be viewed or edited.

Authorizations:
knoxApiToken

Responses

requirement-assignments

requirement_assignments_list

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

Authorizations:
knoxApiToken
query Parameters
actor
Array of strings <uuid> [ items <uuid > ]
compliance_assessment
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.

search
string

A search term.

status
Array of strings
Items Enum: "changes_requested" "closed" "draft" "in_progress" "submitted"
  • draft - Draft
  • in_progress - In Progress
  • submitted - Submitted
  • closed - Closed
  • changes_requested - Changes Requested

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": [
    ]
}

requirement_assignments_create

API endpoint that allows requirement assignments to be viewed or edited. Requirement assignments delegate groups of requirement assessments to specific actors.

Authorizations:
knoxApiToken
Request Body schema:
required
is_published
boolean (Published)
folder
string <uuid>
compliance_assessment
required
string <uuid>
actor
required
Array of strings <uuid> (Assigned To) [ items <uuid > ]
requirement_assessments
Array of strings <uuid> (Requirement Assessments) [ items <uuid > ]

Responses

Request samples

Content type
{
  • "is_published": true,
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
  • "compliance_assessment": "6bd85a47-43f6-4d11-a20e-028ab89fe81d",
  • "actor": [
    ],
  • "requirement_assessments": [
    ]
}

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,
  • "status": "draft",
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
  • "compliance_assessment": "6bd85a47-43f6-4d11-a20e-028ab89fe81d",
  • "actor": [
    ],
  • "requirement_assessments": [
    ]
}

requirement_assignments_retrieve

Return a single object with unauthorized related fields masked.

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Requirement Assignment.

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "folder": "string",
  • "compliance_assessment": "string",
  • "actor": [
    ],
  • "requirement_assessments": [
    ],
  • "events": [
    ],
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "is_published": true,
  • "status": "draft"
}

requirement_assignments_update

API endpoint that allows requirement assignments to be viewed or edited. Requirement assignments delegate groups of requirement assessments to specific actors.

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Requirement Assignment.

Request Body schema:
required
is_published
boolean (Published)
folder
string <uuid>
compliance_assessment
required
string <uuid>
actor
required
Array of strings <uuid> (Assigned To) [ items <uuid > ]
requirement_assessments
Array of strings <uuid> (Requirement Assessments) [ items <uuid > ]

Responses

Request samples

Content type
{
  • "is_published": true,
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
  • "compliance_assessment": "6bd85a47-43f6-4d11-a20e-028ab89fe81d",
  • "actor": [
    ],
  • "requirement_assessments": [
    ]
}

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,
  • "status": "draft",
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
  • "compliance_assessment": "6bd85a47-43f6-4d11-a20e-028ab89fe81d",
  • "actor": [
    ],
  • "requirement_assessments": [
    ]
}

requirement_assignments_partial_update

API endpoint that allows requirement assignments to be viewed or edited. Requirement assignments delegate groups of requirement assessments to specific actors.

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Requirement Assignment.

Request Body schema:
is_published
boolean (Published)
folder
string <uuid>
compliance_assessment
string <uuid>
actor
Array of strings <uuid> (Assigned To) [ items <uuid > ]
requirement_assessments
Array of strings <uuid> (Requirement Assessments) [ items <uuid > ]

Responses

Request samples

Content type
{
  • "is_published": true,
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
  • "compliance_assessment": "6bd85a47-43f6-4d11-a20e-028ab89fe81d",
  • "actor": [
    ],
  • "requirement_assessments": [
    ]
}

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,
  • "status": "draft",
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
  • "compliance_assessment": "6bd85a47-43f6-4d11-a20e-028ab89fe81d",
  • "actor": [
    ],
  • "requirement_assessments": [
    ]
}

requirement_assignments_destroy

API endpoint that allows requirement assignments to be viewed or edited. Requirement assignments delegate groups of requirement assessments to specific actors.

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Requirement Assignment.

Responses

requirement_assignments_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 Requirement Assignment.

Responses

requirement_assignments_object_retrieve

API endpoint that allows requirement assignments to be viewed or edited. Requirement assignments delegate groups of requirement assessments to specific actors.

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Requirement Assignment.

Responses

requirement_assignments_requirements_list_retrieve

Returns the scoped requirements list for this assignment.

Authorization is enforced by get_queryset() which filters auditee-only users to their own assignments.

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Requirement Assignment.

Responses

requirement_assignments_set_status_create

Transition assignment to a new status.

Accepts {"status": "", "reviewer_observation": "..."}. Valid transitions and their constraints are defined in TRANSITIONS.

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Requirement Assignment.

Responses

requirement_assignments_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