{"docs":{"name":"Datonis","info":"\n\u003cp\u003eAnother API description\u003c/p\u003e\n","copyright":null,"doc_url":"/apidoc/3.0","api_url":"","resources":{"alert":{"doc_url":"/apidoc/3.0/alert","api_url":"","name":"Alert","short_description":null,"full_description":"","version":"3.0","formats":null,"metadata":{"order":10},"methods":[{"doc_url":"/apidoc/3.0/alert/index","name":"index","apis":[{"api_url":"/api/v3/alerts","http_method":"GET","short_description":"List all alerts","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eReturns a list of all alerts generated for an account as per the specified\ncriteria. This API is paginated and returns 20 alerts by default. An alert\nis uniquely identified by a \u0026#39;alert_key\u0026#39;. This key should be used in\nall the other API referencing a particular alert.\u003c/p\u003e\n","errors":[],"params":[{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number of results to be fetched, Default 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be Integer.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"per","full_name":"per","description":"\n\u003cp\u003eNumber of alerts to be returned in one page, Default 20\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be Integer.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order_by","full_name":"order_by","description":"\n\u003cp\u003eField on which alerts should be sorted\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eOrder, “asc” or “desc”, in which results should be sorted\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003eKeywords based on which alerts should be searched.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"scope","full_name":"scope","description":"\n\u003cp\u003eMatching condition if multiple keywords are specified for search. Valid\nvalues are “all” or “any”. Default is “all”\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"time_zone","full_name":"time_zone","description":"\n\u003cp\u003eTimezone.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"thing_key","full_name":"thing_key","description":"\n\u003cp\u003eThing for which the alerts should be returned\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"instruction_key","full_name":"instruction_key","description":"\n\u003cp\u003eInstruction for which the alerts should be returned\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"alert_type","full_name":"alert_type","description":"\n\u003cp\u003eAlert types for which alerts should be returned\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of [0, 1, 2, 3]","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"timestamp_format","full_name":"timestamp_format","description":"\n\u003cp\u003eFormat, “str” or “int”, in which timestamps should be returned, Default\n“int”\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"pretty","full_name":"pretty","description":"\n\u003cp\u003eReturn a pretty formatted response if true, Default is false\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Boolean","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"is_oem","full_name":"is_oem","description":"\n\u003cp\u003eReturns alerts of child accounts along with things of oem account if is_oem\nflag is true.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":["Request - listing all alerts without any criteria\n  curl -X GET  -H \"Content-Type:application/json\" -H \"X-Auth-Token:ENDVcVtaZvVuKlSIxKhQbw\" https://api.datonis.io/api/v3/alerts\n\nResponse (returns first 20 records)\n{\n  \"total_count\": 6,\n  \"page\": 1,\n  \"alerts\": [\n    {\n      \"alert_key\": \"71ta3d639f\",\n      \"alert_type\": 0,\n      \"created_at\": 1448449140,\n      \"data\": {\n        \"thing\": {\n          \"bi_directional\": true,\n          \"coordinates\": [\n            \"21.15\",\n            \"79.09\"\n          ],\n          \"created_at\": 1448430551,\n          \"description\": \"Thing for washing machines\",\n          \"name\": \"Fully Automated Washing Machine\",\n          \"state\": null,\n          \"tags_array\": [\n            \"Corporate\",\n            \"automated\"\n          ],\n          \"thing_key\": \"92df5df8cb\",\n          \"updated_at\": 1448437358,\n          \"user_defined_properties\": {\n            \"Firmware Ver\": \"1.0\",\n            \"STATE\": \"OK\",\n            \"Installation Type\": \"Free Standing\",\n            \"Manufacturer\": \"LG\",\n            \"Color\": \"White\"\n          },\n          \"alive\": false,\n          \"tags\": \"Corporate,automated\",\n          \"last_event\": null,\n          \"last_beat\": null,\n          \"thing_template_name\": \"Washing Machine\",\n          \"thing_template_key\": \"831e1tf472\"\n        },\n        \"alert_type_string\": \"Info\"\n      },\n      \"message\": \"Thing Fully Automated Washing Machine registered\",\n      \"timestamp\": 1448447,\n      \"updated_at\": 1448449140,\n      \"alert_type_string\": \"Info\",\n      \"thing_key\": \"92df5df8cb\",\n      \"thing_name\": \"Fully Automated Washing Machine\"\n    },\n    {\n      \"alert_key\": \"ee2ad1t5t5\",\n      \"alert_type\": 0,\n      \"created_at\": 1448449362,\n      \"data\": {\n...","Request - listing alerts by specifying number of alerts to be returned at a time (page size) and specific set to be returned (page)\n  curl -X GET  -H \"Content-Type:application/json\" -H \"X-Auth-Token:ENDVcVtaZvVuKlSIxKhQbw\" -d '{\"per\":\"2\",\"page\":\"2\"}' https://api.datonis.io/api/v3/alerts\n\nResponse (returns page 2 with 2 alerts per page)\n{\n  \"total_count\": 6,\n  \"page\": \"2\",\n  \"alerts\": [\n    {\n      \"alert_key\": \"2b1554f38f\",\n      \"alert_type\": 0,\n      \"created_at\": 1448449462,\n      \"data\": {\n        \"thing\": {\n          \"bi_directional\": true,\n          \"coordinates\": [\n            20.15,\n            78.09\n          ],\n          \"created_at\": 1448435611,\n          \"description\": \"Thing for Energy Meters\",\n          \"name\": \"Energy Meter 1\",\n          \"state\": null,\n          \"tags_array\": [\n            \"Residential\"\n          ],\n          \"thing_key\": \"45bf16bb4e\",\n          \"updated_at\": 1448435611,\n          \"user_defined_properties\": {\n            \"Firmware Ver\": \"1.0\",\n            \"STATE\": \"OK\"\n          },\n          \"alive\": false,\n          \"tags\": \"Residential\",\n          \"last_event\": null,\n          \"last_beat\": null,\n          \"thing_template_name\": \"Energy Meter\",\n          \"thing_template_key\": \"82e2et9c31\"\n        },\n        \"alert_type_string\": \"Info\"\n      },\n      \"message\": \"Thing Energy Meter 1 registered\",\n      \"timestamp\": 1448449,\n      \"updated_at\": 1448449462,\n      \"alert_type_string\": \"Info\",\n      \"thing_key\": \"45bf16bb4e\",\n      \"thing_name\": \"Energy Meter 1\"\n    },\n    {\n      \"alert_key\": \"5fbata9e6a\",\n      \"alert_type\": 1,\n      \"created_at\": 1448449654,\n      \"data\": {\n        \"thing\": {\n          \"bi_directional\": true,\n          \"coordinates\": [\n            20.15,\n            78.09\n          ],\n          \"created_at\": 1448435611,\n          \"description\": \"Thing for...","Request - listing alerts ordered by a field\n  curl -X GET  -H \"Content-Type:application/json\" -H \"X-Auth-Token:ENDVcVtaZvVuKlSIxKhQbw\" -d '{\"order_by\":\"alert_type\",\"order\":\"desc\"}' https://api.datonis.io/api/v3/alerts\n\nResponse (returns alerts in the reverse order of alert type)\n{\n  \"total_count\": 6,\n  \"page\": 1,\n  \"alerts\": [\n    {\n      \"alert_key\": \"5fbata9e6a\",\n      \"alert_type\": 1,\n      \"created_at\": 1448449654,\n      \"data\": {\n        \"thing\": {\n          \"bi_directional\": true,\n          \"coordinates\": [\n            20.15,\n            78.09\n          ],\n          \"created_at\": 1448435611,\n          \"description\": \"Thing for Energy Meters\",\n          \"name\": \"Energy Meter 1\",\n          \"state\": null,\n          \"tags_array\": [\n            \"Residential\"\n          ],\n          \"thing_key\": \"45bf16bb4e\",\n          \"updated_at\": 1448435611,\n          \"user_defined_properties\": {\n            \"Firmware Ver\": \"1.0\",\n            \"STATE\": \"OK\"\n          },\n          \"alive\": false,\n          \"tags\": \"Residential\",\n          \"last_event\": null,\n          \"last_beat\": null,\n          \"thing_template_name\": \"Energy Meter\",\n          \"thing_template_key\": \"82e2et9c31\"\n        },\n        \"alert_type_string\": \"Warning\"\n      },\n      \"message\": \"New Alert\",\n      \"timestamp\": 1448449,\n      \"updated_at\": 1448449654,\n      \"alert_type_string\": \"Warning\",\n      \"thing_key\": \"45bf16bb4e\",\n      \"thing_name\": \"Energy Meter 1\"\n    },\n    {\n      \"alert_key\": \"36a9t18tfe\",\n      \"alert_type\": 1,\n      \"created_at\": 1448449721,\n      \"data\": {\n        \"thing\": {\n          \"bi_directional\": false,\n          \"coordinates\": [\n            \"20.15\",\n            \"78.09\"\n          ],\n          \"created_at\": 1448430551,\n          \"description\": \"Thing for washing...","Request - listing alerts based on some search criteria with all keywords matching\n  curl -X GET  -H \"Content-Type:application/json\" -H \"X-Auth-Token:ENDVcVtaZvVuKlSIxKhQbw\" -d '{\"search\":\"Semi New\"}' https://api.datonis.io/api/v3/alerts\n\nResponse (returns alerts containing both keywords 'Semi' as well as 'New')\n{\n  \"total_count\": 1,\n  \"page\": 1,\n  \"alerts\": [\n    {\n      \"alert_key\": \"36a9t18tfe\",\n      \"alert_type\": 1,\n      \"created_at\": 1448449721,\n      \"data\": {\n        \"thing\": {\n          \"bi_directional\": false,\n          \"coordinates\": [\n            \"20.15\",\n            \"78.09\"\n          ],\n          \"created_at\": 1448430551,\n          \"description\": \"Thing for washing machines\",\n          \"name\": \"Semi Automated Washing Machine\",\n          \"state\": null,\n          \"tags_array\": [\n            \"Residencial\",\n            \"automated\"\n          ],\n          \"thing_key\": \"ta597t738b\",\n          \"updated_at\": 1448437372,\n          \"user_defined_properties\": {\n            \"Firmware Ver\": \"1.0\",\n            \"STATE\": \"OK\",\n            \"Installation Type\": \"Free Standing\",\n            \"Manufacturer\": \"LG\",\n            \"Color\": \"Red\"\n          },\n          \"alive\": false,\n          \"tags\": \"Residencial,automated\",\n          \"last_event\": null,\n          \"last_beat\": null,\n          \"thing_template_name\": \"Washing Machine\",\n          \"thing_template_key\": \"831e1tf472\"\n        },\n        \"alert_type_string\": \"Warning\"\n      },\n      \"message\": \"New Alert\",\n      \"timestamp\": 1448449,\n      \"updated_at\": 1448449721,\n      \"alert_type_string\": \"Warning\",\n      \"thing_key\": \"ta597t738b\",\n      \"thing_name\": \"Semi Automated Washing Machine\"\n    }\n  ]\n}","Request - listing alerts based on some search criteria with any of the keywords matching\n  curl -X GET  -H \"Content-Type:application/json\" -H \"X-Auth-Token:ENDVcVtaZvVuKlSIxKhQbw\" -d '{\"search\":\"Semi New\",\"scope\":\"any\"}' https://api.datonis.io/api/v3/alerts\n\nResponse (returns alerts containing either of the keywords 'Semi' or 'New')\n{\n  \"total_count\": 3,\n  \"page\": 1,\n  \"alerts\": [\n    {\n      \"alert_key\": \"36a9t18tfe\",\n      \"alert_type\": 1,\n      \"created_at\": 1448449721,\n      \"data\": {\n        \"thing\": {\n          \"bi_directional\": false,\n          \"coordinates\": [\n            \"20.15\",\n            \"78.09\"\n          ],\n          \"created_at\": 1448430551,\n          \"description\": \"Thing for washing machines\",\n          \"name\": \"Semi Automated Washing Machine\",\n          \"state\": null,\n          \"tags_array\": [\n            \"Residencial\",\n            \"automated\"\n          ],\n          \"thing_key\": \"ta597t738b\",\n          \"updated_at\": 1448437372,\n          \"user_defined_properties\": {\n            \"Firmware Ver\": \"1.0\",\n            \"STATE\": \"OK\",\n            \"Installation Type\": \"Free Standing\",\n            \"Manufacturer\": \"LG\",\n            \"Color\": \"Red\"\n          },\n          \"alive\": false,\n          \"tags\": \"Residencial,automated\",\n          \"last_event\": null,\n          \"last_beat\": null,\n          \"thing_template_name\": \"Washing Machine\",\n          \"thing_template_key\": \"831e1tf472\"\n        },\n        \"alert_type_string\": \"Warning\"\n      },\n      \"message\": \"New Alert\",\n      \"timestamp\": 1448449,\n      \"updated_at\": 1448449721,\n      \"alert_type_string\": \"Warning\",\n      \"thing_key\": \"ta597t738b\",\n      \"thing_name\": \"Semi Automated Washing Machine\"\n    },\n    {\n      \"alert_key\": \"5fbata9e6a\",\n      \"alert_type\": 1,\n      \"created_at\": 1448449654,\n      \"data\": {\n        \"thing\": {\n         ...","Request - listing alerts for a thing\n  curl -X GET  -H \"Content-Type:application/json\" -H \"X-Auth-Token:ENDVcVtaZvVuKlSIxKhQbw\" -d '{\"thing_key\":\"ta597t738b\"}' https://api.datonis.io/api/v3/alerts\n\nResponse (returns alerts generated for a thing with key mentioned above)\n{\n  \"total_count\": 2,\n  \"page\": 1,\n  \"alerts\": [\n    {\n      \"alert_key\": \"36a9t18tfe\",\n      \"alert_type\": 1,\n      \"created_at\": 1448449721,\n      \"data\": {\n        \"thing\": {\n          \"bi_directional\": false,\n          \"coordinates\": [\n            \"20.15\",\n            \"78.09\"\n          ],\n          \"created_at\": 1448430551,\n          \"description\": \"Thing for washing machines\",\n          \"name\": \"Semi Automated Washing Machine\",\n          \"state\": null,\n          \"tags_array\": [\n            \"Residencial\",\n            \"automated\"\n          ],\n          \"thing_key\": \"ta597t738b\",\n          \"updated_at\": 1448437372,\n          \"user_defined_properties\": {\n            \"Firmware Ver\": \"1.0\",\n            \"STATE\": \"OK\",\n            \"Installation Type\": \"Free Standing\",\n            \"Manufacturer\": \"LG\",\n            \"Color\": \"Red\"\n          },\n          \"alive\": false,\n          \"tags\": \"Residencial,automated\",\n          \"last_event\": null,\n          \"last_beat\": null,\n          \"thing_template_name\": \"Washing Machine\",\n          \"thing_template_key\": \"831e1tf472\"\n        },\n        \"alert_type_string\": \"Warning\"\n      },\n      \"message\": \"New Alert\",\n      \"timestamp\": 1448449,\n      \"updated_at\": 1448449721,\n      \"alert_type_string\": \"Warning\",\n      \"thing_key\": \"ta597t738b\",\n      \"thing_name\": \"Semi Automated Washing Machine\"\n    },\n    {\n      \"alert_key\": \"ee2ad1t5t5\",\n      \"alert_type\": 0,\n      \"created_at\": 1448449362,\n      \"data\": {\n        \"thing\": {\n         ...","Request - listing alerts for an instruction\n  curl -X GET  -H \"Content-Type:application/json\" -H \"X-Auth-Token:ENDVcVtaZvVuKlSIxKhQbw\" -d '{\"instruction_key\":\"t4bd14d659\"}' https://api.datonis.io/api/v3/alerts\n\nResponse (returns alerts generated for a instruction with key mentioned above)\n{\n  \"total_count\": 1,\n  \"page\": 1,\n  \"alerts\": [\n    {\n      \"alert_key\": \"6abfc13459\",\n      \"alert_type\": 0,\n      \"created_at\": 1448451693,\n      \"data\": {\n        \"thing\": {\n          \"bi_directional\": true,\n          \"coordinates\": [\n            20.15,\n            78.09\n          ],\n          \"created_at\": 1448435611,\n          \"description\": \"Thing for Energy Meters\",\n          \"name\": \"Energy Meter 1\",\n          \"state\": null,\n          \"tags_array\": [\n            \"Residential\"\n          ],\n          \"thing_key\": \"45bf16bb4e\",\n          \"updated_at\": 1448435611,\n          \"user_defined_properties\": {\n            \"Firmware Ver\": \"1.0\",\n            \"STATE\": \"OK\"\n          },\n          \"alive\": false,\n          \"tags\": \"Residential\",\n          \"last_event\": null,\n          \"last_beat\": null,\n          \"thing_template_name\": \"Energy Meter\",\n          \"thing_template_key\": \"82e2et9c31\"\n        },\n        \"instruction\": {\n          \"definition\": {\n            \"command\": 1\n          },\n          \"description\": null,\n          \"instruction_key\": \"t4bd14d659\",\n          \"name\": \"Turn ON\",\n          \"created_at\": 1448275718,\n          \"updated_at\": 1448275718\n        },\n        \"alert_type_string\": \"Info\"\n      },\n      \"message\": \"Instruction Turn ON sent to Energy Meter1\",\n      \"timestamp\": 1448451,\n      \"updated_at\": 1448451693,\n      \"alert_type_string\": \"Info\",\n      \"thing_key\": \"45bf16bb4e\",\n      \"thing_name\": \"Energy Meter 1\",\n      \"instruction_key\": \"t4bd14d659\",...","Request - listing alerts of one or more types (levels)\n  curl -X GET  -H \"Content-Type:application/json\" -H \"X-Auth-Token:ENDVcVtaZvVuKlSIxKhQbw\" -d '{\"alert_type\":[1]}' https://api.datonis.io/api/v3/alerts\n\nResponse (containing alerts of type 1 i.e. WARNING)\n{\n  \"total_count\": 2,\n  \"page\": 1,\n  \"alerts\": [\n    {\n      \"alert_key\": \"36a9t18tfe\",\n      \"alert_type\": 1,\n      \"created_at\": 1448449721,\n      \"data\": {\n        \"thing\": {\n          \"bi_directional\": false,\n          \"coordinates\": [\n            \"20.15\",\n            \"78.09\"\n          ],\n          \"created_at\": 1448430551,\n          \"description\": \"Thing for washing machines\",\n          \"name\": \"Semi Automated Washing Machine\",\n          \"state\": null,\n          \"tags_array\": [\n            \"Residencial\",\n            \"automated\"\n          ],\n          \"thing_key\": \"ta597t738b\",\n          \"updated_at\": 1448437372,\n          \"user_defined_properties\": {\n            \"Firmware Ver\": \"1.0\",\n            \"STATE\": \"OK\",\n            \"Installation Type\": \"Free Standing\",\n            \"Manufacturer\": \"LG\",\n            \"Color\": \"Red\"\n          },\n          \"alive\": false,\n          \"tags\": \"Residencial,automated\",\n          \"last_event\": null,\n          \"last_beat\": null,\n          \"thing_template_name\": \"Washing Machine\",\n          \"thing_template_key\": \"831e1tf472\"\n        },\n        \"alert_type_string\": \"Warning\"\n      },\n      \"message\": \"New Alert\",\n      \"timestamp\": 1448449,\n      \"updated_at\": 1448449721,\n      \"alert_type_string\": \"Warning\",\n      \"thing_key\": \"ta597t738b\",\n      \"thing_name\": \"Semi Automated Washing Machine\"\n    },\n    {\n      \"alert_key\": \"5fbata9e6a\",\n      \"alert_type\": 1,\n      \"created_at\": 1448449654,\n      \"data\": {\n        \"thing\": {\n         ..."],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/3.0/alert/show","name":"show","apis":[{"api_url":"/api/v3/alerts/:alert_key","http_method":"GET","short_description":"Fetch an alert","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eReturns details of the requested alert\u003c/p\u003e\n","errors":[],"params":[{"name":"pretty","full_name":"pretty","description":"\n\u003cp\u003eReturn a pretty formatted response if true, Default is false\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Boolean","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"is_oem","full_name":"is_oem","description":"\n\u003cp\u003eShow alert of child account if is_oem flag is true.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":["Request\n  curl -X GET  -H \"Content-Type:application/json\" -H \"X-Auth-Token:ENDVcVtaZvVuKlSIxKhQbw\"  https://api.datonis.io/api/v3/alerts/6abfc13459\n\nResponse (containing details of the alert fetched)\n{\n  \"alert\": {\n    \"alert_key\": \"6abfc13459\",\n    \"alert_type\": 0,\n    \"created_at\": 1448451693,\n    \"data\": {\n      \"thing\": {\n        \"bi_directional\": true,\n        \"coordinates\": [\n          20.15,\n          78.09\n        ],\n        \"created_at\": 1448435611,\n        \"description\": \"Thing for Energy Meters\",\n        \"name\": \"Energy Meter 1\",\n        \"state\": null,\n        \"tags_array\": [\n          \"Residential\"\n        ],\n        \"thing_key\": \"45bf16bb4e\",\n        \"updated_at\": 1448435611,\n        \"user_defined_properties\": {\n          \"Firmware Ver\": \"1.0\",\n          \"STATE\": \"OK\"\n        },\n        \"alive\": false,\n        \"tags\": \"Residential\",\n        \"last_event\": null,\n        \"last_beat\": null,\n        \"thing_template_name\": \"Energy Meter\",\n        \"thing_template_key\": \"82e2et9c31\"\n      },\n      \"instruction\": {\n        \"definition\": {\n          \"command\": 1\n        },\n        \"description\": null,\n        \"instruction_key\": \"t4bd14d659\",\n        \"name\": \"Turn ON\",\n        \"created_at\": 1448275718,\n        \"updated_at\": 1448275718\n      },\n      \"alert_type_string\": \"Info\"\n    },\n    \"message\": \"Instruction Turn ON sent to Energy Meter1\",\n    \"timestamp\": 1448451,\n    \"updated_at\": 1448451693,\n    \"alert_type_string\": \"Info\",\n    \"thing_key\": \"45bf16bb4e\",\n    \"thing_name\": \"Energy Meter 1\",\n    \"instruction_key\": \"t4bd14d659\",\n    \"instruction_name\": \"Turn ON\"\n  }\n}"],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[]},"audit_trail":{"doc_url":"/apidoc/3.0/audit_trail","api_url":"","name":"Audit trail","short_description":null,"full_description":"","version":"3.0","formats":null,"metadata":{"order":15},"methods":[{"doc_url":"/apidoc/3.0/audit_trail/index","name":"index","apis":[{"api_url":"/api/v3/audit_trails","http_method":"GET","short_description":"List all audit trails","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eReturns a list of all audit trails belonging to an account as per the\nspecified criteria. This API is paginated and returns 10 audit trails by\ndefault. An audit trail is uniquely identified by an\n\u0026#39;audit_trail_key\u0026#39;. This key should be used in all the other API\nreferencing a particular audit trail.\u003c/p\u003e\n","errors":[],"params":[{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number of results to be fetched, Default 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be Integer.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"per","full_name":"per","description":"\n\u003cp\u003eNumber of audit_trail records to be returned in one page, Default 10\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be Integer.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order_by","full_name":"order_by","description":"\n\u003cp\u003eField on which resultant audit_trails should be sorted\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eOrder, asc or desc, in which results should be sorted\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"timestamp_format","full_name":"timestamp_format","description":"\n\u003cp\u003eFormat, “str” or “int”, in which timestamps should be returned, Default\n“int”\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003eKeywords based on which audit_trails should be searched. Currently you can\nsearch audit_trails on - action_taken, entity_type, entity_name, entity_key\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"scope","full_name":"scope","description":"\n\u003cp\u003eMatching condition if multiple keywords are specified for search. Valid\nvalues are “all” or “any”. Default is “all”\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"pretty","full_name":"pretty","description":"\n\u003cp\u003eReturn a pretty formatted response if true, Default is false\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Boolean","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"entity_type","full_name":"entity_type","description":"\n\u003cp\u003eThe type of the object for which audit_trails are to be fetched, such as\nThing, Rule\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"entity_key","full_name":"entity_key","description":"\n\u003cp\u003eThe key of the object for which audit_trails are to be fetched\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":["Request - listing all audit trails without any criteria\n  curl -X GET  -H \"Content-Type:application/json\" -H \"X-Auth-Token:6AuwD9E_WT_LEKwNOBbytg\" https://api.datonis.io/api/v3/audit_trails\n\nResponse (returns first 10 records)\n{\n  \"total_count\": 8,\n  \"page\": 1,\n  \"audit_trails\": [\n    {\n      \"action_taken\": \"create\",\n      \"audit_trail_key\": \"ta6c4f6da4\",\n      \"entity_key\": \"7t16794d28\",\n      \"entity_name\": \"Refrigerator\",\n      \"entity_type\": \"ThingTemplate\",\n      \"new_entity_contents\": {\n        \"created_at\": 1448430440,\n        \"description\": \"Template for Refrigerators\",\n        \"name\": \"Refrigerator\",\n        \"thing_template_key\": \"7t16794d28\",\n        \"updated_at\": 1448430440,\n        \"user_defined_properties\": {\n          \"Firmware Ver\": \"1.0\",\n          \"STATE\": \"OK\"\n        },\n        \"metrics\": [\n\n        ]\n      },\n      \"old_entity_contents\": {\n      },\n      \"timestamp\": 1448430440,\n      \"user_name\": \"John Doe\",\n      \"role_name\": \"Account Admin\"\n    },\n    {\n      \"action_taken\": \"create\",\n      \"audit_trail_key\": \"af7bd2dd14\",\n      \"entity_key\": \"831e1tf472\",\n      \"entity_name\": \"Washing Machine\",\n      \"entity_type\": \"ThingTemplate\",\n      \"new_entity_contents\": {\n        \"created_at\": 1448430440,\n        \"description\": \"Template for washing machines\",\n        \"name\": \"Washing Machine\",\n        \"thing_template_key\": \"831e1tf472\",\n        \"updated_at\": 1448430440,\n        \"user_defined_properties\": {\n          \"Firmware Ver\": \"1.0\",\n          \"STATE\": \"OK\"\n        },\n        \"metrics\": [\n\n        ]\n      },\n      \"old_entity_contents\": {\n      },\n      \"timestamp\": 1448430440,\n      \"user_name\": \"John Doe\",\n      \"role_name\": \"Account Admin\"\n    },\n    {\n      \"action_taken\": \"create\",\n      \"audit_trail_key\": \"8a2fb59f27\",\n      \"entity_key\": \"82e2et9c31\",\n     ...","Request - listing audit trails by specifying number of audit trails to be returned at a time (page size) and specific set to be returned (page)\n  curl -X GET  -H \"Content-Type:application/json\" -H \"X-Auth-Token:6AuwD9E_WT_LEKwNOBbytg\" -d '{\"per\":\"2\", \"page\":\"2\"}' https://api.datonis.io/api/v3/audit_trails\n\nResponse (returns page 2 with 2 audit trails per page)\n{\n  \"total_count\": 8,\n  \"page\": \"2\",\n  \"audit_trails\": [\n    {\n      \"action_taken\": \"create\",\n      \"audit_trail_key\": \"8a2fb59f27\",\n      \"entity_key\": \"82e2et9c31\",\n      \"entity_name\": \"Energy Meter\",\n      \"entity_type\": \"ThingTemplate\",\n      \"new_entity_contents\": {\n        \"created_at\": 1448430440,\n        \"description\": \"Template for Energy Meters\",\n        \"name\": \"Energy Meter\",\n        \"thing_template_key\": \"82e2et9c31\",\n        \"updated_at\": 1448430440,\n        \"user_defined_properties\": {\n          \"Firmware Ver\": \"1.0\",\n          \"STATE\": \"OK\"\n        },\n        \"metrics\": [\n\n        ]\n      },\n      \"old_entity_contents\": {\n      },\n      \"timestamp\": 1448430440,\n      \"user_name\": \"John Doe\",\n      \"role_name\": \"Account Admin\"\n    },\n    {\n      \"action_taken\": \"create\",\n      \"audit_trail_key\": \"296ef4f7d9\",\n      \"entity_key\": \"92df5df8cb\",\n      \"entity_name\": \"Fully Automated Washing Machine\",\n      \"entity_type\": \"Thing\",\n      \"new_entity_contents\": {\n        \"bi_directional\": true,\n        \"coordinates\": [\n          21.15,\n          79.09\n        ],\n        \"created_at\": 1448430551,\n        \"description\": \"Thing for washing machines\",\n        \"name\": \"Fully Automated Washing Machine\",\n        \"state\": null,\n        \"tags_array\": [\n          \"Corporate\"\n        ],\n        \"thing_key\": \"92df5df8cb\",\n        \"updated_at\": 1448430551,\n        \"user_defined_properties\": {\n          \"Firmware Ver\": \"1.0\",\n          \"STATE\": \"OK\",\n          \"Installation Type\": \"Free Standing\",\n          \"Manufacturer\": \"LG\",\n          \"Color\": \"White\"\n        },\n       ...","Request - listing audit trails ordered by a field with string formatted timestamps\n  curl -X GET  -H \"Content-Type:application/json\" -H \"X-Auth-Token:6AuwD9E_WT_LEKwNOBbytg\" -d '{\"timestamp_format\":\"str\",\"order_by\":\"entity_name\",\"order\":\"desc\"}' https://api.datonis.io/api/v3/audit_trails\n\nResponse (returns audit trails in the reverse order of entity name and timestamps in string format)\n{\n  \"total_count\": 8,\n  \"page\": 1,\n  \"audit_trails\": [\n    {\n      \"action_taken\": \"create\",\n      \"audit_trail_key\": \"af7bd2dd14\",\n      \"entity_key\": \"831e1tf472\",\n      \"entity_name\": \"Washing Machine\",\n      \"entity_type\": \"ThingTemplate\",\n      \"new_entity_contents\": {\n        \"created_at\": 1448430440,\n        \"description\": \"Template for washing machines\",\n        \"name\": \"Washing Machine\",\n        \"thing_template_key\": \"831e1tf472\",\n        \"updated_at\": 1448430440,\n        \"user_defined_properties\": {\n          \"Firmware Ver\": \"1.0\",\n          \"STATE\": \"OK\"\n        },\n        \"metrics\": [\n\n        ]\n      },\n      \"old_entity_contents\": {\n      },\n      \"timestamp\": 1448430440,\n      \"user_name\": \"John Doe\",\n      \"role_name\": \"Account Admin\"\n    },\n    {\n      \"action_taken\": \"create\",\n      \"audit_trail_key\": \"3e6672tb59\",\n      \"entity_key\": \"466cd49313\",\n      \"entity_name\": \"Top Fridge Refrigerator\",\n      \"entity_type\": \"Thing\",\n      \"new_entity_contents\": {\n        \"bi_directional\": false,\n        \"coordinates\": [\n          20.15,\n          78.09\n        ],\n        \"created_at\": 1448430551,\n        \"description\": \"Thing for Refrigerator\",\n        \"name\": \"Top Fridge Refrigerator\",\n        \"state\": null,\n        \"tags_array\": [\n          \"Residencial\"\n        ],\n        \"thing_key\": \"466cd49313\",\n        \"updated_at\": 1448430551,\n        \"user_defined_properties\": {\n          \"Firmware Ver\": \"1.0\",\n          \"STATE\": \"OK\",\n          \"Manufacturer\": \"LG\",\n          \"Color\": \"Red\"\n        },\n        \"alive\": false,\n        \"tags\": \"Residencial\",\n       ...","Request - listing audit trails based on some search criteria with all keywords matching\n  curl -X GET  -H \"Content-Type:application/json\" -H \"X-Auth-Token:6AuwD9E_WT_LEKwNOBbytg\" -d '{\"search\":\"Machine Full\"}' https://api.datonis.io/api/v3/audit_trails\n\nResponse (returns audit trails containing both keywords 'Machine' as well as 'Full')\n{\n  \"total_count\": 1,\n  \"page\": 1,\n  \"audit_trails\": [\n    {\n      \"action_taken\": \"create\",\n      \"audit_trail_key\": \"296ef4f7d9\",\n      \"entity_key\": \"92df5df8cb\",\n      \"entity_name\": \"Fully Automated Washing Machine\",\n      \"entity_type\": \"Thing\",\n      \"new_entity_contents\": {\n        \"bi_directional\": true,\n        \"coordinates\": [\n          21.15,\n          79.09\n        ],\n        \"created_at\": 1448430551,\n        \"description\": \"Thing for washing machines\",\n        \"name\": \"Fully Automated Washing Machine\",\n        \"state\": null,\n        \"tags_array\": [\n          \"Corporate\"\n        ],\n        \"thing_key\": \"92df5df8cb\",\n        \"updated_at\": 1448430551,\n        \"user_defined_properties\": {\n          \"Firmware Ver\": \"1.0\",\n          \"STATE\": \"OK\",\n          \"Installation Type\": \"Free Standing\",\n          \"Manufacturer\": \"LG\",\n          \"Color\": \"White\"\n        },\n        \"alive\": false,\n        \"tags\": \"Corporate\",\n        \"last_event\": null,\n        \"last_beat\": null,\n        \"thing_template_name\": \"Washing Machine\",\n        \"thing_template_key\": \"831e1tf472\"\n      },\n      \"old_entity_contents\": {\n      },\n      \"timestamp\": 1448430551,\n      \"user_name\": \"John Doe\",\n      \"role_name\": \"Account Admin\"\n    }\n  ]\n}","Request - listing audit trails based on some search criteria with any of the keywords matching\n  curl -X GET  -H \"Content-Type:application/json\" -H \"X-Auth-Token:6AuwD9E_WT_LEKwNOBbytg\" -d '{\"search\":\"Machine Full\",\"scope\":\"any\"}' https://api.datonis.io/api/v3/audit_trails\n\nResponse (returns audit trails containing either of the keywords 'Machine' or 'Full')\n{\n  \"total_count\": 3,\n  \"page\": 1,\n  \"audit_trails\": [\n    {\n      \"action_taken\": \"create\",\n      \"audit_trail_key\": \"af7bd2dd14\",\n      \"entity_key\": \"831e1tf472\",\n      \"entity_name\": \"Washing Machine\",\n      \"entity_type\": \"ThingTemplate\",\n      \"new_entity_contents\": {\n        \"created_at\": 1448430440,\n        \"description\": \"Template for washing machines\",\n        \"name\": \"Washing Machine\",\n        \"thing_template_key\": \"831e1tf472\",\n        \"updated_at\": 1448430440,\n        \"user_defined_properties\": {\n          \"Firmware Ver\": \"1.0\",\n          \"STATE\": \"OK\"\n        },\n        \"metrics\": [\n\n        ]\n      },\n      \"old_entity_contents\": {\n      },\n      \"timestamp\": 1448430440,\n      \"user_name\": \"John Doe\",\n      \"role_name\": \"Account Admin\"\n    },\n    {\n      \"action_taken\": \"create\",\n      \"audit_trail_key\": \"296ef4f7d9\",\n      \"entity_key\": \"92df5df8cb\",\n      \"entity_name\": \"Fully Automated Washing Machine\",\n      \"entity_type\": \"Thing\",\n      \"new_entity_contents\": {\n        \"bi_directional\": true,\n        \"coordinates\": [\n          21.15,\n          79.09\n        ],\n        \"created_at\": 1448430551,\n        \"description\": \"Thing for washing machines\",\n        \"name\": \"Fully Automated Washing Machine\",\n        \"state\": null,\n        \"tags_array\": [\n          \"Corporate\"\n        ],\n        \"thing_key\": \"92df5df8cb\",\n        \"updated_at\": 1448430551,\n        \"user_defined_properties\": {\n          \"Firmware Ver\": \"1.0\",\n          \"STATE\": \"OK\",\n          \"Installation Type\": \"Free Standing\",\n          \"Manufacturer\": \"LG\",\n          \"Color\": \"White\"\n        },\n        \"alive\": false,\n        \"tags\": \"Corporate\",\n        \"last_event\": null,\n        \"last_beat\": null,\n        \"thing_template_name\": \"Washing Machine\",\n        \"thing_template_key\": \"831e1tf472\"\n      },\n      \"old_entity_contents\": {\n      },\n      \"timestamp\": 1448430551,\n      \"user_name\": \"John Doe\",\n      \"role_name\": \"Account Admin\"\n    },\n    {\n      \"action_taken\": \"create\",\n      \"audit_trail_key\": \"ebf7371ac9\",\n      \"entity_key\": \"ta597t738b\",\n      \"entity_name\": \"Semi Automated Washing Machine\",\n      \"entity_type\": \"Thing\",\n      \"new_entity_contents\": {\n        \"bi_directional\": false,\n        \"coordinates\": [\n          20.15,\n          78.09\n        ],\n        \"created_at\": 1448430551,\n        \"description\": \"Thing for washing machines\",\n        \"name\": \"Semi Automated Washing Machine\",\n        \"state\": null,\n        \"tags_array\": [\n          \"Residencial\"\n        ],\n        \"thing_key\": \"ta597t738b\",\n        \"updated_at\": 1448430551,\n       ...","Request - listing audit trails based on entity key and entity type specified\n  curl -X GET  -H \"Content-Type:application/json\" -H \"X-Auth-Token:6AuwD9E_WT_LEKwNOBbytg\" -d '{\"entity_key\":\"831e1tf472\", \"entity_type\":\"ThingTemplate\"}' https://api.datonis.io/api/v3/audit_trails\n\nResponse (returns audit trails matching the entity key and entity type specified)\n{\n  \"total_count\": 1,\n  \"page\": 1,\n  \"audit_trails\": [\n    {\n      \"action_taken\": \"create\",\n      \"audit_trail_key\": \"af7bd2dd14\",\n      \"entity_key\": \"831e1tf472\",\n      \"entity_name\": \"Washing Machine\",\n      \"entity_type\": \"ThingTemplate\",\n      \"new_entity_contents\": {\n        \"created_at\": 1448430440,\n        \"description\": \"Template for washing machines\",\n        \"name\": \"Washing Machine\",\n        \"thing_template_key\": \"831e1tf472\",\n        \"updated_at\": 1448430440,\n        \"user_defined_properties\": {\n          \"Firmware Ver\": \"1.0\",\n          \"STATE\": \"OK\"\n        },\n        \"metrics\": [\n\n        ]\n      },\n      \"old_entity_contents\": {\n      },\n      \"timestamp\": 1448430440,\n      \"user_name\": \"John Doe\",\n      \"role_name\": \"Account Admin\"\n    }\n  ]\n}"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/3.0/audit_trail/show","name":"show","apis":[{"api_url":"/api/v3/audit_trails/:audit_trail_key","http_method":"GET","short_description":"Fetch information for an audit trail","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eReturns details of the audit trail requested\u003c/p\u003e\n","errors":[],"params":[{"name":"pretty","full_name":"pretty","description":"\n\u003cp\u003eReturn a pretty formatted response if true, Default is false\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Boolean","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":["Request - get details of the specified audit trail (audit_trail_key specified as a part of the url)\n  curl -X GET  -H \"Content-Type:application/json\" -H \"X-Auth-Token:6AuwD9E_WT_LEKwNOBbytg\"  https://api.datonis.io/api/v3/audit_trails/296ef4f7d9\n\nResponse (returns details of the audit trail requested)\n{\n  \"audit_trail\": {\n    \"action_taken\": \"create\",\n    \"audit_trail_key\": \"296ef4f7d9\",\n    \"entity_key\": \"92df5df8cb\",\n    \"entity_name\": \"Fully Automated Washing Machine\",\n    \"entity_type\": \"Thing\",\n    \"new_entity_contents\": {\n      \"bi_directional\": true,\n      \"coordinates\": [\n        21.15,\n        79.09\n      ],\n      \"created_at\": 1448430551,\n      \"description\": \"Thing for washing machines\",\n      \"name\": \"Fully Automated Washing Machine\",\n      \"state\": null,\n      \"tags_array\": [\n        \"Corporate\"\n      ],\n      \"thing_key\": \"92df5df8cb\",\n      \"updated_at\": 1448430551,\n      \"user_defined_properties\": {\n        \"Firmware Ver\": \"1.0\",\n        \"STATE\": \"OK\",\n        \"Installation Type\": \"Free Standing\",\n        \"Manufacturer\": \"LG\",\n        \"Color\": \"White\"\n      },\n      \"alive\": false,\n      \"tags\": \"Corporate\",\n      \"last_event\": null,\n      \"last_beat\": null,\n      \"thing_template_name\": \"Washing Machine\",\n      \"thing_template_key\": \"831e1tf472\"\n    },\n    \"old_entity_contents\": {\n    },\n    \"timestamp\": 1448430551,\n    \"user_name\": \"John Doe\",\n    \"role_name\": \"Account Admin\"\n  }\n}"],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[]},"query":{"doc_url":"/apidoc/3.0/query","api_url":"","name":"Query","short_description":null,"full_description":"","version":"3.0","formats":null,"metadata":{"order":5,"name":"Data query"},"methods":[{"doc_url":"/apidoc/3.0/query/thing_aggregated_data","name":"thing_aggregated_data","apis":[{"api_url":"/api/v3/query/thing_aggregated_data","http_method":"POST","short_description":"Get aggregated thing stats like sum, count, min, max","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eReturns aggregated results for thing data for given thing keys\u003c/p\u003e\n","errors":[],"params":[{"name":"thing_keys","full_name":"thing_keys","description":"\n\u003cp\u003eArray of sensor_keys\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"time_grouping","full_name":"time_grouping","description":"\n\u003cp\u003etype of time grouping i.e. month/day/hour/minute\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"time_grouping_value","full_name":"time_grouping_value","description":"\n\u003cp\u003einteger representing value. e.g. if it is 15, and time_grouping is minute,\ndata will be grouped in 15 minute intervals\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be Integer.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"idle_time_required","full_name":"idle_time_required","description":"\n\u003cp\u003eIf idle time is required in the result\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"time_zone","full_name":"time_zone","description":"\n\u003cp\u003eTime zone for calculating data`\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"from","full_name":"from","description":"\n\u003cp\u003eFrom Date in format \u0026#39;yyyy/mm/dd hh:mm:ss\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"to","full_name":"to","description":"\n\u003cp\u003eTo Date in format \u0026#39;yyyy/mm/dd hh:mm:ss\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"timestamp_format","full_name":"timestamp_format","description":"\n\u003cp\u003eFormat, int or str in which event timestamps should be returned\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"metrics","full_name":"metrics","description":"\n\u003cp\u003eList of metric names required in the result.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"data_format","full_name":"data_format","description":"\n\u003cp\u003eFormat in which event data should be returned e.g. “array” , “map”\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"pretty","full_name":"pretty","description":"\n\u003cp\u003eReturn a pretty formatted response if true, Default is false\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Boolean","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"is_oem","full_name":"is_oem","description":"\n\u003cp\u003eReturn thing aggregated data of child thing if is_oem flag is true.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Boolean","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"functions","full_name":"functions","description":"\n\u003cp\u003eList of functions to be used for aggregation. Valid values are : avg, min,\nmax, sum, count. Note: if avg is selected them and sum and count are also\nreturned\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}],"examples":["Request data for a thing for a period of 5 hours in Asia/Calcutta time zone.\n  curl -X POST -H \"Content-Type:application/json\" --header 'X-Auth-Token:IEkmVGHsa4R3cGPw56MkfQ' -d '{\"idle_time_required\":true,\"time_zone\":\"Asia/Calcutta\",\"thing_keys\":[\"11a6238e445dtd65a45ddfdabd6b8f41dbfetdfd\"],\"from\":\"2016/02/01 00:00:00\",\"to\":\"2016/02/01 05:00:00\" }' 'https://api.datonis.io/api/v3/datonis_query/thing_aggregated_data'\n\nReturns a summary result and thing wise result.\n{\n  \"summary_result\": {\n    \"cpu\": {\n      \"count\": 498.0,\n      \"sum\": 2028.144,\n      \"min\": 0.046,\n      \"max\": 7.988,\n      \"avg\": 4.072578313253012,\n      \"idle_time_mins\": 42,\n      \"total_time_mins\": 300\n    },\n    \"mem\": {\n      \"count\": 498.0,\n      \"sum\": 124426.342,\n      \"min\": 100.369,\n      \"max\": 399.048,\n      \"avg\": 249.85209236947793,\n      \"idle_time_mins\": 42,\n      \"total_time_mins\": 300\n    }\n  },\n  \"thing_wise_result\": {\n    \"11a6238e445dtd65a45ddfdabd6b8f41dbfetdfd\": {\n      \"cpu\": {\n        \"count\": 498.0,\n        \"sum\": 2028.144,\n        \"min\": 0.046,\n        \"max\":...","Request data for a thing for a period of 3 hours in Asia/Calcutta time zone, grouped into hourly buckets.\n  curl -X POST -H \"Content-Type:application/json\" --header 'X-Auth-Token:IEkmVGHsa4R3cGPw56MkfQ' -d '{\"time_grouping\":\"hour\",\"idle_time_required\":true,\"time_zone\":\"Asia/Calcutta\",\"thing_keys\":[\"11a6238e445dtd65a45ddfdabd6b8f41dbfetdfd\"],\"from\":\"2016/02/01 10:00:00\",\"to\":\"2016/02/01 13:00:00\" }' 'https://api.datonis.io/api/v3/datonis_query/thing_aggregated_data'\n\nReturns a summary result, thing wise result and a hourly time grouped result for the thing.\n{\n  \"summary_result\": {\n    \"cpu\": {\n      \"count\": 634.0,\n      \"sum\": 2532.3750000000005,\n      \"min\": 0.004,\n      \"max\": 7.996,\n      \"avg\": 3.9942823343848586,\n      \"idle_time_mins\": 4,\n      \"total_time_mins\": 180\n    },\n    \"mem\": {\n      \"count\": 634.0,\n      \"sum\": 158742.0,\n      \"min\": 100.343,\n      \"max\": 399.703,\n      \"avg\": 250.38170347003154,\n      \"idle_time_mins\": 4,\n      \"total_time_mins\": 180\n    }\n  },\n  \"thing_wise_result\": {\n    \"11a6238e445dtd65a45ddfdabd6b8f41dbfetdfd\": {\n      \"cpu\": {\n        \"count\": 634.0,\n        \"sum\": 2532.3750000000005,\n        \"min\": 0.004,\n ...","Request data for a thing for 10 minute period in UTC time zone, grouped in minutely buckets.\n  curl -X POST -H \"Content-Type:application/json\" --header 'X-Auth-Token:IEkmVGHsa4R3cGPw56MkfQ' -d '{\"time_grouping\":\"minute\",\"idle_time_required\":true,\"time_zone\":\"UTC\",\"thing_keys\":[\"e4aa3e35t675fc57ce81f3dd6e2dcdef492at4f7\"],\"date_ranges\":[{\"from\":\"2015/04/02 17:05:00\",\"to\":\"2015/04/02 17:15:00\"}]}' 'https://api.datonis.io/api/v3/datonis_query/thing_aggregated_data'\n\nReturns a summary result, thing wise result and a minutely  time grouped result for the thing.\n{\n  \"summary_result\": {\n    \"cpu\": {\n      \"count\": 32.0,\n      \"sum\": 113.804,\n      \"min\": 0.095,\n      \"max\": 7.894,\n      \"avg\": 3.556375,\n      \"idle_time_mins\": 0,\n      \"total_time_mins\": 10\n    },\n    \"mem\": {\n      \"count\": 32.0,\n      \"sum\": 7925.794999999999,\n      \"min\": 107.754,\n      \"max\": 399.647,\n      \"avg\": 247.68109374999997,\n      \"idle_time_mins\": 0,\n      \"total_time_mins\": 10\n    }\n  },\n  \"thing_wise_result\": {\n    \"11a6238e445dtd65a45ddfdabd6b8f41dbfetdfd\": {\n      \"cpu\": {\n        \"count\": 32.0,\n        \"sum\": 113.804,\n        \"min\": 0.095,\n        \"max\": 7.894,\n       ...","Request data for a thing for 1 hour for the 'cpu' field only.\n  curl -X POST -H \"Content-Type:application/json\" --header 'X-Auth-Token:IEkmVGHsa4R3cGPw56MkfQ' -d '{\"idle_time_required\":true,\"time_zone\":\"Asia/Calcutta\",\"thing_keys\":[\"11a6238e445dtd65a45ddfdabd6b8f41dbfetdfd\"],\"from\":\"2016/02/01 10:00:00\",\"to\":\"2016/02/01 11:00:00\", \"metrics\":[\"cpu\"] }' 'https://api.datonis.io/api/v3/datonis_query/thing_aggregated_data'\n\nReturns one hour of aggregated data for 'cpu' field\n{\n  \"summary_result\": {\n    \"cpu\": {\n      \"count\": 35.0,\n      \"sum\": 124.828,\n      \"min\": 0.095,\n      \"max\": 7.894,\n      \"avg\": 3.5665142857142857,\n      \"idle_time_mins\": 0,\n      \"total_time_mins\": 11\n    }\n  },\n  \"thing_wise_result\": {\n    \"11a6238e445dtd65a45ddfdabd6b8f41dbfetdfd\": {\n      \"cpu\": {\n        \"count\": 35.0,\n        \"sum\": 124.828,\n        \"min\": 0.095,\n        \"max\": 7.894,\n        \"avg\": 3.5665142857142857,\n        \"idle_time_mins\": 0,\n        \"total_time_mins\": 11\n      }\n    }\n  }\n}"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/3.0/query/thing_data","name":"thing_data","apis":[{"api_url":"/api/v3/query/thing_data","http_method":"POST","short_description":"Get raw event data for a thing","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eReturns raw event data for a thing\u003c/p\u003e\n","errors":[],"params":[{"name":"thing_key","full_name":"thing_key","description":"\n\u003cp\u003eThing key\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"from","full_name":"from","description":"\n\u003cp\u003eFrom Date in format \u0026#39;yyyy/mm/dd hh:mm:ss\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"to","full_name":"to","description":"\n\u003cp\u003eTo Date in format \u0026#39;yyyy/mm/dd hh:mm:ss\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number of results to be fetched\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be Integer.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"per","full_name":"per","description":"\n\u003cp\u003eNumber of records to be returnes in one page\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be Integer.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"timestamp_format","full_name":"timestamp_format","description":"\n\u003cp\u003eFormat, int or str in which event timestamps should be returned\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"time_zone","full_name":"time_zone","description":"\n\u003cp\u003etime zone in which to return data e.g. “Mumbai”, “EST” etc\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eOrder of time_stamp, asc or desc, in which events will be filtered\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"metrics","full_name":"metrics","description":"\n\u003cp\u003eList of fields required in the result.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"data_format","full_name":"data_format","description":"\n\u003cp\u003eFormat in which event data should be returned e.g. “array” , “map”\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"pretty","full_name":"pretty","description":"\n\u003cp\u003eReturn a pretty formatted response if true, Default is false\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Boolean","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"is_oem","full_name":"is_oem","description":"\n\u003cp\u003eReturn thing data of child thing if is_oem flag is true.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Boolean","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"query_by_created_at","full_name":"query_by_created_at","description":"\n\u003cp\u003eIf set to true, “from” and “to” range is applied on “created_at” field\ninstead of “timestamp”\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Boolean","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":["Request raw data for a thing for a period of 5 minutes in time zone Mumbai with 10 events per page.\n  curl -X POST -H \"Content-Type:application/json\" --header 'X-Auth-Token:IEkmVGHsa4R3cGPw56MkfQ' -d '{\"thing_key\":\"11a6238e445dtd65a45ddfdabd6b8f41dbfetdfd\", \"from\":\"2016/02/02 17:05:00\", \"to\":\"2016/02/02 17:10:00\", \"time_zone\":\"Mumbai\" , \"time_format\":\"str\", \"per\":\"10\"}' 'https://api.datonis.io/api/v3/datonis_query/thing_data'\n\nReturns upto 10 events.\n{\n  \"11a6238e445dtd65a45ddfdabd6b8f41dbfetdfd\": {\n    \"total_event_count\": 22,\n    \"page_number\": \"1\",\n    \"event_data\": [\n      {\n        \"timestamp\": \"2016/02/02 17:09:53\",\n        \"data\": {\n          \"mem\": 171.573,\n          \"cpu\": 1.365\n        }\n      },\n      {\n        \"timestamp\": \"2016/02/02 17:09:36\",\n        \"data\": {\n          \"mem\": 172.742,\n          \"cpu\": 7.427\n        }\n      },\n      {\n        \"timestamp\": \"2016/02/02 17:09:07\",\n        \"data\": {\n          \"mem\": 302.88,\n          \"cpu\": 6.717\n        }\n      },\n      {\n        \"timestamp\": \"2016/02/02 17:08:30\",\n       ...","Request page no 2 of raw data for a thing for a period of 5 minutes in time zone Mumbai with 10 events per page.\n  curl -X POST -H \"Content-Type:application/json\" --header 'X-Auth-Token:IEkmVGHsa4R3cGPw56MkfQ' -d '{\"thing_key\":\"11a6238e445dtd65a45ddfdabd6b8f41dbfetdfd\", \"from\":\"2016/02/02 17:05:00\", \"to\":\"2016/02/02 17:10:00\", \"time_zone\":\"Mumbai\" , \"time_format\":\"str\", \"per\":10, \"page\":2}' 'https://api.datonis.io/api/v3/datonis_query/thing_data'\n\nReturn data for page no 2.\n{\n  \"11a6238e445dtd65a45ddfdabd6b8f41dbfetdfd\": {\n    \"total_event_count\": 22,\n    \"page_number\": \"2\",\n    \"event_data\": [\n      {\n        \"timestamp\": \"2016/02/02 17:07:01\",\n        \"data\": {\n          \"cpu\": 0.463,\n          \"mem\": 159.714\n        }\n      },\n      {\n        \"timestamp\": \"2016/02/02 17:06:56\",\n        \"data\": {\n          \"mem\": 192.217,\n          \"cpu\": 0.613\n        }\n      },\n      {\n        \"timestamp\": \"2016/02/02 17:06:55\",\n        \"data\": {\n          \"cpu\": 0.099,\n          \"mem\": 161.124\n        }\n      },\n      {\n        \"timestamp\": \"2016/02/02 17:06:42\",\n       ...","Request raw data where time is returned in integer format (seconds after epoch)\n  curl -X POST -H \"Content-Type:application/json\" --header 'X-Auth-Token:IEkmVGHsa4R3cGPw56MkfQ' -d '{\"thing_key\":\"11a6238e445dtd65a45ddfdabd6b8f41dbfetdfd\", \"from\":\"2016/02/02 17:05:00\", \"to\":\"2016/02/02 17:10:00\", \"time_zone\":\"Mumbai\" , \"time_format\":\"int\", \"per\":10, \"page\":2}' 'https://api.datonis.io/api/v3/datonis_query/thing_data'\n\nReturns data with timestamps in integer form.\n{\n  \"11a6238e445dtd65a45ddfdabd6b8f41dbfetdfd\": {\n    \"total_event_count\": 22,\n    \"page_number\": \"2\",\n    \"event_data\": [\n      {\n        \"timestamp\": 1454413021,\n        \"data\": {\n          \"cpu\": 0.463,\n          \"mem\": 159.714\n        }\n      },\n      {\n        \"timestamp\": 1454413016,\n        \"data\": {\n          \"mem\": 192.217,\n          \"cpu\": 0.613\n        }\n      },\n      {\n        \"timestamp\": 1454413015,\n        \"data\": {\n          \"cpu\": 0.099,\n          \"mem\": 161.124\n        }\n      },\n      {\n        \"timestamp\": 1454413002,\n        \"data\": {\n          \"cpu\": 5.308,\n         ...","Request raw data only for 'cpu' field.\n  curl -X POST -H \"Content-Type:application/json\" --header 'X-Auth-Token:IEkmVGHsa4R3cGPw56MkfQ' -d '{\"thing_key\":\"e4aa3e35t675fc57ce81f3dd6e2dcdef492at4f7\", \"from\":\"2015/04/02 17:05:00\", \"to\":\"2015/04/02 17:10:00\", \"time_zone\":\"Mumbai\" , \"time_format\":\"int\", \"per\":\"10\", \"page\":\"1\", \"metrics\":[\"cpu\"]}' 'https://api.datonis.io/api/v3/datonis_query/thing_data'\n\nReturn data with only the required fields.\n{\n  \"e4aa3e35t675fc57ce81f3dd6e2dcdef492at4f7\": {\n    \"total_event_count\": 30,\n    \"page_number\": \"1\",\n    \"event_data\": [\n      {\n        \"data\": {\n          \"cpu\": 1.3250000000000002\n        },\n        \"time_stamp\": 1427974799\n      },\n      {\n        \"data\": {\n          \"cpu\": 1.45\n        },\n        \"time_stamp\": 1427974797\n      },\n      {\n        \"data\": {\n          \"cpu\": 1.45\n        },\n        \"time_stamp\": 1427974795\n      },\n      {\n        \"data\": {\n          \"cpu\": 1.45\n        },\n        \"time_stamp\": 1427974794\n      },\n      {\n        \"data\": {\n          \"cpu\": 1.35\n        },\n  ..."],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[]},"role":{"doc_url":"/apidoc/3.0/role","api_url":"","name":"Role","short_description":null,"full_description":"","version":"3.0","formats":null,"metadata":{"order":13,"name":"Role"},"methods":[{"doc_url":"/apidoc/3.0/role/index","name":"index","apis":[{"api_url":"/api/v3/roles","http_method":"GET","short_description":"List all roles","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eReturns a list of all roles belonging to an account as per the specified\ncriteria. This API is paginated and returns 20 roles by default. A role is\nuniquely identified by a \u0026#39;role_key\u0026#39;. This key should be used in all\nthe other API referencing a particular role.\u003c/p\u003e\n","errors":[],"params":[{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number of results to be fetched, Default 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be Integer.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"per","full_name":"per","description":"\n\u003cp\u003eNumber of roles records to be returned in one page, Default 20\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be Integer.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order_by","full_name":"order_by","description":"\n\u003cp\u003eField on which resultant roles should be sorted\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eOrder, asc or desc, in which results should be sorted\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"timestamp_format","full_name":"timestamp_format","description":"\n\u003cp\u003eFormat, “str” or “int”, in which timestamps should be returned, Default\n“int”\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003eKeywords based on which roles should be searched. Currently you can search\nroles on - role_key, name\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"scope","full_name":"scope","description":"\n\u003cp\u003eMatching condition if multiple keywords are specified for search. Valid\nvalues are “all” or “any”. Default is “all”\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"pretty","full_name":"pretty","description":"\n\u003cp\u003eReturn a pretty formatted response if true, Default is false\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Boolean","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"field_list","full_name":"field_list","description":"\n\u003cp\u003eList of fields required in the result.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"fields","full_name":"fields","description":"\n\u003cp\u003e[Deprecated]Comma separated list of fields required in the result.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"is_oem","full_name":"is_oem","description":"\n\u003cp\u003eReturns roles of child accounts along with roles of oem account if is_oem\nflag is true.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":["Request - listing all roles without any criteria\n  curl -X GET  -H \"Content-Type:application/json\" -H \"X-Auth-Token:WtUFnj8pvSxVnH9e_xkq7A\" https://api.datonis.io/api/v3/roles\n\nResponse (returns first 20 records)\n{\n  \"total_count\": 5,\n  \"page\": 1,\n  \"roles\": [\n    {\n      \"abilities\": [\n        0\n      ],\n      \"account_admin\": true,\n      \"role_key\": \"2e46ec4f56\",\n      \"name\": \"Account Admin\",\n      \"permissions\": [\n        {\n          \"class\": \"all\",\n          \"operation\": null,\n          \"seqno\": 0\n        }\n      ],\n      \"created_at\": 1448282945,\n      \"updated_at\": 1448282945\n    },\n    {\n      \"abilities\": [\n        1,\n        11,\n        17,\n        6\n      ],\n      \"account_admin\": false,\n      \"role_key\": \"9c6dcctaec\",\n      \"name\": \"Read Only\",\n      \"permissions\": [\n        {\n          \"class\": \"thing\",\n          \"operation\": \"read\",\n          \"seqno\": 1\n        },\n        {\n          \"class\": \"sensor\",\n          \"operation\": \"read\",\n          \"seqno\": 1\n        },\n        {\n          \"class\": \"rule\",\n          \"operation\": \"read\",\n          \"seqno\": 6\n        },\n        {\n          \"class\": \"instruction\",\n          \"operation\": \"read\",\n          \"seqno\": 11\n        },\n        {\n          \"class\": \"group\",\n          \"operation\": \"read\",\n          \"seqno\": 17\n        }\n      ],\n      \"created_at\": 1448282945,\n      \"updated_at\": 1448282945\n    },\n    {\n      \"abilities\": [\n        3\n      ],\n      \"account_admin\": false,\n      \"role_key\": \"d5552947a8\",\n      \"name\": \"Agent\",\n      \"permissions\": [\n        {\n          \"class\": \"thing\",\n          \"operation\": \"read\",\n          \"seqno\": 1\n        },\n        {\n          \"class\": \"thing\",\n          \"operation\": \"update\",\n          \"seqno\": 3\n        },\n        {\n          \"class\": \"sensor\",\n          \"operation\": \"read\",\n ...","Request - listing roles by specifying number of roles to be returned at a time (page size) and specific set to be returned (page)\n  curl -X GET  -H \"Content-Type:application/json\" -H \"X-Auth-Token:WtUFnj8pvSxVnH9e_xkq7A\" -d '{\"per\":\"2\", \"page\":\"2\"}' https://api.datonis.io/api/v3/roles\n\nResponse (returns page 2 with 2 roles per page)\n{\n  \"total_count\": 5,\n  \"page\": \"2\",\n  \"roles\": [\n    {\n      \"abilities\": [\n        3\n      ],\n      \"account_admin\": false,\n      \"role_key\": \"d5552947a8\",\n      \"name\": \"Agent\",\n      \"permissions\": [\n        {\n          \"class\": \"thing\",\n          \"operation\": \"read\",\n          \"seqno\": 1\n        },\n        {\n          \"class\": \"thing\",\n          \"operation\": \"update\",\n          \"seqno\": 3\n        },\n        {\n          \"class\": \"sensor\",\n          \"operation\": \"read\",\n          \"seqno\": 1\n        },\n        {\n          \"class\": \"sensor\",\n          \"operation\": \"update\",\n          \"seqno\": 3\n        }\n      ],\n      \"created_at\": 1448282945,\n      \"updated_at\": 1448282945\n    },\n    {\n      \"abilities\": [\n        5\n      ],\n      \"account_admin\": false,\n      \"role_key\": \"6t9f5bed7f\",\n      \"name\": \"Thing_only\",\n      \"permissions\": [\n        {\n          \"class\": \"thing\",\n          \"operation\": \"read\",\n          \"seqno\": 1\n        },\n        {\n          \"class\": \"thing\",\n          \"operation\": \"create\",\n          \"seqno\": 2\n        },\n        {\n          \"class\": \"thing\",\n          \"operation\": \"update\",\n          \"seqno\": 3\n        },\n        {\n          \"class\": \"thing\",\n          \"operation\": \"delete\",\n          \"seqno\": 4\n        },\n        {\n          \"class\": \"thing\",\n          \"operation\": \"all\",\n          \"seqno\": 5\n        },\n        {\n          \"class\": \"sensor\",\n          \"operation\": \"read\",\n          \"seqno\": 1\n        },\n        {\n          \"class\": \"sensor\",\n          \"operation\": \"create\",\n          \"seqno\": 2\n        },\n        {\n          \"class\":..."],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/3.0/role/show","name":"show","apis":[{"api_url":"/api/v3/roles/:role_key","http_method":"GET","short_description":"Fetch information for a role","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eReturns details of the role requested\u003c/p\u003e\n","errors":[],"params":[{"name":"pretty","full_name":"pretty","description":"\n\u003cp\u003eReturn a pretty formatted response if true, Default is false\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Boolean","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"is_oem","full_name":"is_oem","description":"\n\u003cp\u003eShow role of child account if is_oem flag is true.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":["Request - get details of the specified role (role specified as a part of the url)\n  curl -X GET  -H \"Content-Type:application/json\" -H \"X-Auth-Token:WtUFnj8pvSxVnH9e_xkq7A\"  https://api.datonis.io/api/v3/roles/d5552947a8\n\nResponse (returns details of the role requested)\n{\n  \"role\": {\n    \"abilities\": [\n      3\n    ],\n    \"account_admin\": false,\n    \"role_key\": \"d5552947a8\",\n    \"name\": \"Agent\",\n    \"permissions\": [\n      {\n        \"class\": \"thing\",\n        \"operation\": \"read\",\n        \"seqno\": 1\n      },\n      {\n        \"class\": \"thing\",\n        \"operation\": \"update\",\n        \"seqno\": 3\n      },\n      {\n        \"class\": \"sensor\",\n        \"operation\": \"read\",\n        \"seqno\": 1\n      },\n      {\n        \"class\": \"sensor\",\n        \"operation\": \"update\",\n        \"seqno\": 3\n      }\n    ],\n    \"created_at\": 1448282945,\n    \"updated_at\": 1448282945\n  }\n}"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/3.0/role/create","name":"create","apis":[{"api_url":"/api/v3/roles","http_method":"POST","short_description":"Create a role","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eCreates a role with given parameters\u003c/p\u003e\n","errors":[],"params":[{"name":"pretty","full_name":"pretty","description":"\n\u003cp\u003eReturn a pretty formatted response if true, Default is false\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Boolean","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"is_oem","full_name":"is_oem","description":"\n\u003cp\u003eCreate role in child account by oem user if is_oem flag is true.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Boolean","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"child_organisation_key","full_name":"child_organisation_key","description":"\n\u003cp\u003eOrganisation key of child account where oem user wants to create role.\nRequired field if is_oem is present.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":["Request\n  curl -X POST -H \"Content-Type:application/json\" -H \"X-Auth-Token:WtUFnj8pvSxVnH9e_xkq7A\" -d '{\"role\":{\"name\":\"Write Only\", \"abilities\":[3]}}' https://api.datonis.io/api/v3/roles\n\nResponse (returns details of the role created)\n{\n  \"role\": {\n    \"abilities\": [\n      3\n    ],\n    \"account_admin\": false,\n    \"role_key\": \"517d8e4695\",\n    \"name\": \"Write Only\",\n    \"permissions\": [\n      {\n        \"class\": \"role\",\n        \"operation\": \"read\",\n        \"seqno\": 1\n      },\n      {\n        \"class\": \"role\",\n        \"operation\": \"update\",\n        \"seqno\": 3\n      }\n    ]\n  }\n}"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/3.0/role/destroy","name":"destroy","apis":[{"api_url":"/api/v3/roles/:role_key","http_method":"DELETE","short_description":"Delete a role","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eDeletes the specified role from the system. All associated data is also\nlost.\u003c/p\u003e\n","errors":[],"params":[{"name":"pretty","full_name":"pretty","description":"\n\u003cp\u003eReturn a pretty formatted response if true, Default is false\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Boolean","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"is_oem","full_name":"is_oem","description":"\n\u003cp\u003eDelete role in child account by oem user if is_oem flag is true.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Boolean","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":["Request\n  curl -X DELETE -H \"Content-Type:application/json\" -H \"X-Auth-Token:WtUFnj8pvSxVnH9e_xkq7A\"  https://api.datonis.io/api/v3/roles/517d8e4695\n\nResponse\n{\n}"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/3.0/role/update","name":"update","apis":[{"api_url":"/api/v3/roles/:role_key","http_method":"PUT","short_description":"Updates a role","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eUpdates a role with given parameters\u003c/p\u003e\n","errors":[],"params":[{"name":"pretty","full_name":"pretty","description":"\n\u003cp\u003eReturn a pretty formatted response if true, Default is false\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Boolean","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"is_oem","full_name":"is_oem","description":"\n\u003cp\u003eUpdate role in child account by oem user if is_oem flag is true.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Boolean","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":["Request - containing parameters to be modified\n  curl -X PUT -H \"Content-Type:application/json\" -H \"X-Auth-Token:WtUFnj8pvSxVnH9e_xkq7A\" -d '{\"role\":{\"abilities\":[5],\"name\":\"Write Only\"}}}' https://api.datonis.io/api/v3/roles/517d8e4695\n\nResponse (returns details of the role updated)\n{\n  \"role\": {\n    \"abilities\": [\n      5\n    ],\n    \"account_admin\": false,\n    \"role_key\": \"517d8e4695\",\n    \"name\": \"Write Only\",\n    \"permissions\": [\n      {\n        \"class\": \"role\",\n        \"operation\": \"read\",\n        \"seqno\": 1\n      },\n      {\n        \"class\": \"role\",\n        \"operation\": \"create\",\n        \"seqno\": 2\n      },\n      {\n        \"class\": \"role\",\n        \"operation\": \"update\",\n        \"seqno\": 3\n      },\n      {\n        \"class\": \"role\",\n        \"operation\": \"delete\",\n        \"seqno\": 4\n      },\n      {\n        \"class\": \"role\",\n        \"operation\": \"all\",\n        \"seqno\": 5\n      }\n    ]\n  }\n}"],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[]},"gateway":{"doc_url":"/apidoc/3.0/gateway","api_url":"","name":"Gateway","short_description":null,"full_description":null,"version":"3.0","formats":null,"metadata":null,"methods":[{"doc_url":"/apidoc/3.0/gateway/create","name":"create","apis":[{"api_url":"/api/v3/gateway","http_method":"POST","short_description":"Create a gateway","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eCreates a gateway with given parameters\u003c/p\u003e\n","errors":[],"params":[{"name":"gateway","full_name":"gateway","description":"\n\u003cp\u003eObject containing information about the gateway to be created\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[]},{"name":"pretty","full_name":"pretty","description":"\n\u003cp\u003eReturn a pretty formatted response if true, Default is false\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Boolean","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":["Request\n  curl -X GET -H \"Content-Type:application/json\" -H \"X-Auth-Token:WtUFnj8pvSxVnH9e_xkq7A\" -d '{\"gateway\":{\"name\":\"Vertical gateway\"}}' https://api.datonis.io/api/v3/gateway\n\nResponse (returns details of the gateway created)\n{\n  \"gateway\": {\n    \"gateway_key\": \"4ea741566a\",\n    \"gateway_type\": null,\n    \"name\": \"Vertical gateway\",\n    \"gateway_version\": null,\n    \"tags\": \"\",\n    \"adapters\": [\n\n    ]\n  }\n}"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/3.0/gateway/index","name":"index","apis":[{"api_url":"/api/v3/gateway","http_method":"GET","short_description":"List all gateways","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eReturns a list of all gateways belonging to an account as per the specified\ncriteria. This API is paginated and returns 20 gateways by default. A\ngateway is uniquely identified by a \u0026#39;gateway_key\u0026#39;. This key should\nbe used in all the other API referencing a particular gateway.\u003c/p\u003e\n","errors":[],"params":[{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number of results to be fetched, Default 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be Integer.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"per","full_name":"per","description":"\n\u003cp\u003eNumber of gateways records to be returned in one page, Default 20\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be Integer.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order_by","full_name":"order_by","description":"\n\u003cp\u003eField on which resultant gateways should be sorted\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eOrder, asc or desc, in which results should be sorted\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"pretty","full_name":"pretty","description":"\n\u003cp\u003eReturn a pretty formatted response if true, Default is false\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Boolean","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003eKeywords based on which gateways should be searched. Currently you can\nsearch gateways on - name or tag\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"scope","full_name":"scope","description":"\n\u003cp\u003eMatching condition if multiple keywords are specified for search. Valid\nvalues are “all” or “any”. Default is “all”\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":["Request - listing all gateways without any criteria\n  curl -X GET  -H \"Content-Type:application/json\" -H \"X-Auth-Token:WtUFnj8pvSxVnH9e_xkq7A\" https://api.datonis.io/api/v3/gateway\n\nResponse (returns first 20 records)\n{\n  \"gateway\": [\n    {\n      \"gateway_key\": \"a1aad6t93b\",\n      \"gateway_type\": null,\n      \"name\": \"gosling123\",\n      \"gateway_version\": null,\n      \"tags\": \"bavdhan,pune\",\n      \"adapters\": [\n\n      ]\n    },\n    {\n      \"gateway_key\": \"e54986t366\",\n      \"gateway_type\": \"kura\",\n      \"name\": \"trial\",\n      \"gateway_version\": \"4.5.160\",\n      \"tags\": \"hji\",\n      \"adapters\": [\n        {\n          \"type\": null,\n          \"configuration\": \"{}\",\n          \"enabled\": true,\n          \"adapter_pid\": \"com.altizon.gateway.SimulatorAdapter\"\n        },\n        {\n          \"type\": null,\n          \"configuration\": \"{}\",\n          \"enabled\": false,\n          \"adapter_pid\": \"com.altizon.gateway.OPCUAAdapter\"\n        }\n      ]\n    }\n  ],\n  \"total_count\": 1,\n  \"page\": 1\n}"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/3.0/gateway/show","name":"show","apis":[{"api_url":"/api/v3/gateway/:gateway_key","http_method":"GET","short_description":"Fetch information for a gateway","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eReturns details of the gateway requested\u003c/p\u003e\n","errors":[],"params":[{"name":"pretty","full_name":"pretty","description":"\n\u003cp\u003eReturn a pretty formatted response if true, Default is false\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Boolean","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":["Request - get details of the specified gateway (gateway_key specified as a part of the url)\n  curl -X GET  -H \"Content-Type:application/json\" -H \"X-Auth-Token:WtUFnj8pvSxVnH9e_xkq7A\"  https://api.datonis.io/api/v3/gateway/e54986t366\n\nResponse (returns details of the gateway requested)\n{\n  \"gateway\": {\n    \"gateway_key\": \"e54986t366\",\n    \"gateway_type\": \"kura\",\n    \"name\": \"trial\",\n    \"gateway_version\": \"4.5.160\",\n    \"tags\": \"hji\",\n    \"adapters\": [\n      {\n        \"type\": null,\n        \"configuration\": \"{}\",\n        \"enabled\": true,\n        \"adapter_pid\": \"com.altizon.gateway.SimulatorAdapter\"\n      },\n      {\n        \"type\": null,\n        \"configuration\": \"{}\",\n        \"enabled\": false,\n        \"adapter_pid\": \"com.altizon.gateway.OPCUAAdapter\"\n      }\n    ]\n  }\n}"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/3.0/gateway/update","name":"update","apis":[{"api_url":"/api/v3/gateway/:gateway_key","http_method":"PUT","short_description":"Updates a gateway","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eUpdates a gateway with given parameters\u003c/p\u003e\n","errors":[],"params":[{"name":"gateway","full_name":"gateway","description":"\n\u003cp\u003eObject containing information about the gateway to be updated\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[]},{"name":"pretty","full_name":"pretty","description":"\n\u003cp\u003eReturn a pretty formatted response if true, Default is false\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Boolean","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":["Request - containing parameters to be modified\n  curl -X PUT -H \"Content-Type:application/json\" -H \"X-Auth-Token:WtUFnj8pvSxVnH9e_xkq7A\" -d '{\"gateway\":{\"tags\":\"Pune\"}}' https://api.datonis.io/api/v3/gateway/4ea741566a\n\nResponse (returns details of the gateway updated)\n{\n  \"gateway\": {\n    \"gateway_key\": \"4ea741566a\",\n    \"gateway_type\": null,\n    \"name\": \"Vertical gateway\",\n    \"gateway_version\": null,\n    \"tags\": \"Pune\",\n    \"adapters\": [\n\n    ]\n  }\n}"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/3.0/gateway/destroy","name":"destroy","apis":[{"api_url":"/api/v3/gateway/:gateway_key","http_method":"DELETE","short_description":"Delete a gateway","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eDeletes the specified gateway from the system. All associated data is also\nlost.\u003c/p\u003e\n","errors":[],"params":[{"name":"pretty","full_name":"pretty","description":"\n\u003cp\u003eReturn a pretty formatted response if true, Default is false\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Boolean","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":["Request\n  curl -X DELETE -H \"Content-Type:application/json\" -H \"X-Auth-Token:WtUFnj8pvSxVnH9e_xkq7A\"  https://api.datonis.io/api/v3/gateway/4ea741566a\n\nResponse\n{\n}"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/3.0/gateway/configuration","name":"configuration","apis":[{"api_url":"/api/v3/gateway/:gateway_key/configuration","http_method":"GET","short_description":"Fetch configuration","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eFetch information about the configuration of a gateway\u003c/p\u003e\n","errors":[],"params":[{"name":"pretty","full_name":"pretty","description":"\n\u003cp\u003eReturn a pretty formatted response if true, Default is false\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Boolean","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":["Request - get configuration details of the specified gateway (gateway_key specified as a part of the url)\n  curl -X GET  -H \"Content-Type:application/json\" -H \"X-Auth-Token:WtUFnj8pvSxVnH9e_xkq7A\" https://api.datonis.io/api/v3/gateway/4ea741566a/configuration\n\nResponse (returns gateway configuration in encoded form)\n{\n  \"result\": \"data:text/html;charset=utf-8,%3Chtml+lang%3D%22en%22%3E%3Chead%3E%3Ctitle%3EEmbedded+Window%3C%2Ftitle%3E%3C%2Fhead%3E%3Cbody%3E%3Ch1%3E42%3C%2Fh1%3E%3C%2Fbody%3E%3C%2Fhtml%3E\"\n}"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/3.0/gateway/register","name":"register","apis":[{"api_url":"/api/v3/gateway/register","http_method":"POST","short_description":"Register gateway","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eRegister gateway initially with the gateway type and version\u003c/p\u003e\n","errors":[],"params":[{"name":"pretty","full_name":"pretty","description":"\n\u003cp\u003eReturn a pretty formatted response if true, Default is false\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Boolean","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"type","full_name":"type","description":"\n\u003cp\u003eType of gateway e.g. Datonis Edge or other\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"version","full_name":"version","description":"\n\u003cp\u003eGateway version\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"configuration","full_name":"configuration","description":"\n\u003cp\u003eSpecify the gateway configuration as data URI\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":["Request - containing parameters to be registered\n  curl -X POST -H \"Content-Type:application/json\" -H \"X-Auth-Token:WtUFnj8pvSxVnH9e_xkq7A\" -d '{\"gateway\":{\"gateway_key\":\"4ea741566a\",\"gateway_version\":\"4.5.160\",\"gateway_type\":\"kura\",\"config\":\"hello world\"}}' https://api.datonis.io/api/v3/gateways/register\n\nResponse\n{\n}"],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null},"group":{"doc_url":"/apidoc/3.0/group","api_url":"","name":"Group","short_description":null,"full_description":"","version":"3.0","formats":null,"metadata":{"order":6},"methods":[{"doc_url":"/apidoc/3.0/group/index","name":"index","apis":[{"api_url":"/api/v3/groups","http_method":"GET","short_description":"List all groups","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eReturns a list of all groups belonging to an account as per the specified\ncriteria. This API is paginated and returns 20 groups by default. A group\nis uniquely identified by a \u0026#39;group_key\u0026#39;. This key should be used in\nall the other API referencing a particular group.\u003c/p\u003e\n","errors":[],"params":[{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number of results to be fetched, Default 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be Integer.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"per","full_name":"per","description":"\n\u003cp\u003eNumber of group records to be returned in one page, Default 20\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be Integer.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order_by","full_name":"order_by","description":"\n\u003cp\u003eField on which resultant group records should be sorted\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eOrder, “asc” or “desc”, in which results should be sorted\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"timestamp_format","full_name":"timestamp_format","description":"\n\u003cp\u003eFormat, “str” or “int”, in which timestamps of the group records should be\nreturned, Default “int”\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003eKeywords based on which groups should be searched. Currently you can search\ngroups on - group_key, name or tag\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"scope","full_name":"scope","description":"\n\u003cp\u003eMatching condition if multiple keywords are specified for search. Valid\nvalues are “all” or “any”. Default is “all”\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"pretty","full_name":"pretty","description":"\n\u003cp\u003eReturn a pretty formatted response if true, Default is false\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Boolean","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"field_list","full_name":"field_list","description":"\n\u003cp\u003eList of fields required in the result.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"is_oem","full_name":"is_oem","description":"\n\u003cp\u003eReturns groups of child accounts along with groups of oem account if is_oem\nflag is true.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":["Request - listing all groups without any criteria\n  curl -X GET -H \"Content-Type:application/json\" -H \"X-Auth-Token:49b7q_nYN4YZ2k-MsYx5Ng\" https://api.datonis.io/api/v3/groups\n\nResponse (returns first 20 records)\n{\n  \"total_count\": 3,\n  \"page\": 1,\n  \"groups\": [\n    {\n      \"created_at\": 1448436290,\n      \"description\": \"\",\n      \"group_key\": \"ca5ec715f2\",\n      \"group_type\": 1,\n      \"name\": \"Energy Meters Single Phase 30Amps\",\n      \"scope\": \"all\",\n      \"thing_expression\": null,\n      \"updated_at\": 1448436290,\n      \"tags\": \"1-Phase,30-Amps\"\n    },\n    {\n      \"created_at\": 1448436624,\n      \"description\": \"\",\n      \"group_key\": \"d1b3572168\",\n      \"group_type\": 2,\n      \"name\": \"Red Refrigerators and Machines\",\n      \"scope\": \"all\",\n      \"thing_expression\": \"this.user_defined_properties.Color ==...","Request - listing groups by specifying number of groups to be returned at a time (page size) and specific set to be returned (page)\n  curl -X GET -H \"Content-Type:application/json\" -H \"X-Auth-Token:49b7q_nYN4YZ2k-MsYx5Ng\" -d '{\"per\":\"2\",\"page\":\"2\"}' https://api.datonis.io/api/v3/groups\n\nResponse (returns page 2 with 2 groups per page)\n{\n  \"total_count\": 3,\n  \"page\": \"2\",\n  \"groups\": [\n    {\n      \"created_at\": 1448437406,\n      \"description\": \"\",\n      \"group_key\": \"88a714c562\",\n      \"group_type\": 1,\n      \"name\": \"Automated Washing Machines\",\n      \"scope\": \"all\",\n      \"thing_expression\": null,\n      \"updated_at\": 1448437406,\n      \"tags\": \"automated\"\n    }\n  ]\n}","Request - listing groups ordered by a field with string formatted timestamps\n  curl -X GET -H \"Content-Type:application/json\" -H \"X-Auth-Token:49b7q_nYN4YZ2k-MsYx5Ng\" -d '{\"timestamp_format\":\"str\",\"order_by\":\"created_at\",\"order\":\"desc\"}' https://api.datonis.io/api/v3/groups\n\nResponse (returns groups in the reverse order of time that they were created at with timestamps in string format)\n{\n  \"total_count\": 3,\n  \"page\": 1,\n  \"groups\": [\n    {\n      \"created_at\": \"2015/11/25 07:43:26\",\n      \"description\": \"\",\n      \"group_key\": \"88a714c562\",\n      \"group_type\": 1,\n      \"name\": \"Automated Washing Machines\",\n      \"scope\": \"all\",\n      \"thing_expression\": null,\n      \"updated_at\": \"2015/11/25 07:43:26\",\n      \"tags\": \"automated\"\n    },\n    {\n      \"created_at\": \"2015/11/25 07:30:24\",\n      \"description\": \"\",\n      \"group_key\": \"d1b3572168\",\n      \"group_type\": 2,\n      \"name\": \"Red Refrigerators and Machines\",\n      \"scope\": \"all\",\n      \"thing_expression\":...","Request - listing groups based on some search criteria with all keywords matching\n  curl -X GET -H \"Content-Type:application/json\" -H \"X-Auth-Token:49b7q_nYN4YZ2k-MsYx5Ng\" -d '{\"search\":\"Washing Machines\"}' https://api.datonis.io/api/v3/groups\n\nResponse (returns groups containing both keywords 'Washing' as well as 'Machines')\n{\n  \"total_count\": 1,\n  \"page\": 1,\n  \"groups\": [\n    {\n      \"created_at\": 1448437406,\n      \"description\": \"\",\n      \"group_key\": \"88a714c562\",\n      \"group_type\": 1,\n      \"name\": \"Automated Washing Machines\",\n      \"scope\": \"all\",\n      \"thing_expression\": null,\n      \"updated_at\": 1448437406,\n      \"tags\": \"automated\"\n    }\n  ]\n}","Request - listing groups based on some search criteria with any of the keywords matching\n  curl -X GET -H \"Content-Type:application/json\" -H \"X-Auth-Token:49b7q_nYN4YZ2k-MsYx5Ng\" -d '{\"search\":\"Washing Machines\", \"scope\":\"any\"}' https://api.datonis.io/api/v3/groups\n\nResponse (returns groups containing either of the keywords 'Washing' or 'Machines')\n{\n  \"total_count\": 2,\n  \"page\": 1,\n  \"groups\": [\n    {\n      \"created_at\": 1448437406,\n      \"description\": \"\",\n      \"group_key\": \"88a714c562\",\n      \"group_type\": 1,\n      \"name\": \"Automated Washing Machines\",\n      \"scope\": \"all\",\n      \"thing_expression\": null,\n      \"updated_at\": 1448437406,\n      \"tags\": \"automated\"\n    },\n    {\n      \"created_at\": 1448436624,\n      \"description\": \"\",\n      \"group_key\": \"d1b3572168\",\n      \"group_type\": 2,\n      \"name\": \"Red Refrigerators and Machines\",\n      \"scope\": \"all\",\n      \"thing_expression\": \"this.user_defined_properties.Color == 'Red'\",\n      \"updated_at\": 1448437019,\n      \"tags\": \"\"\n    }\n  ]\n}"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/3.0/group/show","name":"show","apis":[{"api_url":"/api/v3/groups/:group_key","http_method":"GET","short_description":"Fetch details of a specific group","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eReturns details of the group specified\u003c/p\u003e\n","errors":[],"params":[{"name":"pretty","full_name":"pretty","description":"\n\u003cp\u003eReturn a pretty formatted response if true, Default is false\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Boolean","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"is_oem","full_name":"is_oem","description":"\n\u003cp\u003eShow group of child account if is_oem flag is true.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":["Request - get details of the specified group (group_key specified as a part of the url)\n  curl -X GET -H \"Content-Type:application/json\" -H \"X-Auth-Token:49b7q_nYN4YZ2k-MsYx5Ng\" https://api.datonis.io/api/v3/groups/88a714c562\n\nResponse (details of the group requested)\n{\n  \"group\": {\n    \"created_at\": 1448437406,\n    \"description\": \"\",\n    \"group_key\": \"88a714c562\",\n    \"group_type\": 1,\n    \"name\": \"Automated Washing Machines\",\n    \"scope\": \"all\",\n    \"thing_expression\": null,\n    \"updated_at\": 1448437406,\n    \"tags\": \"automated\"\n  }\n}"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/3.0/group/create","name":"create","apis":[{"api_url":"/api/v3/groups","http_method":"POST","short_description":"Create a group","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eCreates a group with given parameters\u003c/p\u003e\n","errors":[],"params":[{"name":"group","full_name":"group","description":"\n\u003cp\u003eObject containing information about the group to be created\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[]},{"name":"pretty","full_name":"pretty","description":"\n\u003cp\u003eReturn a pretty formatted response if true, Default is false\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Boolean","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"is_oem","full_name":"is_oem","description":"\n\u003cp\u003eCreate group in child account by oem user if is_oem flag is true.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Boolean","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"child_organisation_key","full_name":"child_organisation_key","description":"\n\u003cp\u003eOrganisation key of child account where oem user wants to create group.\nRequired field if is_oem is present.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":["Request\n  curl -X POST -H \"Content-Type:application/json\" -H \"X-Auth-Token:49b7q_nYN4YZ2k-MsYx5Ng\" -d '{\"group\":{\"name\":\"Energy Meters Three Phase 45Amps\",\"description\":\"Energy Meters Three Phase 45Amps\",\"scope\":\"all\",\"tags\":\"3-Phase,45-Amps\"}}' https://api.datonis.io/api/v3/groups\n\nResponse (details of the group created)\n{\n  \"group\": {\n    \"created_at\": 1448438832,\n    \"description\": \"Energy Meters Three Phase 45Amps\",\n    \"group_key\": \"ace98fcd44\",\n    \"group_type\": 1,\n    \"name\": \"Energy Meters Three Phase 45Amps\",\n    \"scope\": \"all\",\n    \"thing_expression\": null,\n    \"updated_at\": 1448438832,\n    \"tags\": \"3-Phase,45-Amps\"\n  }\n}"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/3.0/group/update","name":"update","apis":[{"api_url":"/api/v3/groups/:group_key","http_method":"PUT","short_description":"Updates a group","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eUpdates the group with given parameters\u003c/p\u003e\n","errors":[],"params":[{"name":"group","full_name":"group","description":"\n\u003cp\u003eObject containing information about the group to be updated\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[]},{"name":"pretty","full_name":"pretty","description":"\n\u003cp\u003eReturn a pretty formatted response if true, Default is false\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Boolean","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"is_oem","full_name":"is_oem","description":"\n\u003cp\u003eUpdate group in child account by oem user if is_oem flag is true.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Boolean","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":["Request - containing parameters to be modified\n  curl -X PUT -H \"Content-Type:application/json\" -H \"X-Auth-Token:49b7q_nYN4YZ2k-MsYx5Ng\" -d '{\"group\":{\"name\":\"Energy Meters Three Phase 50Amps\",\"description\":\"Energy Meters Three Phase 50Amps\",\"tags\":\"3-Phase,50-Amps\"}}' https://api.datonis.io/api/v3/groups/ace98fcd44\n\nResponse (details of the group updated)\n{\n  \"group\": {\n    \"created_at\": 1448438832,\n    \"description\": \"Energy Meters Three Phase 50Amps\",\n    \"group_key\": \"ace98fcd44\",\n    \"group_type\": 1,\n    \"name\": \"Energy Meters Three Phase 50Amps\",\n    \"scope\": \"all\",\n    \"thing_expression\": null,\n    \"updated_at\": 1448438952,\n    \"tags\": \"3-Phase,50-Amps\"\n  }\n}"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/3.0/group/destroy","name":"destroy","apis":[{"api_url":"/api/v3/groups/:group_key","http_method":"DELETE","short_description":"Delete the specified group","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eDeletes the specified group from the system\u003c/p\u003e\n","errors":[],"params":[{"name":"pretty","full_name":"pretty","description":"\n\u003cp\u003eReturn a pretty formatted response if true, Default is false\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Boolean","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"is_oem","full_name":"is_oem","description":"\n\u003cp\u003eDelete group in child account by oem user if is_oem flag is true.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Boolean","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":["Request\n  curl -X DELETE -H \"Content-Type:application/json\" -H \"X-Auth-Token:49b7q_nYN4YZ2k-MsYx5Ng\"  https://api.datonis.io/api/v3/groups/ace98fcd44\n\nResponse\n{\n}"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/3.0/group/tag","name":"tag","apis":[{"api_url":"/api/v3/groups/:group_key/tag","http_method":"PUT","short_description":"Add specified tags to a group","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eAdds specified tags to the existing list of tags associated with the group\u003c/p\u003e\n","errors":[],"params":[{"name":"tags","full_name":"tags","description":"\n\u003cp\u003eComma separated list of tags to be added to the group\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"pretty","full_name":"pretty","description":"\n\u003cp\u003eReturn a pretty formatted response if true, Default is false\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Boolean","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"is_oem","full_name":"is_oem","description":"\n\u003cp\u003eAdd tag in group of child account by oem user if is_oem flag is true.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Boolean","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":["Request - add tags to the specified group (group_key specified as a part of the url)\n  curl -X PUT -H \"Content-Type:application/json\" -H \"X-Auth-Token:49b7q_nYN4YZ2k-MsYx5Ng\" -d '{\"tags\":\"Balanced\"}' https://api.datonis.io/api/v3/groups/ace98fcd44/tag\n\nResponse (group with updated tags)\n{\n  \"group\": {\n    \"created_at\": 1448438832,\n    \"description\": \"Energy Meters Three Phase 50Amps\",\n    \"group_key\": \"ace98fcd44\",\n    \"group_type\": 1,\n    \"name\": \"Energy Meters Three Phase 50Amps\",\n    \"scope\": \"all\",\n    \"thing_expression\": null,\n    \"updated_at\": 1448439061,\n    \"tags\": \"3-Phase,50-Amps,Balanced\"\n  }\n}"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/3.0/group/untag","name":"untag","apis":[{"api_url":"/api/v3/groups/:group_key/untag","http_method":"PUT","short_description":"Remove specified tags from the group","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eRemoves specified tags from the group\u003c/p\u003e\n","errors":[],"params":[{"name":"tags","full_name":"tags","description":"\n\u003cp\u003eComma separated list of tags to be removed from the group\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"pretty","full_name":"pretty","description":"\n\u003cp\u003eReturn a pretty formatted response if true, Default is false\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Boolean","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"is_oem","full_name":"is_oem","description":"\n\u003cp\u003eRemove tag from group of child account by oem user if is_oem flag is true.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Boolean","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":["Request - remove tags from the specified group (group_key specified as a part of the url)\n  curl -X PUT -H \"Content-Type:application/json\" -H \"X-Auth-Token:49b7q_nYN4YZ2k-MsYx5Ng\" -d '{\"tags\":\"Balanced\"}' https://api.datonis.io/api/v3/groups/ace98fcd44/untag\n\nResponse (group with updated tags)\n{\n  \"group\": {\n    \"created_at\": 1448438832,\n    \"description\": \"Energy Meters Three Phase 50Amps\",\n    \"group_key\": \"ace98fcd44\",\n    \"group_type\": 1,\n    \"name\": \"Energy Meters Three Phase 50Amps\",\n    \"scope\": \"all\",\n    \"thing_expression\": null,\n    \"updated_at\": 1448439142,\n    \"tags\": \"3-Phase,50-Amps\"\n  }\n}"],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[]},"instruction":{"doc_url":"/apidoc/3.0/instruction","api_url":"","name":"Instruction","short_description":null,"full_description":null,"version":"3.0","formats":null,"metadata":null,"methods":[{"doc_url":"/apidoc/3.0/instruction/index","name":"index","apis":[{"api_url":"/api/v3/instructions","http_method":"GET","short_description":"List all instructions","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eReturns a list of all instructions belonging to an account as per the\nspecified criteria. This API is paginated and returns 20 instructions by\ndefault. An instruction is uniquely identified by an\n\u0026#39;instruction_key\u0026#39;. This key should be used in all the other API\nreferencing a particular instruction.\u003c/p\u003e\n","errors":[],"params":[{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number of results to be fetched, Default 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be Integer.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"per","full_name":"per","description":"\n\u003cp\u003eNumber of things records to be returned in one page, Default 20\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be Integer.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order_by","full_name":"order_by","description":"\n\u003cp\u003eField on which resultant things should be sorted\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eOrder, asc or desc, in which results should be sorted\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"timestamp_format","full_name":"timestamp_format","description":"\n\u003cp\u003eFormat, “str” or “int”, in which timestamps should be returned, Default\n“int”\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003eKeywords based on which things should be searched. Currently you can search\nthings on - thing_key, name or tag\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"scope","full_name":"scope","description":"\n\u003cp\u003eMatching condition if multiple keywords are specified for search. Valid\nvalues are “all” or “any”. Default is “all”\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"pretty","full_name":"pretty","description":"\n\u003cp\u003eReturn a pretty formatted response if true, Default is false\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Boolean","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"field_list","full_name":"field_list","description":"\n\u003cp\u003eList of fields required in the result.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"fields","full_name":"fields","description":"\n\u003cp\u003e[Deprecated]Comma separated list of fields required in the result.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"is_oem","full_name":"is_oem","description":"\n\u003cp\u003eReturn instructions of child accounts along with instructions of oem\naccount if is_oem flag is true.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":["Request - listing all instructions without any criteria\n  curl -X GET -H \"Content-Type:application/json\" -H \"X-Auth-Token:olezAZXGQn9MutnfNerKDQ\" https://api.datonis.io/api/v3/instructions\n\nResponse (returns first 20 records)\n{\n  \"total_count\": 9,\n  \"page\": 1,\n  \"instructions\": [\n    {\n      \"definition\": {\n        \"val\": \"off\"\n      },\n      \"description\": \"Turn the sensor off\",\n      \"instruction_key\": \"t9t2a63b4f\",\n      \"max_retries\": 0,\n      \"name\": \"TURNOFF\",\n      \"timeout\": 30,\n      \"created_at\": 1425912572,\n      \"updated_at\": 1425912572\n    },\n    {\n      \"definition\": {\n        \"value\": \"on\"\n      },\n      \"description\": \"Turn the machine on\",\n      \"instruction_key\": \"e23t78333c\",\n      \"max_retries\": 0,\n      \"name\": \"TURNON\",\n      \"timeout\": 30,\n      \"created_at\": 1425984214,\n      \"updated_at\": 1427986515\n    },\n    {\n      \"definition\": {\n        \"temp\": 50,\n        \"humidity\": 65\n      },\n      \"description\": \"Turn up the thermostat\",\n      \"instruction_key\": \"e661ctd8fa\",\n      \"max_retries\": 0,\n      \"name\": \"TURNUP\",\n      \"timeout\": 30,\n      \"created_at\": 1426142755,\n      \"updated_at\": 1426142755\n    },\n    {\n      \"definition\": {\n        \"address\": \"gfff\",\n        \"value\": \"foo\"\n      },\n      \"description\": \"\",\n      \"instruction_key\": \"11aae44468\",\n      \"max_retries\": 0,\n      \"name\": \"MODBUSOFF\",\n      \"timeout\": 30,\n      \"created_at\": 1434350522,\n      \"updated_at\": 1434350522\n    },\n    {\n      \"definition\": {\n        \"status\": \"on\"\n      },\n      \"description\": \"start machine\",\n      \"instruction_key\": \"ea96tc6c57\",\n      \"max_retries\": 0,\n      \"name\": \"Start Machine\",\n      \"timeout\": 30,\n      \"created_at\": 1448429915,\n      \"updated_at\": 1448429915\n    },\n    {\n      \"definition\": {\n        \"status\": \"off\"\n      },\n      \"description\": \"stop machine\",\n ...","Request - listing instructions by specifying number of instructions to be returned at a time (page size) and specific set to be returned (page)\n  curl -X GET -H \"Content-Type:application/json\" -H \"X-Auth-Token:olezAZXGQn9MutnfNerKDQ\" -d '{\"per\":\"2\",\"page\":\"2\"}' https://api.datonis.io/api/v3/instructions\n\nResponse (returns page 2 with 2 instructions per page)\n{\n  \"total_count\": 9,\n  \"page\": \"2\",\n  \"instructions\": [\n    {\n      \"definition\": {\n        \"temp\": 50,\n        \"humidity\": 65\n      },\n      \"description\": \"Turn up the thermostat\",\n      \"instruction_key\": \"e661ctd8fa\",\n      \"max_retries\": 0,\n      \"name\": \"TURNUP\",\n      \"timeout\": 30,\n      \"created_at\": 1426142755,\n      \"updated_at\": 1426142755\n    },\n    {\n      \"definition\": {\n        \"address\": \"gfff\",\n        \"value\": \"foo\"\n      },\n      \"description\": \"\",\n      \"instruction_key\": \"11aae44468\",\n      \"max_retries\": 0,\n      \"name\": \"MODBUSOFF\",\n      \"timeout\": 30,\n      \"created_at\": 1434350522,\n      \"updated_at\": 1434350522\n    }\n  ]\n}","Request - listing instructions ordered by a field\n  curl -X GET -H \"Content-Type:application/json\" -H \"X-Auth-Token:olezAZXGQn9MutnfNerKDQ\" -d '{\"order_by\":\"name\",\"order\":\"desc\"}' https://api.datonis.io/api/v3/instructions\n\nResponse (returns instructions in the reverse order of their name)\n{\n  \"total_count\": 9,\n  \"page\": 1,\n  \"instructions\": [\n    {\n      \"definition\": {\n        \"temp\": 50,\n        \"humidity\": 65\n      },\n      \"description\": \"Turn up the thermostat\",\n      \"instruction_key\": \"e661ctd8fa\",\n      \"max_retries\": 0,\n      \"name\": \"TURNUP\",\n      \"timeout\": 30,\n      \"created_at\": 1426142755,\n      \"updated_at\": 1426142755\n    },\n    {\n      \"definition\": {\n        \"value\": \"on\"\n      },\n      \"description\": \"Turn the machine on\",\n      \"instruction_key\": \"e23t78333c\",\n      \"max_retries\": 0,\n      \"name\": \"TURNON\",\n      \"timeout\": 30,\n      \"created_at\": 1425984214,\n      \"updated_at\": 1427986515\n    },\n    {\n      \"definition\": {\n        \"val\": \"off\"\n      },\n      \"description\": \"Turn the sensor off\",\n      \"instruction_key\": \"t9t2a63b4f\",\n      \"max_retries\": 0,\n      \"name\": \"TURNOFF\",\n      \"timeout\": 30,\n      \"created_at\": 1425912572,\n      \"updated_at\": 1425912572\n    },\n    {\n      \"definition\": {\n        \"status\": \"off\"\n      },\n      \"description\": \"stop machine\",\n      \"instruction_key\": \"767dte9eeb\",\n      \"max_retries\": 0,\n      \"name\": \"Stop Machine\",\n      \"timeout\": 30,\n      \"created_at\": 1448429947,\n      \"updated_at\": 1448429947\n    },\n    {\n      \"definition\": {\n        \"status\": \"on\"\n      },\n      \"description\": \"start machine\",\n      \"instruction_key\": \"ea96tc6c57\",\n      \"max_retries\": 0,\n      \"name\": \"Start Machine\",\n      \"timeout\": 30,\n      \"created_at\": 1448429915,\n      \"updated_at\": 1448429915\n    },\n    {\n      \"definition\": {\n        \"reduce_pressure\": 10\n      },\n      \"description\": \"\",\n     ...","Request - listing instructions based on some search criteria with all keywords matching\n  curl -X GET -H \"Content-Type:application/json\" -H \"X-Auth-Token:olezAZXGQn9MutnfNerKDQ\" -d '{\"search\":\"start machine\"}' https://api.datonis.io/api/v3/instructions\n\nResponse (returns instructions containing both keywords 'start' as well as 'machine')\n{\n  \"total_count\": 1,\n  \"page\": 1,\n  \"instructions\": [\n    {\n      \"definition\": {\n        \"status\": \"on\"\n      },\n      \"description\": \"start machine\",\n      \"instruction_key\": \"ea96tc6c57\",\n      \"max_retries\": 0,\n      \"name\": \"Start Machine\",\n      \"timeout\": 30,\n      \"created_at\": 1448429915,\n      \"updated_at\": 1448429915\n    }\n  ]\n}","Request - listing instructions based on some search criteria with any of the keywords matching\n  curl -X GET -H \"Content-Type:application/json\" -H \"X-Auth-Token:olezAZXGQn9MutnfNerKDQ\" -d '{\"search\":\"start machine\", \"scope\":\"any\"}' https://api.datonis.io/api/v3/instructions\n\nResponse (returns instructions containing either of the keywords 'start' or 'machine')\n{\n  \"total_count\": 2,\n  \"page\": 1,\n  \"instructions\": [\n    {\n      \"definition\": {\n        \"status\": \"off\"\n      },\n      \"description\": \"stop machine\",\n      \"instruction_key\": \"767dte9eeb\",\n      \"max_retries\": 0,\n      \"name\": \"Stop Machine\",\n      \"timeout\": 30,\n      \"created_at\": 1448429947,\n      \"updated_at\": 1448429947\n    },\n    {\n      \"definition\": {\n        \"status\": \"on\"\n      },\n      \"description\": \"start machine\",\n      \"instruction_key\": \"ea96tc6c57\",\n      \"max_retries\": 0,\n      \"name\": \"Start Machine\",\n      \"timeout\": 30,\n      \"created_at\": 1448429915,\n      \"updated_at\": 1448429915\n    }\n  ]\n}"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/3.0/instruction/create","name":"create","apis":[{"api_url":"/api/v3/instructions","http_method":"POST","short_description":"Create an instruction","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eCreates an instruction with given parameters\u003c/p\u003e\n","errors":[],"params":[{"name":"instruction","full_name":"instruction","description":"\n\u003cp\u003eObject containing information about the instruction to be created\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[]},{"name":"pretty","full_name":"pretty","description":"\n\u003cp\u003eReturn a pretty formatted response if true, Default is false\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Boolean","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"is_oem","full_name":"is_oem","description":"\n\u003cp\u003eCreate instruction in child account by oem user if is_oem flag is true.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Boolean","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"child_organisation_key","full_name":"child_organisation_key","description":"\n\u003cp\u003eOrganisation key of child account where oem user wants to create\ninstruction. Required field if is_oem is present.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":["Request - create instruction with parameters - name, definition and description\n  curl -X POST -H \"Content-Type:application/json\" -H \"X-Auth-Token:olezAZXGQn9MutnfNerKDQ\"  -d '{\"instruction\":{\"name\":\"Increase Pressure 20 PSI\",\"definition\":{\"add_pressure\":20},\"description\":\"Increases pressure by 20 PSI\"}}' https://api.datonis.io/api/v3/instructions\n\nResponse (containing details of the instruction created )\n{\n  \"instruction\": {\n    \"definition\": {\n      \"add_pressure\": 20\n    },\n    \"description\": \"Increases pressure by 20 PSI\",\n    \"instruction_key\": \"2ab8dfe1b4\",\n    \"max_retries\": 0,\n    \"name\": \"Increase Pressure 20 PSI\",\n    \"timeout\": 15,\n    \"created_at\": 1448430636,\n    \"updated_at\": 1448430636\n  }\n}","Request - create instruction with parameters - name, definition, description, max_retries (execution retries) and timeout (timeout in seconds for instruction acknowledgement)\n  curl -X POST -H \"Content-Type:application/json\" -H \"X-Auth-Token:olezAZXGQn9MutnfNerKDQ\"  -d '{\"instruction\":{\"name\":\"Increase Pressure 20 PSI\",\"definition\":{\"add_pressure\":20},\"description\":\"Increases pressure by 20 PSI\",\"max_retries\":3,\"timeout\":30}}' https://api.datonis.io/api/v3/instructions\n\nResponse (containing details of the instruction created)\n{\n  \"instruction\": {\n    \"definition\": {\n      \"add_pressure\": 20\n    },\n    \"description\": \"Increases pressure by 20 PSI\",\n    \"instruction_key\": \"2ab8dfe1b4\",\n    \"max_retries\": 3,\n    \"name\": \"Increase Pressure 20 PSI\",\n    \"timeout\": 30,\n    \"created_at\": 1448430636,\n    \"updated_at\": 1448430636\n  }\n}"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/3.0/instruction/show","name":"show","apis":[{"api_url":"/api/v3/instructions/:instruction_key","http_method":"GET","short_description":"Fetch an instruction","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eGet details of an instruction\u003c/p\u003e\n","errors":[],"params":[{"name":"pretty","full_name":"pretty","description":"\n\u003cp\u003eReturn a pretty formatted response if true, Default is false\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Boolean","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"is_oem","full_name":"is_oem","description":"\n\u003cp\u003eShow instruction of child account if is_oem flag is true.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":["Request\n  curl -X GET -H \"Content-Type:application/json\" -H \"X-Auth-Token:olezAZXGQn9MutnfNerKDQ\"  https://api.datonis.io/api/v3/instructions/767dte9eeb\n\nResponse (containing details of the instruction)\n{\n  \"instruction\": {\n    \"definition\": {\n      \"status\": \"off\"\n    },\n    \"description\": \"stop machine\",\n    \"instruction_key\": \"767dte9eeb\",\n    \"max_retries\": 0,\n    \"name\": \"Stop Machine\",\n    \"timeout\": 30,\n    \"created_at\": 1448429947,\n    \"updated_at\": 1448429947\n  }\n}"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/3.0/instruction/update","name":"update","apis":[{"api_url":"/api/v3/instructions/:instruction_key","http_method":"PUT","short_description":"Update an instruction","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eUpdates an instruction with given parameters\u003c/p\u003e\n","errors":[],"params":[{"name":"instruction","full_name":"instruction","description":"\n\u003cp\u003eObject containing information about the instruction to be updated\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[]},{"name":"pretty","full_name":"pretty","description":"\n\u003cp\u003eReturn a pretty formatted response if true, Default is false\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Boolean","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"is_oem","full_name":"is_oem","description":"\n\u003cp\u003eUpdate instruction in child account by oem user if is_oem flag is true.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Boolean","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":["Request - update parameters - name, definition and description\n  curl -X PUT -H \"Content-Type:application/json\" -H \"X-Auth-Token:olezAZXGQn9MutnfNerKDQ\"  -d '{\"instruction\":{\"name\":\"Increase Pressure 10 PSI\",\"definition\":{\"add_pressure\":10},\"description\":\"Increases pressure by 10 PSI\"}}' https://api.datonis.io/api/v3/instructions/2ab8dfe1b4\n\nResponse (containing details of the instruction updated )\n{\n  \"instruction\": {\n    \"definition\": {\n      \"add_pressure\": 10\n    },\n    \"description\": \"Increases pressure by 10 PSI\",\n    \"instruction_key\": \"2ab8dfe1b4\",\n    \"max_retries\": 0,\n    \"name\": \"Increase Pressure 10 PSI\",\n    \"timeout\": 15,\n    \"created_at\": 1448430636,\n    \"updated_at\": 1448430747\n  }\n}","Request - update  parameters - name, definition, description, max_retries (execution retries) and timeout (timeout in seconds for instruction acknowledgement)\n  curl -X PUT -H \"Content-Type:application/json\" -H \"X-Auth-Token:olezAZXGQn9MutnfNerKDQ\"  -d '{\"instruction\":{\"name\":\"Increase Pressure 10 PSI\",\"definition\":{\"add_pressure\":10},\"description\":\"Increases pressure by 10 PSI\",\"max_retries\":2,\"timeout\":10}}' https://api.datonis.io/api/v3/instructions\n\nResponse (containing details of the instruction updated)\n{\n  \"instruction\": {\n    \"definition\": {\n      \"add_pressure\": 10\n    },\n    \"description\": \"Increases pressure by 10 PSI\",\n    \"instruction_key\": \"2ab8dfe1b4\",\n    \"max_retries\": 2,\n    \"name\": \"Increase Pressure 10 PSI\",\n    \"timeout\": 10,\n    \"created_at\": 1448430636,\n    \"updated_at\": 1448430636\n  }\n}"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/3.0/instruction/destroy","name":"destroy","apis":[{"api_url":"/api/v3/instructions/:instruction_key","http_method":"DELETE","short_description":"Delete an instruction","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eDeletes an instruction from the system\u003c/p\u003e\n","errors":[],"params":[{"name":"pretty","full_name":"pretty","description":"\n\u003cp\u003eReturn a pretty formatted response if true, Default is false\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Boolean","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"is_oem","full_name":"is_oem","description":"\n\u003cp\u003eDelete instruction in child account by oem user if is_oem flag is true.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Boolean","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":["Request\n  curl -X DELETE -H \"Content-Type:application/json\" -H \"X-Auth-Token:olezAZXGQn9MutnfNerKDQ\"  https://api.datonis.io/api/v3/instructions/2ab8dfe1b4\n\nResponse\n{\n}"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/3.0/instruction/execute","name":"execute","apis":[{"api_url":"/api/v3/instructions/:instruction_key/execute","http_method":"PUT","short_description":"Execute an instruction","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eExecutes the specified instruction against given input objects\u003c/p\u003e\n","errors":[],"params":[{"name":"instruction_applicability","full_name":"instruction_applicability","description":"\n\u003cp\u003eWhether to execute an instruction on:\u003c/p\u003e\n\n\u003cpre\u003e2: things belonging to specified thing_template\n3: specified things\u003c/pre\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be Integer.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"instruction_applicability_value","full_name":"instruction_applicability_value","description":"\n\u003cp\u003ething_template or a thing_key or an array of thing keys depending on the\nvalue of instruction_applicability\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"json_map","full_name":"json_map","description":"\n\u003cp\u003eMap of configurable parameters\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[]},{"name":"pretty","full_name":"pretty","description":"\n\u003cp\u003eReturn a pretty formatted response if true, Default is false\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Boolean","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"is_oem","full_name":"is_oem","description":"\n\u003cp\u003eExecute an instruction in child account by oem user if is_oem flag is true.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Boolean","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"child_organisation_key","full_name":"child_organisation_key","description":"\n\u003cp\u003eOrganisation key of child account where oem user wants to execute\ninstruction. Required field if is_oem is present.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":["Request - execute an instruction against all sensors of type 'Energy Meter'\n  curl -X PUT -H \"Content-Type:application/json\" -H \"X-Auth-Token:olezAZXGQn9MutnfNerKDQ\" -d '{\"instruction_applicability\":\"2\",\"instruction_applicability_value\":\"Energy Meter\"}' https://api.datonis.io/api/v3/instructions/a5ad49t441/execute\n\nResponse (list of sensor alert keys describing execution status of the instruction against each sensor)\n{\n  \"status\": [\n    \"af1b856c7t\",\n    \"e5688474t6\",\n    \"bf72966t3b\"\n  ]\n}","Request - execute an instruction against specified sensors\n  curl -X PUT -H \"Content-Type:application/json\" -H \"X-Auth-Token:olezAZXGQn9MutnfNerKDQ\" -d '{\"instruction_applicability\":\"3\",\"instruction_applicability_value\":[\"4dc7t6fe93\",\"t6fd4btb5e\"]}' https://api.datonis.io/api/v3/instructions/767dte9eeb/execute\n\nResponse (list of sensor alert keys describing execution status of the instruction against each sensor)\n{\n  \"status\": [\n    \"af1b856c7t\",\n    \"e5688474t6\",\n    \"bf72966t3b\"\n  ]\n}"],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null},"key_pair":{"doc_url":"/apidoc/3.0/key_pair","api_url":"","name":"Key pair","short_description":null,"full_description":"","version":"3.0","formats":null,"metadata":{"order":14},"methods":[{"doc_url":"/apidoc/3.0/key_pair/index","name":"index","apis":[{"api_url":"/api/v3/key_pairs","http_method":"GET","short_description":"List all key_pairs","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eReturns a list of all key_pairs belonging to an account as per the\nspecified criteria. This API is paginated and returns 20 key_pairs by\ndefault. A key_pair is uniquely identified by a \u0026#39;key_pair_key\u0026#39;.\nThis key should be used in all the other API referencing a particular\nkey_pair.\u003c/p\u003e\n","errors":[],"params":[{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number of results to be fetched, Default 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be Integer.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"per","full_name":"per","description":"\n\u003cp\u003eNumber of key_pairs records to be returned in one page, Default 20\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be Integer.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order_by","full_name":"order_by","description":"\n\u003cp\u003eField on which resultant key_pairs should be sorted\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eOrder, asc or desc, in which results should be sorted\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"timestamp_format","full_name":"timestamp_format","description":"\n\u003cp\u003eFormat, “str” or “int”, in which timestamps should be returned, Default\n“int”\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003eKeywords based on which key_pairs should be searched. Currently you can\nsearch key_pairs on - key_pair_key\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"scope","full_name":"scope","description":"\n\u003cp\u003eMatching condition if multiple keywords are specified for search. Valid\nvalues are “all” or “any”. Default is “all”\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"pretty","full_name":"pretty","description":"\n\u003cp\u003eReturn a pretty formatted response if true, Default is false\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Boolean","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"field_list","full_name":"field_list","description":"\n\u003cp\u003eList of fields required in the result.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"fields","full_name":"fields","description":"\n\u003cp\u003e[Deprecated]Comma separated list of fields required in the result.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"is_oem","full_name":"is_oem","description":"\n\u003cp\u003eReturns key pairs of child account if is_oem flag is true.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"child_organisation_key","full_name":"child_organisation_key","description":"\n\u003cp\u003eOrganisation key of child account whose key pairs oem user wants to see.\nRequired field if is_oem is present.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":["Request - listing all key_pairs without any criteria\n  curl -X GET  -H \"Content-Type:application/json\" -H \"X-Auth-Token:WtUFnj8pvSxVnH9e_xkq7A\" https://api.datonis.io/api/v3/key_pairs\n\nResponse (returns first 20 records)\n{\n  \"total_count\": 3,\n  \"page\": 1,\n  \"key_pairs\": [\n    {\n      \"access_key\": \"t711t338ttf7b36c4cb27dc9d4acf62ta8c75a7f\",\n      \"enabled\": false,\n      \"expiry_date\": \"2015-10-29T18:30:00.000Z\",\n      \"secret_key\": \"fte4bc52f791eb8513ac71a52ff5463t1bbf2tf9\",\n      \"key_pair_key\": \"t711t338ttf7b36c4cb27dc9d4acf62ta8c75a7f\",\n      \"created_at\": 1446017446,\n      \"updated_at\": 1446104758,\n      \"role_name\": \"Agent\",\n      \"role_key\": \"1946c4ce5c\"\n    },\n    {\n      \"access_key\": \"7d3tdb2a7ff33d6824a6et171b84988aa22993af\",\n      \"enabled\": false,\n      \"expiry_date\": \"2015-10-14T18:30:00.000Z\",\n      \"secret_key\": \"f7a45fe4fat5b235269cfd74896detcb1b6cfe7e\",\n      \"key_pair_key\": \"7d3tdb2a7ff33d6824a6et171b84988aa22993af\",\n      \"created_at\": 1446026087,\n      \"updated_at\": 1446102581,\n      \"role_name\": \"abc\",\n      \"role_key\": \"dc459a67b3\"\n    },\n    {\n      \"access_key\": \"e98f8a4db1dec78tf56668292f576be17521ef3e\",\n      \"enabled\": true,\n      \"expiry_date\": \"2015-11-05T18:30:00.000Z\",\n      \"secret_key\": \"2118ca66886e74fe3atbf7e4f3t8554f8t9eft82\",\n      \"key_pair_key\": \"e98f8a4db1dec78tf56668292f576be17521ef3e\",\n      \"created_at\": 1446104372,\n      \"updated_at\": 1446104372,\n      \"role_name\": \"Agent\",\n      \"role_key\": \"1946c4ce5c\"\n    }\n  ]\n}","Request - listing key_pairs by specifying number of key_pairs to be returned at a time (page size) and specific set to be returned (page)\n  curl -X GET  -H \"Content-Type:application/json\" -H \"X-Auth-Token:WtUFnj8pvSxVnH9e_xkq7A\" -d '{\"per\":\"2\", \"page\":\"2\"}' https://api.datonis.io/api/v3/key_pairs\n\nResponse (returns page 2 with 2 key_pairs per page)\n{\n  \"total_count\": 3,\n  \"page\": \"2\",\n  \"key_pairs\": [\n    {\n      \"access_key\": \"e98f8a4db1dec78tf56668292f576be17521ef3e\",\n      \"enabled\": true,\n      \"expiry_date\": \"2015-11-05T18:30:00.000Z\",\n      \"secret_key\": \"2118ca66886e74fe3atbf7e4f3t8554f8t9eft82\",\n      \"key_pair_key\": \"e98f8a4db1dec78tf56668292f576be17521ef3e\",\n      \"created_at\": 1446104372,\n      \"updated_at\": 1446104372,\n      \"role_name\": \"Agent\",\n      \"role_key\": \"1946c4ce5c\"\n    }\n  ]\n}","Request - listing key_pairs ordered by a field with string formatted timestamps\n  curl -X GET  -H \"Content-Type:application/json\" -H \"X-Auth-Token:WtUFnj8pvSxVnH9e_xkq7A\" -d '{\"timestamp_format\":\"str\",\"order_by\":\"name\",\"order\":\"desc\"}' https://api.datonis.io/api/v3/key_pairs\n\nResponse (returns key_pairs in the reverse order of name and timestamps in string format)\n{\n  \"total_count\": 5,\n  \"page\": 1,\n  \"key_pairs\": [\n    {\n      \"access_key\": \"7d3tdb2a7ff33d6824a6et171b84988aa22993af\",\n      \"enabled\": false,\n      \"expiry_date\": \"2015-10-14T18:30:00.000Z\",\n      \"secret_key\": \"f7a45fe4fat5b235269cfd74896detcb1b6cfe7e\",\n      \"key_pair_key\": \"7d3tdb2a7ff33d6824a6et171b84988aa22993af\",\n      \"created_at\": \"2015/10/28 09:54:47\",\n      \"updated_at\": \"2015/10/29 07:09:41\",\n      \"role_name\": \"abc\",\n      \"role_key\": \"dc459a67b3\"\n    },\n    {\n      \"access_key\": \"abec9bb3d2e18c2c1dt4t792b3t73768bf7d68cd\",\n      \"enabled\": false,\n      \"expiry_date\": \"2016-09-09T00:00:00.000Z\",\n      \"secret_key\": \"f2ddt21at5f56128a36t8t9949231acc89481f2f\",\n      \"key_pair_key\": \"abec9bb3d2e18c2c1dt4t792b3t73768bf7d68cd\",\n      \"created_at\": \"2015/11/02 07:10:42\",\n      \"updated_at\": \"2015/11/02 07:19:39\",\n      \"role_name\": \"Write Only\",\n      \"role_key\": \"517d8e4695\"\n    },\n    {\n      \"access_key\": \"e98f8a4db1dec78tf56668292f576be17521ef3e\",\n      \"enabled\": true,\n      \"expiry_date\": \"2015-11-05T18:30:00.000Z\",\n      \"secret_key\": \"2118ca66886e74fe3atbf7e4f3t8554f8t9eft82\",\n      \"key_pair_key\": \"e98f8a4db1dec78tf56668292f576be17521ef3e\",\n      \"created_at\": \"2015/10/29 07:39:32\",\n      \"updated_at\": \"2015/10/29 07:39:32\",\n      \"role_name\": \"Agent\",\n      \"role_key\": \"1946c4ce5c\"\n    },\n    {\n      \"access_key\": \"t711t338ttf7b36c4cb27dc9d4acf62ta8c75a7f\",\n      \"enabled\": false,\n      \"expiry_date\": \"2015-10-29T18:30:00.000Z\",\n      \"secret_key\": \"fte4bc52f791eb8513ac71a52ff5463t1bbf2tf9\",\n      \"key_pair_key\":...","Request - listing key_pair based on keys specified\n  curl -X GET  -H \"Content-Type:application/json\" -H \"X-Auth-Token:WtUFnj8pvSxVnH9e_xkq7A\" -d '{\"key_pairs\":[\"t711t338ttf7b36c4cb27dc9d4acf62ta8c75a7f\",\"d887tb6b876261bd3efae81b63adee585b14tb2c\"]}' https://api.datonis.io/api/v3/key_pairs\n\nResponse (returns sensors matching the keys specified)\n{\n  \"total_count\": 5,\n  \"page\": 1,\n  \"key_pairs\": [\n    {\n      \"access_key\": \"t711t338ttf7b36c4cb27dc9d4acf62ta8c75a7f\",\n      \"enabled\": false,\n      \"expiry_date\": \"2015-10-29T18:30:00.000Z\",\n      \"secret_key\": \"fte4bc52f791eb8513ac71a52ff5463t1bbf2tf9\",\n      \"key_pair_key\": \"t711t338ttf7b36c4cb27dc9d4acf62ta8c75a7f\",\n      \"created_at\": 1446017446,\n      \"updated_at\": 1446104758,\n      \"role_name\": \"Agent\",\n      \"role_key\": \"1946c4ce5c\"\n    },\n    {\n      \"access_key\": \"7d3tdb2a7ff33d6824a6et171b84988aa22993af\",\n      \"enabled\": false,\n      \"expiry_date\": \"2015-10-14T18:30:00.000Z\",\n      \"secret_key\": \"f7a45fe4fat5b235269cfd74896detcb1b6cfe7e\",\n      \"key_pair_key\": \"7d3tdb2a7ff33d6824a6et171b84988aa22993af\",\n      \"created_at\": 1446026087,\n      \"updated_at\": 1446102581,\n      \"role_name\": \"abc\",\n      \"role_key\": \"dc459a67b3\"\n    },\n    {\n      \"access_key\": \"e98f8a4db1dec78tf56668292f576be17521ef3e\",\n      \"enabled\": true,\n      \"expiry_date\": \"2015-11-05T18:30:00.000Z\",\n      \"secret_key\": \"2118ca66886e74fe3atbf7e4f3t8554f8t9eft82\",\n      \"key_pair_key\": \"e98f8a4db1dec78tf56668292f576be17521ef3e\",\n      \"created_at\": 1446104372,\n      \"updated_at\": 1446104372,\n      \"role_name\": \"Agent\",\n      \"role_key\": \"1946c4ce5c\"\n    },\n    {\n      \"access_key\": \"abec9bb3d2e18c2c1dt4t792b3t73768bf7d68cd\",\n      \"enabled\": false,\n      \"expiry_date\": \"2016-09-09T00:00:00.000Z\",\n      \"secret_key\": \"f2ddt21at5f56128a36t8t9949231acc89481f2f\",\n      \"key_pair_key\": \"abec9bb3d2e18c2c1dt4t792b3t73768bf7d68cd\",\n      \"created_at\": 1446448242,\n      \"updated_at\": 1446448779,\n  ..."],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/3.0/key_pair/show","name":"show","apis":[{"api_url":"/api/v3/key_pairs/:key_pair_key","http_method":"GET","short_description":"Fetch information for a key_pair","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eReturns details of the key_pair requested\u003c/p\u003e\n","errors":[],"params":[{"name":"pretty","full_name":"pretty","description":"\n\u003cp\u003eReturn a pretty formatted response if true, Default is false\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Boolean","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"is_oem","full_name":"is_oem","description":"\n\u003cp\u003eReturns key pair of child account if is_oem flag is true.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"child_organisation_key","full_name":"child_organisation_key","description":"\n\u003cp\u003eOrganisation key of child account whose key pair oem user wants to see.\nRequired field if is_oem is present.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":["Request - get details of the specified key_pair (key_pair_key specified as a part of the url)\n  curl -X GET  -H \"Content-Type:application/json\" -H \"X-Auth-Token:WtUFnj8pvSxVnH9e_xkq7A\"  https://api.datonis.io/api/v3/key_pairs/t711t338ttf7b36c4cb27dc9d4acf62ta8c75a7f\n\nResponse (returns details of the key_pair requested)\n{\n  \"key_pair\": {\n    \"access_key\": \"t711t338ttf7b36c4cb27dc9d4acf62ta8c75a7f\",\n    \"enabled\": false,\n    \"expiry_date\": \"2015-10-29T18:30:00.000Z\",\n    \"secret_key\": \"fte4bc52f791eb8513ac71a52ff5463t1bbf2tf9\",\n    \"key_pair_key\": \"t711t338ttf7b36c4cb27dc9d4acf62ta8c75a7f\",\n    \"created_at\": 1446017446,\n    \"updated_at\": 1446104758,\n    \"role_name\": \"Agent\",\n    \"role_key\": \"1946c4ce5c\"\n  }\n}"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/3.0/key_pair/create","name":"create","apis":[{"api_url":"/api/v3/key_pairs","http_method":"POST","short_description":"Create a key_pair","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eCreates a key_pair with given parameters\u003c/p\u003e\n","errors":[],"params":[{"name":"key_pair","full_name":"key_pair","description":"\n\u003cp\u003eObject containing information about the key_pair to be created\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[]},{"name":"pretty","full_name":"pretty","description":"\n\u003cp\u003eReturn a pretty formatted response if true, Default is false\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Boolean","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"is_oem","full_name":"is_oem","description":"\n\u003cp\u003eGenerates key pair of child account if is_oem flag is true.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Boolean","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"child_organisation_key","full_name":"child_organisation_key","description":"\n\u003cp\u003eOrganisation key of child account where oem user wants to create key pair.\nRequired field if is_oem is present.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":["Request\n  curl -X POST -H \"Content-Type:application/json\" -H \"X-Auth-Token:WtUFnj8pvSxVnH9e_xkq7A\" -d '{\"key_pair\":{\"expiry_date\":\"09/09/2016\",\"role_key\":\"517d8e4695\"}}' https://api.datonis.io/api/v3/key_pairs\n\nResponse (returns details of the key_pair created)\n{\n  \"key_pair\": {\n    \"access_key\": \"abec9bb3d2e18c2c1dt4t792b3t73768bf7d68cd\",\n    \"enabled\": true,\n    \"expiry_date\": \"2016-09-08T18:30:00.000Z\",\n    \"secret_key\": \"f2ddt21at5f56128a36t8t9949231acc89481f2f\",\n    \"key_pair_key\": \"abec9bb3d2e18c2c1dt4t792b3t73768bf7d68cd\",\n    \"created_at\": 1446448242,\n    \"updated_at\": 1446448242,\n    \"role_name\": \"Write Only\",\n    \"role_key\": \"517d8e4695\"\n  }\n}"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/3.0/key_pair/destroy","name":"destroy","apis":[{"api_url":"/api/v3/key_pairs/:key_pair_key","http_method":"DELETE","short_description":"Delete a key_pair","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eDeletes the specified key_pair from the system. All associated data is also\nlost.\u003c/p\u003e\n","errors":[],"params":[{"name":"pretty","full_name":"pretty","description":"\n\u003cp\u003eReturn a pretty formatted response if true, Default is false\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Boolean","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"is_oem","full_name":"is_oem","description":"\n\u003cp\u003eDelete key pair of child account if is_oem flag is true.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Boolean","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":["Request\n  curl -X DELETE -H \"Content-Type:application/json\" -H \"X-Auth-Token:WtUFnj8pvSxVnH9e_xkq7A\"  https://api.datonis.io/api/v3/key_pairs/abec9bb3d2e18c2c1dt4t792b3t73768bf7d68cd\n\nResponse\n{\n}"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/3.0/key_pair/update","name":"update","apis":[{"api_url":"/api/v3/key_pairs/:key_pair_key","http_method":"PUT","short_description":"Updates a key_pair","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eUpdates a key_pair with given parameters\u003c/p\u003e\n","errors":[],"params":[{"name":"key_pair","full_name":"key_pair","description":"\n\u003cp\u003eObject containing information about the key_pair to be updated\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[]},{"name":"pretty","full_name":"pretty","description":"\n\u003cp\u003eReturn a pretty formatted response if true, Default is false\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Boolean","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"is_oem","full_name":"is_oem","description":"\n\u003cp\u003eUpdate key pair of child account if is_oem flag is true.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Boolean","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"child_organisation_key","full_name":"child_organisation_key","description":"\n\u003cp\u003eOrganisation key of child account where oem user wants to update key pair.\nRequired field if is_oem is present.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":["Request - containing parameters to be modified\n  curl -X PUT -H \"Content-Type:application/json\" -H \"X-Auth-Token:WtUFnj8pvSxVnH9e_xkq7A\" -d '{\"key_pair\":{\"expiry_date\":\"09/09/2016\", \"enabled\":\"false\"}, \"role_key\":\"517d8e4695\"}' https://api.datonis.io/api/v3/key_pairs/abec9bb3d2e18c2c1dt4t792b3t73768bf7d68cd\n\nResponse (returns details of the key_pair updated)\n{\n  \"key_pair\": {\n    \"access_key\": \"abec9bb3d2e18c2c1dt4t792b3t73768bf7d68cd\",\n    \"enabled\": false,\n    \"expiry_date\": \"2016-09-09T00:00:00.000Z\",\n    \"secret_key\": \"f2ddt21at5f56128a36t8t9949231acc89481f2f\",\n    \"key_pair_key\": \"abec9bb3d2e18c2c1dt4t792b3t73768bf7d68cd\",\n    \"created_at\": 1446448242,\n    \"updated_at\": 1446448779,\n    \"role_name\": \"Write Only\",\n    \"role_key\": \"517d8e4695\"\n  }\n}"],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[]},"license":{"doc_url":"/apidoc/3.0/license","api_url":"","name":"License","short_description":null,"full_description":"","version":"3.0","formats":null,"metadata":{"order":12},"methods":[{"doc_url":"/apidoc/3.0/license/get_license_details","name":"get_license_details","apis":[{"api_url":"/api/v3/licenses/details","http_method":"GET","short_description":"Get license details","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eReturns details of license plan for the user\u003c/p\u003e\n","errors":[],"params":[],"examples":["Request:\n curl -X GET -H \"Content-Type:application/json\" --header 'X-Auth-Token:qplZbr0tKnjCFaBZSmmpOw' 'http://api.datonis.io/api/v3/licenses/details' \nResponse:\n {\n  \"license_details\": {\n    \"name\": \"Advance\",\n    \"description\": \"Advance license\",\n    \"price\": 0,\n    \"time_period\": 30,\n    \"data_retention_period\": 7,\n    \"agg_data_retention_period\": 30,\n    \"audit_trail_retention_period\": 2,\n    \"start_date\": \"November 04, 2015\",\n    \"end_date\": \"December 04, 2015\",\n    \"requests\": 50,\n    \"users\": 12,\n    \"rules_count\": 2,\n    \"alert_count\": 120,\n    \"notifications_count\": 10,\n    \"instructions_count\": 10,\n    \"roles_count\": 5,\n    \"key_pairs_count\": 5,\n    \"things_count\": 10,\n    \"thing_templates_count\": 5\n  }\n}"],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[]},"metric":{"doc_url":"/apidoc/3.0/metric","api_url":"","name":"Metric","short_description":null,"full_description":"","version":"3.0","formats":null,"metadata":{"order":3},"methods":[{"doc_url":"/apidoc/3.0/metric/index","name":"index","apis":[{"api_url":"/api/v3/metrics","http_method":"GET","short_description":"List all metrics","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eReturns a list of all metrics belonging to a thing template as per the\nspecified criteria. This API is paginated and returns 20 metrics by\ndefault. An metric is uniquely identified by an \u0026#39;metric_key\u0026#39;. This\nkey should be used in all the other API referencing a particular metric.\u003c/p\u003e\n","errors":[],"params":[{"name":"thing_template_key","full_name":"thing_template_key","description":"\n\u003cp\u003eKey of thing template for which metrics to be fetched. This field is\nrequired\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number of results to be fetched, Default 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be Integer.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"per","full_name":"per","description":"\n\u003cp\u003eNumber of metrics to be returned in one page, Default 20\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be Integer.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order_by","full_name":"order_by","description":"\n\u003cp\u003eField on which metrics should be sorted\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eOrder, “asc” or “desc”, in which results should be sorted\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003eKeywords based on which metrics should be searched. Currently you can\nsearch metrics on - metric_key, name, tags or user_defined_properties\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"scope","full_name":"scope","description":"\n\u003cp\u003eMatching condition if multiple keywords are specified for search. Valid\nvalues are “all” or “any”. Default is “all”\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"timestamp_format","full_name":"timestamp_format","description":"\n\u003cp\u003eFormat, “str” or “int”, in which timestamps should be returned, Default\n“int”\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"pretty","full_name":"pretty","description":"\n\u003cp\u003eReturn a pretty formatted response if true, Default is false\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Boolean","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"field_list","full_name":"field_list","description":"\n\u003cp\u003eList of fields required in the result.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"is_oem","full_name":"is_oem","description":"\n\u003cp\u003eReturns metrics of child accounts if is_oem flag is true.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":["Request - listing all metrics belonging to a thing template without any criteria\n  curl -X GET -H \"Content-Type:application/json\" -H \"X-Auth-Token:olezAZXGQn9MutnfNerKDQ\" -d '{\"thing_template_key\":\"af31ae5fb2\"}' https://api.datonis.io/api/v3/metrics\n\nResponse (returns first 20 records)\n{\n  \"total_count\": 4,\n  \"page\": 1,\n  \"metrics\": [\n    {\n      \"abbreviation\": \"capacity\",\n      \"created_at\": 1448364456,\n      \"data_type\": 0,\n      \"description\": \"Metric for thing template Washing Machine\",\n      \"metric_key\": \"4f9b9764t7\",\n      \"name\": \"capacity\",\n      \"unit_of_measure\": \"kilogram\",\n      \"updated_at\": 1448364456,\n      \"treatments\": [\n\n      ],\n      \"thing_template_key\": \"af31ae5fb2\"\n    },\n    {\n      \"abbreviation\": \"speed\",\n      \"created_at\": 1448364456,\n      \"data_type\": 0,\n      \"description\": \"Metric for thing template Washing Machine\",\n      \"metric_key\": \"4tb363cc88\",\n      \"name\": \"maximum_rotational_speed\",\n      \"unit_of_measure\": \"RPM\",\n      \"updated_at\": 1448364456,\n      \"treatments\": [\n\n      ],...","Request - listing metrics belonging to a thing template by specifying number of metrics to be returned at a time (page size) and specific set to be returned (page)\n  curl -X GET -H \"Content-Type:application/json\" -H \"X-Auth-Token:olezAZXGQn9MutnfNerKDQ\" -d '{\"thing_template_key\":\"af31ae5fb2\",\"per\":\"2\",\"page\":\"2\"}' https://api.datonis.io/api/v3/metrics\n\nResponse (returns page 2 with 2 metrics per page)\n{\n  \"total_count\": 4,\n  \"page\": \"2\",\n  \"metrics\": [\n    {\n      \"abbreviation\": \"noise\",\n      \"created_at\": 1448364456,\n      \"data_type\": 0,\n      \"description\": \"Metric for thing template Washing Machine\",\n      \"metric_key\": \"278t29123d\",\n      \"name\": \"noise_level\",\n      \"unit_of_measure\": \"dB\",\n      \"updated_at\": 1448364456,\n      \"treatments\": [\n\n      ],\n      \"thing_template_key\": \"af31ae5fb2\"\n    },\n    {\n      \"abbreviation\": \"voltage\",\n      \"created_at\": 1448364457,\n      \"data_type\": 0,\n      \"description\": \"Metric for thing template Washing Machine\",\n      \"metric_key\": \"492c52bf56\",\n      \"name\": \"voltage\",\n      \"unit_of_measure\": \"volt\",\n      \"updated_at\": 1448364457,\n      \"treatments\": [\n\n      ],\n     ...","Request - listing metrics belonging to a thing template ordered by a field with string formatted timestamps\n  curl -X GET -H \"Content-Type:application/json\" -H \"X-Auth-Token:olezAZXGQn9MutnfNerKDQ\" -d '{\"thing_template_key\":\"af31ae5fb2\",\"timestamp_format\":\"str\",\"order_by\":\"name\",\"order\":\"desc\"}' https://api.datonis.io/api/v3/metrics\n\nResponse (returns metrics in the reverse order of their name and timestamps in string format)\n{\n  \"total_count\": 4,\n  \"page\": 1,\n  \"metrics\": [\n    {\n      \"abbreviation\": \"voltage\",\n      \"created_at\": \"2015/11/24 11:27:37\",\n      \"data_type\": 0,\n      \"description\": \"Metric for thing template Washing Machine\",\n      \"metric_key\": \"492c52bf56\",\n      \"name\": \"voltage\",\n      \"unit_of_measure\": \"volt\",\n      \"updated_at\": \"2015/11/24 11:27:37\",\n      \"treatments\": [\n\n      ],\n      \"thing_template_key\": \"af31ae5fb2\"\n    },\n    {\n      \"abbreviation\": \"noise\",\n      \"created_at\": \"2015/11/24 11:27:36\",\n      \"data_type\": 0,\n      \"description\": \"Metric for thing template Washing Machine\",\n      \"metric_key\": \"278t29123d\",\n      \"name\": \"noise_level\",\n      \"unit_of_measure\": \"dB\",\n      \"updated_at\": \"2015/11/24 11:27:36\",\n     ...","Request - listing metrics belonging to a thing template based on some search criteria with all keywords matching\n  curl -X GET -H \"Content-Type:application/json\" -H \"X-Auth-Token:olezAZXGQn9MutnfNerKDQ\" -d '{\"thing_template_key\":\"af31ae5fb2\",\"search\":\"capacity level\"}' https://api.datonis.io/api/v3/metrics\n\nResponse (returns metrics containing both keywords 'capacity' as well as 'level')\n{\n  \"total_count\": 0,\n  \"page\": 1,\n  \"metrics\": [\n\n  ]\n}","Request - listing metrics belonging to a thing template based on some search criteria with any of the keywords matching\n  curl -X GET -H \"Content-Type:application/json\" -H \"X-Auth-Token:olezAZXGQn9MutnfNerKDQ\" -d '{\"thing_template_key\":\"af31ae5fb2\",\"search\":\"capacity level\",\"scope\":\"any\"}' https://api.datonis.io/api/v3/metrics\n\nResponse (returns metrics containing either of the keywords 'capacity' or 'level')\n{\n  \"total_count\": 2,\n  \"page\": 1,\n  \"metrics\": [\n    {\n      \"abbreviation\": \"capacity\",\n      \"created_at\": 1448364456,\n      \"data_type\": 0,\n      \"description\": \"Metric for thing template Washing Machine\",\n      \"metric_key\": \"4f9b9764t7\",\n      \"name\": \"capacity\",\n      \"unit_of_measure\": \"kilogram\",\n      \"updated_at\": 1448364456,\n      \"treatments\": [\n\n      ],\n      \"thing_template_key\": \"af31ae5fb2\"\n    },\n    {\n      \"abbreviation\": \"noise\",\n      \"created_at\": 1448364456,\n      \"data_type\": 0,\n      \"description\": \"Metric for thing template Washing Machine\",\n      \"metric_key\": \"278t29123d\",\n      \"name\": \"noise_level\",\n      \"unit_of_measure\": \"dB\",\n      \"updated_at\": 1448364456,\n      \"treatments\": [\n\n      ],\n      \"thing_template_key\": \"af31ae5fb2\"\n    }\n  ]\n}"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/3.0/metric/create","name":"create","apis":[{"api_url":"/api/v3/metrics","http_method":"POST","short_description":"Create an metric","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eCreates an metric with given parameters\u003c/p\u003e\n","errors":[],"params":[{"name":"metric","full_name":"metric","description":"\n\u003cp\u003eMap containing details of the metric to be created, This map must contain\nthing_template_key\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[]},{"name":"pretty","full_name":"pretty","description":"\n\u003cp\u003eReturn a pretty formatted response if true, Default is false\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Boolean","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"is_oem","full_name":"is_oem","description":"\n\u003cp\u003eCreate metric in child account by oem user if is_oem flag is true.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Boolean","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"child_organisation_key","full_name":"child_organisation_key","description":"\n\u003cp\u003eOrganisation key of child account where oem user wants to create metric.\nRequired field if is_oem is present.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":["Request\n  curl -X POST -H \"Content-Type:application/json\" -H \"X-Auth-Token:olezAZXGQn9MutnfNerKDQ\"  -d '{\"metric\":{\"name\":\"capacity\",\"abbreviation\":\"capacity\",\"description\":\"Metric for thing template Washing Machine\",\"data_type\":0,\"unit_of_measure\":\"kilogram\",\"thing_template_key\":\"af31ae5fb2\"}}' https://api.datonis.io/api/v3/metrics\n\nResponse (containing details of the metric created)\n{\n  \"metric\": {\n    \"abbreviation\": \"capacity\",\n    \"created_at\": 1448364456,\n    \"data_type\": 0,\n    \"description\": \"Metric for thing template Washing Machine\",\n    \"metric_key\": \"4f9b9764t7\",\n    \"name\": \"capacity\",\n    \"unit_of_measure\": \"kilogram\",\n    \"updated_at\": 1448364456,\n    \"treatments\": [\n\n    ],\n    \"thing_template_key\": \"af31ae5fb2\"\n  }\n}"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/3.0/metric/show","name":"show","apis":[{"api_url":"/api/v3/metrics/:metric_key","http_method":"GET","short_description":"Fetch an metric","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eGet details of an metric\u003c/p\u003e\n","errors":[],"params":[{"name":"pretty","full_name":"pretty","description":"\n\u003cp\u003eReturn a pretty formatted response if true, Default is false\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Boolean","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"is_oem","full_name":"is_oem","description":"\n\u003cp\u003eShow metric of child account if is_oem flag is true.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":["Request\n  curl -X GET -H \"Content-Type:application/json\" -H \"X-Auth-Token:olezAZXGQn9MutnfNerKDQ\"  https://api.datonis.io/api/v3/metrics/4f9b9764t7\n\nResponse (containing details of the metric)\n{\n  \"metric\": {\n    \"abbreviation\": \"capacity\",\n    \"created_at\": 1448364456,\n    \"data_type\": 0,\n    \"description\": \"Metric for thing template Washing Machine\",\n    \"metric_key\": \"4f9b9764t7\",\n    \"name\": \"capacity\",\n    \"unit_of_measure\": \"kilogram\",\n    \"updated_at\": 1448364456,\n    \"treatments\": [\n\n    ],\n    \"thing_template_key\": \"af31ae5fb2\"\n  }\n}"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/3.0/metric/update","name":"update","apis":[{"api_url":"/api/v3/metrics/:metric_key","http_method":"PUT","short_description":"Update an metric","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eUpdates an metric with given parameters\u003c/p\u003e\n","errors":[],"params":[{"name":"metric","full_name":"metric","description":"\n\u003cp\u003eMap containing details of the metric to be updated\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[]},{"name":"pretty","full_name":"pretty","description":"\n\u003cp\u003eReturn a pretty formatted response if true, Default is false\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Boolean","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"is_oem","full_name":"is_oem","description":"\n\u003cp\u003eUpdate metric in child account by oem user if is_oem flag is true.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Boolean","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"child_organisation_key","full_name":"child_organisation_key","description":"\n\u003cp\u003eOrganisation key of child account where oem user wants to update metric.\nRequired field if is_oem is present.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":["Request\n  curl -X PUT -H \"Content-Type:application/json\" -H \"X-Auth-Token:olezAZXGQn9MutnfNerKDQ\"  -d '{\"metric\":{\"unit_of_measure\":\"kg\"}}' https://api.datonis.io/api/v3/metrics/4f9b9764t7\n\nResponse (containing details of the metric updated)\n{\n  \"metric\": {\n    \"abbreviation\": \"capacity\",\n    \"created_at\": 1448364456,\n    \"data_type\": 0,\n    \"description\": \"Metric for thing template Washing Machine\",\n    \"metric_key\": \"4f9b9764t7\",\n    \"name\": \"capacity\",\n    \"unit_of_measure\": \"kg\",\n    \"updated_at\": 1448428909,\n    \"treatments\": [\n\n    ],\n    \"thing_template_key\": \"af31ae5fb2\"\n  }\n}"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/3.0/metric/destroy","name":"destroy","apis":[{"api_url":"/api/v3/metrics/:metric_key","http_method":"DELETE","short_description":"Delete an metric","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eDeletes an metric from the system\u003c/p\u003e\n","errors":[],"params":[{"name":"pretty","full_name":"pretty","description":"\n\u003cp\u003eReturn a pretty formatted response if true, Default is false\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Boolean","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"is_oem","full_name":"is_oem","description":"\n\u003cp\u003eDelete metric in child account by oem user if is_oem flag is true.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Boolean","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":["Request\n  curl -X DELETE -H \"Content-Type:application/json\" -H \"X-Auth-Token:olezAZXGQn9MutnfNerKDQ\"  https://api.datonis.io/api/v3/metrics/4f9b9764t7\n\nResponse\n{\n}"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/3.0/metric/add_treatments","name":"add_treatments","apis":[{"api_url":"/api/v3/metrics/:metric_key/add_treatments","http_method":"POST","short_description":"Add treatments to metric","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eCreates treatments with given parameters\u003c/p\u003e\n","errors":[],"params":[{"name":"treatments","full_name":"treatments","description":"\n\u003cp\u003eMap containing details of the treatments to be created\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[]},{"name":"pretty","full_name":"pretty","description":"\n\u003cp\u003eReturn a pretty formatted response if true, Default is false\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Boolean","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"is_oem","full_name":"is_oem","description":"\n\u003cp\u003eAdd treatment in child account by oem user if is_oem flag is true.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Boolean","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":["Request\n  curl -X POST -H \"Content-Type:application/json\" -H \"X-Auth-Token:olezAZXGQn9MutnfNerKDQ\"  -d '{\"treatments\":{\"RangeTreatment\":{\"_type\":\"Range\",\"min\":2,\"max\":10,\"off_limit_treatment\":0},\"DerivedTreatment\":{\"_type\":\"DerivedTreatment\",\"expression\":\"$event.data.metric_name * 3\"}}}' https://api.datonis.io/api/v3/metrics/4f9b9764t7/add_treatments\n\nResponse (containing details of the metric added treatment)\n{\n  \"metric\": {\n    \"abbreviation\": \"capacity\",\n    \"created_at\": 1448364456,\n    \"data_type\": 0,\n    \"description\": \"Metric for thing template Washing Machine\",\n    \"metric_key\": \"4f9b9764t7\",\n    \"name\": \"capacity\",\n    \"unit_of_measure\": \"kilogram\",\n    \"updated_at\": 1448364456,\n    \"treatments\": {\n      \"{\\\"RangeTreatment\\\"=\u003e{\\\"_type\\\"=\u003e\\\"Range\\\", \\\"min\\\"=\u003e2, \\\"max\\\"=\u003e10, \\\"off_limit_treatment\\\"=\u003e0}, \\\"DerivedTreatment\\\"=\u003e{\\\"_type\\\"=\u003e\\\"DerivedTreatment\\\", \\\"expression\\\"=\u003e\\\"$event.data.metric_name * 3\\\"}}\": null\n    },\n    \"thing_template_key\": \"af31ae5fb2\"\n  }\n}"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/3.0/metric/update_treatments","name":"update_treatments","apis":[{"api_url":"/api/v3/metrics/:metric_key/update_treatments","http_method":"PUT","short_description":"Update treatments","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eUpdates treatments belonging to this given metric with given parameters\u003c/p\u003e\n","errors":[],"params":[{"name":"treatments","full_name":"treatments","description":"\n\u003cp\u003eMap containing details of the treatments to be updated\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[]},{"name":"pretty","full_name":"pretty","description":"\n\u003cp\u003eReturn a pretty formatted response if true, Default is false\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Boolean","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"is_oem","full_name":"is_oem","description":"\n\u003cp\u003eUpdate treatment in child account by oem user if is_oem flag is true.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Boolean","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"child_organisation_key","full_name":"child_organisation_key","description":"\n\u003cp\u003eOrganisation key of child account where oem user wants to update treatment.\nRequired field if is_oem is present.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":["Request\n  curl -X PUT -H \"Content-Type:application/json\" -H \"X-Auth-Token:olezAZXGQn9MutnfNerKDQ\"  -d '{\"treatments\":{\"RangeTreatment\":{\"_type\":\"Range\",\"min\":2,\"max\":10,\"off_limit_treatment\":0},\"DerivedTreatment\":{\"_type\":\"DerivedTreatment\",\"expression\":\"$event.data.metric_name * 3\"}}}' https://api.datonis.io/api/v3/metrics/4f9b9764t7/update_treatments\n\nResponse (containing details of the metric updated)\n{\n  \"metric\": {\n    \"abbreviation\": \"capacity\",\n    \"created_at\": 1448364456,\n    \"data_type\": 0,\n    \"description\": \"Metric for thing template Washing Machine\",\n    \"metric_key\": \"4f9b9764t7\",\n    \"name\": \"capacity\",\n    \"unit_of_measure\": \"kg\",\n    \"updated_at\": 1448428909,\n    \"treatments\": \"{\\\"treatments\\\":{ \\\"RangeTreatment\\\" : {\\\"_type\\\" : \\\"Range\\\", \\\"min\\\" : 2, \\\"max\\\" : 10, \\\"off_limit_treatment\\\" : 0}, \\\"DerivedTreatment\\\" : {\\\"_type\\\" : \\\"DerivedTreatment\\\", \\\"expression\\\" : \\\"$event.data.metric_name * 3\\\"}}}\",\n    \"thing_template_key\": \"af31ae5fb2\"\n  }\n}"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/3.0/metric/delete_treatments","name":"delete_treatments","apis":[{"api_url":"/api/v3/metrics/:metric_key/delete_treatments","http_method":"DELETE","short_description":"Delete treatments","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eDeletes treatments belonging to given metric from the system\u003c/p\u003e\n","errors":[],"params":[{"name":"pretty","full_name":"pretty","description":"\n\u003cp\u003eReturn a pretty formatted response if true, Default is false\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Boolean","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"treatment_keys","full_name":"treatment_keys","description":"\n\u003cp\u003eArray containing treatment keys to be deleted\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"is_oem","full_name":"is_oem","description":"\n\u003cp\u003eDelete treatments in child account by oem user if is_oem flag is true.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Boolean","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":["Request\n  curl -X DELETE -H \"Content-Type:application/json\" -H \"X-Auth-Token:olezAZXGQn9MutnfNerKDQ\" -d '{\"treatment_keys\":[\"123456\",\"125896\"]}' https://api.datonis.io/api/v3/metrics/4f9b9764t7/delete_treatments\n\nResponse\n{\n}"],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[]},"metric_event_counter":{"doc_url":"/apidoc/3.0/metric_event_counter","api_url":"","name":"Metric event counter","short_description":null,"full_description":"","version":"3.0","formats":null,"metadata":{"order":16},"methods":[{"doc_url":"/apidoc/3.0/metric_event_counter/get_metric_event_count","name":"get_metric_event_count","apis":[{"api_url":"/api/v3/metric_event_counters/metric_events","http_method":"GET","short_description":"Fetch metric evets in date range","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eReturns the number of metric events for given license keys. Date range is\nlimited to mixum 30 days.\u003c/p\u003e\n","errors":[],"params":[{"name":"from","full_name":"from","description":"\n\u003cp\u003eDate in YYYY-MM-DD format, from which metric events to be returned\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"to","full_name":"to","description":"\n\u003cp\u003eDate in YYYY-MM-DD, to which metric events to be returned\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"is_oem","full_name":"is_oem","description":"\n\u003cp\u003eIf this flag is true then data for all child organisations will be\nreturned, when it is false it will return only data for that account. By\ndefault it is false\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Boolean","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"timezone","full_name":"timezone","description":"\n\u003cp\u003eTime zone in which from and to date should be considered. By default it is\nUTC\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":["Request\n  curl -X GET -H \"Content-Type:application/json\" --header 'X-Auth-Token:qplZbr0tKnjCFaBZSmmpOw' -d '{\"from\":\"2022-10-10\", \"to\":\"2022-10-18\", \"timezone\":\"Mumbai\", \"is_oem\":true}' 'http://api.datonis.io/api/v3//metric_event_counters/metric_events'\n\nResponse (Metric events for each organisation)\n{\n  \"Altizon Mumbai\": 5477636,\n  \"Altizon Pune\": 1633,\n  \"Altizon Delhi\": 2156,\n  \"Altizon Bangalore\": 5853\n}","Request\n  curl -X GET -H \"Content-Type:application/json\" --header 'X-Auth-Token:qplZbr0tKnjCFaBZSmmpOw' -d '{\"from\":\"2022-10-10\", \"to\":\"2022-10-18\", \"timezone\":\"Mumbai\"}' 'http://api.datonis.io/api/v3//metric_event_counters/metric_events'\n\nResponse (Metric events for each organisation)\n{\n  \"Altizon Demo\": 54776\n}"],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[]},"notification_action":{"doc_url":"/apidoc/3.0/notification_action","api_url":"","name":"Notification action","short_description":null,"full_description":"","version":"3.0","formats":null,"metadata":{"order":8},"methods":[{"doc_url":"/apidoc/3.0/notification_action/index","name":"index","apis":[{"api_url":"/api/v3/notification_actions","http_method":"GET","short_description":"List all notification actions","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eReturns a list of all notification actions belonging to an account as per\nthe specified criteria. This API is paginated and returns 20 actions by\ndefault. An action is uniquely identified by a\n\u0026#39;notification_action_key\u0026#39;. This key should be used in all the other\nAPI referencing a particular notification action.\u003c/p\u003e\n","errors":[],"params":[{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number of results to be fetched, Default 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be Integer.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"per","full_name":"per","description":"\n\u003cp\u003eNumber of notification actions to be returned in one page, Default 20\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be Integer.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order_by","full_name":"order_by","description":"\n\u003cp\u003eField on which results should be sorted\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eOrder, “asc” or “desc”, in which results should be sorted\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003eKeywords based on which notfication actions should be searched. Currently\nnot supported\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"scope","full_name":"scope","description":"\n\u003cp\u003eMatching condition if multiple keywords are specified for search. Currently\nnot supported\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"rule_key","full_name":"rule_key","description":"\n\u003cp\u003eMandatory, rule_key in string format.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"type","full_name":"type","description":"\n\u003cp\u003eOptional, one from “EmailNotificationAction”, “CallHttpUrlAction” or\n“ThingUserDefinedPropertiesAction”\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"timestamp_format","full_name":"timestamp_format","description":"\n\u003cp\u003eFormat, “str” or “int”, in which timestamps should be returned, Default\n“int”\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"pretty","full_name":"pretty","description":"\n\u003cp\u003eReturn a pretty formatted response if true, Default is false\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Boolean","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":["Request - listing all notification actions associated with a rule\n  curl -X GET -H \"Content-Type:application/json\" -H 'X-Auth-Token:SMvLmYkkIVSYrrEQZSix0Q' -d '{\"rule_key\":\"a24e3747bd\"}' https://api.datonis.io/api/v3/notification_actions\n\nResponse (returns first 20 records)\n{\n  \"total_count\": 3,\n  \"page\": 1,\n  \"notification_actions\": [\n    {\n      \"bcc\": \"\",\n      \"body\": null,\n      \"cc\": \"john@acme.com\",\n      \"created_at\": 1448514905,\n      \"notification_action_key\": \"e18c3t386e\",\n      \"subject\": null,\n      \"to\": \"bill@acme.com\",\n      \"updated_at\": 1448514905,\n      \"type\": \"EmailNotificationAction\"\n    },\n    {\n      \"body\": \"{\\\"user_defined_properties\\\":{\\\"Status\\\":\\\"Green\\\"}}\",\n      \"created_at\": 1448515099,\n      \"headers\": {\n      },\n      \"method\": \"PUT\",\n      \"notification_action_key\": \"4d1d745e94\",\n      \"query\": {\n      },\n      \"updated_at\":...","\n  curl -X GET -H \"Content-Type:application/json\" -H 'X-Auth-Token:SMvLmYkkIVSYrrEQZSix0Q' -d '{\"rule_key\":\"a24e3747bd\", \"per\":\"2\", \"page\":\"2\"}' https://api.datonis.io/api/v3/notification_actions\n\nResponse (returns page 2 with 2 notification actions per page)\n{\n  \"total_count\": 3,\n  \"page\": \"2\",\n  \"notification_actions\": [\n    {\n      \"body\": \"\",\n      \"created_at\": 1448514914,\n      \"headers\": {\n      },\n      \"method\": \"GET\",\n      \"notification_action_key\": \"dt1b22767c\",\n      \"query\": {\n      },\n      \"updated_at\": 1448514914,\n      \"url\": \"http://epochconverter.com\",\n      \"type\": \"CallHttpUrlAction\"\n    }\n  ]\n}","Request - listing notification actions ordered by a field\n  curl -X GET -H \"Content-Type:application/json\" -H 'X-Auth-Token:SMvLmYkkIVSYrrEQZSix0Q' -d '{\"rule_key\":\"a24e3747bd\", \"order_by\":\"type\", \"order\":\"desc\"}' https://api.datonis.io/api/v3/notification_actions\n\nResponse (returns notification in the reverse order of type)\n{\n  \"total_count\": 3,\n  \"page\": 1,\n  \"notification_actions\": [\n    {\n      \"bcc\": \"\",\n      \"body\": null,\n      \"cc\": \"john@acme.com\",\n      \"created_at\": 1448514905,\n      \"notification_action_key\": \"e18c3t386e\",\n      \"subject\": null,\n      \"to\": \"bill@acme.com\",\n      \"updated_at\": 1448514905,\n      \"type\": \"EmailNotificationAction\"\n    },\n    {\n      \"body\": \"{\\\"user_defined_properties\\\":{\\\"Status\\\":\\\"Green\\\"}}\",\n      \"created_at\": 1448515099,\n      \"headers\": {\n      },\n      \"method\": \"PUT\",\n      \"notification_action_key\": \"4d1d745e94\",\n      \"query\": {\n      },\n      \"updated_at\": 1448515099,\n      \"url\": \"http://localhost:3000/api/v3/things/$THING$/set_user_defined_properties\",\n      \"type\": \"ThingUserDefinedPropertiesAction\"\n    },\n    {\n      \"body\": \"\",\n      \"created_at\": 1448514914,\n      \"headers\": {\n      },\n      \"method\": \"GET\",\n      \"notification_action_key\": \"dt1b22767c\",\n      \"query\": {\n      },\n      \"updated_at\": 1448514914,\n      \"url\":...","Request - listing notification based on action type\n  curl -X GET -H \"Content-Type:application/json\" -H 'X-Auth-Token:SMvLmYkkIVSYrrEQZSix0Q' -d '{\"rule_key\":\"a24e3747bd\", \"type\":\"EmailNotificationAction\"}' https://api.datonis.io/api/v3/notification_actions\n\nResponse (returns notification actions of type \"EmailNotificationAction\")\n{\n  \"total_count\": 1,\n  \"page\": 1,\n  \"notification_actions\": [\n    {\n      \"bcc\": \"\",\n      \"body\": null,\n      \"cc\": \"john@acme.com\",\n      \"created_at\": 1448514905,\n      \"notification_action_key\": \"e18c3t386e\",\n      \"subject\": null,\n      \"to\": \"bill@acme.com\",\n      \"updated_at\": 1448514905,\n      \"type\": \"EmailNotificationAction\"\n    }\n  ]\n}"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/3.0/notification_action/show","name":"show","apis":[{"api_url":"/api/v3/notification_actions/:notification_key","http_method":"GET","short_description":"Fetch details of a notification action","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eReturns details of the specified notification action\u003c/p\u003e\n","errors":[],"params":[{"name":"pretty","full_name":"pretty","description":"\n\u003cp\u003eReturn a pretty formatted response if true, Default is false\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Boolean","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":["Request - get details of the specified notification (notification_action_key specified as a part of the url)\n  curl -X GET -H \"Content-Type:application/json\" -H 'X-Auth-Token:SMvLmYkkIVSYrrEQZSix0Q' https://api.datonis.io/api/v3/notification_actions/e18c3t386e\n\nResponse (details of the notification action requested)\n{\n  \"notification_action\": {\n    \"bcc\": \"\",\n    \"body\": null,\n    \"cc\": \"john@acme.com\",\n    \"created_at\": 1448514905,\n    \"notification_action_key\": \"e18c3t386e\",\n    \"subject\": null,\n    \"to\": \"bill@acme.com\",\n    \"updated_at\": 1448514905,\n    \"type\": \"EmailNotificationAction\"\n  }\n}"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/3.0/notification_action/create","name":"create","apis":[{"api_url":"/api/v3/notification_actions","http_method":"POST","short_description":"Create a notification action","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eCreates a notification action with given parameters\u003c/p\u003e\n","errors":[],"params":[{"name":"notification_action","full_name":"notification_action","description":"\n\u003cp\u003eMap containing the details of the notification action to be created\u003c/p\u003e\n\n\u003cpre\u003eMandatory keys that should be sent from within the hash:\ntype: type of notification action to create, can be one of:\n* EmailNotificationAction : Mandatory Parameters - \u0026quot;to\u0026quot;, Optional Parameters - \u0026quot;cc\u0026quot;, \u0026quot;bcc\u0026quot;\n* CallHttpUrlAction : Mandatory Parameters - \u0026quot;url\u0026quot;, \u0026quot;method\u0026quot;\n* ThingUserDefinedPropertiesAction : Mandatory Parameters - \u0026quot;body\u0026quot;. body format {\u0026quot;user_defined_properties\u0026quot; =\u0026gt; {$key=\u0026gt;$value}}\n* SMSNotificationAction : Mandatory Parameters - \u0026quot;name\u0026quot;, \u0026quot;phone_number\u0026quot;\nrule_key: rule_key of the rule for which the action should be associated\u003c/pre\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[]},{"name":"pretty","full_name":"pretty","description":"\n\u003cp\u003eReturn a pretty formatted response if true, Default is false\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Boolean","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":["Request - to create an email notification action\n  curl -X POST -H \"Content-Type:application/json\"  -H \"X-Auth-Token:SMvLmYkkIVSYrrEQZSix0Q\" -d '{\"notification_action\":{\"type\":\"EmailNotificationAction\",\"rule_key\":\"a24e3747bd\",\"to\":\"bill@acme.com\",\"cc\":\"bob@acme.com\",\"bcc\":\"john@acme.com\"}}' https://api.datonis.io/api/v3/notification_actions\n\nResponse (details of the notification action created)\n{\n  \"notification_action\": {\n    \"bcc\": \"john@acme.com\",\n    \"body\": null,\n    \"cc\": \"bob@acme.com\",\n    \"created_at\": 1448515909,\n    \"notification_action_key\": \"49ffa24fet\",\n    \"subject\": null,\n    \"to\": \"bill@acme.com\",\n    \"updated_at\": 1448515909,\n    \"type\": \"EmailNotificationAction\"\n  }\n}","Request - to create a call http url action\n  curl -X POST -H \"Content-Type:application/json\"  -H \"X-Auth-Token:SMvLmYkkIVSYrrEQZSix0Q\" -d '{\"notification_action\":{\"type\":\"CallHttpUrlAction\",\"rule_key\":\"a24e3747bd\",\"method\":\"POST\",\"url\":\"https://api.datonis.io/api/v3/things\"}}' https://api.datonis.io/api/v3/notification_actions\n\nResponse (details of the notification action created)\n{\n  \"notification_action\": {\n    \"body\": \"\",\n    \"created_at\": 1448516142,\n    \"headers\": {\n    },\n    \"method\": \"POST\",\n    \"notification_action_key\": \"7b6f47t5f5\",\n    \"query\": {\n    },\n    \"updated_at\": 1448516142,\n    \"url\": \"https://api.datonis.io/api/v3/things\",\n    \"type\": \"CallHttpUrlAction\"\n  }\n}","Request - to create a set thing user defined property action\n  curl -X POST -H \"Content-Type:application/json\"  -H \"X-Auth-Token:SMvLmYkkIVSYrrEQZSix0Q\" -d '{\"notification_action\":{\"type\":\"ThingUserDefinedPropertiesAction\",\"rule_key\":\"a24e3747bd\",\"body\":{\"user_defined_properties\":{\"Status\":\"Red\"}}}}' https://api.datonis.io/api/v3/notification_actions\n\nResponse (details of the notification action created)\n{\n  \"notification_action\": {\n    \"body\": \"{\\\"user_defined_properties\\\":{\\\"Status\\\":\\\"Red\\\"}}\",\n    \"created_at\": 1448516262,\n    \"headers\": {\n    },\n    \"method\": \"PUT\",\n    \"notification_action_key\": \"e4b268b9ca\",\n    \"query\": {\n    },\n    \"updated_at\": 1448516262,\n    \"url\": \"http://localhost:3000/api/v3/things/$THING$/set_user_defined_properties\",\n    \"type\": \"ThingUserDefinedPropertiesAction\"\n  }\n}"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/3.0/notification_action/update","name":"update","apis":[{"api_url":"/api/v3/notification_actions/:notification_action_key","http_method":"PUT","short_description":"Updates a notification action","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eUpdates the notification with given parameters\u003c/p\u003e\n","errors":[],"params":[{"name":"notification_action","full_name":"notification_action","description":"\n\u003cp\u003eMap containing the details of the notification action to be updated\u003c/p\u003e\n\n\u003cpre\u003eMandatory keys that should be sent from within the hash:\ntype: type of notification action to create, can be one of:\n* EmailNotificationAction : Optional Parameters - \u0026quot;to\u0026quot;, \u0026quot;cc\u0026quot;, \u0026quot;bcc\u0026quot;\n* CallHttpUrlAction : Optional Parameters - \u0026quot;url\u0026quot;, \u0026quot;method\u0026quot;\n* ThingUserDefinedPropertiesAction : Optional Parameters - \u0026quot;body\u0026quot;. body format {\u0026quot;user_defined_properties\u0026quot; =\u0026gt; {$key=\u0026gt;$value}}\nOptional keys:\nrule_key: rule_key of the rule for which the action should be associated\u003c/pre\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[]},{"name":"pretty","full_name":"pretty","description":"\n\u003cp\u003eReturn a pretty formatted response if true, Default is false\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Boolean","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":["Request - update an email notification action\n  curl -X PUT -H \"Content-Type:application/json\"  -H \"X-Auth-Token:SMvLmYkkIVSYrrEQZSix0Q\" -d '{\"notification_action\":{\"type\":\"EmailNotificationAction\",\"to\":\"bill@acme.com\",\"cc\":\"bob@acme.com\",\"bcc\":\"john@acme.com\"}}' https://api.datonis.io/api/v3/notification_actions/49ffa24fet\n\nResponse (details of the notification action updated)\n{\n  \"notification_action\": {\n    \"bcc\": \"john@acme.com\",\n    \"body\": null,\n    \"cc\": \"bob@acme.com\",\n    \"created_at\": 1448515909,\n    \"notification_action_key\": \"49ffa24fet\",\n    \"subject\": null,\n    \"to\": \"bill@acme.com\",\n    \"updated_at\": 1448516424,\n    \"type\": \"EmailNotificationAction\"\n  }\n}","Request - update a call http url action\n  curl -X PUT -H \"Content-Type:application/json\"  -H \"X-Auth-Token:SMvLmYkkIVSYrrEQZSix0Q\" -d '{\"notification_action\":{\"type\":\"CallHttpUrlAction\",\"method\":\"GET\",\"url\":\"https://api.datonis.io/api/v3/things\"}}' https://api.datonis.io/api/v3/notification_actions/7b6f47t5f5\n\nResponse (details of the notification action updated)\n{\n  \"notification_action\": {\n    \"body\": \"\",\n    \"created_at\": 1448516142,\n    \"headers\": {\n    },\n    \"method\": \"GET\",\n    \"notification_action_key\": \"7b6f47t5f5\",\n    \"query\": {\n    },\n    \"updated_at\": 1448516553,\n    \"url\": \"https://api.datonis.io/api/v3/things\",\n    \"type\": \"CallHttpUrlAction\"\n  }\n}","Request - update a thing user defined property action\n  curl -X PUT -H \"Content-Type:application/json\"  -H \"X-Auth-Token:SMvLmYkkIVSYrrEQZSix0Q\" -d '{\"notification_action\":{\"type\":\"ThingUserDefinedPropertiesAction\",\"body\":{\"user_defined_properties\":{\"Status\":\"Green\"}}}}' https://api.datonis.io/api/v3/notification_actions/e4b268b9ca\n\nResponse (details of the notification action updated)\n{\n  \"notification_action\": {\n    \"body\": \"{\\\"user_defined_properties\\\":{\\\"Status\\\":\\\"Green\\\"}}\",\n    \"created_at\": 1448516262,\n    \"headers\": {\n    },\n    \"method\": \"PUT\",\n    \"notification_action_key\": \"e4b268b9ca\",\n    \"query\": {\n    },\n    \"updated_at\": 1448516768,\n    \"url\": \"http://localhost:3000/api/v3/things/$THING$/set_user_defined_properties\",\n    \"type\": \"ThingUserDefinedPropertiesAction\"\n  }\n}"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/3.0/notification_action/destroy","name":"destroy","apis":[{"api_url":"/api/v3/notification_actions/:notification_key","http_method":"DELETE","short_description":"Delete a notification action","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eDeletes the specified notification action from the system\u003c/p\u003e\n","errors":[],"params":[{"name":"pretty","full_name":"pretty","description":"\n\u003cp\u003eReturn a pretty formatted response if true, Default is false\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Boolean","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":["Request\n  curl -X DELETE -H \"Content-Type:application/json\"  -H \"X-Auth-Token:SMvLmYkkIVSYrrEQZSix0Q\"  https://api.datonis.io/api/v3/notification_actions/e4b268b9ca\n\nResponse\n{\n}"],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[]},"rule":{"doc_url":"/apidoc/3.0/rule","api_url":"","name":"Rule","short_description":null,"full_description":"","version":"3.0","formats":null,"metadata":{"order":7},"methods":[{"doc_url":"/apidoc/3.0/rule/index","name":"index","apis":[{"api_url":"/api/v3/rules","http_method":"GET","short_description":"List all rules","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eReturns a list of all rules belonging to an account as per the specified\ncriteria. This API is paginated and returns 20 groups by default. A rule is\nuniquely identified by a \u0026#39;rule_key\u0026#39;. This key should be used in all\nthe other API referencing a particular rule.\u003c/p\u003e\n","errors":[],"params":[{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number of results to be fetched, Default 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be Integer.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"per","full_name":"per","description":"\n\u003cp\u003eNumber of rule records to be returned in one page, Default 20\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be Integer.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order_by","full_name":"order_by","description":"\n\u003cp\u003eField on which results should be sorted\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eOrder, “asc” or “desc”, in which results should be sorted.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"fetch_na_keys","full_name":"fetch_na_keys","description":"\n\u003cp\u003eOptional, whether to fetch notification action keys for a rule along with\nits definition\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"eval_engine","full_name":"eval_engine","description":"\n\u003cp\u003eOptional, specify specific evaluation engine, 0 for Datonis rules and 1 for\nEdge rules\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be Integer.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"timestamp_format","full_name":"timestamp_format","description":"\n\u003cp\u003eFormat, “str” or “int”, in which timestamps should be returned, Default\n“int”\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003eKeywords based on which rules should be searched. Currently you can search\nrules on - rule_key or name\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"scope","full_name":"scope","description":"\n\u003cp\u003eMatching condition if multiple keywords are specified for search. Valid\nvalues are “all” or “any”. Default is “all”\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"pretty","full_name":"pretty","description":"\n\u003cp\u003eReturn a pretty formatted response if true, Default is false\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Boolean","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"field_list","full_name":"field_list","description":"\n\u003cp\u003eList of fields required in the result.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}],"examples":["Request - listing all rules without any criteria\n  curl -X GET -H \"Content-Type:application/json\" -H \"X-Auth-Token:DarTKU-eUJ7md2vS-lFroA\" https://api.datonis.io/api/v3/rules\n\nResponse (returns first 20 rules)\n{\n  \"total_count\": 4,\n  \"page\": 1,\n  \"rules\": [\n    {\n      \"created_at\": 1429165920,\n      \"enabled\": false,\n      \"expression\": \"$event.data.cpu \u003e 0\",\n      \"name\": \"Example-RJ-3\",\n      \"rule_applicability\": 3,\n      \"rule_applicability_value\": \"e4aa3e35t675fc57ce81f3dd6e2dcdef492at4f7\",\n      \"rule_key\": \"33e73fa4f7\",\n      \"rule_properties\": {\n      },\n      \"rule_type\": 1,\n      \"time_between_triggers\": 300,\n      \"updated_at\": 1432116233,\n      \"user_visible_expression\": null,\n      \"last_trigger_time\": \"N.A\"\n    },\n    {\n      \"created_at\": 1426581040,\n      \"enabled\": true,\n      \"expression\": \"($event.data.cpu \u003e 1)\",\n      \"name\": \"CPU Rule\",\n      \"rule_applicability\": 3,\n      \"rule_applicability_value\": \"2f3ebc1cfted1956de1d8tat3be5f66ab7ed27ct\",\n      \"rule_key\": \"atc27bfd67\",\n      \"rule_properties\": {\n      },\n      \"rule_type\": 1,\n      \"time_between_triggers\": 60,\n      \"updated_at\": 1430299095,\n     ...","Request - listing rules by specifying number of rules to be returned at a time (page size) and specific set to be returned (page)\n  curl -X GET -H \"Content-Type:application/json\" -H \"X-Auth-Token:DarTKU-eUJ7md2vS-lFroA\" -d '{\"per\":\"2\",\"page\":\"2\"}' https://api.datonis.io/api/v3/rules\n\nResponse (returns page 2 with 2 rules per page)\n{\n  \"total_count\": 4,\n  \"page\": \"2\",\n  \"rules\": [\n    {\n      \"created_at\": 1448437343,\n      \"enabled\": true,\n      \"expression\": \"$event.data.temperature  \u003e 100\",\n      \"name\": \"Temperature monitoring rule\",\n      \"rule_applicability\": 3,\n      \"rule_applicability_value\": \"e28t112bdt,t6fd4btb5e\",\n      \"rule_key\": \"f79f7tf6f9\",\n      \"rule_properties\": {\n        \"since\": 1,\n        \"timezone\": \"Mumbai\",\n        \"minutes\": 5,\n        \"utc_offset\": 19800\n      },\n      \"rule_type\": 1,\n      \"time_between_triggers\": 1800,\n      \"updated_at\": 1448437527,\n      \"user_visible_expression\": null,\n      \"last_trigger_time\": \"N.A\"\n    },\n    {\n      \"created_at\": 1448437424,\n      \"enabled\": true,\n      \"expression\": \"$event.data.voltage \u003e 230\",\n      \"name\": \"Voltage Monitoring Rule\",\n      \"rule_applicability\": 2,\n      \"rule_applicability_value\": \"Temp Sensor\",\n      \"rule_key\": \"5de74et6cd\",\n      \"rule_properties\": {\n        \"since\": 1,...","Request - listing rules ordered by a field with string formatted timestamps\n  curl -X GET -H \"Content-Type:application/json\" -H \"X-Auth-Token:DarTKU-eUJ7md2vS-lFroA\" -d '{\"order_by\":\"name\",\"order\":\"desc\",\"timestamp_format\":\"str\"}' https://api.datonis.io/api/v3/rules\n\nResponse (returns groups in the reverse order of their name, with timestamps in string format)\n{\n  \"total_count\": 4,\n  \"page\": 1,\n  \"rules\": [\n    {\n      \"created_at\": \"2015/11/25 07:43:44\",\n      \"enabled\": true,\n      \"expression\": \"$event.data.voltage \u003e 230\",\n      \"name\": \"Voltage Monitoring Rule\",\n      \"rule_applicability\": 2,\n      \"rule_applicability_value\": \"Temp Sensor\",\n      \"rule_key\": \"5de74et6cd\",\n      \"rule_properties\": {\n        \"since\": 1,\n        \"timezone\": \"Mumbai\",\n        \"minutes\": 5,\n        \"utc_offset\": 19800\n      },\n      \"rule_type\": 1,\n      \"time_between_triggers\": 1800,\n      \"updated_at\": \"2015/11/25 07:43:44\",\n      \"user_visible_expression\": null,\n      \"last_trigger_time\": \"N.A\"\n    },\n    {\n      \"created_at\": \"2015/11/25 07:42:23\",\n      \"enabled\": true,\n      \"expression\": \"$event.data.temperature  \u003e 100\",\n      \"name\": \"Temperature monitoring rule\",\n      \"rule_applicability\": 3,\n      \"rule_applicability_value\": \"e28t112bdt,t6fd4btb5e\",\n      \"rule_key\": \"f79f7tf6f9\",\n      \"rule_properties\": {\n        \"since\": 1,\n       ...","Request - listing rules based on some search criteria with all keywords matching\n  curl -X GET -H \"Content-Type:application/json\" -H \"X-Auth-Token:DarTKU-eUJ7md2vS-lFroA\" -d '{\"search\":\"Voltage Monitoring\"}' https://api.datonis.io/api/v3/rules\n\nResponse (returns rules containing both keywords 'Voltage' as well as 'Monitoring')\n{\n  \"total_count\": 1,\n  \"page\": 1,\n  \"rules\": [\n    {\n      \"created_at\": 1448437424,\n      \"enabled\": true,\n      \"expression\": \"$event.data.voltage \u003e 230\",\n      \"name\": \"Voltage Monitoring Rule\",\n      \"rule_applicability\": 2,\n      \"rule_applicability_value\": \"Temp Sensor\",\n      \"rule_key\": \"5de74et6cd\",\n      \"rule_properties\": {\n        \"since\": 1,\n        \"timezone\": \"Mumbai\",\n        \"minutes\": 5,\n        \"utc_offset\": 19800\n      },\n      \"rule_type\": 1,\n      \"time_between_triggers\": 1800,\n      \"updated_at\": 1448437424,\n      \"user_visible_expression\": null,\n      \"last_trigger_time\": \"N.A\"\n    }\n  ]\n}","Request - listing rules based on some search criteria with any of the keywords matching\n  curl -X GET -H \"Content-Type:application/json\" -H \"X-Auth-Token:DarTKU-eUJ7md2vS-lFroA\" -d '{\"search\":\"Voltage 33e73fa4f7\", \"scope\":\"any\"}' https://api.datonis.io/api/v3/rules\n\nResponse (returns rules containing either of the keywords 'Voltage' or 't2514225a7' - In this case one rule matched per keyword)\n{\n  \"total_count\": 2,\n  \"page\": 1,\n  \"rules\": [\n    {\n      \"created_at\": 1429165920,\n      \"enabled\": false,\n      \"expression\": \"$event.data.cpu \u003e 0\",\n      \"name\": \"Example-RJ-3\",\n      \"rule_applicability\": 3,\n      \"rule_applicability_value\": \"e4aa3e35t675fc57ce81f3dd6e2dcdef492at4f7\",\n      \"rule_key\": \"33e73fa4f7\",\n      \"rule_properties\": {\n      },\n      \"rule_type\": 1,\n      \"time_between_triggers\": 300,\n      \"updated_at\": 1432116233,\n      \"user_visible_expression\": null,\n      \"last_trigger_time\": \"N.A\"\n    },\n    {\n      \"created_at\": 1448437424,\n      \"enabled\": true,\n      \"expression\": \"$event.data.voltage \u003e 230\",\n      \"name\": \"Voltage Monitoring Rule\",\n      \"rule_applicability\": 2,\n      \"rule_applicability_value\": \"Temp Sensor\",\n      \"rule_key\": \"5de74et6cd\",\n      \"rule_properties\": {\n        \"since\": 1,\n        \"timezone\": \"Mumbai\",\n        \"minutes\": 5,\n        \"utc_offset\": 19800\n      },\n      \"rule_type\": 1,\n      \"time_between_triggers\": 1800,\n     ...","Request - listing rules along with associated notification action keys\n  curl -X GET -H \"Content-Type:application/json\" -H \"X-Auth-Token:DarTKU-eUJ7md2vS-lFroA\" -d '{\"fetch_na_keys\":\"1\"}' https://api.datonis.io/api/v3/rules\n\nResponse (returns rules containing either of the keywords 'Voltage' or 't2514225a7' - In this case one rule matched per keyword)\n{\n  \"total_count\": 4,\n  \"page\": 1,\n  \"rules\": [\n    {\n      \"created_at\": 1429165920,\n      \"enabled\": false,\n      \"expression\": \"$event.data.cpu \u003e 0\",\n      \"name\": \"Example-RJ-3\",\n      \"rule_applicability\": 3,\n      \"rule_applicability_value\": \"e4aa3e35t675fc57ce81f3dd6e2dcdef492at4f7\",\n      \"rule_key\": \"33e73fa4f7\",\n      \"rule_properties\": {\n      },\n      \"rule_type\": 1,\n      \"time_between_triggers\": 300,\n      \"updated_at\": 1432116233,\n      \"user_visible_expression\": null,\n      \"notification_action_keys\": [\n        \"99c47515f1\"\n      ],\n      \"last_trigger_time\": \"N.A\"\n    },\n    {\n      \"created_at\": 1426581040,\n      \"enabled\": true,\n      \"expression\": \"($event.data.cpu \u003e 1)\",\n      \"name\": \"CPU Rule\",\n      \"rule_applicability\": 3,\n      \"rule_applicability_value\": \"2f3ebc1cfted1956de1d8tat3be5f66ab7ed27ct\",\n      \"rule_key\": \"atc27bfd67\",\n      \"rule_properties\": {\n      },\n      \"rule_type\": 1,\n      \"time_between_triggers\": 60,\n      \"updated_at\": 1430299095,\n      \"user_visible_expression\": null,\n      \"notification_action_keys\": [\n        \"t2e9b13568\",\n       ..."],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/3.0/rule/show","name":"show","apis":[{"api_url":"/api/v3/rules/:rule_key","http_method":"GET","short_description":"Fetch details of a specific rule","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eReturns details of the rule specified\u003c/p\u003e\n","errors":[],"params":[{"name":"pretty","full_name":"pretty","description":"\n\u003cp\u003eReturn a pretty formatted response if true, Default is false\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Boolean","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":["Request - get details of the specified rule (rule_key specified as a part of the url)\n  curl -X GET -H \"Content-Type:application/json\" -H \"X-Auth-Token:DarTKU-eUJ7md2vS-lFroA\" https://api.datonis.io/api/v3/rules/33e73fa4f7\n\nResponse (details of the rule requested)\n{\n  \"rule\": {\n    \"enabled\": true,\n    \"expression\": \"$event.data.power \u003c 500\",\n    \"name\": \"Power monitoring rule\",\n    \"rule_applicability\": 3,\n    \"rule_applicability_value\": \"27ce8667143fa217b3eb9ecbedcbacdc28addt97,16dc891e4b255735d7tafete13e6fdc412628t84\",\n    \"rule_key\": \"t2514225a7\",\n    \"rule_type\": null,\n    \"time_between_triggers\": 1800,\n    \"user_visible_expression\": null\n  }\n}"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/3.0/rule/create","name":"create","apis":[{"api_url":"/api/v3/rules","http_method":"POST","short_description":"Create a rule","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eCreates a rule with given parameters\u003c/p\u003e\n","errors":[],"params":[{"name":"rule","full_name":"rule","description":"\n\u003cp\u003eMap containing the details of the rule to be created\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[]},{"name":"pretty","full_name":"pretty","description":"\n\u003cp\u003eReturn a pretty formatted response if true, Default is false\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Boolean","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":["Request\n  curl -X POST -H \"Content-Type:application/json\" -H \"X-Auth-Token:DarTKU-eUJ7md2vS-lFroA\" -d '{\"rule\":{\"enabled\":true,\"name\":\"Voltage High Threshold monitoring\",\"expression\":\"$event.data.voltage \\u003C 270\",\"rule_applicability\":3,\"rule_applicability_value\":[\"27ce8667143fa217b3eb9ecbedcbacdc28addt97\",\"16dc891e4b255735d7tafete13e6fdc412628t84\"],\"time_between_triggers\":1800}}' https://api.datonis.io/api/v3/rules\n\nResponse (containing details of the rule created)\n{\n  \"rule\": {\n    \"enabled\": true,\n    \"expression\": \"$event.data.voltage \u003c 270\",\n    \"name\": \"Voltage High Threshold monitoring\",\n    \"rule_applicability\": 3,\n    \"rule_applicability_value\": \"27ce8667143fa217b3eb9ecbedcbacdc28addt97,16dc891e4b255735d7tafete13e6fdc412628t84\",\n    \"rule_key\": \"ted3793aa3\",\n    \"rule_type\": null,\n    \"time_between_triggers\": 1800,\n    \"user_visible_expression\": null\n  }\n}"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/3.0/rule/update","name":"update","apis":[{"api_url":"/api/v3/rules/:rule_key","http_method":"PUT","short_description":"Updates a rule","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eUpdates the rule with given parameters\u003c/p\u003e\n","errors":[],"params":[{"name":"rule","full_name":"rule","description":"\n\u003cp\u003eMap containing the details of the rule to be updated\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[]},{"name":"pretty","full_name":"pretty","description":"\n\u003cp\u003eReturn a pretty formatted response if true, Default is false\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Boolean","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":["Request\n  curl -X PUT -H \"Content-Type:application/json\" -H \"X-Auth-Token:Ko2rILQPWNxzFj1zudWx7g\" -d '{\"rule\":{\"enabled\":false,\"expression\":\"$event.data.voltage \\u003E 270\",\"time_between_triggers\":900}}' https://api.datonis.io/api/v3/rules/ce9t822eda\n\nResponse (containing details of the rule updated)\n{\n  \"rule\": {\n    \"enabled\": false,\n    \"expression\": \"$event.data.voltage \u003e 270\",\n    \"name\": \"Voltage High Threshold monitoring\",\n    \"rule_applicability\": 3,\n    \"rule_applicability_value\": \"27ce8667143fa217b3eb9ecbedcbacdc28addt97,16dc891e4b255735d7tafete13e6fdc412628t84\",\n    \"rule_key\": \"ce9t822eda\",\n    \"rule_type\": null,\n    \"time_between_triggers\": 900,\n    \"user_visible_expression\": null\n  }\n}"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/3.0/rule/destroy","name":"destroy","apis":[{"api_url":"/api/v3/rules/:rule_key","http_method":"DELETE","short_description":"Deletes the specified rule","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eDeletes the specified rule from the system\u003c/p\u003e\n","errors":[],"params":[{"name":"pretty","full_name":"pretty","description":"\n\u003cp\u003eReturn a pretty formatted response if true, Default is false\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Boolean","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":["Request\n  curl -X DELETE -H \"Content-Type:application/json\" -H \"X-Auth-Token:Ko2rILQPWNxzFj1zudWx7g\"  https://api.datonis.io/api/v3/rules/ce9t822eda\n\nResponse\n{\n}"],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[]},"rule_state":{"doc_url":"/apidoc/3.0/rule_state","api_url":"","name":"Rule state","short_description":null,"full_description":"","version":"3.0","formats":null,"metadata":{"order":12},"methods":[{"doc_url":"/apidoc/3.0/rule_state/index","name":"index","apis":[{"api_url":"/api/v3/rule_trigger_events","http_method":"GET","short_description":"List all rule trigger events","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eReturns details of the rule trigger event\u003c/p\u003e\n","errors":[],"params":[{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number of results to be fetched, Default 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be Integer.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"per","full_name":"per","description":"\n\u003cp\u003eNumber of records to be returnes in one page, Default 40\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be Integer.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eOrder, asc or desc, in which results should be sorted by time of occurance,\nDefault desc\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"individualRecords","full_name":"individualRecords","description":"\n\u003cp\u003eChoose between Summary “false” or Individual records (“true”). Default is\nfalse\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Boolean","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"rule_key","full_name":"rule_key","description":"\n\u003cp\u003eRule State changes for the particular rule will be fetched\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"thing_key","full_name":"thing_key","description":"\n\u003cp\u003eRule State changes for the particular thing will be fetched\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"timestamp_format","full_name":"timestamp_format","description":"\n\u003cp\u003eFormat, str or int, in which timestamps should be returned, Default int\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":["Request:\n curl -X GET  -H \"Content-Type:application/json\" -H \"X-Auth-Token:WtUFnj8pvSxVnH9e_xkq7A\" https://api.datonis.io/api/v3/rule_trigger_events \nResponse:\n {\n  \"total_count\": 2,\n  \"rule_trigger_events\": [\n    {\n      \"created_at\": 1448517402,\n      \"details\": {\n      },\n      \"rte_key\": \"t6c5df36c2\",\n      \"thing_keys\": \"af46eec35151abt6546f7ff8t294cf1e8t74e967\",\n      \"timestamp\": 1448517402,\n      \"updated_at\": 1448517402,\n      \"rule_key\": \"12tb3c686t\"\n    },\n    {\n      \"created_at\": 1448517402,\n      \"details\": {\n      },\n      \"rte_key\": \"c34ac88ca3\",\n      \"thing_keys\": \"af46eec35151abt6546f7ff8t294cf1e8t74e967\",\n      \"timestamp\": 1448517402,\n      \"updated_at\": 1448517402,\n      \"rule_key\": \"12tb3c686t\"\n    }\n  ],\n  \"page\": 1\n}"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/3.0/rule_state/show","name":"show","apis":[{"api_url":"/api/v3/rule_trigger_events/:rule_trigger_event_key","http_method":"GET","short_description":"Fetch information for a rule_trigger_event","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eReturns details of the rule_trigger_event requested\u003c/p\u003e\n","errors":[],"params":[{"name":"pretty","full_name":"pretty","description":"\n\u003cp\u003eReturn a pretty formatted response if true, Default is false\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Boolean","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":["Request - get details of the specified rule_trigger_event (rule_trigger_event_key specified as a part of the url)\n  curl -X GET  -H \"Content-Type:application/json\" -H \"X-Auth-Token:WtUFnj8pvSxVnH9e_xkq7A\"  https://api.datonis.io/api/v3/rule_trigger_events/532e376tfd\n\nResponse (returns details of the rule_trigger_event requested)\n{\n  \"created_at\": 1448517402,\n  \"details\": {\n  },\n  \"rte_key\": \"be3f77894c\",\n  \"thing_keys\": \"af46eec35151abt6546f7ff8t294cf1e8t74e967\",\n  \"timestamp\": 1448517402,\n  \"updated_at\": 1448517402,\n  \"rule_key\": \"4f441ef263\"\n}"],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[]},"rule_trigger_event":{"doc_url":"/apidoc/3.0/rule_trigger_event","api_url":"","name":"Rule trigger event","short_description":null,"full_description":"","version":"3.0","formats":null,"metadata":{"order":9},"methods":[{"doc_url":"/apidoc/3.0/rule_trigger_event/index","name":"index","apis":[{"api_url":"/api/v3/rule_trigger_events","http_method":"GET","short_description":"List all rule trigger events","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eReturns details of the rule trigger event\u003c/p\u003e\n","errors":[],"params":[{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number of results to be fetched, Default 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be Integer.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"per","full_name":"per","description":"\n\u003cp\u003eNumber of records to be returnes in one page, Default 20\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be Integer.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order_by","full_name":"order_by","description":"\n\u003cp\u003eField on which results should be sorted\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eOrder, asc or desc, in which results should be sorted\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003eSearch string, rule_key\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"scope","full_name":"scope","description":"\n\u003cp\u003eMatching condition. Valid values are “all” or “any”\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"rule_key","full_name":"rule_key","description":"\n\u003cp\u003eRule trigger events for the particular rule will be fetched\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"thing_key","full_name":"thing_key","description":"\n\u003cp\u003eRule trigger events for the particular thing will be fetched\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"timestamp_format","full_name":"timestamp_format","description":"\n\u003cp\u003eFormat, str or int, in which timestamps should be returned, Default int\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"field_list","full_name":"field_list","description":"\n\u003cp\u003eList of fields required in the result.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}],"examples":["Request:\n curl -X GET  -H \"Content-Type:application/json\" -H \"X-Auth-Token:WtUFnj8pvSxVnH9e_xkq7A\" https://api.datonis.io/api/v3/rule_trigger_events \nResponse:\n {\n  \"total_count\": 2,\n  \"rule_trigger_events\": [\n    {\n      \"created_at\": 1448517402,\n      \"details\": {\n      },\n      \"rte_key\": \"t6c5df36c2\",\n      \"thing_keys\": \"af46eec35151abt6546f7ff8t294cf1e8t74e967\",\n      \"timestamp\": 1448517402,\n      \"updated_at\": 1448517402,\n      \"rule_key\": \"12tb3c686t\"\n    },\n    {\n      \"created_at\": 1448517402,\n      \"details\": {\n      },\n      \"rte_key\": \"c34ac88ca3\",\n      \"thing_keys\": \"af46eec35151abt6546f7ff8t294cf1e8t74e967\",\n      \"timestamp\": 1448517402,\n      \"updated_at\": 1448517402,\n      \"rule_key\": \"12tb3c686t\"\n    }\n  ],\n  \"page\": 1\n}"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/3.0/rule_trigger_event/show","name":"show","apis":[{"api_url":"/api/v3/rule_trigger_events/:rule_trigger_event_key","http_method":"GET","short_description":"Fetch information for a rule_trigger_event","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eReturns details of the rule_trigger_event requested\u003c/p\u003e\n","errors":[],"params":[{"name":"pretty","full_name":"pretty","description":"\n\u003cp\u003eReturn a pretty formatted response if true, Default is false\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Boolean","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":["Request - get details of the specified rule_trigger_event (rule_trigger_event_key specified as a part of the url)\n  curl -X GET  -H \"Content-Type:application/json\" -H \"X-Auth-Token:WtUFnj8pvSxVnH9e_xkq7A\"  https://api.datonis.io/api/v3/rule_trigger_events/532e376tfd\n\nResponse (returns details of the rule_trigger_event requested)\n{\n  \"created_at\": 1448517402,\n  \"details\": {\n  },\n  \"rte_key\": \"be3f77894c\",\n  \"thing_keys\": \"af46eec35151abt6546f7ff8t294cf1e8t74e967\",\n  \"timestamp\": 1448517402,\n  \"updated_at\": 1448517402,\n  \"rule_key\": \"4f441ef263\"\n}"],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[]},"thing":{"doc_url":"/apidoc/3.0/thing","api_url":"","name":"Thing","short_description":null,"full_description":"","version":"3.0","formats":null,"metadata":{"order":4},"methods":[{"doc_url":"/apidoc/3.0/thing/index","name":"index","apis":[{"api_url":"/api/v3/things","http_method":"GET","short_description":"List all things","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eReturns a list of all things belonging to an account as per the specified\ncriteria. This API is paginated and returns 20 things by default. A thing\nis uniquely identified by a \u0026#39;thing_key\u0026#39;. This key should be used in\nall the other API referencing a particular thing.\u003c/p\u003e\n","errors":[],"params":[{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number of results to be fetched, Default 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be Integer.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"per","full_name":"per","description":"\n\u003cp\u003eNumber of things records to be returned in one page, Default 20\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be Integer.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order_by","full_name":"order_by","description":"\n\u003cp\u003eField on which resultant things should be sorted\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eOrder, asc or desc, in which results should be sorted\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"things","full_name":"things","description":"\n\u003cp\u003eList of things that should be queried for\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"timestamp_format","full_name":"timestamp_format","description":"\n\u003cp\u003eFormat, “str” or “int”, in which timestamps should be returned, Default\n“int”\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003eKeywords based on which things should be searched. Currently you can search\nthings on - thing_key, name or tag\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"scope","full_name":"scope","description":"\n\u003cp\u003eMatching condition if multiple keywords are specified for search. Valid\nvalues are “all” or “any”. Default is “all”\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"bi_directional","full_name":"bi_directional","description":"\n\u003cp\u003eWhether to return things that have bi-directional support, Default all will\nbe returned\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Boolean","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"expr","full_name":"expr","description":"\n\u003cp\u003eExpression based on user_defined_properties for searching things based on\nuser_defined_properties value\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"pretty","full_name":"pretty","description":"\n\u003cp\u003eReturn a pretty formatted response if true, Default is false\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Boolean","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"group_key","full_name":"group_key","description":"\n\u003cp\u003eReturns things belonging to the specified group\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"thing_template_key","full_name":"thing_template_key","description":"\n\u003cp\u003eReturns things belonging to the specified thing template\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"field_list","full_name":"field_list","description":"\n\u003cp\u003e[Deprecated]Comma separated list of fields required in the result.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"is_oem","full_name":"is_oem","description":"\n\u003cp\u003eReturns things of child accounts along with things of oem account if is_oem\nflag is true.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":["Request - listing all things without any criteria\n  curl -X GET  -H \"Content-Type:application/json\" -H \"X-Auth-Token:WtUFnj8pvSxVnH9e_xkq7A\" https://api.datonis.io/api/v3/things\n\nResponse (returns first 20 records)\n{\n  \"total_count\": 6,\n  \"page\": 1,\n  \"things\": [\n    {\n      \"bi_directional\": true,\n      \"coordinates\": [\n        18.123,\n        73.123\n      ],\n      \"created_at\": 1448363909,\n      \"description\": \"Thing for washing machines\",\n      \"name\": \"Fully Automated Washing Machine\",\n      \"state\": null,\n      \"tags_array\": [\n        \"Pune\"\n      ],\n      \"thing_key\": \"8955641a65\",\n      \"updated_at\": 1448432790,\n      \"user_defined_properties\": {\n        \"Firmware Ver\": \"1.0\",\n        \"STATE\": \"OK\",\n        \"Installation Type\": \"Free Standing\",\n        \"Manufacturer\": \"LG\",\n        \"Color\": \"White\",\n        \"status\": \"green\"\n      },\n      \"alive\": false,\n      \"tags\": \"Pune\",\n      \"last_event\": null,\n      \"last_beat\": null,\n      \"thing_template_name\": \"Washing Machine\",\n      \"thing_template_key\": \"af31ae5fb2\"\n    },\n    {\n      \"bi_directional\": false,\n      \"coordinates\": [\n        20.15,\n        78.09\n      ],\n      \"created_at\": 1448363909,\n      \"description\": \"Thing for washing machines\",\n      \"name\": \"Semi Automated Washing Machine\",\n      \"state\": null,\n      \"tags_array\": [\n        \"Residencial\"\n      ],\n      \"thing_key\": \"f3ba14f785\",\n      \"updated_at\": 1448363909,\n      \"user_defined_properties\": {\n        \"Firmware Ver\": \"1.0\",\n        \"STATE\": \"OK\",\n        \"Installation Type\": \"Free Standing\",\n        \"Manufacturer\": \"LG\",\n        \"Color\": \"Red\"\n      },\n      \"alive\": false,\n      \"tags\": \"Residencial\",\n      \"last_event\": null,\n      \"last_beat\": null,\n      \"thing_template_name\": \"Washing Machine\",\n      \"thing_template_key\": \"af31ae5fb2\"\n    },\n    {...","Request - listing things by specifying number of things to be returned at a time (page size) and specific set to be returned (page)\n  curl -X GET  -H \"Content-Type:application/json\" -H \"X-Auth-Token:WtUFnj8pvSxVnH9e_xkq7A\" -d '{\"per\":\"2\", \"page\":\"2\"}' https://api.datonis.io/api/v3/things\n\nResponse (returns page 2 with 2 things per page)\n{\n  \"total_count\": 6,\n  \"page\": \"2\",\n  \"things\": [\n    {\n      \"bi_directional\": true,\n      \"coordinates\": [\n        22.25,\n        79.99\n      ],\n      \"created_at\": 1448363909,\n      \"description\": \"Thing for Refrigerator\",\n      \"name\": \"French Door Refrigerator\",\n      \"state\": null,\n      \"tags_array\": [\n        \"Residencial\"\n      ],\n      \"thing_key\": \"ad253ccad2\",\n      \"updated_at\": 1448363909,\n      \"user_defined_properties\": {\n        \"Firmware Ver\": \"1.0\",\n        \"STATE\": \"OK\",\n        \"Manufacturer\": \"LG\",\n        \"Color\": \"Red\"\n      },\n      \"alive\": false,\n      \"tags\": \"Residencial\",\n      \"last_event\": null,\n      \"last_beat\": null,\n      \"thing_template_name\": \"Refrigerator\",\n      \"thing_template_key\": \"2a5t58bbt8\"\n    },\n    {\n      \"bi_directional\": false,\n      \"coordinates\": [\n        21.15,\n        79.09\n      ],\n      \"created_at\": 1448363909,\n      \"description\": \"Thing for Refrigerator\",\n      \"name\": \"Ice Maker Refrigerator\",\n      \"state\": null,\n      \"tags_array\": [\n        \"Residencial\"\n      ],\n      \"thing_key\": \"eeccaf4f8a\",\n      \"updated_at\": 1448363909,\n      \"user_defined_properties\": {\n        \"Firmware Ver\": \"1.0\",\n        \"STATE\": \"OK\",\n        \"Manufacturer\": \"LG\",\n        \"Color\": \"White\"\n      },\n      \"alive\": false,\n      \"tags\": \"Residencial\",\n      \"last_event\": null,\n      \"last_beat\": null,\n      \"thing_template_name\": \"Refrigerator\",\n      \"thing_template_key\": \"2a5t58bbt8\"\n    }\n  ]\n}","Request - listing things ordered by a field with string formatted timestamps\n  curl -X GET  -H \"Content-Type:application/json\" -H \"X-Auth-Token:WtUFnj8pvSxVnH9e_xkq7A\" -d '{\"timestamp_format\":\"str\",\"order_by\":\"name\",\"order\":\"desc\"}' https://api.datonis.io/api/v3/things\n\nResponse (returns things in the reverse order of name and timestamps in string format)\n{\n  \"total_count\": 6,\n  \"page\": 1,\n  \"things\": [\n    {\n      \"bi_directional\": false,\n      \"coordinates\": [\n        20.15,\n        78.09\n      ],\n      \"created_at\": \"2015/11/24 11:18:29\",\n      \"description\": \"Thing for Refrigerator\",\n      \"name\": \"Top Fridge Refrigerator\",\n      \"state\": null,\n      \"tags_array\": [\n        \"Residencial\"\n      ],\n      \"thing_key\": \"6b913at941\",\n      \"updated_at\": \"2015/11/24 11:18:29\",\n      \"user_defined_properties\": {\n        \"Firmware Ver\": \"1.0\",\n        \"STATE\": \"OK\",\n        \"Manufacturer\": \"LG\",\n        \"Color\": \"Red\"\n      },\n      \"alive\": false,\n      \"tags\": \"Residencial\",\n      \"last_event\": null,\n      \"last_beat\": null,\n      \"thing_template_name\": \"Refrigerator\",\n      \"thing_template_key\": \"2a5t58bbt8\"\n    },\n    {\n      \"bi_directional\": false,\n      \"coordinates\": [\n        20.15,\n        78.09\n      ],\n      \"created_at\": \"2015/11/24 11:18:29\",\n      \"description\": \"Thing for washing machines\",\n      \"name\": \"Semi Automated Washing Machine\",\n      \"state\": null,\n      \"tags_array\": [\n        \"Residencial\"\n      ],\n      \"thing_key\": \"f3ba14f785\",\n      \"updated_at\": \"2015/11/24 11:18:29\",\n      \"user_defined_properties\": {\n        \"Firmware Ver\": \"1.0\",\n        \"STATE\": \"OK\",\n        \"Installation Type\": \"Free Standing\",\n        \"Manufacturer\": \"LG\",\n        \"Color\": \"Red\"\n      },\n      \"alive\": false,\n      \"tags\": \"Residencial\",\n      \"last_event\": null,\n      \"last_beat\": null,\n      \"thing_template_name\": \"Washing Machine\",\n      \"thing_template_key\": \"af31ae5fb2\"\n    },\n    {\n      \"bi_directional\": false,\n ...","Request - listing things based on some search criteria with all keywords matching\n  curl -X GET  -H \"Content-Type:application/json\" -H \"X-Auth-Token:WtUFnj8pvSxVnH9e_xkq7A\" -d '{\"search\":\"Meter state\"}' https://api.datonis.io/api/v3/things\n\nResponse (returns things containing both keywords 'Meter' as well as 'state')\n{\n  \"total_count\": 1,\n  \"page\": 1,\n  \"things\": [\n    {\n      \"bi_directional\": true,\n      \"coordinates\": [\n        20.15,\n        78.09\n      ],\n      \"created_at\": 1448363909,\n      \"description\": \"Thing for Energy Meters\",\n      \"name\": \"Energy Meter 1\",\n      \"state\": null,\n      \"tags_array\": [\n        \"Residencial\"\n      ],\n      \"thing_key\": \"54ca6t8155\",\n      \"updated_at\": 1448363909,\n      \"user_defined_properties\": {\n        \"Firmware Ver\": \"1.0\",\n        \"STATE\": \"OK\"\n      },\n      \"alive\": false,\n      \"tags\": \"Residencial\",\n      \"last_event\": null,\n      \"last_beat\": null,\n      \"thing_template_name\": \"Energy Meter\",\n      \"thing_template_key\": \"bdb1fd1ae1\"\n    }\n  ]\n}","Request - listing things based on some search criteria with any of the keywords matching\n  curl -X GET  -H \"Content-Type:application/json\" -H \"X-Auth-Token:WtUFnj8pvSxVnH9e_xkq7A\" -d '{\"search\":\"Meter state\",\"scope\":\"any\"}' https://api.datonis.io/api/v3/things\n\nResponse (returns things containing either of the keywords 'Meter' or 'state')\n{\n  \"total_count\": 6,\n  \"page\": 1,\n  \"things\": [\n    {\n      \"bi_directional\": true,\n      \"coordinates\": [\n        18.123,\n        73.123\n      ],\n      \"created_at\": 1448363909,\n      \"description\": \"Thing for washing machines\",\n      \"name\": \"Fully Automated Washing Machine\",\n      \"state\": null,\n      \"tags_array\": [\n        \"Pune\"\n      ],\n      \"thing_key\": \"8955641a65\",\n      \"updated_at\": 1448432790,\n      \"user_defined_properties\": {\n        \"Firmware Ver\": \"1.0\",\n        \"STATE\": \"OK\",\n        \"Installation Type\": \"Free Standing\",\n        \"Manufacturer\": \"LG\",\n        \"Color\": \"White\",\n        \"status\": \"green\"\n      },\n      \"alive\": false,\n      \"tags\": \"Pune\",\n      \"last_event\": null,\n      \"last_beat\": null,\n      \"thing_template_name\": \"Washing Machine\",\n      \"thing_template_key\": \"af31ae5fb2\"\n    },\n    {\n      \"bi_directional\": false,\n      \"coordinates\": [\n        20.15,\n        78.09\n      ],\n      \"created_at\": 1448363909,\n      \"description\": \"Thing for washing machines\",\n      \"name\": \"Semi Automated Washing Machine\",\n      \"state\": null,\n      \"tags_array\": [\n        \"Residencial\"\n      ],\n      \"thing_key\": \"f3ba14f785\",\n      \"updated_at\": 1448363909,\n      \"user_defined_properties\": {\n        \"Firmware Ver\": \"1.0\",\n        \"STATE\": \"OK\",\n        \"Installation Type\": \"Free Standing\",\n        \"Manufacturer\": \"LG\",\n        \"Color\": \"Red\"\n      },\n      \"alive\": false,\n      \"tags\": \"Residencial\",\n      \"last_event\": null,\n      \"last_beat\": null,\n      \"thing_template_name\": \"Washing Machine\",\n      \"thing_template_key\": \"af31ae5fb2\"\n    },\n    {\n      \"bi_directional\": true,\n      \"coordinates\": [\n        22.25,\n        79.99\n      ],\n      \"created_at\": 1448363909,\n      \"description\": \"Thing for Refrigerator\",\n      \"name\": \"French Door Refrigerator\",\n      \"state\": null,\n      \"tags_array\": [\n        \"Residencial\"\n      ],\n      \"thing_key\": \"ad253ccad2\",\n      \"updated_at\": 1448363909,\n      \"user_defined_properties\": {\n        \"Firmware Ver\": \"1.0\",\n        \"STATE\": \"OK\",\n        \"Manufacturer\": \"LG\",\n        \"Color\": \"Red\"\n      },\n      \"alive\": false,\n      \"tags\": \"Residencial\",\n      \"last_event\": null,\n      \"last_beat\": null,\n      \"thing_template_name\": \"Refrigerator\",\n      \"thing_template_key\": \"2a5t58bbt8\"\n    },\n    {\n      \"bi_directional\": false,\n      \"coordinates\": [\n        21.15,\n        79.09\n      ],\n      \"created_at\": 1448363909,\n      \"description\": \"Thing for Refrigerator\",\n      \"name\": \"Ice Maker Refrigerator\",\n      \"state\": null,\n      \"tags_array\": [\n        \"Residencial\"\n      ],\n     ...","Request - listing things based on keys specified\n  curl -X GET  -H \"Content-Type:application/json\" -H \"X-Auth-Token:WtUFnj8pvSxVnH9e_xkq7A\" -d '{\"things\":[\"eeccaf4f8a\",\"f3ba14f785\"]}' https://api.datonis.io/api/v3/things\n\nResponse (returns things matching the keys specified)\n{\n  \"total_count\": 2,\n  \"page\": 1,\n  \"things\": [\n    {\n      \"bi_directional\": false,\n      \"coordinates\": [\n        20.15,\n        78.09\n      ],\n      \"created_at\": 1448363909,\n      \"description\": \"Thing for washing machines\",\n      \"name\": \"Semi Automated Washing Machine\",\n      \"state\": null,\n      \"tags_array\": [\n        \"Residencial\"\n      ],\n      \"thing_key\": \"f3ba14f785\",\n      \"updated_at\": 1448363909,\n      \"user_defined_properties\": {\n        \"Firmware Ver\": \"1.0\",\n        \"STATE\": \"OK\",\n        \"Installation Type\": \"Free Standing\",\n        \"Manufacturer\": \"LG\",\n        \"Color\": \"Red\"\n      },\n      \"alive\": false,\n      \"tags\": \"Residencial\",\n      \"last_event\": null,\n      \"last_beat\": null,\n      \"thing_template_name\": \"Washing Machine\",\n      \"thing_template_key\": \"af31ae5fb2\"\n    },\n    {\n      \"bi_directional\": false,\n      \"coordinates\": [\n        21.15,\n        79.09\n      ],\n      \"created_at\": 1448363909,\n      \"description\": \"Thing for Refrigerator\",\n      \"name\": \"Ice Maker Refrigerator\",\n      \"state\": null,\n      \"tags_array\": [\n        \"Residencial\"\n      ],\n      \"thing_key\": \"eeccaf4f8a\",\n      \"updated_at\": 1448363909,\n      \"user_defined_properties\": {\n        \"Firmware Ver\": \"1.0\",\n        \"STATE\": \"OK\",\n        \"Manufacturer\": \"LG\",\n        \"Color\": \"White\"\n      },\n      \"alive\": false,\n      \"tags\": \"Residencial\",\n      \"last_event\": null,\n      \"last_beat\": null,\n      \"thing_template_name\": \"Refrigerator\",\n      \"thing_template_key\": \"2a5t58bbt8\"\n    }\n  ]\n}","Request - listing things that support bi directional communication\n  curl -X GET  -H \"Content-Type:application/json\" -H \"X-Auth-Token:WtUFnj8pvSxVnH9e_xkq7A\" -d '{\"bi_directional\":true}' https://api.datonis.io/api/v3/things\n\nResponse (returns things that support bi_directional communication)\n{\n  \"total_count\": 3,\n  \"page\": 1,\n  \"things\": [\n    {\n      \"bi_directional\": true,\n      \"coordinates\": [\n        18.123,\n        73.123\n      ],\n      \"created_at\": 1448363909,\n      \"description\": \"Thing for washing machines\",\n      \"name\": \"Fully Automated Washing Machine\",\n      \"state\": null,\n      \"tags_array\": [\n        \"Pune\"\n      ],\n      \"thing_key\": \"8955641a65\",\n      \"updated_at\": 1448432790,\n      \"user_defined_properties\": {\n        \"Firmware Ver\": \"1.0\",\n        \"STATE\": \"OK\",\n        \"Installation Type\": \"Free Standing\",\n        \"Manufacturer\": \"LG\",\n        \"Color\": \"White\",\n        \"status\": \"green\"\n      },\n      \"alive\": false,\n      \"tags\": \"Pune\",\n      \"last_event\": null,\n      \"last_beat\": null,\n      \"thing_template_name\": \"Washing Machine\",\n      \"thing_template_key\": \"af31ae5fb2\"\n    },\n    {\n      \"bi_directional\": true,\n      \"coordinates\": [\n        22.25,\n        79.99\n      ],\n      \"created_at\": 1448363909,\n      \"description\": \"Thing for Refrigerator\",\n      \"name\": \"French Door Refrigerator\",\n      \"state\": null,\n      \"tags_array\": [\n        \"Residencial\"\n      ],\n      \"thing_key\": \"ad253ccad2\",\n      \"updated_at\": 1448363909,\n      \"user_defined_properties\": {\n        \"Firmware Ver\": \"1.0\",\n        \"STATE\": \"OK\",\n        \"Manufacturer\": \"LG\",\n        \"Color\": \"Red\"\n      },\n      \"alive\": false,\n      \"tags\": \"Residencial\",\n      \"last_event\": null,\n      \"last_beat\": null,\n      \"thing_template_name\": \"Refrigerator\",\n      \"thing_template_key\": \"2a5t58bbt8\"\n    },\n    {\n      \"bi_directional\": true,\n      \"coordinates\": [\n      ...","Request - listing things based on given expression for user_defined_properties\n  curl -X GET  -H \"Content-Type:application/json\" -H \"X-Auth-Token:WtUFnj8pvSxVnH9e_xkq7A\" -d '{\"expr\":\"this.user_defined_properties.Color=='\"'Red'\"'\"}' https://api.datonis.io/api/v3/things\n\nResponse (returns things after evaluating expression based on user_defined_properties)\n{\n  \"total_count\": 3,\n  \"page\": 1,\n  \"things\": [\n    {\n      \"bi_directional\": false,\n      \"coordinates\": [\n        20.15,\n        78.09\n      ],\n      \"created_at\": 1448363909,\n      \"description\": \"Thing for washing machines\",\n      \"name\": \"Semi Automated Washing Machine\",\n      \"state\": null,\n      \"tags_array\": [\n        \"Residencial\"\n      ],\n      \"thing_key\": \"f3ba14f785\",\n      \"updated_at\": 1448363909,\n      \"user_defined_properties\": {\n        \"Firmware Ver\": \"1.0\",\n        \"STATE\": \"OK\",\n        \"Installation Type\": \"Free Standing\",\n        \"Manufacturer\": \"LG\",\n        \"Color\": \"Red\"\n      },\n      \"alive\": false,\n      \"tags\": \"Residencial\",\n      \"last_event\": null,\n      \"last_beat\": null,\n      \"thing_template_name\": \"Washing Machine\",\n      \"thing_template_key\": \"af31ae5fb2\"\n    },\n    {\n      \"bi_directional\": true,\n      \"coordinates\": [\n        22.25,\n        79.99\n      ],\n      \"created_at\": 1448363909,\n      \"description\": \"Thing for Refrigerator\",\n      \"name\": \"French Door Refrigerator\",\n      \"state\": null,\n      \"tags_array\": [\n        \"Residencial\"\n      ],\n      \"thing_key\": \"ad253ccad2\",\n      \"updated_at\": 1448363909,\n      \"user_defined_properties\": {\n        \"Firmware Ver\": \"1.0\",\n        \"STATE\": \"OK\",\n        \"Manufacturer\": \"LG\",\n        \"Color\": \"Red\"\n      },\n      \"alive\": false,\n      \"tags\": \"Residencial\",\n      \"last_event\": null,\n      \"last_beat\": null,\n      \"thing_template_name\": \"Refrigerator\",\n      \"thing_template_key\": \"2a5t58bbt8\"\n    },\n    {\n      \"bi_directional\": false,\n      \"coordinates\": [\n        20.15,\n       ...","Request - listing things that belong to a group\n  curl -X GET  -H \"Content-Type:application/json\" -H \"X-Auth-Token:WtUFnj8pvSxVnH9e_xkq7A\" -d '{\"group_key\":\"6fdd6c9ef8\"}' https://api.datonis.io/api/v3/things\n\nResponse (returns things belonging to the specified group)\n{\n  \"total_count\": 1,\n  \"page\": 1,\n  \"things\": [\n    {\n      \"bi_directional\": true,\n      \"coordinates\": [\n        18.123,\n        73.123\n      ],\n      \"created_at\": 1448363909,\n      \"description\": \"Thing for washing machines\",\n      \"name\": \"Fully Automated Washing Machine\",\n      \"state\": null,\n      \"tags_array\": [\n        \"Pune\"\n      ],\n      \"thing_key\": \"8955641a65\",\n      \"updated_at\": 1448432790,\n      \"user_defined_properties\": {\n        \"Firmware Ver\": \"1.0\",\n        \"STATE\": \"OK\",\n        \"Installation Type\": \"Free Standing\",\n        \"Manufacturer\": \"LG\",\n        \"Color\": \"White\",\n        \"status\": \"green\"\n      },\n      \"alive\": false,\n      \"tags\": \"Pune\",\n      \"last_event\": null,\n      \"last_beat\": null,\n      \"thing_template_name\": \"Washing Machine\",\n      \"thing_template_key\": \"af31ae5fb2\"\n    }\n  ]\n}"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/3.0/thing/create","name":"create","apis":[{"api_url":"/api/v3/things","http_method":"POST","short_description":"Create a thing","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eCreates a thing with given parameters\u003c/p\u003e\n","errors":[],"params":[{"name":"thing","full_name":"thing","description":"\n\u003cp\u003eObject containing information about the thing to be created\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[]},{"name":"pretty","full_name":"pretty","description":"\n\u003cp\u003eReturn a pretty formatted response if true, Default is false\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Boolean","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"is_oem","full_name":"is_oem","description":"\n\u003cp\u003eCreate thing in child account by oem user if is_oem flag is true.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Boolean","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"child_organisation_key","full_name":"child_organisation_key","description":"\n\u003cp\u003eOrganisation key of child account where oem user wants to create thing.\nRequired field if is_oem is present.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":["Request\n  curl -X POST -H \"Content-Type:application/json\" -H \"X-Auth-Token:WtUFnj8pvSxVnH9e_xkq7A\" -d '{\"thing\":{\"name\":\"Fully Automated Washing Machine\",\"description\":\"Thing for washing machines\",\"user_defined_properties\":{\"Firmware Ver\":\"1.0\",\"STATE\":\"OK\",\"Installation Type\":\"Free Standing\",\"Manufacturer\":\"LG\",\"Color\":\"White\"},\"bi_directional\":\"true\",\"tags\":\"Corporate\",\"coordinates\":[21.15,79.09]},\"thing_template_key\":\"af31ae5fb2\"}' https://api.datonis.io/api/v3/things\n\nResponse (returns details of the thing created)\n{\n  \"thing\": {\n    \"bi_directional\": true,\n    \"coordinates\": [\n      21.15,\n      79.09\n    ],\n    \"created_at\": 1448363909,\n    \"description\": \"Thing for washing machines\",\n    \"name\": \"Fully Automated Washing Machine\",\n    \"state\": null,\n    \"tags_array\": [\n      \"Corporate\"\n    ],\n    \"thing_key\": \"8955641a65\",\n    \"updated_at\": 1448363909,\n    \"user_defined_properties\": {\n      \"Firmware Ver\": \"1.0\",\n      \"STATE\": \"OK\",\n      \"Installation Type\": \"Free Standing\",\n      \"Manufacturer\": \"LG\",\n      \"Color\": \"White\"\n    },\n    \"alive\": false,\n    \"tags\": \"Corporate\",\n    \"last_event\": null,\n    \"last_beat\": null,\n    \"thing_template_name\": \"Washing Machine\",\n    \"thing_template_key\": \"af31ae5fb2\"\n  }\n}"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/3.0/thing/show","name":"show","apis":[{"api_url":"/api/v3/things/:thing_key","http_method":"GET","short_description":"Fetch information for a thing","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eReturns details of the thing requested\u003c/p\u003e\n","errors":[],"params":[{"name":"pretty","full_name":"pretty","description":"\n\u003cp\u003eReturn a pretty formatted response if true, Default is false\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Boolean","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"is_oem","full_name":"is_oem","description":"\n\u003cp\u003eShow thing of child account if is_oem flag is true.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":["Request - get details of the specified thing (thing_key specified as a part of the url)\n  curl -X GET  -H \"Content-Type:application/json\" -H \"X-Auth-Token:WtUFnj8pvSxVnH9e_xkq7A\"  https://api.datonis.io/api/v3/things/8955641a65\n\nResponse (returns details of the thing requested)\n{\n  \"thing\": {\n    \"bi_directional\": true,\n    \"coordinates\": [\n      21.15,\n      79.09\n    ],\n    \"created_at\": 1448363909,\n    \"description\": \"Thing for washing machines\",\n    \"name\": \"Fully Automated Washing Machine\",\n    \"state\": null,\n    \"tags_array\": [\n      \"Corporate\"\n    ],\n    \"thing_key\": \"8955641a65\",\n    \"updated_at\": 1448363909,\n    \"user_defined_properties\": {\n      \"Firmware Ver\": \"1.0\",\n      \"STATE\": \"OK\",\n      \"Installation Type\": \"Free Standing\",\n      \"Manufacturer\": \"LG\",\n      \"Color\": \"White\"\n    },\n    \"alive\": false,\n    \"tags\": \"Corporate\",\n    \"last_event\": null,\n    \"last_beat\": null,\n    \"thing_template_name\": \"Washing Machine\",\n    \"thing_template_key\": \"af31ae5fb2\"\n  }\n}"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/3.0/thing/update","name":"update","apis":[{"api_url":"/api/v3/things/:thing_key","http_method":"PUT","short_description":"Updates a thing","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eUpdates a thing with given parameters\u003c/p\u003e\n","errors":[],"params":[{"name":"thing","full_name":"thing","description":"\n\u003cp\u003eObject containing information about the thing to be updated\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[]},{"name":"pretty","full_name":"pretty","description":"\n\u003cp\u003eReturn a pretty formatted response if true, Default is false\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Boolean","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"is_oem","full_name":"is_oem","description":"\n\u003cp\u003eUpdate thing in child account by oem user if is_oem flag is true.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Boolean","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":["Request - containing parameters to be modified\n  curl -X PUT -H \"Content-Type:application/json\" -H \"X-Auth-Token:WtUFnj8pvSxVnH9e_xkq7A\" -d '{\"thing\":{\"tags\":\"Pune\",\"coordinates\":[18.123,73.123]}}' https://api.datonis.io/api/v3/things/8955641a65\n\nResponse (returns details of the thing updated)\n{\n  \"thing\": {\n    \"bi_directional\": true,\n    \"coordinates\": [\n      18.123,\n      73.123\n    ],\n    \"created_at\": 1448363909,\n    \"description\": \"Thing for washing machines\",\n    \"name\": \"Fully Automated Washing Machine\",\n    \"state\": null,\n    \"tags_array\": [\n      \"Pune\"\n    ],\n    \"thing_key\": \"8955641a65\",\n    \"updated_at\": 1448432116,\n    \"user_defined_properties\": {\n      \"Firmware Ver\": \"1.0\",\n      \"STATE\": \"OK\",\n      \"Installation Type\": \"Free Standing\",\n      \"Manufacturer\": \"LG\",\n      \"Color\": \"White\"\n    },\n    \"alive\": false,\n    \"tags\": \"Pune\",\n    \"last_event\": null,\n    \"last_beat\": null,\n    \"thing_template_name\": \"Washing Machine\",\n    \"thing_template_key\": \"af31ae5fb2\"\n  }\n}"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/3.0/thing/destroy","name":"destroy","apis":[{"api_url":"/api/v3/things/:thing_key","http_method":"DELETE","short_description":"Delete a thing","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eDeletes the specified thing from the system. All associated data is also\nlost.\u003c/p\u003e\n","errors":[],"params":[{"name":"pretty","full_name":"pretty","description":"\n\u003cp\u003eReturn a pretty formatted response if true, Default is false\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Boolean","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"is_oem","full_name":"is_oem","description":"\n\u003cp\u003eDelete thing in child account by oem user if is_oem flag is true.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Boolean","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":["Request\n  curl -X DELETE -H \"Content-Type:application/json\" -H \"X-Auth-Token:WtUFnj8pvSxVnH9e_xkq7A\"  https://api.datonis.io/api/v3/things/8955641a65\n\nResponse\n{\n}"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/3.0/thing/tag","name":"tag","apis":[{"api_url":"/api/v3/things/:thing_key/tag","http_method":"PUT","short_description":"Adds tags to a thing","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eAdds specified tags to an existing list of tags for a thing\u003c/p\u003e\n","errors":[],"params":[{"name":"tags","full_name":"tags","description":"\n\u003cp\u003eComma separated list of tags to be added to the thing\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"pretty","full_name":"pretty","description":"\n\u003cp\u003eReturn a pretty formatted response if true, Default is false\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Boolean","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"is_oem","full_name":"is_oem","description":"\n\u003cp\u003eAdd tag in thing of child account by oem user if is_oem flag is true.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Boolean","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":["Request - containing the list of tags to be added\n  curl -X PUT -H \"Content-Type:application/json\" -H \"X-Auth-Token:WtUFnj8pvSxVnH9e_xkq7A\" -d '{\"tags\":\"Baner,automatic\"}' https://api.datonis.io/api/v3/things/8955641a65/tag\n\nResponse (returns details of the thing with updated tags)\n{\n  \"thing\": {\n    \"bi_directional\": true,\n    \"coordinates\": [\n      18.123,\n      73.123\n    ],\n    \"created_at\": 1448363909,\n    \"description\": \"Thing for washing machines\",\n    \"name\": \"Fully Automated Washing Machine\",\n    \"state\": null,\n    \"tags_array\": [\n      \"Pune\",\n      \"Baner\",\n      \"automatic\"\n    ],\n    \"thing_key\": \"8955641a65\",\n    \"updated_at\": 1448432329,\n    \"user_defined_properties\": {\n      \"Firmware Ver\": \"1.0\",\n      \"STATE\": \"OK\",\n      \"Installation Type\": \"Free Standing\",\n      \"Manufacturer\": \"LG\",\n      \"Color\": \"White\"\n    },\n    \"alive\": false,\n    \"tags\":..."],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/3.0/thing/untag","name":"untag","apis":[{"api_url":"/api/v3/things/:thing_key/untag","http_method":"PUT","short_description":"Removes tags from a thing","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eRemoves specified tags from the list of tags associated with a thing\u003c/p\u003e\n","errors":[],"params":[{"name":"tags","full_name":"tags","description":"\n\u003cp\u003eComma separated list of tags to be removed from the thing\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"pretty","full_name":"pretty","description":"\n\u003cp\u003eReturn a pretty formatted response if true, Default is false\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Boolean","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"is_oem","full_name":"is_oem","description":"\n\u003cp\u003eRemove tag from thing of child account by oem user if is_oem flag is true.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Boolean","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":["Request - containing the list of tags to be removed\n  curl -X PUT -H \"Content-Type:application/json\" -H \"X-Auth-Token:WtUFnj8pvSxVnH9e_xkq7A\" -d '{\"tags\":\"Baner,automatic\"}' https://api.datonis.io/api/v3/things/8955641a65/untag\n\nResponse (returns details of the thing with updated tags)\n{\n  \"thing\": {\n    \"bi_directional\": true,\n    \"coordinates\": [\n      18.123,\n      73.123\n    ],\n    \"created_at\": 1448363909,\n    \"description\": \"Thing for washing machines\",\n    \"name\": \"Fully Automated Washing Machine\",\n    \"state\": null,\n    \"tags_array\": [\n      \"Pune\"\n    ],\n    \"thing_key\": \"8955641a65\",\n    \"updated_at\": 1448432412,\n    \"user_defined_properties\": {\n      \"Firmware Ver\": \"1.0\",\n      \"STATE\": \"OK\",\n      \"Installation Type\": \"Free Standing\",\n      \"Manufacturer\": \"LG\",\n      \"Color\": \"White\"\n    },\n    \"alive\": false,\n    \"tags\": \"Pune\",\n    \"last_event\": null,\n   ..."],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/3.0/thing/set_user_defined_properties","name":"set_user_defined_properties","apis":[{"api_url":"/api/v3/things/:thing_key/set_user_defined_properties","http_method":"PUT","short_description":"Set user defined user_defined_properties (properties) on a thing","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eAdds specified user defined properties on a thing\u003c/p\u003e\n","errors":[],"params":[{"name":"user_defined_properties","full_name":"user_defined_properties","description":"\n\u003cp\u003emap of key value pairs to be set\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[]},{"name":"pretty","full_name":"pretty","description":"\n\u003cp\u003eReturn a pretty formatted response if true, Default is false\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Boolean","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"is_oem","full_name":"is_oem","description":"\n\u003cp\u003eAdd user defined properties in thing of child account by oem user if is_oem\nflag is true.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Boolean","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":["Request - containing user defined properties to be added\n  curl -X PUT -H \"Content-Type:application/json\" -H \"X-Auth-Token:WtUFnj8pvSxVnH9e_xkq7A\"  -d '{\"user_defined_properties\":{\"status\":\"green\",\"customer_code\":13433}}' https://api.datonis.io/api/v3/things/8955641a65/set_user_defined_properties\n\nResponse (returns details of the thing with updated user_defined_properties (properties))\n{\n  \"thing\": {\n    \"bi_directional\": true,\n    \"coordinates\": [\n      18.123,\n      73.123\n    ],\n    \"created_at\": 1448363909,\n    \"description\": \"Thing for washing machines\",\n    \"name\": \"Fully Automated Washing Machine\",\n    \"state\": null,\n    \"tags_array\": [\n      \"Pune\"\n    ],\n    \"thing_key\": \"8955641a65\",\n    \"updated_at\": 1448432550,\n    \"user_defined_properties\": {\n      \"Firmware Ver\": \"1.0\",\n      \"STATE\": \"OK\",\n      \"Installation Type\": \"Free Standing\",\n      \"Manufacturer\": \"LG\",\n      \"Color\": \"White\",\n      \"status\": \"green\",\n      \"customer_code\": 13433\n    },\n    \"alive\": false,\n    \"tags\": \"Pune\",\n    \"last_event\": null,\n    \"last_beat\": null,\n    \"thing_template_name\": \"Washing Machine\",\n    \"thing_template_key\": \"af31ae5fb2\"\n  }\n}"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/3.0/thing/remove_user_defined_properties","name":"remove_user_defined_properties","apis":[{"api_url":"/api/v3/things/:thing_key/remove_user_defined_properties","http_method":"PUT","short_description":"Remove user defined properties on a thing","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eRemoves specified user defined properties on a thing\u003c/p\u003e\n","errors":[],"params":[{"name":"user_defined_properties","full_name":"user_defined_properties","description":"\n\u003cp\u003eList of user_defined_properties keys to be removed\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"pretty","full_name":"pretty","description":"\n\u003cp\u003eReturn a pretty formatted response if true, Default is false\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Boolean","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"is_oem","full_name":"is_oem","description":"\n\u003cp\u003eRemove user defined properties in thing of child account by oem user if\nis_oem flag is true.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Boolean","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":["Request - containing user defined properties to be removed\n  curl -X PUT -H \"Content-Type:application/json\" -H \"X-Auth-Token:WtUFnj8pvSxVnH9e_xkq7A\"  -d '{\"user_defined_properties\":[\"customer_code\"]}' https://api.datonis.io/api/v3/things/8955641a65/remove_user_defined_properties\n\nResponse (returns details of the thing with updated user_defined_properties (properties))\n{\n  \"thing\": {\n    \"bi_directional\": true,\n    \"coordinates\": [\n      18.123,\n      73.123\n    ],\n    \"created_at\": 1448363909,\n    \"description\": \"Thing for washing machines\",\n    \"name\": \"Fully Automated Washing Machine\",\n    \"state\": null,\n    \"tags_array\": [\n      \"Pune\"\n    ],\n    \"thing_key\": \"8955641a65\",\n    \"updated_at\": 1448432790,\n    \"user_defined_properties\": {\n      \"Firmware Ver\": \"1.0\",\n      \"STATE\": \"OK\",\n      \"Installation Type\": \"Free Standing\",\n      \"Manufacturer\": \"LG\",\n      \"Color\": \"White\",\n      \"status\": \"green\"\n    },\n    \"alive\": false,\n    \"tags\": \"Pune\",\n    \"last_event\": null,\n    \"last_beat\": null,\n    \"thing_template_name\": \"Washing Machine\",\n    \"thing_template_key\": \"af31ae5fb2\"\n  }\n}"],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[]},"thing_template":{"doc_url":"/apidoc/3.0/thing_template","api_url":"","name":"Thing template","short_description":null,"full_description":"","version":"3.0","formats":null,"metadata":{"order":2},"methods":[{"doc_url":"/apidoc/3.0/thing_template/index","name":"index","apis":[{"api_url":"/api/v3/thing_templates","http_method":"GET","short_description":"List all thing templates","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eReturns a list of all thing templates belonging to an account as per the\nspecified criteria. This API is paginated and returns 20 thing templates by\ndefault. An thing template is uniquely identified by an\n\u0026#39;thing_template_key\u0026#39;. This key should be used in all the other API\nreferencing a particular thing template.\u003c/p\u003e\n","errors":[],"params":[{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number of results to be fetched, Default 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be Integer.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"per","full_name":"per","description":"\n\u003cp\u003eNumber of thing templates to be returned in one page, Default 20\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be Integer.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order_by","full_name":"order_by","description":"\n\u003cp\u003eField on which thing templates should be sorted\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eOrder, “asc” or “desc”, in which results should be sorted\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003eKeywords based on which thing templates should be searched. Currently you\ncan search thing templates on - thing_template_key, name, tags or\nuser_defined_properties\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"scope","full_name":"scope","description":"\n\u003cp\u003eMatching condition if multiple keywords are specified for search. Valid\nvalues are “all” or “any”. Default is “all”\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"timestamp_format","full_name":"timestamp_format","description":"\n\u003cp\u003eFormat, “str” or “int”, in which timestamps should be returned, Default\n“int”\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"pretty","full_name":"pretty","description":"\n\u003cp\u003eReturn a pretty formatted response if true, Default is false\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Boolean","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"field_list","full_name":"field_list","description":"\n\u003cp\u003eList of fields required in the result.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"is_oem","full_name":"is_oem","description":"\n\u003cp\u003eReturn thing templates of child accounts along with thing templates of oem\naccount if is_oem flag is true.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":["Request - listing all thing templates without any criteria\n  curl -X GET -H \"Content-Type:application/json\" -H \"X-Auth-Token:olezAZXGQn9MutnfNerKDQ\" https://api.datonis.io/api/v3/thing_templates\n\nResponse (returns first 20 records)\n{\n  \"total_count\": 3,\n  \"page\": 1,\n  \"thing_templates\": [\n    {\n      \"created_at\": 1448361986,\n      \"description\": \"Template for Refrigerators\",\n      \"name\": \"Refrigerator\",\n      \"thing_template_key\": \"2a5t58bbt8\",\n      \"updated_at\": 1448361986,\n      \"user_defined_properties\": {\n        \"Firmware Ver\": \"1.0\",\n        \"STATE\": \"OK\"\n      },\n      \"metrics\": [\n        {\n          \"metric_key\": \"d3tdc136b3\",\n          \"metric_name\": \"temperature\"\n        },\n        {\n          \"metric_key\": \"b44c32be53\",\n          \"metric_name\": \"power\"\n        },\n        {\n          \"metric_key\": \"c6a86c8576\",\n          \"metric_name\": \"voltage\"\n        }\n      ]\n    },\n    {\n      \"created_at\": 1448361987,\n      \"description\": \"Template for washing...","Request - listing thing templates by specifying number of thing templates to be returned at a time (page size) and specific set to be returned (page)\n  curl -X GET -H \"Content-Type:application/json\" -H \"X-Auth-Token:olezAZXGQn9MutnfNerKDQ\" -d '{\"per\":\"2\",\"page\":\"2\"}' https://api.datonis.io/api/v3/thing_templates\n\nResponse (returns page 2 with 2 thing templates per page)\n{\n  \"total_count\": 3,\n  \"page\": \"2\",\n  \"thing_templates\": [\n    {\n      \"created_at\": 1448361987,\n      \"description\": \"Template for Energy Meters\",\n      \"name\": \"Energy Meter\",\n      \"thing_template_key\": \"bdb1fd1ae1\",\n      \"updated_at\": 1448361987,\n      \"user_defined_properties\": {\n        \"Firmware Ver\": \"1.0\",\n        \"STATE\": \"OK\"\n      },\n      \"metrics\": [\n        {\n          \"metric_key\": \"3et13bet93\",\n          \"metric_name\": \"consumption\"\n        },\n        {\n          \"metric_key\": \"ef15ed79t1\",\n          \"metric_name\": \"voltage\"\n        },\n        {\n          \"metric_key\": \"caf425fb7f\",\n          \"metric_name\": \"current\"\n        }\n      ]\n    }\n  ]\n}","Request - listing thing templates ordered by a field with string formatted timestamps\n  curl -X GET -H \"Content-Type:application/json\" -H \"X-Auth-Token:olezAZXGQn9MutnfNerKDQ\" -d '{\"timestamp_format\":\"str\",\"order_by\":\"name\",\"order\":\"desc\"}' https://api.datonis.io/api/v3/thing_templates\n\nResponse (returns thing templates in the reverse order of their name and timestamps in string format)\n{\n  \"total_count\": 3,\n  \"page\": 1,\n  \"thing_templates\": [\n    {\n      \"created_at\": \"2015/11/24 10:46:27\",\n      \"description\": \"Template for washing machines\",\n      \"name\": \"Washing Machine\",\n      \"thing_template_key\": \"af31ae5fb2\",\n      \"updated_at\": \"2015/11/24 10:46:27\",\n      \"user_defined_properties\": {\n        \"Firmware Ver\": \"1.0\",\n        \"STATE\": \"OK\"\n      },\n      \"metrics\": [\n        {\n          \"metric_key\": \"4f9b9764t7\",\n          \"metric_name\": \"capacity\"\n        },\n        {\n          \"metric_key\": \"4tb363cc88\",\n          \"metric_name\": \"maximum_rotational_speed\"\n        },\n        {\n          \"metric_key\": \"278t29123d\",\n          \"metric_name\": \"noise_level\"\n        },\n        {\n          \"metric_key\": \"492c52bf56\",\n...","Request - listing thing templates based on some search criteria with all keywords matching\n  curl -X GET -H \"Content-Type:application/json\" -H \"X-Auth-Token:olezAZXGQn9MutnfNerKDQ\" -d '{\"search\":\"refrigerator state\"}' https://api.datonis.io/api/v3/thing_templates\n\nResponse (returns thing templates containing both keywords 'refrigerator' as well as 'state')\n{\n  \"total_count\": 1,\n  \"page\": 1,\n  \"thing_templates\": [\n    {\n      \"created_at\": 1448361986,\n      \"description\": \"Template for Refrigerators\",\n      \"name\": \"Refrigerator\",\n      \"thing_template_key\": \"2a5t58bbt8\",\n      \"updated_at\": 1448361986,\n      \"user_defined_properties\": {\n        \"Firmware Ver\": \"1.0\",\n        \"STATE\": \"OK\"\n      },\n      \"metrics\": [\n        {\n          \"metric_key\": \"d3tdc136b3\",\n          \"metric_name\": \"temperature\"\n        },\n        {\n          \"metric_key\": \"b44c32be53\",\n          \"metric_name\": \"power\"\n        },\n        {\n          \"metric_key\": \"c6a86c8576\",\n          \"metric_name\": \"voltage\"\n        }\n      ]\n    }\n  ]\n}","Request - listing thing templates based on some search criteria with any of the keywords matching\n  curl -X GET -H \"Content-Type:application/json\" -H \"X-Auth-Token:olezAZXGQn9MutnfNerKDQ\" -d '{\"search\":\"refrigerator state\",\"scope\":\"any\"}' https://api.datonis.io/api/v3/thing_templates\n\nResponse (returns thing templates containing either of the keywords 'refrigerator' or 'state')\n{\n  \"total_count\": 3,\n  \"page\": 1,\n  \"thing_templates\": [\n    {\n      \"created_at\": 1448361986,\n      \"description\": \"Template for Refrigerators\",\n      \"name\": \"Refrigerator\",\n      \"thing_template_key\": \"2a5t58bbt8\",\n      \"updated_at\": 1448361986,\n      \"user_defined_properties\": {\n        \"Firmware Ver\": \"1.0\",\n        \"STATE\": \"OK\"\n      },\n      \"metrics\": [\n        {\n          \"metric_key\": \"d3tdc136b3\",\n          \"metric_name\": \"temperature\"\n        },\n        {\n          \"metric_key\": \"b44c32be53\",\n          \"metric_name\": \"power\"\n        },\n        {\n          \"metric_key\": \"c6a86c8576\",\n          \"metric_name\": \"voltage\"\n        }\n      ]\n    },\n    {\n      \"created_at\": 1448361987,\n      \"description\": \"Template for washing machines\",\n      \"name\": \"Washing Machine\",\n      \"thing_template_key\": \"af31ae5fb2\",\n      \"updated_at\": 1448361987,\n      \"user_defined_properties\":..."],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/3.0/thing_template/create","name":"create","apis":[{"api_url":"/api/v3/thing_templates","http_method":"POST","short_description":"Create an thing template","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eCreates an thing template with given parameters\u003c/p\u003e\n","errors":[],"params":[{"name":"thing_template","full_name":"thing_template","description":"\n\u003cp\u003eMap containing details of the thing template to be created\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[]},{"name":"pretty","full_name":"pretty","description":"\n\u003cp\u003eReturn a pretty formatted response if true, Default is false\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Boolean","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"is_oem","full_name":"is_oem","description":"\n\u003cp\u003eCreate thing template in child account by oem user if is_oem flag is true.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Boolean","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"child_organisation_key","full_name":"child_organisation_key","description":"\n\u003cp\u003eOrganisation key of child account where oem user wants to create thing\ntemplate. Required field if is_oem is present.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":["Request\n  curl -X POST -H \"Content-Type:application/json\" -H \"X-Auth-Token:olezAZXGQn9MutnfNerKDQ\"  -d '{\"thing_template\":{\"name\":\"Refrigerator\",\"description\":\"Template for Refrigerators\",\"user_defined_properties\":{\"Firmware Ver\":\"1.0\",\"STATE\":\"OK\"}}}' https://api.datonis.io/api/v3/thing_templates\n\nResponse (containing details of the thing template created)\n{\n  \"thing_template\": {\n    \"created_at\": 1448361986,\n    \"description\": \"Template for Refrigerators\",\n    \"name\": \"Refrigerator\",\n    \"thing_template_key\": \"2a5t58bbt8\",\n    \"updated_at\": 1448361986,\n    \"user_defined_properties\": {\n      \"Firmware Ver\": \"1.0\",\n      \"STATE\": \"OK\"\n    },\n    \"metrics\": [\n\n    ]\n  }\n}"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/3.0/thing_template/show","name":"show","apis":[{"api_url":"/api/v3/thing_templates/:thing_template_key","http_method":"GET","short_description":"Fetch an thing template","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eGet details of an thing template\u003c/p\u003e\n","errors":[],"params":[{"name":"pretty","full_name":"pretty","description":"\n\u003cp\u003eReturn a pretty formatted response if true, Default is false\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Boolean","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"is_oem","full_name":"is_oem","description":"\n\u003cp\u003eShow thing template of child account if is_oem flag is true.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":["Request\n  curl -X GET -H \"Content-Type:application/json\" -H \"X-Auth-Token:olezAZXGQn9MutnfNerKDQ\"  https://api.datonis.io/api/v3/thing_templates/2a5t58bbt8\n\nResponse (containing details of the thing template)\n{\n  \"thing_template\": {\n    \"created_at\": 1448361986,\n    \"description\": \"Template for Refrigerators\",\n    \"name\": \"Refrigerator\",\n    \"thing_template_key\": \"2a5t58bbt8\",\n    \"updated_at\": 1448361986,\n    \"user_defined_properties\": {\n      \"Firmware Ver\": \"1.0\",\n      \"STATE\": \"OK\"\n    },\n    \"metrics\": [\n      {\n        \"metric_key\": \"d3tdc136b3\",\n        \"metric_name\": \"temperature\"\n      },\n      {\n        \"metric_key\": \"b44c32be53\",\n        \"metric_name\": \"power\"\n      },\n      {\n        \"metric_key\": \"c6a86c8576\",\n        \"metric_name\": \"voltage\"\n      }\n    ]\n  }\n}"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/3.0/thing_template/update","name":"update","apis":[{"api_url":"/api/v3/thing_templates/:thing_template_key","http_method":"PUT","short_description":"Update an thing template","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eUpdates an thing template with given parameters\u003c/p\u003e\n","errors":[],"params":[{"name":"thing_template","full_name":"thing_template","description":"\n\u003cp\u003eMap containing details of the thing template to be updated\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[]},{"name":"pretty","full_name":"pretty","description":"\n\u003cp\u003eReturn a pretty formatted response if true, Default is false\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Boolean","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"is_oem","full_name":"is_oem","description":"\n\u003cp\u003eUpdate thing template in child account by oem user if is_oem flag is true.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Boolean","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":["Request\n  curl -X PUT -H \"Content-Type:application/json\" -H \"X-Auth-Token:olezAZXGQn9MutnfNerKDQ\"  -d '{\"thing_template\":{\"description\":\"Thing Template for Refrigerators\"}}' https://api.datonis.io/api/v3/thing_templates/2a5t58bbt8\n\nResponse (containing details of the thing template updated)\n{\n  \"thing_template\": {\n    \"created_at\": 1448361986,\n    \"description\": \"Thing Template for Refrigerators\",\n    \"name\": \"Refrigerator\",\n    \"thing_template_key\": \"2a5t58bbt8\",\n    \"updated_at\": 1448366573,\n    \"user_defined_properties\": {\n      \"Firmware Ver\": \"1.0\",\n      \"STATE\": \"OK\"\n    },\n    \"metrics\": [\n      {\n        \"metric_key\": \"d3tdc136b3\",\n        \"metric_name\": \"temperature\"\n      },\n      {\n        \"metric_key\": \"b44c32be53\",\n        \"metric_name\": \"power\"\n      },\n      {\n        \"metric_key\": \"c6a86c8576\",\n        \"metric_name\": \"voltage\"\n      }\n    ]\n  }\n}"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/3.0/thing_template/destroy","name":"destroy","apis":[{"api_url":"/api/v3/thing_templates/:thing_template_key","http_method":"DELETE","short_description":"Delete an thing template","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eDeletes an thing template from the system and also deletes its dependent\nthings and metrics\u003c/p\u003e\n","errors":[],"params":[{"name":"pretty","full_name":"pretty","description":"\n\u003cp\u003eReturn a pretty formatted response if true, Default is false\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Boolean","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"is_oem","full_name":"is_oem","description":"\n\u003cp\u003eDelete thing template in child account by oem user if is_oem flag is true.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Boolean","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":["Request\n  curl -X DELETE -H \"Content-Type:application/json\" -H \"X-Auth-Token:olezAZXGQn9MutnfNerKDQ\"  https://api.datonis.io/api/v3/thing_templates/2a5t58bbt8\n\nResponse\n{\n}"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/3.0/thing_template/set_user_defined_properties","name":"set_user_defined_properties","apis":[{"api_url":"/api/v3/thing_templates/:thing_template_key/set_user_defined_properties","http_method":"PUT","short_description":"Set user defined properties on a thing template","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eAdds specified user defined properties on a thing template\u003c/p\u003e\n","errors":[],"params":[{"name":"user_defined_properties","full_name":"user_defined_properties","description":"\n\u003cp\u003emap of key value pairs to be set\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[]},{"name":"pretty","full_name":"pretty","description":"\n\u003cp\u003eReturn a pretty formatted response if true, Default is false\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Boolean","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"is_oem","full_name":"is_oem","description":"\n\u003cp\u003eAdd user defined properties in thing template of child account by oem user\nif is_oem flag is true.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Boolean","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":["Request - containing user defined properties to be added\n  curl -X PUT -H \"Content-Type:application/json\" -H \"X-Auth-Token:WtUFnj8pvSxVnH9e_xkq7A\"  -d '{\"user_defined_properties\":{\"Color\":\"Red\"}}' https://api.datonis.io/api/v3/thing_templates/2a5t58bbt8/set_user_defined_properties\n\nResponse (returns details of the thing template with updated user defined properties)\n{\n  \"thing_template\": {\n    \"created_at\": 1448361986,\n    \"description\": \"Thing Template for Refrigerators\",\n    \"name\": \"Refrigerator\",\n    \"thing_template_key\": \"2a5t58bbt8\",\n    \"updated_at\": 1448367485,\n    \"user_defined_properties\": {\n      \"Firmware Ver\": \"1.0\",\n      \"STATE\": \"OK\",\n      \"Color\": \"Red\"\n    },\n    \"metrics\": [\n      {\n        \"metric_key\": \"d3tdc136b3\",\n        \"metric_name\": \"temperature\"\n      },\n      {\n        \"metric_key\": \"b44c32be53\",\n        \"metric_name\": \"power\"\n      },\n      {\n        \"metric_key\": \"c6a86c8576\",\n        \"metric_name\": \"voltage\"\n      }\n    ]\n  }\n}"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/3.0/thing_template/remove_user_defined_properties","name":"remove_user_defined_properties","apis":[{"api_url":"/api/v3/thing_templates/:thing_template_key/remove_user_defined_properties","http_method":"PUT","short_description":"Remove user defined properties on a thing template","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eRemoves specified user defined properties on a thing template\u003c/p\u003e\n","errors":[],"params":[{"name":"user_defined_properties","full_name":"user_defined_properties","description":"\n\u003cp\u003eList of user defined properties keys to be removed\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"pretty","full_name":"pretty","description":"\n\u003cp\u003eReturn a pretty formatted response if true, Default is false\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Boolean","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"is_oem","full_name":"is_oem","description":"\n\u003cp\u003eRemove user defined properties from thing tempalte of child account by oem\nuser if is_oem flag is true.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Boolean","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":["Request - containing user defined properties to be removed\n  curl -X PUT -H \"Content-Type:application/json\" -H \"X-Auth-Token:WtUFnj8pvSxVnH9e_xkq7A\"  -d '{\"user_defined_properties\":[\"Color\"]}' https://api.datonis.io/api/v3/thing_templates/2a5t58bbt8/remove_user_defined_properties\n\nResponse (returns details of the thing template with updated user defined properties)\n{\n  \"thing_template\": {\n    \"created_at\": 1448361986,\n    \"description\": \"Thing Template for Refrigerators\",\n    \"name\": \"Refrigerator\",\n    \"thing_template_key\": \"2a5t58bbt8\",\n    \"updated_at\": 1448367534,\n    \"user_defined_properties\": {\n      \"Firmware Ver\": \"1.0\",\n      \"STATE\": \"OK\"\n    },\n    \"metrics\": [\n      {\n        \"metric_key\": \"d3tdc136b3\",\n        \"metric_name\": \"temperature\"\n      },\n      {\n        \"metric_key\": \"b44c32be53\",\n        \"metric_name\": \"power\"\n      },\n      {\n        \"metric_key\": \"c6a86c8576\",\n        \"metric_name\": \"voltage\"\n      }\n    ]\n  }\n}"],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[]},"user":{"doc_url":"/apidoc/3.0/user","api_url":"","name":"User","short_description":null,"full_description":"","version":"3.0","formats":null,"metadata":{"order":16},"methods":[{"doc_url":"/apidoc/3.0/user/index","name":"index","apis":[{"api_url":"/api/v3/users","http_method":"GET","short_description":"List all users","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eReturns a list of all users belonging to an account as per the specified\ncriteria. This API is paginated and returns 20 users by default. A user is\nuniquely identified by a \u0026#39;user_key\u0026#39;. This key should be used in all\nthe other API referencing a particular user.\u003c/p\u003e\n","errors":[],"params":[{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number of results to be fetched, Default 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be Integer.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"per","full_name":"per","description":"\n\u003cp\u003eNumber of users to be returned in one page, Default 20\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be Integer.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order_by","full_name":"order_by","description":"\n\u003cp\u003eField on which users should be sorted\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eOrder, “asc” or “desc”, in which results should be sorted\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003eKeywords based on which users should be searched. Currently you can search\nusers on - user_key, name, tags or user_defined_properties\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"scope","full_name":"scope","description":"\n\u003cp\u003eMatching condition if multiple keywords are specified for search. Valid\nvalues are “all” or “any”. Default is “all”\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"timestamp_format","full_name":"timestamp_format","description":"\n\u003cp\u003eFormat, “str” or “int”, in which timestamps should be returned, Default\n“int”\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"pretty","full_name":"pretty","description":"\n\u003cp\u003eReturn a pretty formatted response if true, Default is false\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Boolean","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"field_list","full_name":"field_list","description":"\n\u003cp\u003eList of fields required in the result.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"is_oem","full_name":"is_oem","description":"\n\u003cp\u003eReturn users of child account if is_oem flag is true.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"child_organisation_key","full_name":"child_organisation_key","description":"\n\u003cp\u003eOrganisation key of child account. Required field if is_oem is present.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":["Request - listing all users without any criteria\n  curl -X GET  -H \"Content-Type:application/json\" -H \"X-Auth-Token:WtUFnj8pvSxVnH9e_xkq7A\" https://api.datonis.io/api/v3/users\n\nResponse (returns first 20 records)\n{\n  \"total_count\": 3,\n  \"page\": 1,\n  \"users\": [\n    {\n      \"address\": \"Baner\",\n      \"city\": \"Pune\",\n      \"confirmed_at\": \"2015-11-04T09:08:01.247Z\",\n      \"country\": \"India\",\n      \"email\": \"bill@acme.com\",\n      \"first_name\": \"Bill\",\n      \"last_name\": \"Doe\",\n      \"phone\": \"9803123547\",\n      \"role\": \"admin\",\n      \"time_zone\": \"Mumbai\",\n      \"user_key\": \"1e5228ttd8\",\n      \"created_at\": 1446627978,\n      \"updated_at\": 1448445578,\n      \"role_name\": \"Account Admin\",\n      \"role_key\": \"67e37d7bat\"\n    },\n    {\n      \"address\": \"Bandra Mumbai\",\n      \"city\": \"Mumbai\",\n      \"confirmed_at\": \"2015-11-25T09:32:58.950Z\",\n      \"country\": \"India\",\n      \"email\": \"jack@yahoo.com\",\n      \"first_name\": \"Jack\",\n      \"last_name\": \"Timberly\",\n...","Request - listing users by specifying number of users to be returned at a time (page size) and specific set to be returned (page)\n  curl -X GET  -H \"Content-Type:application/json\" -H \"X-Auth-Token:WtUFnj8pvSxVnH9e_xkq7A\" -d '{\"per\":\"2\", \"page\":\"2\"}' https://api.datonis.io/api/v3/users\n\nResponse (returns page 2 with 2 users per page)\n{\n  \"total_count\": 3,\n  \"page\": \"2\",\n  \"users\": [\n    {\n      \"address\": \"Andheri Mumbai\",\n      \"city\": \"Mumbai\",\n      \"confirmed_at\": \"2015-11-25T09:40:35.295Z\",\n      \"country\": \"India\",\n      \"email\": \"mike@gmail.com\",\n      \"first_name\": \"Mike\",\n      \"last_name\": \"Potter\",\n      \"phone\": \"9981563298\",\n      \"role\": \"normal\",\n      \"time_zone\": \"Mumbai\",\n      \"user_key\": \"3ee266547t\",\n      \"created_at\": 1448444349,\n      \"updated_at\": 1448444435,\n      \"role_name\": \"Read Only\",\n      \"role_key\": \"411a45tdc7\"\n    }\n  ]\n}","Request - listing users ordered by a field with string formatted timestamps\n  curl -X GET -H \"Content-Type:application/json\" -H \"X-Auth-Token:olezAZXGQn9MutnfNerKDQ\" -d '{\"timestamp_format\":\"str\",\"order_by\":\"first_name\",\"order\":\"desc\"}' https://api.datonis.io/api/v3/users\n\nResponse (returns users in the reverse order of their name and timestamps in string format)\n{\n  \"total_count\": 3,\n  \"page\": 1,\n  \"users\": [\n    {\n      \"address\": \"Andheri Mumbai\",\n      \"city\": \"Mumbai\",\n      \"confirmed_at\": \"2015-11-25T09:40:35.295Z\",\n      \"country\": \"India\",\n      \"email\": \"mike@gmail.com\",\n      \"first_name\": \"Mike\",\n      \"last_name\": \"Potter\",\n      \"phone\": \"9981563298\",\n      \"role\": \"normal\",\n      \"time_zone\": \"Mumbai\",\n      \"user_key\": \"3ee266547t\",\n      \"created_at\": \"2015/11/25 09:39:09\",\n      \"updated_at\": \"2015/11/25 09:40:35\",\n      \"role_name\": \"Read Only\",\n      \"role_key\": \"411a45tdc7\"\n    },\n    {\n      \"address\": \"Baner\",\n      \"city\": \"Pune\",\n      \"confirmed_at\": \"2015-11-04T09:08:01.247Z\",\n      \"country\": \"India\",\n      \"email\": \"bill@acme.com\",\n      \"first_name\": \"Bill\",\n     ...","Request - listing users based on some search criteria with all keywords matching\n  curl -X GET -H \"Content-Type:application/json\" -H \"X-Auth-Token:olezAZXGQn9MutnfNerKDQ\" -d '{\"search\":\"Jack Mike\"}' https://api.datonis.io/api/v3/users\n\nResponse (returns users containing both keywords 'Jack' as well as 'Mike')\n{\n  \"total_count\": 0,\n  \"page\": 1,\n  \"users\": [\n\n  ]\n}","Request - listing users based on some search criteria with any of the keywords matching\n  curl -X GET -H \"Content-Type:application/json\" -H \"X-Auth-Token:olezAZXGQn9MutnfNerKDQ\" -d '{\"search\":\"Jack Mike\",\"scope\":\"any\"}' https://api.datonis.io/api/v3/users\n\nResponse (returns users containing either of the keywords 'Jack' or 'Mike')\n{\n  \"total_count\": 2,\n  \"page\": 1,\n  \"users\": [\n    {\n      \"address\": \"Bandra Mumbai\",\n      \"city\": \"Mumbai\",\n      \"confirmed_at\": \"2015-11-25T09:32:58.950Z\",\n      \"country\": \"India\",\n      \"email\": \"jack@yahoo.com\",\n      \"first_name\": \"Jack\",\n      \"last_name\": \"Timberly\",\n      \"phone\": \"9824678234\",\n      \"role\": \"admin\",\n      \"time_zone\": \"Mumbai\",\n      \"user_key\": \"93et87a5a5\",\n      \"created_at\": 1448443772,\n      \"updated_at\": 1448443978,\n      \"role_name\": \"Account Admin\",\n      \"role_key\": \"67e37d7bat\"\n    },\n    {\n      \"address\": \"Andheri Mumbai\",\n      \"city\": \"Mumbai\",\n      \"confirmed_at\": \"2015-11-25T09:40:35.295Z\",\n      \"country\": \"India\",\n      \"email\": \"mike@gmail.com\",\n      \"first_name\": \"Mike\",\n      \"last_name\": \"Potter\",\n      \"phone\": \"9981563298\",\n      \"role\": \"normal\",\n      \"time_zone\": \"Mumbai\",\n      \"user_key\": \"3ee266547t\",\n      \"created_at\":..."],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/3.0/user/show","name":"show","apis":[{"api_url":"/api/v3/users/:user_key","http_method":"GET","short_description":"Fetch information for a role","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eReturns details of the user requested\u003c/p\u003e\n","errors":[],"params":[{"name":"pretty","full_name":"pretty","description":"\n\u003cp\u003eReturn a pretty formatted response if true, Default is false\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Boolean","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"is_oem","full_name":"is_oem","description":"\n\u003cp\u003eShow user of child account if is_oem flag is true.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":["Request - get details of the specified user (user specified as a part of the url)\n  curl -X GET  -H \"Content-Type:application/json\" -H \"X-Auth-Token:WtUFnj8pvSxVnH9e_xkq7A\"  https://api.datonis.io/api/v3/users/1e5228ttd8\n\nResponse (returns details of the user requested)\n{\n  \"user\": {\n    \"address\": \"Baner\",\n    \"city\": \"Pune\",\n    \"confirmed_at\": \"2015-11-04T09:08:01.247Z\",\n    \"country\": \"India\",\n    \"email\": \"bill@acme.com\",\n    \"first_name\": \"bill\",\n    \"last_name\": \"Doe\",\n    \"phone\": \"9803123547\",\n    \"role\": \"admin\",\n    \"time_zone\": \"Mumbai\",\n    \"user_key\": \"1e5228ttd8\",\n    \"created_at\": 1446627978,\n    \"updated_at\": 1448444844,\n    \"role_name\": \"Account Admin\",\n    \"role_key\": \"67e37d7bat\"\n  }\n}"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/3.0/user/update","name":"update","apis":[{"api_url":"/api/v3/users/:user_key","http_method":"PUT","short_description":"Updates a user","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eUpdates a user with given parameters\u003c/p\u003e\n","errors":[],"params":[{"name":"datonis_role_key","full_name":"datonis_role_key","description":"\n\u003cp\u003eKey of datonis role to be assigned to user. This field is required\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"user","full_name":"user","description":"\n\u003cp\u003eMap containing details of the user to be updated\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[]},{"name":"pretty","full_name":"pretty","description":"\n\u003cp\u003eReturn a pretty formatted response if true, Default is false\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Boolean","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"is_oem","full_name":"is_oem","description":"\n\u003cp\u003eUpdate user in child account by oem user if is_oem flag is true.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Boolean","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"child_organisation_key","full_name":"child_organisation_key","description":"\n\u003cp\u003eOrganisation key of child account where oem user wants to update user.\nRequired field if is_oem is present.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":["Request - containing parameters to be modified\n  curl -X PUT -H \"Content-Type:application/json\" -H \"X-Auth-Token:WtUFnj8pvSxVnH9e_xkq7A\" -d '{\"user\":{\"address\":\"Baner\",\"city\":\"Pune\",\"country\":\"India\",\"first_name\":\"bill\",\"last_name\":\"Doe\",\"phone\":\"9803123547\",\"role\":\"admin\"},\"role_key\":\"67e37d7bat\"}' https://api.datonis.io/api/v3/users/1e5228ttd8\n\nResponse (returns details of the user updated)\n{\n  \"user\": {\n    \"address\": \"Baner\",\n    \"city\": \"Pune\",\n    \"confirmed_at\": \"2015-11-04T09:08:01.247Z\",\n    \"country\": \"India\",\n    \"email\": \"bill@acme.com\",\n    \"first_name\": \"bill\",\n    \"last_name\": \"Doe\",\n    \"phone\": \"9803123547\",\n    \"role\": \"admin\",\n    \"time_zone\": \"Mumbai\",\n    \"user_key\": \"1e5228ttd8\",\n    \"created_at\": 1446627978,\n    \"updated_at\": 1448444844,\n    \"role_name\": \"Account Admin\",\n    \"role_key\": \"67e37d7bat\"\n  }\n}"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/3.0/user/destroy","name":"destroy","apis":[{"api_url":"/api/v3/users/:user_key","http_method":"DELETE","short_description":"Delete a user","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eDeletes the specified user from the system. All associated data is also\nlost.\u003c/p\u003e\n","errors":[],"params":[{"name":"pretty","full_name":"pretty","description":"\n\u003cp\u003eReturn a pretty formatted response if true, Default is false\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Boolean","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"is_oem","full_name":"is_oem","description":"\n\u003cp\u003eDelete user in child account by oem user if is_oem flag is true.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Boolean","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":["Request\n  curl -X DELETE -H \"Content-Type:application/json\" -H \"X-Auth-Token:WtUFnj8pvSxVnH9e_xkq7A\"  https://api.datonis.io/api/v3/users/93et87a5a5\n\nResponse\n{\n}"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/3.0/user/change_password","name":"change_password","apis":[{"api_url":"/api/v3/users/:user_key","http_method":"PUT","short_description":"Change user password","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eChange the users password.\u003c/p\u003e\n","errors":[],"params":[{"name":"user","full_name":"user","description":"\n\u003cp\u003eMap containing users  password value to be updated\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[]},{"name":"pretty","full_name":"pretty","description":"\n\u003cp\u003eReturn a pretty formatted response if true, Default is false\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Boolean","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"is_oem","full_name":"is_oem","description":"\n\u003cp\u003eOEM Admin user can change password of user in child account by oem user if\nis_oem flag is true.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Boolean","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":["Request\n  curl -X PUT -H \"Content-Type:application/json\" -H \"X-Auth-Token:BmHmv9IJey5l_LK0N2Ciaw\" -d '{\"user\":{\"password\":\"jack123456\"}}' https://api.datonis.io/api/v3/users/1e5228ttd8/change_password\n\nResponse\n{\n  \"user\": {\n    \"address\": \"Baner\",\n    \"city\": \"Pune\",\n    \"confirmed_at\": \"2015-11-04T09:08:01.247Z\",\n    \"country\": \"India\",\n    \"email\": \"bill@acme.com\",\n    \"first_name\": \"bill\",\n    \"last_name\": \"Doe\",\n    \"phone\": \"9803123547\",\n    \"role\": \"admin\",\n    \"time_zone\": \"Mumbai\",\n    \"user_key\": \"1e5228ttd8\",\n    \"created_at\": 1446627978,\n    \"updated_at\": 1448445499,\n    \"role_name\": \"Account Admin\",\n    \"role_key\": \"67e37d7bat\"\n  }\n}"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/3.0/user/invite","name":"invite","apis":[{"api_url":"/api/v3/users/:user_key","http_method":"POST","short_description":"Invite user","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eInvite new user\u003c/p\u003e\n","errors":[],"params":[{"name":"datonis_role_key","full_name":"datonis_role_key","description":"\n\u003cp\u003eKey of datonis role to be assigned to user\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"user","full_name":"user","description":"\n\u003cp\u003eMap containing details of the user to be invited\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[]},{"name":"pretty","full_name":"pretty","description":"\n\u003cp\u003eReturn a pretty formatted response if true, Default is false\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Boolean","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"is_oem","full_name":"is_oem","description":"\n\u003cp\u003eInvite user in child account by oem user if is_oem flag is true.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Boolean","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"child_organisation_key","full_name":"child_organisation_key","description":"\n\u003cp\u003eOrganisation key of child account where oem user wants to invite user.\nRequired field if is_oem is present.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":["Request\n  curl -X POST -H \"Content-Type:application/json\" -H \"X-Auth-Token:D--gyhhE-FPH5LXL3osGAQ\" -d '{\"user\":{\"first_name\":\"Jack\", \"last_name\":\"Timberly\", \"email\":\"jack@yahoo.com\"},\"role_key\":\"67e37d7bat\"}' https://api.datonis.io/api/v3/users/invite\n\nResponse\nInvitation sent successfully"],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[]},"Sessions":{"doc_url":"/apidoc/3.0/Sessions","api_url":"","name":"Sessions","short_description":null,"full_description":"","version":"3.0","formats":null,"metadata":{"order":1,"name":"Session"},"methods":[{"doc_url":"/apidoc/3.0/Sessions/api_sign_in","name":"api_sign_in","apis":[{"api_url":"/api_sign_in","http_method":"POST","short_description":"Authenticate and return auth_token","deprecated":null}],"formats":["JSON"],"full_description":"\n\u003cp\u003eReturns authentication token on verifying credentials.\u003cstrong\u003e This\nauth_token should be added to header of every other api request.\u003c/strong\u003e\u003c/p\u003e\n","errors":[],"params":[{"name":"email","full_name":"email","description":"\n\u003cp\u003eEmail address of user\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"password","full_name":"password","description":"\n\u003cp\u003ePassword of user\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"organisation_key","full_name":"organisation_key","description":"\n\u003cp\u003eOrganisation Key of a child organisation of an OEM account. This allows an\nOEM admin to login as admin of that account\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":["Request:\n curl -X POST -H \"Content-Type:application/json\" -d '{\"email\":\"bob@acme.com\",\"password\":\"foobar\"}' 'https://api.datonis.io/api_sign_in' \nResponse:\n {\n  \"success\": true,\n  \"auth_token\": \"wOzV_s3ZIheqrkCcKHTPxQ\",\n  \"email\": \"bob@acme.com\",\n  \"role\": \"admin\",\n  \"time_zone\": \"Mumbai\",\n  \"organisation\": {\n    \"name\": null,\n    \"organisation_key\": \"f58155467d2ba784516a59ade6t6715fde567131\",\n    \"license\": {\n      \"license_key\": \"61572fd9137fd5c95d33454tf98e662762116812\"\n    }\n  }\n}"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/3.0/Sessions/api_sign_out","name":"api_sign_out","apis":[{"api_url":"/api_sign_out","http_method":"DELETE","short_description":"Signout the User.","deprecated":null}],"formats":["JSON"],"full_description":"\n\u003cp\u003eDelete the AuthToken and User will Signout\u003c/p\u003e\n","errors":[],"params":[],"examples":["Request:\n curl -X DELETE -H \"Content-Type:application/json\" 'https://api.datonis.io/api_sign_out' \nResponse:\n {\n  \"success\": true,\n  \"message\": \"User signout Sucessfully.\"\n}"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apidoc/3.0/Sessions/oauth_api_sign_in","name":"oauth_api_sign_in","apis":[{"api_url":"/azure_api_sign_in","http_method":"POST","short_description":"Authenticate using OAuth and return auth_token","deprecated":null}],"formats":["JSON"],"full_description":"\n\u003cp\u003eReturns authentication token on verifying credentials.\u003cstrong\u003e This\nauth_token should be added to header of every other api request.\u003c/strong\u003e\u003c/p\u003e\n","errors":[],"params":[{"name":"client_id","full_name":"client_id","description":"\n\u003cp\u003ec\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"code","full_name":"code","description":"\n\u003cp\u003ePassword of user\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"examples":["Request:\n curl -X POST -H \"Content-Type:application/json\" -d '{\"code\":\"1234-5678-91011212-131415\",\"client_id\":\"foobar\",\"mode\":\"AzureAD\"}' 'https://api.datonis.io/azure_api_sign_in' \nResponse:\n {\n  \"success\": true,\n  \"auth_token\": \"wOzV_s3ZIheqrkCcKHTPxQ\",\n  \"email\": \"bob@acme.com\",\n  \"role\": \"admin\",\n  \"time_zone\": \"Mumbai\",\n  \"organisation\": {\n    \"name\": null,\n    \"organisation_key\": \"f58155467d2ba784516a59ade6t6715fde567131\",\n    \"license\": {\n      \"license_key\": \"61572fd9137fd5c95d33454tf98e662762116812\"\n    }\n  }\n}"],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[]}}}}