Create a checklist
Create
| Parameter | Mandatory | Description | Examples | More Info |
|---|---|---|---|---|
| API | Yes | The API area | checklistheader.json | |
| General | Yes | Parameters described in overview | Authorization: Bearer <access_token> header — see Synergist API Authentication | Structure of an API call |
| Action | Yes | The action to perform | action=create | |
| Input | Yes | JSON string | See below |
| JSON Input | Mandatory | Description | Examples |
|---|---|---|---|
| checklistActivityID | Yes | Activity ID or UUID | "checklistActivityID":7078 |
| checklistTitle | Yes | Header title | "checklistTitle":"My Checklist" |
| checklistTemplate | No | Header template UUID | "checklistTemplate":"B169DA9B3B5810448C5B2151FF232DB2" |
Example request (OAuth 2.0):
Authorization: Bearer <access_token>
http://<SERVER>/jsonapi/checklistheader.json?&action=create&version=6&input={
"data": [
{
"checklistActivityID": 7078,
"checklistTitle": "My Checklist",
"checklistTemplate": "B169DA9B3B5810448C5B2151FF232DB2"
}
]
}
Example request (legacy username/password):
http://<SERVER>/jsonapi/checklistheader.json?&action=create&version=6&input={
"data": [
{
"checklistActivityID": 7078,
"checklistTitle": "My Checklist",
"checklistTemplate": "B169DA9B3B5810448C5B2151FF232DB2"
}
]
}&user=<username>&password=<password>
Example response:
{
"responsecode": 1,
"responsestatus": "OK",
"errorcode": 0,
"errormessage": "",
"responsemessage": "data processed successfully.",
"warningmessage": "",
"success": true,
"data": [
{
"checklistUuid": "1206A47F6D784247A1C39D372AC75878",
"checklistTimestampModified": 1539787856,
"checklistRecordVersionNumber": 0
}
]
}