Core
IoT Platform v2.x
2

get #

Gets a raw payload by UUID. It is only authorized for the platform admin.


Query Syntax #

HTTP #

URL: http://kuzzle:7512/_/raw-payload/:_id
Method: GET

Other protocols #

{
  "controller": "raw-payload",
  "action": "get",
  "_id": "<payloadUUID>"
}

Arguments #

  • _id: payload uuid

Response #

{
  "action": "get",
  "controller": "raw-payload",
  "error": null,
  "node": "nodeId",
  "requestId": "<requestId>",
  "result": {
    "_id": "<payloadUUID>",
    "_source": {
      "apiAction": "<payloadEndpoint>",
      "deviceModel": "<deviceModelName>",
      "payload": {
        // payload content
      },
      "state": "VALID",
      "uuid": "<payloadUUID>",
      "valid": true,
      "_kuzzle_info": {
        // kuzzle information
      }
    },
    "_version": "<version>""
  },
  "status": 200,
  "volatile": {
    "sdkInstanceId": "<sdkInstanceId>",
    "sdkName": "<sdkNameVersion>"
  }
  "room": "<roomId>"
}