API docs by Redocly

CISO Assistant API — Evidence & Attachments (0.7.0)

Download OpenAPI specification:

CISO Assistant - API Documentation for automating all your GRC needs

document-attachments

document_attachments_retrieve

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

Authorizations:
knoxApiToken

Responses

document_attachments_create

API endpoint for serving document attachment files.

Authorizations:
knoxApiToken

Responses

document_attachments_retrieve_2

Return a single object with unauthorized related fields masked.

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Document attachment.

Responses

document_attachments_update

API endpoint for serving document attachment files.

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Document attachment.

Responses

document_attachments_partial_update

API endpoint for serving document attachment files.

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Document attachment.

Responses

document_attachments_destroy

API endpoint for serving document attachment files.

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Document attachment.

Responses

document_attachments_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 Document attachment.

Responses

document_attachments_file_retrieve

Serve the attachment file with correct content type.

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Document attachment.

Responses

document_attachments_object_retrieve

API endpoint for serving document attachment files.

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Document attachment.

Responses

document_attachments_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

document-revisions

document_revisions_list

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

Authorizations:
knoxApiToken
query Parameters
document
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: "change_requested" "deprecated" "draft" "in_review" "published" "validated"
  • draft - Draft
  • in_review - In review
  • change_requested - Change requested
  • validated - Validated
  • published - Published
  • 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": [
    ]
}

document_revisions_create

API endpoint that allows document revisions to be viewed or edited.

Authorizations:
knoxApiToken
Request Body schema:
required
is_published
boolean (Published)
content
string
change_summary
string <= 500 characters
folder
string <uuid>
document
required
string <uuid>

Responses

Request samples

Content type
{
  • "is_published": true,
  • "content": "string",
  • "change_summary": "string",
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
  • "document": "ef592bd9-25ea-448f-8809-b37124cc7bef"
}

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,
  • "version_number": 0,
  • "content": "string",
  • "status": "draft",
  • "reviewer_comments": "string",
  • "change_summary": "string",
  • "pdf_snapshot": "http://example.com",
  • "published_at": "2019-08-24T14:15:22Z",
  • "editing_since": "2019-08-24T14:15:22Z",
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
  • "document": "ef592bd9-25ea-448f-8809-b37124cc7bef",
  • "author": "32ad2cdb-22a2-48aa-a42c-1c53a9afc4bd",
  • "reviewer": "a4b7b7a3-a1d0-4e27-9161-fa5679d1e0d6",
  • "editing_user": "4667095d-489c-4ab0-b1af-bfbbc422ed35"
}

document_revisions_retrieve

Return a single object with unauthorized related fields masked.

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Document revision.

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "document": "string",
  • "author": "string",
  • "reviewer": "string",
  • "status_display": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "is_published": true,
  • "version_number": 9223372036854776000,
  • "content": "string",
  • "status": "draft",
  • "reviewer_comments": "string",
  • "change_summary": "string",
  • "pdf_snapshot": "http://example.com",
  • "published_at": "2019-08-24T14:15:22Z",
  • "editing_since": "2019-08-24T14:15:22Z",
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
  • "editing_user": "4667095d-489c-4ab0-b1af-bfbbc422ed35"
}

document_revisions_update

API endpoint that allows document revisions to be viewed or edited.

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Document revision.

Request Body schema:
required
is_published
boolean (Published)
content
string
change_summary
string <= 500 characters
folder
string <uuid>
document
required
string <uuid>

Responses

Request samples

Content type
{
  • "is_published": true,
  • "content": "string",
  • "change_summary": "string",
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
  • "document": "ef592bd9-25ea-448f-8809-b37124cc7bef"
}

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,
  • "version_number": 0,
  • "content": "string",
  • "status": "draft",
  • "reviewer_comments": "string",
  • "change_summary": "string",
  • "pdf_snapshot": "http://example.com",
  • "published_at": "2019-08-24T14:15:22Z",
  • "editing_since": "2019-08-24T14:15:22Z",
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
  • "document": "ef592bd9-25ea-448f-8809-b37124cc7bef",
  • "author": "32ad2cdb-22a2-48aa-a42c-1c53a9afc4bd",
  • "reviewer": "a4b7b7a3-a1d0-4e27-9161-fa5679d1e0d6",
  • "editing_user": "4667095d-489c-4ab0-b1af-bfbbc422ed35"
}

document_revisions_partial_update

API endpoint that allows document revisions to be viewed or edited.

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Document revision.

Request Body schema:
is_published
boolean (Published)
content
string
change_summary
string <= 500 characters
folder
string <uuid>
document
string <uuid>

Responses

Request samples

Content type
{
  • "is_published": true,
  • "content": "string",
  • "change_summary": "string",
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
  • "document": "ef592bd9-25ea-448f-8809-b37124cc7bef"
}

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,
  • "version_number": 0,
  • "content": "string",
  • "status": "draft",
  • "reviewer_comments": "string",
  • "change_summary": "string",
  • "pdf_snapshot": "http://example.com",
  • "published_at": "2019-08-24T14:15:22Z",
  • "editing_since": "2019-08-24T14:15:22Z",
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
  • "document": "ef592bd9-25ea-448f-8809-b37124cc7bef",
  • "author": "32ad2cdb-22a2-48aa-a42c-1c53a9afc4bd",
  • "reviewer": "a4b7b7a3-a1d0-4e27-9161-fa5679d1e0d6",
  • "editing_user": "4667095d-489c-4ab0-b1af-bfbbc422ed35"
}

document_revisions_destroy

API endpoint that allows document revisions to be viewed or edited.

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Document revision.

Responses

document_revisions_approve_create

Approve a revision: transition from in_review to validated.

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Document revision.

Responses

document_revisions_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 Document revision.

Responses

document_revisions_diff_retrieve

Compute unified diff between this revision and another of the same document.

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Document revision.

other_id
required
string

Responses

document_revisions_edit_diff_retrieve

Compute unified diff between two DocumentEdit content snapshots.

Authorizations:
knoxApiToken
path Parameters
edit_a_id
required
string
edit_b_id
required
string
id
required
string <uuid>

A UUID string identifying this Document revision.

Responses

document_revisions_edit_history_retrieve

Return the edit history for this revision.

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Document revision.

Responses

document_revisions_edit_snapshot_retrieve

Return the content snapshot of a specific edit.

Authorizations:
knoxApiToken
path Parameters
edit_id
required
string
id
required
string <uuid>

A UUID string identifying this Document revision.

Responses

document_revisions_editing_status_retrieve

Check who is currently editing.

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Document revision.

Responses

document_revisions_export_pdf_retrieve

Export revision content as a PDF document.

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Document revision.

Responses

document_revisions_object_retrieve

API endpoint that allows document revisions to be viewed or edited.

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Document revision.

Responses

document_revisions_publish_create

Publish a validated revision: deprecate previous, generate PDF.

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Document revision.

Responses

document_revisions_request_changes_create

Request changes on an in-review revision.

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Document revision.

Responses

document_revisions_start_editing_create

Mark the current user as editing this revision.

Uses select_for_update to prevent two concurrent requests from both believing they acquired the lock (race in the read-check-write path).

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Document revision.

Responses

document_revisions_stop_editing_create

Release the editing lock.

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Document revision.

Responses

document_revisions_submit_for_review_create

Transition from draft or change_requested to in_review.

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Document revision.

Responses

document_revisions_take_over_editing_create

Force-acquire the editing lock, overriding the current editor.

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Document revision.

Responses

document_revisions_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

document_revisions_status_retrieve

API endpoint that allows document revisions to be viewed or edited.

Authorizations:
knoxApiToken

Responses

evidence-revisions

evidence_revisions_list

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

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

Multiple values may be separated by commas.

limit
integer

Number of results to return per page.

offset
integer

The initial index from which to return the results.

ordering
string

Which field to use when ordering the results.

search
string

A search term.

Responses

Response samples

Content type
application/json
{}

evidence_revisions_create

API endpoint that allows evidence revisions to be viewed or edited.

Authorizations:
knoxApiToken
Request Body schema:
required
is_published
boolean (Published)
version
integer <int64> (Version number) [ -9223372036854776000 .. 9223372036854776000 ]
attachment
string or null <uri>
attachment_hash
string or null (Attachment SHA256 Hash) <= 64 characters

SHA256 hash of the attachment file for integrity verification

link
string or null <uri> <= 2048 characters
observation
string or null
folder
string <uuid>
evidence
required
string <uuid>
task_node
string or null <uuid>

Responses

Request samples

Content type
{
  • "is_published": true,
  • "version": -9223372036854776000,
  • "attachment": "http://example.com",
  • "attachment_hash": "string",
  • "link": "http://example.com",
  • "observation": "string",
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
  • "evidence": "8c260907-eb60-42e4-a061-22fcfa00a461",
  • "task_node": "dfaea571-f2f2-4944-9882-25d456d7f612"
}

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,
  • "version": -9223372036854776000,
  • "attachment": "http://example.com",
  • "attachment_hash": "string",
  • "link": "http://example.com",
  • "observation": "string",
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
  • "evidence": "8c260907-eb60-42e4-a061-22fcfa00a461",
  • "task_node": "dfaea571-f2f2-4944-9882-25d456d7f612"
}

evidence_revisions_retrieve

Return a single object with unauthorized related fields masked.

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Evidence Revision.

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "attachment": "string",
  • "size": "string",
  • "evidence": "string",
  • "folder": "string",
  • "str": "string",
  • "task_node": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "is_published": true,
  • "version": -9223372036854776000,
  • "attachment_hash": "string",
  • "link": "http://example.com",
  • "observation": "string"
}

evidence_revisions_update

API endpoint that allows evidence revisions to be viewed or edited.

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Evidence Revision.

Request Body schema:
required
is_published
boolean (Published)
version
integer <int64> (Version number) [ -9223372036854776000 .. 9223372036854776000 ]
attachment
string or null <uri>
attachment_hash
string or null (Attachment SHA256 Hash) <= 64 characters

SHA256 hash of the attachment file for integrity verification

link
string or null <uri> <= 2048 characters
observation
string or null
folder
string <uuid>
evidence
required
string <uuid>
task_node
string or null <uuid>

Responses

Request samples

Content type
{
  • "is_published": true,
  • "version": -9223372036854776000,
  • "attachment": "http://example.com",
  • "attachment_hash": "string",
  • "link": "http://example.com",
  • "observation": "string",
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
  • "evidence": "8c260907-eb60-42e4-a061-22fcfa00a461",
  • "task_node": "dfaea571-f2f2-4944-9882-25d456d7f612"
}

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,
  • "version": -9223372036854776000,
  • "attachment": "http://example.com",
  • "attachment_hash": "string",
  • "link": "http://example.com",
  • "observation": "string",
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
  • "evidence": "8c260907-eb60-42e4-a061-22fcfa00a461",
  • "task_node": "dfaea571-f2f2-4944-9882-25d456d7f612"
}

evidence_revisions_partial_update

API endpoint that allows evidence revisions to be viewed or edited.

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Evidence Revision.

Request Body schema:
is_published
boolean (Published)
version
integer <int64> (Version number) [ -9223372036854776000 .. 9223372036854776000 ]
attachment
string or null <uri>
attachment_hash
string or null (Attachment SHA256 Hash) <= 64 characters

SHA256 hash of the attachment file for integrity verification

link
string or null <uri> <= 2048 characters
observation
string or null
folder
string <uuid>
evidence
string <uuid>
task_node
string or null <uuid>

Responses

Request samples

Content type
{
  • "is_published": true,
  • "version": -9223372036854776000,
  • "attachment": "http://example.com",
  • "attachment_hash": "string",
  • "link": "http://example.com",
  • "observation": "string",
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
  • "evidence": "8c260907-eb60-42e4-a061-22fcfa00a461",
  • "task_node": "dfaea571-f2f2-4944-9882-25d456d7f612"
}

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,
  • "version": -9223372036854776000,
  • "attachment": "http://example.com",
  • "attachment_hash": "string",
  • "link": "http://example.com",
  • "observation": "string",
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
  • "evidence": "8c260907-eb60-42e4-a061-22fcfa00a461",
  • "task_node": "dfaea571-f2f2-4944-9882-25d456d7f612"
}

evidence_revisions_destroy

API endpoint that allows evidence revisions to be viewed or edited.

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Evidence Revision.

Responses

evidence_revisions_attachment_retrieve

API endpoint that allows evidence revisions to be viewed or edited.

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Evidence Revision.

Responses

evidence_revisions_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 Evidence Revision.

Responses

evidence_revisions_delete_attachment_create

API endpoint that allows evidence revisions to be viewed or edited.

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Evidence Revision.

Responses

evidence_revisions_object_retrieve

API endpoint that allows evidence revisions to be viewed or edited.

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Evidence Revision.

Responses

evidence_revisions_upload_create

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>
Request Body schema: */*
required
attachment
required
string <uri>

Responses

Response samples

Content type
application/json
{}

evidence_revisions_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

evidences

evidences_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 > ]
contracts
Array of strings <uuid> [ items <uuid > ]
expiry_date
string <date>
filtering_labels
Array of strings <uuid> [ items <uuid > ]
findings
Array of strings <uuid> [ items <uuid > ]
findings_assessments
Array of strings <uuid> [ items <uuid > ]
folder
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.

owner
Array of strings <uuid> [ items <uuid > ]
processings
Array of strings <uuid> [ items <uuid > ]
requirement_assessments
Array of strings <uuid> [ items <uuid > ]
search
string

A search term.

status
Array of strings
Items Enum: "approved" "draft" "expired" "in_review" "missing" "rejected"
  • draft - Draft
  • missing - Missing
  • in_review - In review
  • approved - Approved
  • rejected - Rejected
  • expired - Expired
timeline_entries
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": [
    ]
}

evidences_create

API endpoint that allows evidences to be viewed or edited.

Authorizations:
knoxApiToken
Request Body schema:
required
applied_controls
Array of strings <uuid> [ items <uuid > ]
requirement_assessments
Array of strings <uuid> [ items <uuid > ]
findings
Array of strings <uuid> [ items <uuid > ]
findings_assessments
Array of strings <uuid> [ items <uuid > ]
timeline_entries
Array of strings <uuid> [ items <uuid > ]
contracts
Array of strings <uuid> [ items <uuid > ]
owner
Array of strings <uuid> [ items <uuid > ]
attachment
string <uri>
link
string <uri>
name
required
string <= 200 characters
description
string or null
status
string (EvidenceWriteStatusEnum)
Enum: "draft" "missing" "in_review" "approved" "rejected" "expired"
  • draft - Draft
  • missing - Missing
  • in_review - In review
  • approved - Approved
  • rejected - Rejected
  • expired - Expired
expiry_date
string or null <date>
folder
string <uuid>
filtering_labels
Array of strings <uuid> (Labels) [ items <uuid > ]

Responses

Request samples

Content type
{
  • "applied_controls": [
    ],
  • "requirement_assessments": [
    ],
  • "findings": [
    ],
  • "findings_assessments": [
    ],
  • "timeline_entries": [
    ],
  • "contracts": [
    ],
  • "owner": [
    ],
  • "attachment": "http://example.com",
  • "link": "http://example.com",
  • "name": "string",
  • "description": "string",
  • "status": "draft",
  • "expiry_date": "2019-08-24",
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
  • "filtering_labels": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "applied_controls": [
    ],
  • "requirement_assessments": [
    ],
  • "findings": [
    ],
  • "findings_assessments": [
    ],
  • "timeline_entries": [
    ],
  • "contracts": [
    ],
  • "owner": [
    ],
  • "attachment": "http://example.com",
  • "link": "http://example.com",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "description": "string",
  • "status": "draft",
  • "expiry_date": "2019-08-24",
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
  • "filtering_labels": [
    ]
}

evidences_retrieve

Return a single object with unauthorized related fields masked.

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Evidence.

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "path": "string",
  • "attachment": "string",
  • "size": "string",
  • "folder": "string",
  • "applied_controls": [
    ],
  • "requirement_assessments": [
    ],
  • "contracts": [
    ],
  • "filtering_labels": [
    ],
  • "owner": [
    ],
  • "status": "string",
  • "link": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "description": "string",
  • "is_published": true,
  • "expiry_date": "2019-08-24"
}

evidences_update

API endpoint that allows evidences to be viewed or edited.

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Evidence.

Request Body schema:
required
applied_controls
Array of strings <uuid> [ items <uuid > ]
requirement_assessments
Array of strings <uuid> [ items <uuid > ]
findings
Array of strings <uuid> [ items <uuid > ]
findings_assessments
Array of strings <uuid> [ items <uuid > ]
timeline_entries
Array of strings <uuid> [ items <uuid > ]
contracts
Array of strings <uuid> [ items <uuid > ]
owner
Array of strings <uuid> [ items <uuid > ]
attachment
string <uri>
link
string <uri>
name
required
string <= 200 characters
description
string or null
status
string (EvidenceWriteStatusEnum)
Enum: "draft" "missing" "in_review" "approved" "rejected" "expired"
  • draft - Draft
  • missing - Missing
  • in_review - In review
  • approved - Approved
  • rejected - Rejected
  • expired - Expired
expiry_date
string or null <date>
folder
string <uuid>
filtering_labels
Array of strings <uuid> (Labels) [ items <uuid > ]

Responses

Request samples

Content type
{
  • "applied_controls": [
    ],
  • "requirement_assessments": [
    ],
  • "findings": [
    ],
  • "findings_assessments": [
    ],
  • "timeline_entries": [
    ],
  • "contracts": [
    ],
  • "owner": [
    ],
  • "attachment": "http://example.com",
  • "link": "http://example.com",
  • "name": "string",
  • "description": "string",
  • "status": "draft",
  • "expiry_date": "2019-08-24",
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
  • "filtering_labels": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "applied_controls": [
    ],
  • "requirement_assessments": [
    ],
  • "findings": [
    ],
  • "findings_assessments": [
    ],
  • "timeline_entries": [
    ],
  • "contracts": [
    ],
  • "owner": [
    ],
  • "attachment": "http://example.com",
  • "link": "http://example.com",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "description": "string",
  • "status": "draft",
  • "expiry_date": "2019-08-24",
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
  • "filtering_labels": [
    ]
}

evidences_partial_update

API endpoint that allows evidences to be viewed or edited.

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Evidence.

Request Body schema:
applied_controls
Array of strings <uuid> [ items <uuid > ]
requirement_assessments
Array of strings <uuid> [ items <uuid > ]
findings
Array of strings <uuid> [ items <uuid > ]
findings_assessments
Array of strings <uuid> [ items <uuid > ]
timeline_entries
Array of strings <uuid> [ items <uuid > ]
contracts
Array of strings <uuid> [ items <uuid > ]
owner
Array of strings <uuid> [ items <uuid > ]
attachment
string <uri>
link
string <uri>
name
string <= 200 characters
description
string or null
status
string (EvidenceWriteStatusEnum)
Enum: "draft" "missing" "in_review" "approved" "rejected" "expired"
  • draft - Draft
  • missing - Missing
  • in_review - In review
  • approved - Approved
  • rejected - Rejected
  • expired - Expired
expiry_date
string or null <date>
folder
string <uuid>
filtering_labels
Array of strings <uuid> (Labels) [ items <uuid > ]

Responses

Request samples

Content type
{
  • "applied_controls": [
    ],
  • "requirement_assessments": [
    ],
  • "findings": [
    ],
  • "findings_assessments": [
    ],
  • "timeline_entries": [
    ],
  • "contracts": [
    ],
  • "owner": [
    ],
  • "attachment": "http://example.com",
  • "link": "http://example.com",
  • "name": "string",
  • "description": "string",
  • "status": "draft",
  • "expiry_date": "2019-08-24",
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
  • "filtering_labels": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "applied_controls": [
    ],
  • "requirement_assessments": [
    ],
  • "findings": [
    ],
  • "findings_assessments": [
    ],
  • "timeline_entries": [
    ],
  • "contracts": [
    ],
  • "owner": [
    ],
  • "attachment": "http://example.com",
  • "link": "http://example.com",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "description": "string",
  • "status": "draft",
  • "expiry_date": "2019-08-24",
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
  • "filtering_labels": [
    ]
}

evidences_destroy

API endpoint that allows evidences to be viewed or edited.

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Evidence.

Responses

evidences_attachment_retrieve

API endpoint that allows evidences to be viewed or edited.

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Evidence.

Responses

evidences_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 Evidence.

Responses

evidences_object_retrieve

API endpoint that allows evidences to be viewed or edited.

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Evidence.

Responses

evidences_upload_create

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>
Request Body schema: */*
required
attachment
required
string <uri>

Responses

Response samples

Content type
application/json
{}

evidences_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

evidences_owner_retrieve

API endpoint that allows evidences to be viewed or edited.

Authorizations:
knoxApiToken

Responses

evidences_status_retrieve

API endpoint that allows evidences to be viewed or edited.

Authorizations:
knoxApiToken

Responses