Update

Update a checklist header

Update

ParameterMandatoryDescriptionExamplesMore Info
APIYesThe API areachecklistheader.json
GeneralYesParameters described in overviewAuthorization: Bearer <access_token> header — see Synergist API AuthenticationStructure of an API call
ActionYesThe action to performaction=update
PositionNoChecklist header positionposition=2
InputYesJSON stringSee below
JSON InputMandatoryDescriptionExamples
IdentifierYesChecklist UUID"checklistUuid":"B60C7E3EEFF2394E97CF4CF2965902A7"
TitleNoChecklist title"checklistTitle": "Test Checklist 2"

Example request (OAuth 2.0):

Authorization: Bearer <access_token>
http://<SERVER>/jsonapi/checklistheader.json?&version=6&action=update&input={
  "data": [
    {
      "checklistUuid": "063B9BE7A170AF4ABE38251FF2039354",
      "checklistTitle": "Test Checklist 2"
    }
  ]
}

Example request (legacy username/password):

http://<SERVER>/jsonapi/checklistheader.json?&version=6&action=update&input={
  "data": [
    {
      "checklistUuid": "063B9BE7A170AF4ABE38251FF2039354",
      "checklistTitle": "Test Checklist 2"
    }
  ]
}&user=<username>&password=<password>

Example response:

{
  "responsecode": 1,
  "responsestatus": "OK",
  "errorcode": 0,
  "errormessage": "",
  "responsemessage": "data processed successfully.",
  "warningmessage": "",
  "success": true,
  "data": [
    {
      "checklistUuid": "063B9BE7A170AF4ABE38251FF2039354",
      "checklistTimestampModified": 1539605562,
      "checklistRecordVersionNumber": 6
    }
  ]
}