Create

Create a checklist

Create

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=create
InputYesJSON stringSee below
JSON InputMandatoryDescriptionExamples
checklistActivityIDYesActivity ID or UUID"checklistActivityID":7078
checklistTitleYesHeader title"checklistTitle":"My Checklist"
checklistTemplateNoHeader 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
    }
  ]
}