Create an item in a checklist
Create
| Parameter | Mandatory | Description | Examples | More Info |
|---|---|---|---|---|
| API | Yes | The API area | checklistitems.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 |
|---|---|---|---|
| ChecklistitemChecklistHeaderUUID | Yes | Checklist header uuid | "ChecklistitemChecklistHeaderUUID":"B169DA9B3B5810448C5B2151FF232DB2" |
| ChecklistitemDescription | Yes | Checklist item description | "ChecklistitemDescription":"item 10" |
| ChecklistitemUuid | No | Checklist item uuid | "ChecklistitemUuid": "81751011112B9242BFC2C72355C601E3" |
| ChecklistItemOrder | No | Checklist item order | "ChecklistItemOrder": 2 |
Example request (OAuth 2.0):
Authorization: Bearer <access_token>
http://<SERVER>/jsonapi/checklistitems.json?&version=6&action=create&input={
"data": [
{
"checklistitemChecklistHeaderUUID": "B169DA9B3B5810448C5B2151FF232DB2",
"checklistitemDescription": "item 10"
}
]
}
Example request (legacy username/password):
http://<SERVER>/jsonapi/checklistitems.json?&version=6&action=create&input={
"data": [
{
"checklistitemChecklistHeaderUUID": "B169DA9B3B5810448C5B2151FF232DB2",
"checklistitemDescription": "item 10"
}
]
}&user=<username>&password=<password>
Example response:
{
"responsecode": 1,
"responsestatus": "OK",
"errorcode": 0,
"errormessage": "",
"responsemessage": "data processed successfully.",
"warningmessage": "",
"success": true,
"data": [
{
"checklistitemUuid": "DE53CBF5C6E96140BD214071BEA5BFDE",
"checklistitemTimestampModified": 1539788746,
"checklistitemRecordVersionNumber": 0
}
]
}