The schedules API URL is designed to return a list of all schedules with the following fields:
schedules/
<int> 'id',
<Template> 'template',
<str - Date> 'when',
<str> 'status',
<User> 'who',
<Asset> 'asset'
Template:
<str> 'name',
<int> 'id',
<int> 'version'
User:
<str> 'username',
<str email> 'email'
Asset:
<int> 'id',
<str> 'name'
This endpoint can be accessed via the https://api.auditcomply.com/schedules/
endpoint URL. An explanation of the fields can be found below:
- id – The unique ID of the Schedule
- template – The Assessment Template which the Schedule will use.
- when – The date of when the Schedule is due for
- status – The current status of the Schedule. (eg. pending, overdue)
- who – The User assigned to the Schedule.
- asset – The Asset the Schedule is attached to.
Template:
- name – Name of the Template.
- id – Unique ID of the Template.
- version – The current version of the Template.
User:
- username – Username of the User.
- email – Email of the User.
Asset
- id – The unique ID of the Asset.
- name – The name of the Asset.
Creating
Schedules can be created by using the endpoint https://api.auditcomply.com/schedules/
. They can be created in single and multiple as seen below:
Single:
{"template_id":12345, "who_id":12345, "asset_id":12345, "when":"2020-12-11 13:37"}
Multiple:
{"schedules":[
{"template_id":12345, "who_id":12345, "asset_id":12345, "when":"2020-12-11 13:38"},
{"template_id":12345, "who_id":12345, "asset_id":12345, "when":"2020-12-11 13:39"},
{"template_id":12345, "who_id":12345, "asset_id":12345, "when":"2020-12-11 13:40"}
]
}