AuditComply API (1.0.0)

Download OpenAPI specification:Download

E-mail: [email protected] Terms of Service

We offer a secure API that any organisation can consume and integrate into their own systems.

This guide will detail the endpoints and the authorisation process how to consume the RESTful data.

To get started – please email support@auditcomply.com with a username/email requesting this user be enabled with API access. Once the user has access, you can begin extracting data from AuditComply.

Authentication

jwtAuth

Token-based authentication with required prefix "JWT"

Security Scheme Type	API Key
Header parameter name:	Authorization

api-token-auth

api_token_auth_create

API View that receives a POST with a user's username and password.

Returns a JSON Web Token that can be used for authenticated requests.

Request Body schema:
application/json
application/json
application/x-www-form-urlencoded
multipart/form-data

username required	string
password required	string

Responses

Request samples

Payload

Content type

{"username": "string",
"password": "string"
}

Response samples

200

Content type

application/json

{"username": "string"
}

api-token-refresh

api_token_refresh_create

API View that returns a refreshed token (with new expiration) based on existing token

If 'orig_iat' field (original issued-at-time) is found, will first check if it's within expiration window, then copy it to the new token

Request Body schema:
application/json
application/json
application/x-www-form-urlencoded
multipart/form-data

token

required

string

Responses

Request samples

Payload

Content type

{"token": "string"
}

Response samples

200

Content type

application/json

{"token": "string"
}

asset

asset_retrieve

API endpoint that allows displays asset information.

Authorizations:

jwtAuth

Responses

asset_create

API endpoint that allows displays asset information.

Authorizations:

jwtAuth

query Parameters

	object Asset Profile Metadata (Dict of metadata containing list of field_id and value, determined from AC portal - see payload example)
metadata_template_id required	integer Asset Profile Template ID

Responses

asset_retrieve_2

API endpoint that allows displays asset information.

Authorizations:

jwtAuth

path Parameters

id

required

integer

A unique integer value identifying this asset.

Responses

asset_breadcrumbs

asset_breadcrumbs_list

API endpoint that displays asset breadcrumbs

Authorizations:

jwtAuth

query Parameters

page	integer A page number within the paginated result set.
page_size	integer Number of results to return per page.

Responses

Response samples

200

Content type

application/json

{"count": 123,
"next": "http://api.example.org/accounts/?page=4",
"previous": "http://api.example.org/accounts/?page=2",
"results": [{"id": 0,
"name": "string",
"breadcrumb": "string"
}
]
}

asset_breadcrumbs_retrieve

API endpoint that displays asset breadcrumbs

Authorizations:

jwtAuth

path Parameters

id

required

integer

A unique integer value identifying this asset.

Responses

Response samples

200

Content type

application/json

{"id": 0,
"name": "string",
"breadcrumb": "string"
}

asset_profiles

asset_profiles_list

API endpoint that lists all active Asset Profiles.

Authorizations:

jwtAuth

query Parameters

page	integer A page number within the paginated result set.
page_size	integer Number of results to return per page.

Responses

Response samples

200

Content type

application/json

{"count": 123,
"next": "http://api.example.org/accounts/?page=4",
"previous": "http://api.example.org/accounts/?page=2",
"results": [{"name": "string",
"id": 0,
"profile_fields": {"property1": null,
"property2": null
}
}
]
}

asset_profiles_retrieve

API endpoint that lists all active Asset Profiles.

Authorizations:

jwtAuth

path Parameters

id

required

integer

A unique integer value identifying this asset template.

Responses

Response samples

200

Content type

application/json

{"name": "string",
"id": 0,
"profile_fields": {"property1": null,
"property2": null
}
}

asset_tree

asset_tree_list

API endpoint that allows asset tree to be viewed.

Authorizations:

jwtAuth

query Parameters

page	integer A page number within the paginated result set.
page_size	integer Number of results to return per page.

Responses

Response samples

200

Content type

application/json

{"count": 123,
"next": "http://api.example.org/accounts/?page=4",
"previous": "http://api.example.org/accounts/?page=2",
"results": [{"id": 0,
"name": "string",
"parent_id": 0,
"numchild": 2147483647
}
]
}

asset_tree_retrieve

API endpoint that allows asset tree to be viewed.

Authorizations:

jwtAuth

path Parameters

id

required

integer

A unique integer value identifying this asset.

Responses

Response samples

200

Content type

application/json

{"id": 0,
"name": "string",
"parent_id": 0,
"numchild": 2147483647
}

audits

audits_list

API endpoint that allows audits to be viewed.

Authorizations:

jwtAuth

query Parameters

asset__name	string asset__name
auditor__email	string auditor__email
auditor__username	string auditor__username
completed_at_gte	string completed_at_gte
completed_at_lte	string completed_at_lte
name	string name
page	integer A page number within the paginated result set.
page_size	integer Number of results to return per page.
published	string published
published__day	string published__day
published__day__gt	string published__day__gt
published__day__lt	string published__day__lt
published__month	string published__month
published__month__gt	string published__month__gt
published__month__lt	string published__month__lt
published__year	string published__year
published__year__gt	string published__year__gt
published__year__lt	string published__year__lt
published_gte	string published_gte
published_lte	string published_lte
state	string Enum: "INPROGRESS" "GENERATING" "INREVIEW" "READYTOCLOSE" "CLOSED" state
state__in	string state__in
status	string status
status__in	string status__in
template__category__label	string template__category__label
template__category__label__in	string template__category__label__in
updated_at	string updated_at
updated_at__day	string updated_at__day
updated_at__day__gt	string updated_at__day__gt
updated_at__day__lt	string updated_at__day__lt
updated_at__month	string updated_at__month
updated_at__month__gt	string updated_at__month__gt
updated_at__month__lt	string updated_at__month__lt
updated_at__year	string updated_at__year
updated_at__year__gt	string updated_at__year__gt
updated_at__year__lt	string updated_at__year__lt
updated_at_gte	string updated_at_gte
updated_at_lte	string updated_at_lte

Responses

Response samples

200

Content type

application/json

{"count": 123,
"next": "http://api.example.org/accounts/?page=4",
"previous": "http://api.example.org/accounts/?page=2",
"results": [{"name": "string",
"id": 0,
"status": "string",
"additional_signature_print": "string",
"additional_signature_position": "string",
"signature": "http://example.com",
"asset_id": 0,
"asset_name": "string",
"updated_at": "string",
"close_audit_enabled": true,
"latitude": 0,
"signature_position": "string",
"report": "http://example.com",
"closed_at": "2019-08-24T14:15:22Z",
"closed_notes": "string",
"closed_by_signature": "http://example.com",
"status_color": "string",
"completed_at": "2019-08-24T14:15:22Z",
"closed_by_id": 0,
"created_at": "2019-08-24T14:15:22Z",
"state": "INPROGRESS",
"longitude": 0,
"signature_print": "string",
"additional_signature": "http://example.com",
"compliant": true,
"status_changed_on_close": true,
"device": "IPAD",
"published": "2019-08-24T14:15:22Z",
"auditor_id": 0,
"notes": "string",
"observations": {"property1": null,
"property2": null
},
"audit_result": {"property1": null,
"property2": null
},
"auditor": {"id": 0,
"username": "string",
"email": "[email protected]",
"first_name": "string",
"last_name": "string"
},
"nc_count": "string",
"template_tags": "string",
"metadata": "string"
}
]
}

audits_create

API endpoint that allows audits to be viewed.

Authorizations:

jwtAuth

Request Body schema:
application/json
application/json
application/x-www-form-urlencoded
multipart/form-data

name required	string <= 255 characters
status	string <= 255 characters
additional_signature_print	string or null <= 255 characters
additional_signature_position	string or null <= 255 characters
signature	string or null <uri> <= 1000 characters
close_audit_enabled	boolean
latitude	number or null <double>
signature_position	string or null <= 255 characters
report	string or null <uri> <= 1000 characters
closed_at	string or null <date-time>
closed_notes	string or null
closed_by_signature	string or null <uri> <= 1000 characters
status_color	string <= 25 characters
completed_at	string <date-time>
created_at	string <date-time>
state	string (AuditStateEnum) Enum: "INPROGRESS" "GENERATING" "INREVIEW" "READYTOCLOSE" "CLOSED"
longitude	number or null <double>
signature_print	string or null <= 255 characters
additional_signature	string or null <uri> <= 1000 characters
compliant	boolean
status_changed_on_close	boolean
	(DeviceEnum (string or null)) or (BlankEnum (any or null)) or (NullEnum (any or null))
published	string or null <date-time>
notes	string
required	object (User)

Responses

Request samples

Payload

Content type

{"name": "string",
"status": "string",
"additional_signature_print": "string",
"additional_signature_position": "string",
"signature": "http://example.com",
"close_audit_enabled": true,
"latitude": 0,
"signature_position": "string",
"report": "http://example.com",
"closed_at": "2019-08-24T14:15:22Z",
"closed_notes": "string",
"closed_by_signature": "http://example.com",
"status_color": "string",
"completed_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z",
"state": "INPROGRESS",
"longitude": 0,
"signature_print": "string",
"additional_signature": "http://example.com",
"compliant": true,
"status_changed_on_close": true,
"device": "IPAD",
"published": "2019-08-24T14:15:22Z",
"notes": "string",
"auditor": {"username": "string",
"email": "[email protected]",
"first_name": "string",
"last_name": "string"
}
}

Response samples

201

Content type

application/json

{"name": "string",
"id": 0,
"status": "string",
"additional_signature_print": "string",
"additional_signature_position": "string",
"signature": "http://example.com",
"asset_id": 0,
"asset_name": "string",
"updated_at": "string",
"close_audit_enabled": true,
"latitude": 0,
"signature_position": "string",
"report": "http://example.com",
"closed_at": "2019-08-24T14:15:22Z",
"closed_notes": "string",
"closed_by_signature": "http://example.com",
"status_color": "string",
"completed_at": "2019-08-24T14:15:22Z",
"closed_by_id": 0,
"created_at": "2019-08-24T14:15:22Z",
"state": "INPROGRESS",
"longitude": 0,
"signature_print": "string",
"additional_signature": "http://example.com",
"compliant": true,
"status_changed_on_close": true,
"device": "IPAD",
"published": "2019-08-24T14:15:22Z",
"auditor_id": 0,
"notes": "string",
"observations": {"property1": null,
"property2": null
},
"audit_result": {"property1": null,
"property2": null
},
"auditor": {"id": 0,
"username": "string",
"email": "[email protected]",
"first_name": "string",
"last_name": "string"
},
"nc_count": "string",
"template_tags": "string",
"metadata": "string"
}

audits_retrieve

API endpoint that allows audits to be viewed.

Authorizations:

jwtAuth

path Parameters

id

required

integer

A unique integer value identifying this audit.

Responses

Response samples

200

Content type

application/json

{"name": "string",
"id": 0,
"status": "string",
"additional_signature_print": "string",
"additional_signature_position": "string",
"signature": "http://example.com",
"asset_id": 0,
"asset_name": "string",
"updated_at": "string",
"close_audit_enabled": true,
"latitude": 0,
"signature_position": "string",
"report": "http://example.com",
"closed_at": "2019-08-24T14:15:22Z",
"closed_notes": "string",
"closed_by_signature": "http://example.com",
"status_color": "string",
"completed_at": "2019-08-24T14:15:22Z",
"closed_by_id": 0,
"created_at": "2019-08-24T14:15:22Z",
"state": "INPROGRESS",
"longitude": 0,
"signature_print": "string",
"additional_signature": "http://example.com",
"compliant": true,
"status_changed_on_close": true,
"device": "IPAD",
"published": "2019-08-24T14:15:22Z",
"auditor_id": 0,
"notes": "string",
"observations": {"property1": null,
"property2": null
},
"audit_result": {"property1": null,
"property2": null
},
"auditor": {"id": 0,
"username": "string",
"email": "[email protected]",
"first_name": "string",
"last_name": "string"
},
"nc_count": "string",
"template_tags": "string",
"metadata": "string"
}

contacts

contacts_retrieve

API endpoint that allows Contacts to be viewed.

Authorizations:

jwtAuth

Responses

contacts_create

API endpoint that allows Contacts to be viewed.

Authorizations:

jwtAuth

Responses

contacts_retrieve_2

API endpoint that allows Contacts to be viewed.

Authorizations:

jwtAuth

path Parameters

id

required

integer

A unique integer value identifying this user.

Responses

datastores

datastores_list

API endpoint that allows the template to be viewed.

Authorizations:

jwtAuth

query Parameters

page	integer A page number within the paginated result set.
page_size	integer Number of results to return per page.

Responses

Response samples

200

Content type

application/json

{"count": 123,
"next": "http://api.example.org/accounts/?page=4",
"previous": "http://api.example.org/accounts/?page=2",
"results": [{"name": "string",
"url": "http://example.com",
"id": 0,
"version": -2147483648
}
]
}

datastores_retrieve

API endpoint that allows the template to be viewed.

Authorizations:

jwtAuth

path Parameters

id

required

integer

A unique integer value identifying this generic customer data store.

Responses

Response samples

200

Content type

application/json

{"name": "string",
"id": 0,
"version": -2147483648,
"metadata": {"property1": null,
"property2": null
}
}

datastoresinfo

datastoresinfo_list

API endpoint that allows the template to be viewed.

Authorizations:

jwtAuth

query Parameters

page	integer A page number within the paginated result set.
page_size	integer Number of results to return per page.

Responses

Response samples

200

Content type

application/json

{"count": 123,
"next": "http://api.example.org/accounts/?page=4",
"previous": "http://api.example.org/accounts/?page=2",
"results": [{"name": "string",
"id": 0,
"current_datastore": "http://example.com"
}
]
}

datastoresinfo_create

API endpoint that allows the template to be viewed.

Authorizations:

jwtAuth

Request Body schema:
application/json
application/json
application/x-www-form-urlencoded
multipart/form-data

name required	string <= 255 characters
current_datastore	string or null <uri>

Responses

Request samples

Payload

Content type

{"name": "string",
"current_datastore": "http://example.com"
}

Response samples

201

Content type

application/json

{"name": "string",
"id": 0,
"current_datastore": "http://example.com"
}

datastoresinfo_retrieve

API endpoint that allows the template to be viewed.

Authorizations:

jwtAuth

path Parameters

id

required

integer

A unique integer value identifying this generic customer data store info.

Responses

Response samples

200

Content type

application/json

{"name": "string",
"id": 0,
"current_datastore": "http://example.com"
}

executive_reports

executive_reports_list

API endpoint that allows the template to be viewed.

Authorizations:

jwtAuth

query Parameters

page	integer A page number within the paginated result set.
page_size	integer Number of results to return per page.

Responses

Response samples

200

Content type

application/json

{"count": 123,
"next": "http://api.example.org/accounts/?page=4",
"previous": "http://api.example.org/accounts/?page=2",
"results": [{"id": 0,
"name": "string",
"updated_at": "2019-08-24T14:15:22Z",
"report": "http://example.com"
}
]
}

executive_reports_retrieve

API endpoint that allows the template to be viewed.

Authorizations:

jwtAuth

path Parameters

id

required

integer

A unique integer value identifying this executive report.

Responses

Response samples

200

Content type

application/json

{"id": 0,
"name": "string",
"updated_at": "2019-08-24T14:15:22Z",
"report": "http://example.com"
}

nonconformances

nonconformances_list

API endpoint that allows NonConformances to be viewed.

Authorizations:

jwtAuth

query Parameters

approved_by__email	string approved_by__email
approved_by__username	string approved_by__username
asset__name	string asset__name
assigned_by__email	string assigned_by__email
assigned_by__username	string assigned_by__username
assigned_to__email	string assigned_to__email
assigned_to__username	string assigned_to__username
audit_completed_at_gte	string audit_completed_at_gte
audit_completed_at_lte	string audit_completed_at_lte
category__label	string category__label
category__label__in	string category__label__in
created_at	string created_at
created_at__day	string created_at__day
created_at__day__gt	string created_at__day__gt
created_at__day__lt	string created_at__day__lt
created_at__month	string created_at__month
created_at__month__gt	string created_at__month__gt
created_at__month__lt	string created_at__month__lt
created_at__year	string created_at__year
created_at__year__gt	string created_at__year__gt
created_at__year__lt	string created_at__year__lt
created_at_gte	string created_at_gte
created_at_lte	string created_at_lte
id	string id
last_updated_gte	string last_updated_gte
last_updated_lte	string last_updated_lte
non_conformance	string non_conformance
page	integer A page number within the paginated result set.
page_size	integer Number of results to return per page.
status	string Enum: "DRAFT" "OPEN" "INPROGRESS" "INREVIEW" "CLOSED" "OVERDUE" "REOPENED" status
status__in	string status__in
template__category__label	string template__category__label
template__category__label__in	string template__category__label__in
template__name	string template__name

Responses

Response samples

200

Content type

application/json

{"count": 123,
"next": "http://api.example.org/accounts/?page=4",
"previous": "http://api.example.org/accounts/?page=2",
"results": [{"nonconformance_id": 0,
"status": "DRAFT",
"overdue": true,
"non_conformance": "string",
"corrective_action": {"id": 0,
"immediate_action": "string",
"root_cause": "string",
"common_answer": [0
]
},
"preventative_action": {"id": 0,
"preventative_action": "string"
},
"complete_by": "2019-08-24",
"approved_date": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z",
"assigned_to": 0,
"assigned_by": 0,
"approved_by": 0,
"assigned_to_user": {"id": 0,
"username": "string",
"email": "[email protected]",
"first_name": "string",
"last_name": "string"
},
"assigned_by_user": {"id": 0,
"username": "string",
"email": "[email protected]",
"first_name": "string",
"last_name": "string"
},
"approved_by_user": {"id": 0,
"username": "string",
"email": "[email protected]",
"first_name": "string",
"last_name": "string"
},
"verification_comment_group": {"id": 0,
"comments": [{"id": 0,
"comment": "string",
"created_by": 0,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
]
},
"rejection_comment_group": {"id": 0,
"comments": [{"id": 0,
"comment": "string",
"created_by": 0,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
]
},
"asset": {"id": 0,
"name": "string"
},
"category": [{"id": 0,
"label": "string"
}
],
"score_response": "string",
"template_name": "string",
"reopened_count": "string",
"audit_id": "string",
"parent_observation_id": 0,
"audit_completed_at": "2019-08-24T14:15:22Z",
"custom_fields": [{"field_id": 0,
"field_label": "string",
"type": "string",
"value": "string"
}
],
"updated_at": "string"
}
]
}

nonconformances_retrieve

API endpoint that allows NonConformances to be viewed.

Authorizations:

jwtAuth

path Parameters

id

required

integer

A unique integer value identifying this non conformance.

Responses

Response samples

200

Content type

application/json

{"nonconformance_id": 0,
"status": "DRAFT",
"overdue": true,
"non_conformance": "string",
"corrective_action": {"id": 0,
"immediate_action": "string",
"root_cause": "string",
"common_answer": [0
]
},
"preventative_action": {"id": 0,
"preventative_action": "string"
},
"complete_by": "2019-08-24",
"approved_date": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z",
"assigned_to": 0,
"assigned_by": 0,
"approved_by": 0,
"assigned_to_user": {"id": 0,
"username": "string",
"email": "[email protected]",
"first_name": "string",
"last_name": "string"
},
"assigned_by_user": {"id": 0,
"username": "string",
"email": "[email protected]",
"first_name": "string",
"last_name": "string"
},
"approved_by_user": {"id": 0,
"username": "string",
"email": "[email protected]",
"first_name": "string",
"last_name": "string"
},
"verification_comment_group": {"id": 0,
"comments": [{"id": 0,
"comment": "string",
"created_by": 0,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
]
},
"rejection_comment_group": {"id": 0,
"comments": [{"id": 0,
"comment": "string",
"created_by": 0,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
]
},
"asset": {"id": 0,
"name": "string"
},
"category": [{"id": 0,
"label": "string"
}
],
"score_response": "string",
"template_name": "string",
"reopened_count": "string",
"audit_id": "string",
"parent_observation_id": 0,
"audit_completed_at": "2019-08-24T14:15:22Z",
"custom_fields": [{"field_id": 0,
"field_label": "string",
"type": "string",
"value": "string"
}
],
"updated_at": "string"
}

program_templates

program_templates_list

API endpoint that lists all active Asset Profiles.

Authorizations:

jwtAuth

query Parameters

page	integer A page number within the paginated result set.
page_size	integer Number of results to return per page.

Responses

Response samples

200

Content type

application/json

{"count": 123,
"next": "http://api.example.org/accounts/?page=4",
"previous": "http://api.example.org/accounts/?page=2",
"results": [{"name": "string",
"id": 0,
"version": -2147483648,
"state": "CURRENT",
"is_latest_state": true,
"created_at": "2019-08-24T14:15:22Z",
"phases": {"property1": null,
"property2": null
}
}
]
}

program_templates_retrieve

API endpoint that lists all active Asset Profiles.

Authorizations:

jwtAuth

path Parameters

id

required

integer

A unique integer value identifying this program template.

Responses

Response samples

200

Content type

application/json

{"name": "string",
"id": 0,
"version": -2147483648,
"state": "CURRENT",
"is_latest_state": true,
"created_at": "2019-08-24T14:15:22Z",
"phases": {"property1": null,
"property2": null
}
}

programs

programs_list

API endpoint that lists all active Work Programs.

Authorizations:

jwtAuth

query Parameters

page	integer A page number within the paginated result set.
page_size	integer Number of results to return per page.

Responses

Response samples

200

Content type

application/json

{"count": 123,
"next": "http://api.example.org/accounts/?page=4",
"previous": "http://api.example.org/accounts/?page=2",
"results": [{"name": "string",
"id": 0,
"program_template_id": 0,
"exec_report": {"property1": null,
"property2": null
},
"completed_at": "2019-08-24T14:15:22Z",
"asset": {"id": 0,
"name": "string"
},
"lead_auditor": {"id": 0,
"username": "string",
"email": "[email protected]",
"first_name": "string",
"last_name": "string"
},
"start_date": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z",
"started": true,
"status": "PLANNING",
"phases": {"property1": null,
"property2": null
}
}
]
}

programs_create

API endpoint that lists all active Work Programs.

Authorizations:

jwtAuth

Request Body schema:
application/json
application/json
application/x-www-form-urlencoded
multipart/form-data

name required	string <= 255 characters
completed_at	string or null <date-time>
required	object (Asset)
required	object (User)
start_date	string <date-time>
started	boolean
status	string (ProgramStatusEnum) Enum: "PLANNING" "PENDING" "INPROGRESS" "COMPLETED"

Responses

Request samples

Payload

Content type

{"name": "string",
"completed_at": "2019-08-24T14:15:22Z",
"asset": {"name": "string"
},
"lead_auditor": {"username": "string",
"email": "[email protected]",
"first_name": "string",
"last_name": "string"
},
"start_date": "2019-08-24T14:15:22Z",
"started": true,
"status": "PLANNING"
}

Response samples

201

Content type

application/json

{"name": "string",
"id": 0,
"program_template_id": 0,
"exec_report": {"property1": null,
"property2": null
},
"completed_at": "2019-08-24T14:15:22Z",
"asset": {"id": 0,
"name": "string"
},
"lead_auditor": {"id": 0,
"username": "string",
"email": "[email protected]",
"first_name": "string",
"last_name": "string"
},
"start_date": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z",
"started": true,
"status": "PLANNING",
"phases": {"property1": null,
"property2": null
}
}

programs_retrieve

API endpoint that lists all active Work Programs.

Authorizations:

jwtAuth

path Parameters

id

required

integer

A unique integer value identifying this program.

Responses

Response samples

200

Content type

application/json

{"name": "string",
"id": 0,
"program_template_id": 0,
"exec_report": {"property1": null,
"property2": null
},
"completed_at": "2019-08-24T14:15:22Z",
"asset": {"id": 0,
"name": "string"
},
"lead_auditor": {"id": 0,
"username": "string",
"email": "[email protected]",
"first_name": "string",
"last_name": "string"
},
"start_date": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z",
"started": true,
"status": "PLANNING",
"phases": {"property1": null,
"property2": null
}
}

schedules

schedules_list

API endpoint that allows schedules to be viewed.

Authorizations:

jwtAuth

query Parameters

page	integer A page number within the paginated result set.
page_size	integer Number of results to return per page.
status	string Enum: "PENDING" "INPROGRESS" "COMPLETED" "CLOSED" "OVERDUE" status
status__in	string status__in
template__name	string template__name
when	string when
when__day	string when__day
when__day__gt	string when__day__gt
when__day__lt	string when__day__lt
when__month	string when__month
when__month__gt	string when__month__gt
when__month__lt	string when__month__lt
when__year	string when__year
when__year__gt	string when__year__gt
when__year__lt	string when__year__lt
when_gte	string when_gte
when_lte	string when_lte
who__email	string who__email
who__username	string who__username

Responses

Response samples

200

Content type

application/json

{"count": 123,
"next": "http://api.example.org/accounts/?page=4",
"previous": "http://api.example.org/accounts/?page=2",
"results": [{"id": 0,
"template": {"name": "string",
"id": 0,
"version": -2147483648
},
"when": "2019-08-24T14:15:22Z",
"status": "PENDING",
"who": {"id": 0,
"username": "string",
"email": "[email protected]",
"first_name": "string",
"last_name": "string"
},
"asset": {"id": 0,
"name": "string",
"metadata": {"property1": null,
"property2": null
}
}
}
]
}

schedules_create

API endpoint that allows schedules to be viewed.

Authorizations:

jwtAuth

Request Body schema:
application/json
application/json
application/x-www-form-urlencoded
multipart/form-data

required	object (Template)
when	string <date-time>
status	string (ScheduleStatusEnum) Enum: "PENDING" "INPROGRESS" "COMPLETED" "CLOSED" "OVERDUE"
required	object (User)
required	object (AssetSchedule)

Responses

Request samples

Payload

Content type

{"template": {"name": "string",
"version": -2147483648
},
"when": "2019-08-24T14:15:22Z",
"status": "PENDING",
"who": {"username": "string",
"email": "[email protected]",
"first_name": "string",
"last_name": "string"
},
"asset": {"name": "string"
}
}

Response samples

201

Content type

application/json

{"id": 0,
"template": {"name": "string",
"id": 0,
"version": -2147483648
},
"when": "2019-08-24T14:15:22Z",
"status": "PENDING",
"who": {"id": 0,
"username": "string",
"email": "[email protected]",
"first_name": "string",
"last_name": "string"
},
"asset": {"id": 0,
"name": "string",
"metadata": {"property1": null,
"property2": null
}
}
}

schedules_retrieve

API endpoint that allows schedules to be viewed.

Authorizations:

jwtAuth

path Parameters

id

required

integer

A unique integer value identifying this schedule.

Responses

Response samples

200

Content type

application/json

{"id": 0,
"template": {"name": "string",
"id": 0,
"version": -2147483648
},
"when": "2019-08-24T14:15:22Z",
"status": "PENDING",
"who": {"id": 0,
"username": "string",
"email": "[email protected]",
"first_name": "string",
"last_name": "string"
},
"asset": {"id": 0,
"name": "string",
"metadata": {"property1": null,
"property2": null
}
}
}

status_groups

status_groups_list

API endpoint that allows ObservationStatusGroups to be viewed.

Authorizations:

jwtAuth

query Parameters

page	integer A page number within the paginated result set.
page_size	integer Number of results to return per page.

Responses

Response samples

200

Content type

application/json

{"count": 123,
"next": "http://api.example.org/accounts/?page=4",
"previous": "http://api.example.org/accounts/?page=2",
"results": [{"id": 0,
"url": "http://example.com",
"name": "string",
"state": "CURRENT",
"version": -2147483648,
"obs_status_group": [{"name": "string",
"weight": 0,
"color": "string",
"group": 0,
"archive": true
}
]
}
]
}

status_groups_retrieve

API endpoint that allows ObservationStatusGroups to be viewed.

Authorizations:

jwtAuth

path Parameters

id

required

integer

A unique integer value identifying this observation status group.

Responses

Response samples

200

Content type

application/json

{"id": 0,
"url": "http://example.com",
"name": "string",
"state": "CURRENT",
"version": -2147483648,
"obs_status_group": [{"name": "string",
"weight": 0,
"color": "string",
"group": 0,
"archive": true
}
]
}

statuses

statuses_retrieve

API endpoint that allows ObservationStatuses to be viewed / added.

Authorizations:

jwtAuth

Responses

statuses_create

API endpoint that allows ObservationStatuses to be viewed / added.

Authorizations:

jwtAuth

Responses

statuses_retrieve_2

API endpoint that allows ObservationStatuses to be viewed / added.

Authorizations:

jwtAuth

path Parameters

id

required

integer

A unique integer value identifying this observation status.

Responses

statuses_destroy

API endpoint that allows ObservationStatuses to be viewed / added.

Authorizations:

jwtAuth

path Parameters

id

required

integer

A unique integer value identifying this observation status.

Responses

tasks

tasks_list

API endpoint that allows Tasks to be viewed.

Authorizations:

jwtAuth

query Parameters

approved_by__email	string approved_by__email
approved_by__username	string approved_by__username
asset__name	string asset__name
assigned_by__email	string assigned_by__email
assigned_by__username	string assigned_by__username
assigned_to__email	string assigned_to__email
assigned_to__username	string assigned_to__username
audit_completed_at_gte	string audit_completed_at_gte
audit_completed_at_lte	string audit_completed_at_lte
category__label	string category__label
category__label__in	string category__label__in
created_at	string created_at
created_at__day	string created_at__day
created_at__day__gt	string created_at__day__gt
created_at__day__lt	string created_at__day__lt
created_at__month	string created_at__month
created_at__month__gt	string created_at__month__gt
created_at__month__lt	string created_at__month__lt
created_at__year	string created_at__year
created_at__year__gt	string created_at__year__gt
created_at__year__lt	string created_at__year__lt
created_at_gte	string created_at_gte
created_at_lte	string created_at_lte
id	string id
last_updated_gte	string last_updated_gte
last_updated_lte	string last_updated_lte
page	integer A page number within the paginated result set.
page_size	integer Number of results to return per page.
status	string Enum: "DRAFT" "OPEN" "INPROGRESS" "INREVIEW" "CLOSED" "OVERDUE" "REOPENED" status
status__in	string status__in
task	string task
template__category__label	string template__category__label
template__category__label__in	string template__category__label__in
template__name	string template__name

Responses

Response samples

200

Content type

application/json

{"count": 123,
"next": "http://api.example.org/accounts/?page=4",
"previous": "http://api.example.org/accounts/?page=2",
"results": [{"task_id": 0,
"status": "DRAFT",
"overdue": true,
"task": "string",
"action": "string",
"complete_by": "2019-08-24",
"approved_date": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z",
"assigned_to": 0,
"assigned_by": 0,
"approved_by": 0,
"assigned_to_user": {"id": 0,
"username": "string",
"email": "[email protected]",
"first_name": "string",
"last_name": "string"
},
"assigned_by_user": {"id": 0,
"username": "string",
"email": "[email protected]",
"first_name": "string",
"last_name": "string"
},
"approved_by_user": {"id": 0,
"username": "string",
"email": "[email protected]",
"first_name": "string",
"last_name": "string"
},
"verification_comment_group": {"id": 0,
"comments": [{"id": 0,
"comment": "string",
"created_by": 0,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
]
},
"rejection_comment_group": {"id": 0,
"comments": [{"id": 0,
"comment": "string",
"created_by": 0,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
]
},
"asset": {"id": 0,
"name": "string"
},
"category": [{"id": 0,
"label": "string"
}
],
"score_response": "string",
"template_name": "string",
"audit_id": "string",
"parent_observation_id": 0,
"audit_completed_at": "2019-08-24T14:15:22Z",
"custom_fields": [{"field_id": 0,
"field_label": "string",
"type": "string",
"value": "string"
}
],
"updated_at": "string"
}
]
}

tasks_retrieve

API endpoint that allows Tasks to be viewed.

Authorizations:

jwtAuth

path Parameters

id

required

integer

A unique integer value identifying this task.

Responses

Response samples

200

Content type

application/json

{"task_id": 0,
"status": "DRAFT",
"overdue": true,
"task": "string",
"action": "string",
"complete_by": "2019-08-24",
"approved_date": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z",
"assigned_to": 0,
"assigned_by": 0,
"approved_by": 0,
"assigned_to_user": {"id": 0,
"username": "string",
"email": "[email protected]",
"first_name": "string",
"last_name": "string"
},
"assigned_by_user": {"id": 0,
"username": "string",
"email": "[email protected]",
"first_name": "string",
"last_name": "string"
},
"approved_by_user": {"id": 0,
"username": "string",
"email": "[email protected]",
"first_name": "string",
"last_name": "string"
},
"verification_comment_group": {"id": 0,
"comments": [{"id": 0,
"comment": "string",
"created_by": 0,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
]
},
"rejection_comment_group": {"id": 0,
"comments": [{"id": 0,
"comment": "string",
"created_by": 0,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
]
},
"asset": {"id": 0,
"name": "string"
},
"category": [{"id": 0,
"label": "string"
}
],
"score_response": "string",
"template_name": "string",
"audit_id": "string",
"parent_observation_id": 0,
"audit_completed_at": "2019-08-24T14:15:22Z",
"custom_fields": [{"field_id": 0,
"field_label": "string",
"type": "string",
"value": "string"
}
],
"updated_at": "string"
}

templates

templates_list

API endpoint that allows the template to be viewed.

Authorizations:

jwtAuth

query Parameters

page	integer A page number within the paginated result set.
page_size	integer Number of results to return per page.

Responses

Response samples

200

Content type

application/json

{"count": 123,
"next": "http://api.example.org/accounts/?page=4",
"previous": "http://api.example.org/accounts/?page=2",
"results": [{"name": "string",
"id": 0,
"version": -2147483648
}
]
}

templates_retrieve

API endpoint that allows the template to be viewed.

Authorizations:

jwtAuth

path Parameters

id

required

integer

A unique integer value identifying this template.

Responses

Response samples

200

Content type

application/json

{"name": "string",
"id": 0,
"version": -2147483648
}

users

users_retrieve

API endpoint that allows users to be viewed.

Authorizations:

jwtAuth

Responses

users_create

API endpoint that allows users to be viewed.

Authorizations:

jwtAuth

Responses

users_retrieve_2

API endpoint that allows users to be viewed.

Authorizations:

jwtAuth

path Parameters

id

required

integer

A unique integer value identifying this user.

AuditComply API (1.0.0)

Authentication

jwtAuth

api-token-auth

api_token_auth_create

Request Body schema: application/jsonapplication/jsonapplication/x-www-form-urlencodedmultipart/form-data

Responses

Request samples

Response samples

api-token-refresh

api_token_refresh_create

Request Body schema: application/jsonapplication/jsonapplication/x-www-form-urlencodedmultipart/form-data

Responses

Request samples

Response samples

asset

asset_retrieve

Authorizations:

Responses

asset_create

Authorizations:

query Parameters

Responses

asset_retrieve_2

Authorizations:

path Parameters

Responses

asset_breadcrumbs

asset_breadcrumbs_list

Authorizations:

query Parameters

Responses

Response samples

asset_breadcrumbs_retrieve

Authorizations:

path Parameters

Responses

Response samples

asset_profiles

asset_profiles_list

Authorizations:

query Parameters

Responses

Response samples

asset_profiles_retrieve

Authorizations:

path Parameters

Responses

Response samples

asset_tree

asset_tree_list

Authorizations:

query Parameters

Responses

Response samples

asset_tree_retrieve

Authorizations:

path Parameters

Responses

Response samples

audits

audits_list

Authorizations:

query Parameters

Responses

Response samples

audits_create

Authorizations:

Request Body schema: application/jsonapplication/jsonapplication/x-www-form-urlencodedmultipart/form-data

Responses

Request samples

Response samples

audits_retrieve

Authorizations:

path Parameters

Responses

Response samples

categories

categories_list

Authorizations:

Request Body schema:
application/json
application/json
application/x-www-form-urlencoded
multipart/form-data

Request Body schema:
application/json
application/json
application/x-www-form-urlencoded
multipart/form-data

Request Body schema:
application/json
application/json
application/x-www-form-urlencoded
multipart/form-data

Request Body schema:
application/json
application/json
application/x-www-form-urlencoded
multipart/form-data

Request Body schema:
application/json
application/json
application/x-www-form-urlencoded
multipart/form-data