Skip to content
Jade Meskill edited this page Mar 31, 2016 · 2 revisions

A Request has two main attributes, metadata and rawData. metadata contains the information about the request, including jobType and auth. rawData represents the payload that will be delivered to the tasks inside the job. rawData is usually, but not required to be, stringified JSON. Using an unparsed string allows for large, complex payloads to be passed around, but only parsed on demand. It also allows for non-JSON payloads if necessary.

metadata requires responseId and jobType. rawData is optional.

Each jobType has different required keys.

Sample Request

{
  "metadata": {
    "responseId": "ca34277c-3c0d-41d7-b277-4383ae07d0e9",
    "jobType": "UpdateDevice",
    "auth": {
      "uuid": "117ec079-33ea-4471-bd8e-0602d3be5bed",
      "token": "ea64f79d5217e57d3e9c9e857b871ccc9a909b70"
    },
    "uuid":"4e625bc8-502f-43f9-aa3b-b5e2eabea357"
  },
  "rawData": "{\"foo\":\"bar\"}"
}