{"_id":"59c31ebe190c90003cb0cfb5","project":"568bdc1483d2061900d86cdc","version":{"_id":"59a72290d61777001b6c42c3","project":"568bdc1483d2061900d86cdc","__v":19,"createdAt":"2017-08-30T20:39:44.453Z","releaseDate":"2017-08-30T20:39:44.453Z","categories":["59a7236e3fe4d90025117c10","59a72eb6cb0db3001b84cfe2","59a734eb757d030019b85af8","59c0243b1b2d07001a9d2b76","59c035e42126e10028effb12","59c06c40df5b3c0010584a13","59c1a5852cabe5002641a3e7","59c2fb00b2b45c0010b7a3d7","59c32ceb9aea850010ac4130","59c32e6e190c90003cb0d12f","59c33affb2b45c0010b7aa23","59c7dfa457bd8200105444dc","59c7e975c50cf30010d712a0","59cffdef0cd4dd0010294d54","59d0622ca91a810032c8f60c","59d06733c1aec60026253065","59d174d44ac471001a07b123","59d5a5e323e6e800103defb2","59ecf1d8ed507c001c52b255"],"is_deprecated":false,"is_hidden":false,"is_beta":true,"is_stable":true,"codename":"","version_clean":"0.0.0","version":"0"},"category":{"_id":"59c2fb00b2b45c0010b7a3d7","project":"568bdc1483d2061900d86cdc","version":"59a72290d61777001b6c42c3","__v":0,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2017-09-20T23:34:24.298Z","from_sync":false,"order":12,"slug":"environments-api","title":"Environments API"},"user":"58cc41f21751ce2f003be3b7","__v":4,"parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-09-21T02:06:54.112Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"settings":"59a75f6e757d030019b85f83","results":{"codes":[]},"examples":{"codes":[]},"method":"get","auth":"required","params":[{"_id":"59c17c889ab7d90024440927","ref":"","in":"path","required":true,"desc":"","default":"","type":"string","name":"id"},{"_id":"59c17c889ab7d90024440926","ref":"","in":"query","required":false,"desc":"","default":"","type":"string","name":"continuationCount"},{"_id":"59c17c889ab7d90024440925","ref":"","in":"query","required":false,"desc":"","default":"","type":"string","name":"continuationToken"},{"_id":"59c17c889ab7d90024440924","ref":"","in":"query","required":false,"desc":"","default":"","type":"datetime","name":"endDate"},{"_id":"59c17c889ab7d90024440923","ref":"","in":"query","required":false,"desc":"","default":"","type":"int","name":"index"},{"_id":"59c17c889ab7d90024440922","ref":"","in":"query","required":false,"desc":"","default":"","type":"string","name":"member"},{"_id":"59c17c889ab7d90024440921","ref":"","in":"query","required":false,"desc":"","default":"","type":"int","name":"pageSize"},{"_id":"59c17c889ab7d90024440920","ref":"","in":"query","required":false,"desc":"","default":"","type":"string","name":"service"},{"_id":"59c17c889ab7d9002444091f","ref":"","in":"query","required":false,"desc":"","default":"","type":"datetime","name":"startDate"},{"_id":"59c17c889ab7d9002444091e","ref":"","in":"query","required":false,"desc":"","default":"","type":"string","name":"type"}],"url":"/:id/history"},"isReference":false,"order":5,"body":"# Details\n\nView the action history of all devices in an environment.\n\nThe action history records the following types of events.\n1. Changed: A property changed event, which can be spawned explicitly by the user or implicitly by the system.\n2. Error: An error event, which spawns when an error occurs pertaining to a device.\n3. Event: A service event, triggered by device service class(es).\n4. Get: An event triggered when the “refresh” flag is used to get the most current (not cached) value of a device property.\n5. Info: An event triggered when the user retrieves the cached value of a device property.\n6. Set: An event triggered when the user explicitly sets a device property.\n\nAn account token, server token, or user token may be used to run this endpoint.\n\n# Parameters\n\n## path\n\n- id (required): The ID of the [environment](https://docs.droplit.io/docs/containers#section-environments).\n\n## query\n\n- continuationCount (optional): The page to read in the action history.\n- continuationToken (optional): A system-generated token representing the page start.\n- endDate (optional): The latest ISO 8601 datetime that should be included in the action history.\n- index (optional): The index of a specific service to include in the action history.\n- member (optional): The specific service member to include in the action history.\n- pageSize (optional): The number of results that should be displayed per page of the action history.\n- service (optional): The name of the service from which to get the action history.\n- startDate (optional): The earliest ISO 8601 datetime that should be included in the action history.\n- type (optional): The action type to view in the action history.\n\n# Responses\n\n## 200\n\n```\n{\n    \"items\": [\n        {\n            \"deviceId\": \"DEVICE-ID\",\n            \"environmentId\": \"ENVIRONMENT-ID\",\n            \"member\": \"SERVICE-MEMBER-NAME\",\n            \"recordKey\": \"INTERNAL-RECORD-KEY\",\n            \"service\": \"SERVICE-NAME\",\n            \"time\": \"DATE-TIME-MODIFIED YYYY-MM-DD HH:MM:SS ENCODED\",\n            \"transactionId\": \"TRANSACTION-ID\",\n            \"type\": \"ACTION-TYPE\",\n            \"value\": \"MEMBER-VALUE\"\n        }\n    ]\n}\n```\n\n## 400\n\n- __History Continuation Count Invalid:__ The standard error structure defines this error as invalid parameters. In this context, it means that the continuation count is invalid because it was supposed to be a positive number.\n- __History End Date Invalid:__ The standard error structure defines this error as invalid parameters. In this context, it means that the end date for which to stop retrieving history records is incorrectly formatted, and needs to be in valid ISO 8601 datetime format.\n- __History Event Type Invalid:__ The standard error structure defines this error as invalid parameters and an invalid value. In this context, it means that the value given to the “type” flag is not valid, and cannot be used to filter history events.\n- __History Page Size Invalid:__ The standard error structure defines this error as invalid parameters. In this context, it means that the page size for viewing history records is invalid because it was supposed to be a positive number.\n- __History Start Date Invalid:__ The standard error structure defines this error as invalid parameters. In this context, it means that the begin date for which to start retrieving history records is incorrectly formatted, and needs to be in valid ISO 8601 datetime format.\n- __History Service Index Invalid:__ The standard error structure defines this error as invalid parameters. In this context, it means that the service index is invalid because it was supposed to be a non-negative number.\n- __Query Field Not Allowed:__ The standard error structure defines this error as invalid parameters, with additional parameters in the query string. In this context, it means that one or more query string fields are incorrect. They do not match the name(s) of the query string field(s) that are allowed for this endpoint.\n- __Environment Invalid:__ The standard error structure defines this error as invalid parameters, with an invalid ID linked to the parameter that designates the environment ID. In this context, it means that the ID given for an environment was not valid.\n\n## 404\n\n- __Environment Not Found:__ This error means that an environment with the given ID was not found. This is distinct from an invalid environment ID being specified; this means that the environment ID once existed, but no longer does.\n\n# Examples\n\n## HTTP\n\n```\nGET https://ioe.droplit.io/api/environments/ENVIRONMENT-ID/history HTTP/1.1\nauthorization: TOKEN\n```\n\n## Droplit Console\n\n```\ndroplit environment history ENVIRONMENT-ID\n```","excerpt":"","slug":"environments-history","type":"endpoint","title":"View the action history of all devices in an environment."}

getView the action history of all devices in an environment.


Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

id:
required
string

Query Params

continuationCount:
string
continuationToken:
string
endDate:
datetime
index:
integer
member:
string
pageSize:
integer
service:
string
startDate:
datetime
type:
string

Documentation

# Details View the action history of all devices in an environment. The action history records the following types of events. 1. Changed: A property changed event, which can be spawned explicitly by the user or implicitly by the system. 2. Error: An error event, which spawns when an error occurs pertaining to a device. 3. Event: A service event, triggered by device service class(es). 4. Get: An event triggered when the “refresh” flag is used to get the most current (not cached) value of a device property. 5. Info: An event triggered when the user retrieves the cached value of a device property. 6. Set: An event triggered when the user explicitly sets a device property. An account token, server token, or user token may be used to run this endpoint. # Parameters ## path - id (required): The ID of the [environment](https://docs.droplit.io/docs/containers#section-environments). ## query - continuationCount (optional): The page to read in the action history. - continuationToken (optional): A system-generated token representing the page start. - endDate (optional): The latest ISO 8601 datetime that should be included in the action history. - index (optional): The index of a specific service to include in the action history. - member (optional): The specific service member to include in the action history. - pageSize (optional): The number of results that should be displayed per page of the action history. - service (optional): The name of the service from which to get the action history. - startDate (optional): The earliest ISO 8601 datetime that should be included in the action history. - type (optional): The action type to view in the action history. # Responses ## 200 ``` { "items": [ { "deviceId": "DEVICE-ID", "environmentId": "ENVIRONMENT-ID", "member": "SERVICE-MEMBER-NAME", "recordKey": "INTERNAL-RECORD-KEY", "service": "SERVICE-NAME", "time": "DATE-TIME-MODIFIED YYYY-MM-DD HH:MM:SS ENCODED", "transactionId": "TRANSACTION-ID", "type": "ACTION-TYPE", "value": "MEMBER-VALUE" } ] } ``` ## 400 - __History Continuation Count Invalid:__ The standard error structure defines this error as invalid parameters. In this context, it means that the continuation count is invalid because it was supposed to be a positive number. - __History End Date Invalid:__ The standard error structure defines this error as invalid parameters. In this context, it means that the end date for which to stop retrieving history records is incorrectly formatted, and needs to be in valid ISO 8601 datetime format. - __History Event Type Invalid:__ The standard error structure defines this error as invalid parameters and an invalid value. In this context, it means that the value given to the “type” flag is not valid, and cannot be used to filter history events. - __History Page Size Invalid:__ The standard error structure defines this error as invalid parameters. In this context, it means that the page size for viewing history records is invalid because it was supposed to be a positive number. - __History Start Date Invalid:__ The standard error structure defines this error as invalid parameters. In this context, it means that the begin date for which to start retrieving history records is incorrectly formatted, and needs to be in valid ISO 8601 datetime format. - __History Service Index Invalid:__ The standard error structure defines this error as invalid parameters. In this context, it means that the service index is invalid because it was supposed to be a non-negative number. - __Query Field Not Allowed:__ The standard error structure defines this error as invalid parameters, with additional parameters in the query string. In this context, it means that one or more query string fields are incorrect. They do not match the name(s) of the query string field(s) that are allowed for this endpoint. - __Environment Invalid:__ The standard error structure defines this error as invalid parameters, with an invalid ID linked to the parameter that designates the environment ID. In this context, it means that the ID given for an environment was not valid. ## 404 - __Environment Not Found:__ This error means that an environment with the given ID was not found. This is distinct from an invalid environment ID being specified; this means that the environment ID once existed, but no longer does. # Examples ## HTTP ``` GET https://ioe.droplit.io/api/environments/ENVIRONMENT-ID/history HTTP/1.1 authorization: TOKEN ``` ## Droplit Console ``` droplit environment history ENVIRONMENT-ID ```

User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}