Update an item in a checklist
Update
| 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=update | |
| Input | Yes | JSON string | See below |
| JSON Input | Mandatory | Description | Examples |
|---|---|---|---|
| Identifier | Yes | Checklist item UUID | "checklistitemUuid":"B60C7E3EEFF2394E97CF4CF2965902A7" |
| ChecklistitemDescription | No | Checklist item description | "ChecklistitemDescription":"item 10" |
Example request (OAuth 2.0):
Authorization: Bearer <access_token>
http://<SERVER>/jsonapi/checklistitems.json?&version=6&action=update&input={
"data": [
{
"checklistitemUuid": "063B9BE7A170AF4ABE38251FF2039354",
"checklistitemDescription": "item 10 updated"
}
]
}
Example request (legacy username/password):
http://<SERVER>/jsonapi/checklistitems.json?&version=6&action=update&input={
"data": [
{
"checklistitemUuid": "063B9BE7A170AF4ABE38251FF2039354",
"checklistitemDescription": "item 10 updated"
}
]
}&user=<username>&password=<password>
Example response:
{
"responsecode": 1,
"responsestatus": "OK",
"errorcode": 0,
"errormessage": "",
"responsemessage": "data processed successfully.",
"warningmessage": "",
"success": true,
"data": [
{
"checklistitemUuid": "09BE9E44B80C634A99C91B57DB6684A2",
"checklistitemTimestampModified": 1539605707,
"checklistitemRecordVersionNumber": 7
}
]
}