API docs by Redocly

CISO Assistant API — Tasks & Timeline (0.7.0)

Download OpenAPI specification:

CISO Assistant - API Documentation for automating all your GRC needs

comments

comments_list

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

Authorizations:
knoxApiToken
query Parameters
applied_control
Array of strings <uuid> [ items <uuid > ]
author
Array of strings <uuid> [ items <uuid > ]
finding
Array of strings <uuid> [ items <uuid > ]
id
Array of strings <uuid> [ items <uuid > ]

Multiple values may be separated by commas.

is_active
boolean
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_assessment
Array of strings <uuid> [ items <uuid > ]
risk_scenario
Array of strings <uuid> [ items <uuid > ]
search
string

A search term.

Responses

Response samples

Content type
application/json
{}

comments_create

Authorizations:
knoxApiToken
Request Body schema:
required
body
required
string
is_active
boolean (Active)
is_published
boolean
requirement_assessment
string or null <uuid>
risk_scenario
string or null <uuid>
applied_control
string or null <uuid>
finding
string or null <uuid>

Responses

Request samples

Content type
{
  • "body": "string",
  • "is_active": true,
  • "is_published": true,
  • "requirement_assessment": "15f5e242-5dd6-4e67-85f4-ee93baa21aa7",
  • "risk_scenario": "08629164-e178-4d7d-834e-755ca00a854a",
  • "applied_control": "0ad321c3-e2b0-4fba-a368-f2fa0a79ced8",
  • "finding": "7f575d74-6d04-459c-97ca-4cfccc1c9531"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "body": "string",
  • "is_active": true,
  • "is_published": true,
  • "requirement_assessment": "15f5e242-5dd6-4e67-85f4-ee93baa21aa7",
  • "risk_scenario": "08629164-e178-4d7d-834e-755ca00a854a",
  • "applied_control": "0ad321c3-e2b0-4fba-a368-f2fa0a79ced8",
  • "finding": "7f575d74-6d04-459c-97ca-4cfccc1c9531"
}

comments_retrieve

Return a single object with unauthorized related fields masked.

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this comment.

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "str": "string",
  • "author": "string",
  • "folder": "string",
  • "requirement_assessment": "string",
  • "risk_scenario": "string",
  • "applied_control": "string",
  • "finding": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "body": "string",
  • "is_tainted": true,
  • "is_active": true,
  • "is_published": true
}

comments_update

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this comment.

Request Body schema:
required
body
required
string
is_active
boolean (Active)
is_published
boolean
requirement_assessment
string or null <uuid>
risk_scenario
string or null <uuid>
applied_control
string or null <uuid>
finding
string or null <uuid>

Responses

Request samples

Content type
{
  • "body": "string",
  • "is_active": true,
  • "is_published": true,
  • "requirement_assessment": "15f5e242-5dd6-4e67-85f4-ee93baa21aa7",
  • "risk_scenario": "08629164-e178-4d7d-834e-755ca00a854a",
  • "applied_control": "0ad321c3-e2b0-4fba-a368-f2fa0a79ced8",
  • "finding": "7f575d74-6d04-459c-97ca-4cfccc1c9531"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "body": "string",
  • "is_active": true,
  • "is_published": true,
  • "requirement_assessment": "15f5e242-5dd6-4e67-85f4-ee93baa21aa7",
  • "risk_scenario": "08629164-e178-4d7d-834e-755ca00a854a",
  • "applied_control": "0ad321c3-e2b0-4fba-a368-f2fa0a79ced8",
  • "finding": "7f575d74-6d04-459c-97ca-4cfccc1c9531"
}

comments_partial_update

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this comment.

Request Body schema:
body
string
is_active
boolean (Active)
is_published
boolean
requirement_assessment
string or null <uuid>
risk_scenario
string or null <uuid>
applied_control
string or null <uuid>
finding
string or null <uuid>

Responses

Request samples

Content type
{
  • "body": "string",
  • "is_active": true,
  • "is_published": true,
  • "requirement_assessment": "15f5e242-5dd6-4e67-85f4-ee93baa21aa7",
  • "risk_scenario": "08629164-e178-4d7d-834e-755ca00a854a",
  • "applied_control": "0ad321c3-e2b0-4fba-a368-f2fa0a79ced8",
  • "finding": "7f575d74-6d04-459c-97ca-4cfccc1c9531"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "body": "string",
  • "is_active": true,
  • "is_published": true,
  • "requirement_assessment": "15f5e242-5dd6-4e67-85f4-ee93baa21aa7",
  • "risk_scenario": "08629164-e178-4d7d-834e-755ca00a854a",
  • "applied_control": "0ad321c3-e2b0-4fba-a368-f2fa0a79ced8",
  • "finding": "7f575d74-6d04-459c-97ca-4cfccc1c9531"
}

comments_destroy

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this comment.

Responses

comments_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 comment.

Responses

comments_object_retrieve

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this comment.

Responses

comments_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

task-nodes

task_nodes_list

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

Authorizations:
knoxApiToken
query Parameters
due_date
string <date>
due_date__gt
string <date>
due_date__gte
string <date>
due_date__lt
string <date>
due_date__lte
string <date>
due_date__month
number
due_date__year
number
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.

past
boolean
search
string

A search term.

status
Array of strings
Items Enum: "cancelled" "completed" "in_progress" "pending"
  • pending - Pending
  • in_progress - In progress
  • completed - Completed
  • cancelled - Cancelled
task_template
string <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": [
    ]
}

task_nodes_create

Authorizations:
knoxApiToken
Request Body schema:
is_published
boolean (Published)
due_date
string or null <date>
status
string (Status9a3Enum)
Enum: "pending" "in_progress" "completed" "cancelled"
  • pending - Pending
  • in_progress - In progress
  • completed - Completed
  • cancelled - Cancelled
observation
string or null
to_delete
boolean
folder
string <uuid>

Responses

Request samples

Content type
{
  • "is_published": true,
  • "due_date": "2019-08-24",
  • "status": "pending",
  • "observation": "string",
  • "to_delete": true,
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5"
}

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,
  • "due_date": "2019-08-24",
  • "status": "pending",
  • "observation": "string",
  • "to_delete": true,
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5"
}

task_nodes_retrieve

Return a single object with unauthorized related fields masked.

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Task node.

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "path": "string",
  • "task_template": "string",
  • "folder": "string",
  • "name": "string",
  • "assigned_to": [
    ],
  • "evidences": [
    ],
  • "is_recurrent": true,
  • "expected_evidence": [
    ],
  • "evidence_reviewed": "string",
  • "evidence_revisions_map": "string",
  • "applied_controls": [
    ],
  • "compliance_assessments": [
    ],
  • "assets": [
    ],
  • "risk_assessments": [
    ],
  • "findings_assessment": [
    ],
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "is_published": true,
  • "due_date": "2019-08-24",
  • "scheduled_date": "2019-08-24",
  • "status": "pending",
  • "observation": "string"
}

task_nodes_update

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Task node.

Request Body schema:
is_published
boolean (Published)
due_date
string or null <date>
status
string (Status9a3Enum)
Enum: "pending" "in_progress" "completed" "cancelled"
  • pending - Pending
  • in_progress - In progress
  • completed - Completed
  • cancelled - Cancelled
observation
string or null
to_delete
boolean
folder
string <uuid>

Responses

Request samples

Content type
{
  • "is_published": true,
  • "due_date": "2019-08-24",
  • "status": "pending",
  • "observation": "string",
  • "to_delete": true,
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5"
}

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,
  • "due_date": "2019-08-24",
  • "status": "pending",
  • "observation": "string",
  • "to_delete": true,
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5"
}

task_nodes_partial_update

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Task node.

Request Body schema:
is_published
boolean (Published)
due_date
string or null <date>
status
string (Status9a3Enum)
Enum: "pending" "in_progress" "completed" "cancelled"
  • pending - Pending
  • in_progress - In progress
  • completed - Completed
  • cancelled - Cancelled
observation
string or null
to_delete
boolean
folder
string <uuid>

Responses

Request samples

Content type
{
  • "is_published": true,
  • "due_date": "2019-08-24",
  • "status": "pending",
  • "observation": "string",
  • "to_delete": true,
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5"
}

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,
  • "due_date": "2019-08-24",
  • "status": "pending",
  • "observation": "string",
  • "to_delete": true,
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5"
}

task_nodes_destroy

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Task node.

Responses

task_nodes_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 Task node.

Responses

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

task_nodes_object_retrieve

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Task node.

Responses

task_nodes_remove_evidence_create

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Task node.

Responses

task_nodes_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

task_nodes_status_retrieve

Authorizations:
knoxApiToken

Responses

task-templates

task_templates_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 > ]
assigned_to
Array of strings <uuid> [ items <uuid > ]
evidences
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.

is_recurrent
boolean
last_occurrence_status
Array of strings
Items Enum: "cancelled" "completed" "in_progress" "pending"
  • pending - Pending
  • in_progress - In progress
  • completed - Completed
  • cancelled - Cancelled
limit
integer

Number of results to return per page.

name
string
next_occurrence_status
Array of strings
Items Enum: "cancelled" "completed" "in_progress" "pending"
  • pending - Pending
  • in_progress - In progress
  • completed - Completed
  • cancelled - Cancelled
objectives
Array of strings <uuid> [ items <uuid > ]
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": [
    ]
}

task_templates_create

Generic export mixin for CSV/XLSX exports. ViewSets define export_config with fields, formatting, and query optimization hints.

Authorizations:
knoxApiToken
Request Body schema:
required
status
string
observation
string or null
objectives
Array of strings <uuid> [ items <uuid > ]
is_published
boolean (Published)
name
required
string <= 200 characters
description
string or null
task_date
string or null <date> (Date)
is_recurrent
boolean
ref_id
string or null (Reference id) <= 100 characters
schedule
any or null (Schedule definition)
enabled
boolean
link
string or null <uri> <= 2048 characters

Link to the evidence (eg. Jira ticket, etc.)

folder
string <uuid>
assigned_to
Array of strings <uuid> [ items <uuid > ]
evidences
Array of strings <uuid> [ items <uuid > ]

Evidences related to the task

assets
Array of strings <uuid> (Related assets) [ items <uuid > ]

Assets related to the task

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

Applied controls related to the task

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

Compliance assessments related to the task

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

Risk assessments related to the task

findings_assessment
Array of strings <uuid> (Finding assessments) [ items <uuid > ]

Finding assessments related to the task

Responses

Request samples

Content type
{
  • "status": "string",
  • "observation": "string",
  • "objectives": [
    ],
  • "is_published": true,
  • "name": "string",
  • "description": "string",
  • "task_date": "2019-08-24",
  • "is_recurrent": true,
  • "ref_id": "string",
  • "schedule": null,
  • "enabled": true,
  • "link": "http://example.com",
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
  • "assigned_to": [
    ],
  • "evidences": [
    ],
  • "assets": [
    ],
  • "applied_controls": [
    ],
  • "compliance_assessments": [
    ],
  • "risk_assessments": [
    ],
  • "findings_assessment": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "status": "string",
  • "observation": "string",
  • "objectives": [
    ],
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "is_published": true,
  • "name": "string",
  • "description": "string",
  • "task_date": "2019-08-24",
  • "is_recurrent": true,
  • "ref_id": "string",
  • "schedule": null,
  • "enabled": true,
  • "link": "http://example.com",
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
  • "assigned_to": [
    ],
  • "evidences": [
    ],
  • "assets": [
    ],
  • "applied_controls": [
    ],
  • "compliance_assessments": [
    ],
  • "risk_assessments": [
    ],
  • "findings_assessment": [
    ]
}

task_templates_retrieve

Return a single object with unauthorized related fields masked.

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Task template.

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "path": "string",
  • "folder": "string",
  • "evidences": [
    ],
  • "assets": [
    ],
  • "applied_controls": [
    ],
  • "compliance_assessments": [
    ],
  • "risk_assessments": [
    ],
  • "assigned_to": [
    ],
  • "findings_assessment": [
    ],
  • "next_occurrence": "string",
  • "last_occurrence_status": "string",
  • "next_occurrence_status": "string",
  • "status": "string",
  • "observation": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "is_published": true,
  • "name": "string",
  • "description": "string",
  • "task_date": "2019-08-24",
  • "is_recurrent": true,
  • "ref_id": "string",
  • "enabled": true,
  • "link": "http://example.com"
}

task_templates_update

Generic export mixin for CSV/XLSX exports. ViewSets define export_config with fields, formatting, and query optimization hints.

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Task template.

Request Body schema:
required
status
string
observation
string or null
objectives
Array of strings <uuid> [ items <uuid > ]
is_published
boolean (Published)
name
required
string <= 200 characters
description
string or null
task_date
string or null <date> (Date)
is_recurrent
boolean
ref_id
string or null (Reference id) <= 100 characters
schedule
any or null (Schedule definition)
enabled
boolean
link
string or null <uri> <= 2048 characters

Link to the evidence (eg. Jira ticket, etc.)

folder
string <uuid>
assigned_to
Array of strings <uuid> [ items <uuid > ]
evidences
Array of strings <uuid> [ items <uuid > ]

Evidences related to the task

assets
Array of strings <uuid> (Related assets) [ items <uuid > ]

Assets related to the task

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

Applied controls related to the task

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

Compliance assessments related to the task

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

Risk assessments related to the task

findings_assessment
Array of strings <uuid> (Finding assessments) [ items <uuid > ]

Finding assessments related to the task

Responses

Request samples

Content type
{
  • "status": "string",
  • "observation": "string",
  • "objectives": [
    ],
  • "is_published": true,
  • "name": "string",
  • "description": "string",
  • "task_date": "2019-08-24",
  • "is_recurrent": true,
  • "ref_id": "string",
  • "schedule": null,
  • "enabled": true,
  • "link": "http://example.com",
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
  • "assigned_to": [
    ],
  • "evidences": [
    ],
  • "assets": [
    ],
  • "applied_controls": [
    ],
  • "compliance_assessments": [
    ],
  • "risk_assessments": [
    ],
  • "findings_assessment": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "status": "string",
  • "observation": "string",
  • "objectives": [
    ],
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "is_published": true,
  • "name": "string",
  • "description": "string",
  • "task_date": "2019-08-24",
  • "is_recurrent": true,
  • "ref_id": "string",
  • "schedule": null,
  • "enabled": true,
  • "link": "http://example.com",
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
  • "assigned_to": [
    ],
  • "evidences": [
    ],
  • "assets": [
    ],
  • "applied_controls": [
    ],
  • "compliance_assessments": [
    ],
  • "risk_assessments": [
    ],
  • "findings_assessment": [
    ]
}

task_templates_partial_update

Generic export mixin for CSV/XLSX exports. ViewSets define export_config with fields, formatting, and query optimization hints.

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Task template.

Request Body schema:
status
string
observation
string or null
objectives
Array of strings <uuid> [ items <uuid > ]
is_published
boolean (Published)
name
string <= 200 characters
description
string or null
task_date
string or null <date> (Date)
is_recurrent
boolean
ref_id
string or null (Reference id) <= 100 characters
schedule
any or null (Schedule definition)
enabled
boolean
link
string or null <uri> <= 2048 characters

Link to the evidence (eg. Jira ticket, etc.)

folder
string <uuid>
assigned_to
Array of strings <uuid> [ items <uuid > ]
evidences
Array of strings <uuid> [ items <uuid > ]

Evidences related to the task

assets
Array of strings <uuid> (Related assets) [ items <uuid > ]

Assets related to the task

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

Applied controls related to the task

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

Compliance assessments related to the task

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

Risk assessments related to the task

findings_assessment
Array of strings <uuid> (Finding assessments) [ items <uuid > ]

Finding assessments related to the task

Responses

Request samples

Content type
{
  • "status": "string",
  • "observation": "string",
  • "objectives": [
    ],
  • "is_published": true,
  • "name": "string",
  • "description": "string",
  • "task_date": "2019-08-24",
  • "is_recurrent": true,
  • "ref_id": "string",
  • "schedule": null,
  • "enabled": true,
  • "link": "http://example.com",
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
  • "assigned_to": [
    ],
  • "evidences": [
    ],
  • "assets": [
    ],
  • "applied_controls": [
    ],
  • "compliance_assessments": [
    ],
  • "risk_assessments": [
    ],
  • "findings_assessment": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "status": "string",
  • "observation": "string",
  • "objectives": [
    ],
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "is_published": true,
  • "name": "string",
  • "description": "string",
  • "task_date": "2019-08-24",
  • "is_recurrent": true,
  • "ref_id": "string",
  • "schedule": null,
  • "enabled": true,
  • "link": "http://example.com",
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
  • "assigned_to": [
    ],
  • "evidences": [
    ],
  • "assets": [
    ],
  • "applied_controls": [
    ],
  • "compliance_assessments": [
    ],
  • "risk_assessments": [
    ],
  • "findings_assessment": [
    ]
}

task_templates_destroy

Generic export mixin for CSV/XLSX exports. ViewSets define export_config with fields, formatting, and query optimization hints.

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Task template.

Responses

task_templates_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 Task template.

Responses

task_templates_object_retrieve

Generic export mixin for CSV/XLSX exports. ViewSets define export_config with fields, formatting, and query optimization hints.

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Task template.

Responses

task_templates_assigned_to_retrieve

Generic export mixin for CSV/XLSX exports. ViewSets define export_config with fields, formatting, and query optimization hints.

Authorizations:
knoxApiToken

Responses

task_templates_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

task_templates_calendar_retrieve

Generic export mixin for CSV/XLSX exports. ViewSets define export_config with fields, formatting, and query optimization hints.

Authorizations:
knoxApiToken
path Parameters
end
required
string^.+$
start
required
string^.+$

Responses

task_templates_export_csv_retrieve

Generic export mixin for CSV/XLSX exports. ViewSets define export_config with fields, formatting, and query optimization hints.

Authorizations:
knoxApiToken

Responses

task_templates_export_xlsx_retrieve

Export task templates with a summary sheet and individual sheets for each template's task nodes.

Authorizations:
knoxApiToken

Responses

task_templates_per_status_retrieve

Generic export mixin for CSV/XLSX exports. ViewSets define export_config with fields, formatting, and query optimization hints.

Authorizations:
knoxApiToken

Responses

task_templates_status_retrieve

Generic export mixin for CSV/XLSX exports. ViewSets define export_config with fields, formatting, and query optimization hints.

Authorizations:
knoxApiToken

Responses

task_templates_yearly_review_retrieve

Get recurrent task templates grouped by folder for yearly review.

Authorizations:
knoxApiToken

Responses

timeline-entries

timeline_entries_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.

incident
Array of strings <uuid> [ items <uuid > ]
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
{}

timeline_entries_create

Authorizations:
knoxApiToken
Request Body schema:
required
entry
required
string <= 200 characters
entry_type
string (EntryTypeEnum)
Enum: "detection" "mitigation" "observation" "severity_changed" "status_changed"
  • detection - Detection
  • mitigation - Mitigation
  • observation - Observation
  • severity_changed - Severity changed
  • status_changed - Status changed
timestamp
string <date-time>
observation
string or null
is_published
boolean (Published)
folder
string <uuid>
incident
required
string <uuid>
author
string or null <uuid>
evidences
Array of strings <uuid> (Evidence) [ items <uuid > ]

Responses

Request samples

Content type
{
  • "entry": "string",
  • "entry_type": "detection",
  • "timestamp": "2019-08-24T14:15:22Z",
  • "observation": "string",
  • "is_published": true,
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
  • "incident": "08f18b31-f0be-4113-98db-25ecf0e9a038",
  • "author": "32ad2cdb-22a2-48aa-a42c-1c53a9afc4bd",
  • "evidences": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "entry": "string",
  • "entry_type": "detection",
  • "timestamp": "2019-08-24T14:15:22Z",
  • "observation": "string",
  • "is_published": true,
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
  • "incident": "08f18b31-f0be-4113-98db-25ecf0e9a038",
  • "author": "32ad2cdb-22a2-48aa-a42c-1c53a9afc4bd",
  • "evidences": [
    ]
}

timeline_entries_retrieve

Return a single object with unauthorized related fields masked.

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this timeline entry.

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "path": "string",
  • "str": "string",
  • "author": "string",
  • "folder": "string",
  • "incident": "string",
  • "evidences": [
    ],
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "entry": "string",
  • "entry_type": "detection",
  • "timestamp": "2019-08-24T14:15:22Z",
  • "observation": "string",
  • "is_published": true
}

timeline_entries_update

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this timeline entry.

Request Body schema:
required
entry
required
string <= 200 characters
entry_type
string (EntryTypeEnum)
Enum: "detection" "mitigation" "observation" "severity_changed" "status_changed"
  • detection - Detection
  • mitigation - Mitigation
  • observation - Observation
  • severity_changed - Severity changed
  • status_changed - Status changed
timestamp
string <date-time>
observation
string or null
is_published
boolean (Published)
folder
string <uuid>
incident
required
string <uuid>
author
string or null <uuid>
evidences
Array of strings <uuid> (Evidence) [ items <uuid > ]

Responses

Request samples

Content type
{
  • "entry": "string",
  • "entry_type": "detection",
  • "timestamp": "2019-08-24T14:15:22Z",
  • "observation": "string",
  • "is_published": true,
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
  • "incident": "08f18b31-f0be-4113-98db-25ecf0e9a038",
  • "author": "32ad2cdb-22a2-48aa-a42c-1c53a9afc4bd",
  • "evidences": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "entry": "string",
  • "entry_type": "detection",
  • "timestamp": "2019-08-24T14:15:22Z",
  • "observation": "string",
  • "is_published": true,
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
  • "incident": "08f18b31-f0be-4113-98db-25ecf0e9a038",
  • "author": "32ad2cdb-22a2-48aa-a42c-1c53a9afc4bd",
  • "evidences": [
    ]
}

timeline_entries_partial_update

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this timeline entry.

Request Body schema:
entry
string <= 200 characters
entry_type
string (EntryTypeEnum)
Enum: "detection" "mitigation" "observation" "severity_changed" "status_changed"
  • detection - Detection
  • mitigation - Mitigation
  • observation - Observation
  • severity_changed - Severity changed
  • status_changed - Status changed
timestamp
string <date-time>
observation
string or null
is_published
boolean (Published)
folder
string <uuid>
incident
string <uuid>
author
string or null <uuid>
evidences
Array of strings <uuid> (Evidence) [ items <uuid > ]

Responses

Request samples

Content type
{
  • "entry": "string",
  • "entry_type": "detection",
  • "timestamp": "2019-08-24T14:15:22Z",
  • "observation": "string",
  • "is_published": true,
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
  • "incident": "08f18b31-f0be-4113-98db-25ecf0e9a038",
  • "author": "32ad2cdb-22a2-48aa-a42c-1c53a9afc4bd",
  • "evidences": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "entry": "string",
  • "entry_type": "detection",
  • "timestamp": "2019-08-24T14:15:22Z",
  • "observation": "string",
  • "is_published": true,
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
  • "incident": "08f18b31-f0be-4113-98db-25ecf0e9a038",
  • "author": "32ad2cdb-22a2-48aa-a42c-1c53a9afc4bd",
  • "evidences": [
    ]
}

timeline_entries_destroy

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this timeline entry.

Responses

timeline_entries_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 timeline entry.

Responses

timeline_entries_object_retrieve

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this timeline entry.

Responses

timeline_entries_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

timeline_entries_entry_type_retrieve

Authorizations:
knoxApiToken

Responses