{"info":{"_postman_id":"96c44f97-9b4c-4909-b3aa-2577499c941b","name":"ESci Cloud","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"description":"","owner":"18529342","collectionId":"96c44f97-9b4c-4909-b3aa-2577499c941b","publishedId":"UVXeqchj","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"257676"},"publishDate":"2022-01-07T11:40:15.000Z"},"item":[{"name":"Organization","item":[{"name":"Get All Organizations","id":"b526b7e9-10c9-4444-89da-b5aefacc1ed5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"api.esci.io/organizations/","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"96c44f97-9b4c-4909-b3aa-2577499c941b","id":"96c44f97-9b4c-4909-b3aa-2577499c941b","name":"ESci Cloud","type":"collection"}},"urlObject":{"path":["organizations",""],"host":["api.esci.io"],"query":[],"variable":[]}},"response":[],"_postman_id":"b526b7e9-10c9-4444-89da-b5aefacc1ed5"},{"name":"Get Current User's Organizations","id":"8a6e209f-1c7c-40b3-ab0c-965fde5571ef","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"api.esci.io/organizations/current_user/","description":"

Gets list of organizations that caller belongs to

Returns instance of organization with some associated parameters.

Authenticated users can create an organization.
- \"name\" is the only required field
\n
The creator will automatically become the admin and member of organization
Preferred UUID for organization can be optionally specified. Otherwise it will be autogenerated
Returns an error if UUID incorrect or non-unique

Allows editing of organization info
All fields are optional
Cannot edit organization uuid
Join_id must be unique
Only organization admins can edit organization info

Leaves the organization and any organization groups
Returns error if not part of organization or organization does not exist
Cannot leave if user is the last admin in organization

Lists all members in organization
Only organization members can call

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"96c44f97-9b4c-4909-b3aa-2577499c941b","id":"96c44f97-9b4c-4909-b3aa-2577499c941b","name":"ESci Cloud","type":"collection"}},"urlObject":{"path":["organizations","{{organization_uuid}}}","users",""],"host":["api.esci.io"],"query":[],"variable":[]}},"response":[],"_postman_id":"b8f45200-7147-4aff-88d0-bb992ed9e02b"},{"name":"Get Organization User","id":"a91663d4-89be-4100-a15d-cc2080d3342a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"api.esci.io/organizations/{{organization_uuid}}/users/{{username}}/","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"96c44f97-9b4c-4909-b3aa-2577499c941b","id":"96c44f97-9b4c-4909-b3aa-2577499c941b","name":"ESci Cloud","type":"collection"}},"urlObject":{"path":["organizations","{{organization_uuid}}","users","{{username}}",""],"host":["api.esci.io"],"query":[],"variable":[]}},"response":[],"_postman_id":"a91663d4-89be-4100-a15d-cc2080d3342a"},{"name":"Remove Organization User","id":"423fc007-9535-4402-a0d8-ee08c53b3044","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"api.esci.io/organizations/{{organization_uuid}}/users/{{username}}/","description":"

Removes user from organization and any organization groups
Cannot remove admins
Returns error if user or organization does not exist
Only admins can call

Lists all admins in organization
\n
Only organization members can call
\n

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"96c44f97-9b4c-4909-b3aa-2577499c941b","id":"96c44f97-9b4c-4909-b3aa-2577499c941b","name":"ESci Cloud","type":"collection"}},"urlObject":{"path":["organizations","{{organization_uuid}}","admins",""],"host":["api.esci.io"],"query":[],"variable":[]}},"response":[],"_postman_id":"b260bf10-6c96-4f44-9062-fffc1145ac04"},{"name":"Get Organization Admin","id":"e56f5949-eeae-4527-8f8a-c0cf2421dd8e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"api.esci.io/organizations/{{organization_uuid}}/admins/{{username}}/","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"96c44f97-9b4c-4909-b3aa-2577499c941b","id":"96c44f97-9b4c-4909-b3aa-2577499c941b","name":"ESci Cloud","type":"collection"}},"urlObject":{"path":["organizations","{{organization_uuid}}","admins","{{username}}",""],"host":["api.esci.io"],"query":[],"variable":[]}},"response":[],"_postman_id":"e56f5949-eeae-4527-8f8a-c0cf2421dd8e"},{"name":"Create Organization Admin","id":"ba37905b-518c-4188-81b6-14a78f8213f9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"username\": \"\"\r\n}","options":{"raw":{"language":"json"}}},"url":"api.esci.io/organizations/{{organization_uuid}}/admins/","description":"

Adds another user as an admin to organization by posting username
Only organization admins can call
Adding a user who is already an Admin, or is not part of the organization, returns an error

Revokes a user's admin status from organization
Cannot remove self
Returns error if user does not exist or is not an admin or organization does not exist
Only admins can call

Lists all groups in the organization with members and devices
Only organization members can call

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"96c44f97-9b4c-4909-b3aa-2577499c941b","id":"96c44f97-9b4c-4909-b3aa-2577499c941b","name":"ESci Cloud","type":"collection"}},"urlObject":{"path":["organizations","{{organization_uuid}}","groups",""],"host":["api.esci.io"],"query":[],"variable":[]}},"response":[],"_postman_id":"05c64b83-4421-4821-8ad1-ffaab6df13a5"},{"name":"Get Organization Group","id":"f8d69e2e-1547-4966-b69f-6e830cc5c424","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"api.esci.io/organizations/{{organization_uuid}}/groups/{{group_id}}/","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"96c44f97-9b4c-4909-b3aa-2577499c941b","id":"96c44f97-9b4c-4909-b3aa-2577499c941b","name":"ESci Cloud","type":"collection"}},"urlObject":{"path":["organizations","{{organization_uuid}}","groups","{{group_id}}",""],"host":["api.esci.io"],"query":[],"variable":[]}},"response":[],"_postman_id":"f8d69e2e-1547-4966-b69f-6e830cc5c424"},{"name":"Create Org Group","id":"dfe165b8-011d-426d-a553-57ef006a51f9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"name\": \"My Group\",\r\n \"add_users\": [\"user1\", \"user2\", \"user3\"],\r\n \"add_devices\": [\"esid1\", \"esid2\", \"esid3\"]\r\n}","options":{"raw":{"language":"json"}}},"url":"api.esci.io/organizations/{{organization_uuid}}/groups/","description":"

Creates group in organization with name from \"name\", users from \"add_users\" and devices from \"add_devices\"
Results in error if any user or device does not exist within organization
Only organization admin can call

Edit organization group with the following optional PATCH parameters:
- \"name\" - Changes group name
- \"add_users\" - Adds additional users to group
- \"add_devices\" - Adds additional devices to group
- \"remove_users\" - Removes the users from group, no effect if user not in group
- \"remove_devies\" - Removes the devices from the group. no effect if device not in group
\n
Results in error if trying to add user or device that does not exist within organization
Only organization admin can call

Deletes organization group
Returns error if organization or group does not exist
Only admins can call

Only organization admins can call

Only organization admins can call

Authenticated users send a join request to an organization by posting its join_id
organization_uuid is ignored
400 Bad Request if user already is part of organization, or already has an active request open, or join_id is not valid for the organization

Organization admins can accept join requests.
Will add user to organization and delete request.

Deletes organization join request by request ID
404 not found if join request does not exist
Only organization admins can call

Lists all devices owned by the organization
Only organization members can call

Lists all devices owned by the organization with their latest data info instead of device details
Returns data for one parameter only
Only organization members can call

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"96c44f97-9b4c-4909-b3aa-2577499c941b","id":"96c44f97-9b4c-4909-b3aa-2577499c941b","name":"ESci Cloud","type":"collection"}},"urlObject":{"path":["organizations","{{organization_uuid}}","devices","with_latest_data",""],"host":["api.esci.io"],"query":[],"variable":[]}},"response":[],"_postman_id":"852fd81f-6eb2-4fc9-9644-f1274eaa951a"},{"name":"Get Organization Device","id":"b3d79a7e-d4cc-4d5b-894a-a3ba1b51eab5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"api.esci.io/organizations/{{organization_uuid}}/devices/{{device_esid}}/","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"96c44f97-9b4c-4909-b3aa-2577499c941b","id":"96c44f97-9b4c-4909-b3aa-2577499c941b","name":"ESci Cloud","type":"collection"}},"urlObject":{"path":["organizations","{{organization_uuid}}","devices","{{device_esid}}",""],"host":["api.esci.io"],"query":[],"variable":[]}},"response":[],"_postman_id":"b3d79a7e-d4cc-4d5b-894a-a3ba1b51eab5"},{"name":"Claim a Device for Organization","id":"e14a612b-133d-400a-94c8-9979755486cd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"esid\": \"\"\r\n}","options":{"raw":{"language":"json"}}},"url":"api.esci.io/organizations/{{organization_uuid}}/devices/claim/","description":"

Claim an unclaimed device for the organization by posting the device esid
Only organization admins can claim.
Adds organization to the device's owner field.

Claim unclaimed devices in bulk for the organization by posting list of device esids
Only organization admins can claim.
If there are any esids that do not exist, are already owned, or are taken by another organization, will return an error but will still claim any valid esid
- response.status will be 400_BAD_REQUEST
- response.data will give details which has been added or not
\n

Gets list of organization device requests
Only organization admins can call

Only organization admins can call

Creates a device transfer request to the organization that owns the device specified by the esid
Returns 400_BAD_REQUEST if device is already owned by requester, device does not exist, the organization does not exist, a request already exists, or device has no owner
Only organization admins can call

Accepts the device transfer request
Changes the device owner to the new owner, and automatically removes node info, device label, and assigned groups if available
If device is a node, dissociates all other devices from this node
Returns error if request does not exist

Get paginated list of all transformed data (and their raw data values) that belong to the organization (max 1000 results per page)
Filter list based on url query parameters (see query param examples for full list)
Only organization members can call

filter on node ESID of the data

\n","type":"text/plain"},"key":"node_esid","value":"123"},{"disabled":true,"description":{"content":"

filter on sensor ESID of the data

\n","type":"text/plain"},"key":"sensor_esid","value":"124"},{"disabled":true,"description":{"content":"

filter on parameter number of the data

\n","type":"text/plain"},"key":"parameter_number","value":"1"},{"disabled":true,"description":{"content":"

filter from start date (and time) of the data (inclusive)

\n","type":"text/plain"},"key":"from_time","value":"YYYY-MM-DDTHH:MM:SS"},{"disabled":true,"description":{"content":"

filter up to end date (and time) of the data (inclusive

\n","type":"text/plain"},"key":"to_time","value":"YYYY-MM-DD"},{"disabled":true,"description":{"content":"

filter from this value (inclusive)

\n","type":"text/plain"},"key":"value__gt","value":"1"},{"disabled":true,"description":{"content":"

filter up to this value (inclusive)

\n","type":"text/plain"},"key":"value__lt","value":"5"},{"disabled":true,"description":{"content":"

filter on unit of the data

\n","type":"text/plain"},"key":"unit","value":"C"},{"disabled":true,"description":{"content":"

filter data that is validated or not

\n","type":"text/plain"},"key":"validated","value":"true"},{"disabled":true,"description":{"content":"

filter data derived from this parameter category

\n","type":"text/plain"},"key":"type","value":"Temperature"}],"variable":[]}},"response":[],"_postman_id":"e38e0439-9404-45d9-8a59-b518d65b3d76"},{"name":"Validate Organization Device Data","id":"87d8c8b8-25e6-47b9-97d7-84ef087ef6e3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n parameter_category: \"Soil Water Tension\",\r\n start_time: \"\",\r\n end_time: \"\"\r\n}","options":{"raw":{"language":"json"}}},"url":"api.esci.io/organizations/{{organization_uuid}}/devices/{{device_esid}}/validate_data/","description":"

Validates or invalidates all transformed data belonging to this organization and device with the posted parameter category between the posted start_time and end_time inclusive
If validate is true, will validate, otherwise will invalidate
Only Organization Admins can call
Returns 200_OK even if no data found
Returns 400_BAD_REQUEST if no device exists in organization with this parameter category

Get paginated list of all raw data that belong to the organization (max 1000 results per page)
Filter list based on url query parameters (see query param examples for full list)
Only organization members can call

filter on node ESID of the data

\n","type":"text/plain"},"key":"node_esid","value":"123"},{"disabled":true,"description":{"content":"

filter on sensor ESID of the data

\n","type":"text/plain"},"key":"sensor_esid","value":"124"},{"disabled":true,"description":{"content":"

filter on parameter number of the data

\n","type":"text/plain"},"key":"parameter_number","value":"1"},{"disabled":true,"description":{"content":"

filter from start date (and time) of the data (inclusive)

\n","type":"text/plain"},"key":"from_time","value":"YYYY-MM-DDTHH:MM:SS"},{"disabled":true,"description":{"content":"

filter up to end date (and time) of the data (inclusive

\n","type":"text/plain"},"key":"to_time","value":"YYYY-MM-DD"},{"disabled":true,"description":{"content":"

filter from this value (inclusive)

\n","type":"text/plain"},"key":"value__gt","value":"1"},{"disabled":true,"description":{"content":"

filter up to this value (inclusive)

\n","type":"text/plain"},"key":"value__lt","value":"5"}],"variable":[]}},"response":[],"_postman_id":"2adcba14-6bd9-49f1-aa52-9ae0bd2cd366"},{"name":"Get Organization Telemetry","id":"7e7c06eb-8e1c-47d6-853e-13639724d989","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"api.esci.io/organizations/{{organization_uuid}}/telemetry/","description":"

Get paginated list of all telemetry that belong to the organization (max 1000 results per page)
Filter list based on url query parameters (see query param examples for full list)
Only organization members can call

filter on node ESID of the data

\n","type":"text/plain"},"key":"node_esid","value":"123"},{"disabled":true,"description":{"content":"

filter on sensor ESID of the data

\n","type":"text/plain"},"key":"device_esid","value":"124"},{"disabled":true,"description":{"content":"

filter from start date (and time) of the data (inclusive)

\n","type":"text/plain"},"key":"from_time","value":"YYYY-MM-DDTHH:MM:SS"},{"disabled":true,"description":{"content":"

filter up to end date (and time) of the data (inclusive

\n","type":"text/plain"},"key":"to_time","value":"YYYY-MM-DD"},{"disabled":true,"description":{"content":"

filter from this value (inclusive)

\n","type":"text/plain"},"key":"value__gt","value":"1"},{"disabled":true,"description":{"content":"

filter up to this value (inclusive)

\n","type":"text/plain"},"key":"value__lt","value":"5"},{"disabled":true,"description":{"content":"

filter on telemetry code

\n","type":"text/plain"},"key":"code","value":"1001A"},{"disabled":true,"description":{"content":"

filter on telemetry code type

\n","type":"text/plain"},"key":"label","value":"Low Battery Warning"},{"disabled":true,"description":{"content":"

filter on severity category

\n","type":"text/plain"},"key":"severity","value":"W"}],"variable":[]}},"response":[],"_postman_id":"7e7c06eb-8e1c-47d6-853e-13639724d989"},{"name":"Get Organization Device Positions","id":"316e0b27-df4d-4c60-bb84-10cfd309bc92","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"api.esci.io/organizations/{{organization_uuid}}/positions/","description":"

Get paginated list of all telemetry that belong to the organization (max 1000 results per page)
Filter list based on url query parameters (see query param examples for full list)
Only organization members can call

filter on node ESID of the data

\n","type":"text/plain"},"key":"node_esid","value":"123"},{"disabled":true,"description":{"content":"

filter on sensor ESID of the data

\n","type":"text/plain"},"key":"device_esid","value":"124"},{"disabled":true,"description":{"content":"

filter from start date (and time) of the data (inclusive)

\n","type":"text/plain"},"key":"from_time","value":"YYYY-MM-DDTHH:MM:SS"},{"disabled":true,"description":{"content":"

filter up to end date (and time) of the data (inclusive

\n","type":"text/plain"},"key":"to_time","value":"YYYY-MM-DD"},{"disabled":true,"description":{"content":"

filter from this latitude (inclusive)

\n","type":"text/plain"},"key":"latitude__gt","value":"29.10491"},{"disabled":true,"description":{"content":"

filter up to this latitude (inclusive)

\n","type":"text/plain"},"key":"latitude__lt","value":"193.10399"},{"disabled":true,"description":{"content":"

filter from this longitude (inclusive)

\n","type":"text/plain"},"key":"longitude__gt","value":"301.4051"},{"disabled":true,"description":{"content":"

filter up to this longitude (inclusive)

\n","type":"text/plain"},"key":"longitude__lt","value":"350.102100"},{"disabled":true,"description":{"content":"

filter from this altitude (inclusive)

\n","type":"text/plain"},"key":"altitude__gt","value":"50.1021"},{"disabled":true,"description":{"content":"

filter up to this altitude (inclusive)

\n","type":"text/plain"},"key":"altitude__lt","value":"95.1029"}],"variable":[]}},"response":[],"_postman_id":"316e0b27-df4d-4c60-bb84-10cfd309bc92"},{"name":"Get Organization Webhooks","id":"204f94ab-d3ab-4002-b5a0-856d4586f376","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"api.esci.io/organizations/{{organization_uuid}}/webhooks/","description":"

Gets all webhooks for the organization
Only organization admins can call

Gets all specified webhook from organization
Returns 404_NOT_FOUND if webhook does not exist
Only organization admins can call

Edit webhook frequency (in minutes) and active state
- Fields are optional
\n
Errors
- 400_BAD_REQUEST
  - No fields / incorrect fields provided
  \n
- 404_NOT_FOUND
  - Webhook does not exist
  \n
\n
Only organization admins can call

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"96c44f97-9b4c-4909-b3aa-2577499c941b","id":"96c44f97-9b4c-4909-b3aa-2577499c941b","name":"ESci Cloud","type":"collection"}},"urlObject":{"path":["organizations","{{organization_uuid}}","webhooks","{{webhook_id}}",""],"host":["api.esci.io"],"query":[],"variable":[]}},"response":[],"_postman_id":"ea5c07d7-9836-45d5-9a29-e5aa7d78ea6c"},{"name":"Create Organization Webhook","id":"86a8bfaa-1ab3-45da-9d2b-150fa1797292","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"url\": \"http://www.example.com\",\r\n \"authorization_header\": \"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX3BrIjoxLCJ0b2tlbl90eXBlIjoiYWNjZXNzIiwiY29sZF9zdHVmZiI6IuKYgyIsImV4cCI6MTIzNDU2LCJqdGkiOiJmZDJmOWQ1ZTFhN2M0MmU4OTQ5MzVlMzYyYmNhOGJjYSJ9.NHlztMGER7UADHZJlxNG0WSi22a2KaYSfd1SAuT7lU\",\r\n \"frequency\": 15\r\n}\r\n\r\n\r\n// Example json that webhook will post to the url\r\n// [\r\n// {\r\n// \"node_esid\": \"123\",\r\n// \"sensor_esid\": \"124\",\r\n// \"parameter_number\": 1,\r\n// \"unit\": \"ºC\",\r\n// \"time\": [\r\n// \"02-09-2022, 22:53:52\",\r\n// \"02-09-2022, 22:54:07\"\r\n// ],\r\n// \"value\": [\r\n// 1,\r\n// 2\r\n// ],\r\n// \"validated\": [\r\n// false,\r\n// false\r\n// ]\r\n// },\r\n// {\r\n// \"node_esid\": \"123\",\r\n// \"sensor_esid\": \"124\",\r\n// \"parameter_number\": 2,\r\n// \"unit\": \"kPa\",\r\n// \"time\": [\r\n// \"02-09-2022, 22:54:23\"\r\n// ],\r\n// \"value\": [\r\n// 3\r\n// ],\r\n// \"validated\": [\r\n// false\r\n// ]\r\n// }\r\n// ]","options":{"raw":{"language":"json"}}},"url":"api.esci.io/organizations/{{organization_uuid}}/webhooks/","description":"

Create webhook for organization
- Will send a confirmation request in the form of an empty array to the url (with authorization if any) before being created
\n
Webhooks automatically send any organization data between current time and the webhook's last transmit time based on the webhook's frequency as long as it is active. Will send an empty array if no new data
authorization_header is optional
frequency is in minutes
Errors
- 400_BAD_REQUEST
  - Invalid json, incorrect url
  - received Response other than 200_OK from url during creation
  - Errors when trying to send confirmation request to the url
  \n
\n
Only organization admins can call

Deletes organization webhook
Returns 404_NOT_FOUND if webhook does not exist
Only organization admins can call

Only ESci admins can call

Gets current user info
Returns
- username
- first name
- last name
- organizations list
- groups list
\n
Authenticated users can call

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"96c44f97-9b4c-4909-b3aa-2577499c941b","id":"96c44f97-9b4c-4909-b3aa-2577499c941b","name":"ESci Cloud","type":"collection"}},"urlObject":{"path":["users","current",""],"host":["api.esci.io"],"query":[],"variable":[]}},"response":[],"_postman_id":"f89f74b0-a18c-44ac-b1fa-922335205efd"},{"name":"Create User","id":"c51c74d0-f542-4f32-9cf1-c3afa0c8b6ca","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"username\": \"{{username}}\",\r\n \"password\": \"{{password}}\",\r\n \"first_name\": \"postman\",\r\n \"last_name\": \"test\",\r\n \"email\": \"test@esci.io\"\r\n}","options":{"raw":{"language":"json"}}},"url":"api.esci.io/users/","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"96c44f97-9b4c-4909-b3aa-2577499c941b","id":"96c44f97-9b4c-4909-b3aa-2577499c941b","name":"ESci Cloud","type":"collection"}},"urlObject":{"path":["users",""],"host":["api.esci.io"],"query":[],"variable":[]}},"response":[],"_postman_id":"c51c74d0-f542-4f32-9cf1-c3afa0c8b6ca"},{"name":"Edit User Info","id":"7ea89722-0a86-4e87-80c8-1b6db6b45662","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\r\n \"password\": \"\",\r\n \"first_name\": \"\",\r\n \"last_name\": \"\",\r\n \"email\": \"\"\r\n}","options":{"raw":{"language":"json"}}},"url":"api.esci.io/users/{{username}}/","description":"

Edit user's first name, last name, email, or password
Only the current user matching {{username}} can call

Checks availability of a username
If username already exists, returns 409_CONFLICT
If username available, returns 200_OK

Checks availability of an email
If email already exists, returns 409_CONFLICT
If email available, returns 200_OK

Gets all organization invites for user
Only the current user matching {{username}} can call

Gets all organization invites for caller

Gets the organization invite for {user_pk} if it is the current user

Creates invite for user {{username}} to join an organization by posting organization UUID
Results in an error if the current user is not an admin of the organization, invited user is already in organization, or invited user already has an invite

Accepts invite
User will now be in the organization and the invite is deleted
Only callable if current user matches {{username}}

Reject invite
Invite is deleted
Only callable if current user matches {{username}}

Only ESci admins can call

Device owners (ie. users who belong to an organization that owns this device) can call

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"96c44f97-9b4c-4909-b3aa-2577499c941b","id":"96c44f97-9b4c-4909-b3aa-2577499c941b","name":"ESci Cloud","type":"collection"}},"urlObject":{"path":["devices","{{esid}}",""],"host":["api.esci.io"],"query":[],"variable":[]}},"response":[],"_postman_id":"98ec2c30-03a7-421e-aec3-0d242b1819c1"},{"name":"Add new device","id":"675eda4c-beff-4c91-826c-f1e4079e2136","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"part_number\": \"ESA-12345\",\n \"hardware_version\": \"B\"\n}\n\n// example response.data\n// {\n// \"esid\": \"GLMCHJ\",\n// \"device_type\": {\n// \"id\": 1,\n// \"name\": \"Temperature Pressure Sensor\",\n// \"part_number\": \"ESA-1001\",\n// \"device_category\": \"S\"\n// },\n// \"hardware_version\": \"B\",\n// \"parameters\": [\n// {\n// \"parameter_number\": 1,\n// \"category\": \"Temperature\",\n// \"unit\": \"ºC\",\n// \"label\": \"Area 1\"\n// },\n// {\n// \"parameter_number\": 2,\n// \"category\": \"Soil Water Tension\",\n// \"unit\": \"kPa\",\n// \"label\": \"Area 2\"\n// }\n// ]\n// }\n","options":{"raw":{"language":"json"}}},"url":"api.esci.io/devices/","description":"

Adds device to cloud with the specified POST data:
- part_number
- hardware_version
\n
Device ESID will automatically be generated and any device parameters will be created based on the DeviceType's default parameter list if it exists.
Any generated parameters will have a 1:1 calibration generated with it as well
If device is interfacer, sets configurable to TRUE, so users can modify the device with other APIs
Errors:
- 400_BAD_REQUEST
  - Device type with part_number does not exist
  - Any fields missing
  \n
\n
Only ESci admins can call

Updates the device's firmware version to the posted firmware_version
Errors:
- 400_BAD_REQUEST when field is missing
- 404_NOT_FOUND if esid does not exist
\n

Edit device details
All fields optional
Changing owner_organization will automatically remove this device from all existing groups it belongs to
Changing node_esid will automatically assign this device to the new node
Errors:
- 400_BAD_REQUEST
  - No fields supplied
  - Node ESID does not exist
  - Owner Organization does not exist
  \n
\n
Only ESci admins can call

Edit device label
Errors:
- 400_BAD_REQUEST
  - No \"label\" field supplied
  \n
\n
Only Device owner admins can call

Device owners (ie. users who belong to an organization that owns this device) can call

Device owners (ie. users who belong to an organization that owns this device) can call

Creates parameter for device
- category field takes in category id generated in the database. (Unknown to non ESci users except on the front-end)
- Will create a 1:1 default calibration for this parameter
\n
Errors:
- 404_NOT_FOUND
  - Device esid does not exist
  \n
- 400_BAD_REQUEST
  - parameter category id does not exist
  - Entering a parameter number that already exists on the device
  \n
- 403_FORBIDDEN
  - Device is not configurable (ignored if ESci admin)
  \n
\n
Only device owner admins or ESci admins can call

Edit device's parameter
All fields are optional
Errors:
- 404_NOT_FOUND
  - Parameter does not exist
  \n
- 400_BAD_REQUEST
  - parameter category id does not exist
  - Entering a parameter number that already exists on the device
  \n
- 403_FORBIDDEN
  - Device is not configurable (ignored if ESci admin)
  \n
\n
Only device owner admins and ESci admins can call

Delete device's parameter if it is configurable
Errors:
- 404_NOT_FOUND
  - Parameter does not exist
  \n
- 403_FORBIDDEN
  - Device is not configurable (ignored if ESci admin)
  \n
\n
Only device owner admins and ESci admins can call

Gets list of all calibrations for parameter {parameter_number} on device {esid}
Only device owners can call

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"96c44f97-9b4c-4909-b3aa-2577499c941b","id":"96c44f97-9b4c-4909-b3aa-2577499c941b","name":"ESci Cloud","type":"collection"}},"urlObject":{"path":["devices","{{esid}}","parameters","{{parameter_number}}","calibrations",""],"host":["api.esci.io"],"query":[],"variable":[]}},"response":[],"_postman_id":"43ca4695-0d4e-4ba0-8ee2-f6c4b58ba3cc"},{"name":"Get Device Parameter Calibration","id":"131b8a3d-101e-4053-8104-cbafeedb160d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"api.esci.io/devices/{{esid}}/parameters/{{parameter_number}}/calibrations/{{calibration_id}}/","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"96c44f97-9b4c-4909-b3aa-2577499c941b","id":"96c44f97-9b4c-4909-b3aa-2577499c941b","name":"ESci Cloud","type":"collection"}},"urlObject":{"path":["devices","{{esid}}","parameters","{{parameter_number}}","calibrations","{{calibration_id}}",""],"host":["api.esci.io"],"query":[],"variable":[]}},"response":[],"_postman_id":"131b8a3d-101e-4053-8104-cbafeedb160d"},{"name":"Add Device Parameter Calibration","id":"28cb2cc5-7982-43d0-9a42-26b7844e59fe","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"conversion_function\": \"x + 5\",\r\n \"start_time\": \"YYYY-MM-DDThh:mm\" \r\n}","options":{"raw":{"language":"json"}}},"url":"api.esci.io/devices/{{esid}}/parameters/{{parameter_number}}/calibrations/","description":"

Creates a Calibration instance for this parameter on the device
Conversion function is required, start_time is optional
If start_time not supplied, will retroactively create transformed data from all raw data matching device and parameter info, but only if the raw data belongs to current device owner.
If start_time supplied, will only create transformed data from raw data that has time stamp = start_time or later
Errors:
- 400_BAD_REQUEST
  - incorrect date time format
  - Missing conversion function
  \n
- 404_NOT_FOUND
  - Parameter does not exist
  \n
\n
Only device owner admins or ESci Admins can call

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"96c44f97-9b4c-4909-b3aa-2577499c941b","id":"96c44f97-9b4c-4909-b3aa-2577499c941b","name":"ESci Cloud","type":"collection"}},"urlObject":{"path":["devices","{{esid}}","parameters","{{parameter_number}}","calibrations",""],"host":["api.esci.io"],"query":[],"variable":[]}},"response":[],"_postman_id":"28cb2cc5-7982-43d0-9a42-26b7844e59fe"},{"name":"TODO: EDIT CALIBRATION??","id":"9f0e3c03-8b1f-4df0-a6fe-f31a2264e716","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"conversion_function\": \"x + 5\",\r\n \"start_time\": \"YYYY-MM-DDThh:mm\" \r\n}","options":{"raw":{"language":"json"}}},"url":"api.esci.io/devices/{{esid}}/parameters/{{parameter_number}}/calibrations/{{calibration_id}}/","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"96c44f97-9b4c-4909-b3aa-2577499c941b","id":"96c44f97-9b4c-4909-b3aa-2577499c941b","name":"ESci Cloud","type":"collection"}},"urlObject":{"path":["devices","{{esid}}","parameters","{{parameter_number}}","calibrations","{{calibration_id}}",""],"host":["api.esci.io"],"query":[],"variable":[]}},"response":[],"_postman_id":"9f0e3c03-8b1f-4df0-a6fe-f31a2264e716"},{"name":"Get Device Raw Data","id":"7cfc09ba-3a98-4c5a-a887-b799c56f5fd6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"api.esci.io/devices/{{esid}}/rawdata/","description":"

Returns list of all raw data from device in order of sensor_esid, parameter number, timestamp
- If device is a node, returns all raw data from all sensors on node
\n
Only ESci Admins can call

Only ESci Admins can call

Returns list of all data from device in order of sensor_esid, parameter number, time generated
- If device is a node, returns all raw data from all sensors on node
\n
Only ESci Admins can call

Only ESci admins can call

Lists all available device types along with their default parameters
Only ESci admins can call

Get device type by its part number
Returns 404_NOT_FOUND if device type does not exist
Only ESci admins can call

Edits device information (all fields optional)
Device Categories: N = Node, S = Sensor, I = Interfacer, A = Actuator
Errors:
- 404_NOT_FOUND if device type does not exist
- 400_BAD_REQUEST if fields incorrect or duplicate part number entered
\n
Only ESci admins can call

Create a device type entry
All fields required.
- parameters is optional for non Sensors
- parameter_category and unit fields use their respective database id's
\n
Device Categories: N = Node, S = Sensor, I = Interfacer, A = Actuator
Returns error 404_BAD_REQUEST if fields missing, part number is duplicate, parameter numbers are duplicate, parameter_category or unit does not exist
Only ESci Admins can call

Gets list of default parameters for the given Device Type
Only ESci admins can call

Gets Default Parameter for given Device Type
Returns 404_DOES_NOT_EXIST if default parameter does not exist for the device type
Only ESci admins can call

Edits given Default Parameter for the Device Type
All fields are optional.
parameter_category and unit fields require their respective database id
Errors:
- 404_NOT_FOUND if default parameter does not exist
- 400_BAD_REQUEST if fields do not have valid values or if no valid fields provided, or if unit or category id's do not exist
\n

Creates and adds a Default Parameter to the device type
All fields required
Errors:
- 400_BAD_REQUEST
  - When trying to add a duplicate parameter number
  - Missing fields
  - Category id or Unit id does not exist
  \n
\n
Only ESci Admins can call

Deletes default parameter for the device type
400_NOT_FOUND if device type or default parameter does not exist
Only ESci Admins can call

Returns list of all transformed data and their raw data value in order of sensor_esid, parameter number, time generated
Only ESci admins can call

Returns list of all transformed data and their raw data value in order of sensor_esid, parameter number, time generated
Only ESci admins can call

Returns list of all raw data in order of sensor_esid, parameter number, time generated
Only ESci admins can call

Only ESci admins can call

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"96c44f97-9b4c-4909-b3aa-2577499c941b","id":"96c44f97-9b4c-4909-b3aa-2577499c941b","name":"ESci Cloud","type":"collection"}},"urlObject":{"path":["data","raw","{{rawdata_id}}",""],"host":["api.esci.io"],"query":[],"variable":[]}},"response":[],"_postman_id":"453ae590-2ff5-4a64-a051-f0b1d035c55c"},{"name":"Bulk Add Raw Data","id":"45c1ba40-078a-4962-878d-625e4785d082","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"node_esid\":\"123\",\r\n \"sensor_data\":[\r\n {\r\n \"sensor_esid\":\"124\",\r\n \"sensor_values\":[\r\n {\r\n \"parameter_number\":1,\r\n \"raw_value\":2.910,\r\n \"timestamp\":\"2022-01-10T17:41:00+0800\"\r\n },\r\n {\r\n \"parameter_number\":1,\r\n \"raw_value\":2.110,\r\n \"timestamp\":\"2022-01-10T17:41:00+0800\"\r\n },\r\n {\r\n \"parameter_number\":2,\r\n \"raw_value\":0.001938,\r\n \"timestamp\":\"2022-01-10T17:41:00+0800\"\r\n }\r\n ]\r\n },\r\n {\r\n \"sensor_esid\":\"125\",\r\n \"sensor_values\":[\r\n {\r\n \"parameter_number\":1,\r\n \"raw_value\":3,\r\n \"timestamp\":\"2022-01-10T17:41:00+0800\"\r\n }\r\n ]\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"api.esci.io/data/raw/bulkadd/","description":"

Adds raw data in bulk
- Syntax: {node_esid, sensor_data[{sensor_esid, sensor_values[{...values}]}]}
- See example body for full syntax
\n
Will add all data except for data under any sensor_esid that does not have a matching device or does not have an owner (reports the list of faulty esids in the 400 response)
Will automatically update any sensor's node to the new node if not updated already.
Auto generates transformed data from raw data using its sensor esid and parameter number with latest calibration function.
- If no parameter or calibration found, will report this in the error message
\n
Results in error when...
- node_esid does not have a matching device
- Any fields missing or bad syntax
\n
Callable by anything

Gets list of all available Telemetry Codes
Only callable by ESci Admins

Adds Telemetry Code type
Results in error if duplicate code entered
severity categories:
- I = Information
- D = Debug
- W = Warning
- E = Error
\n
Only ESci Admins can call

Edits Telemetry Code type
All fields optional
Results in error if duplicate code entered
severity categories:
- I = Information
- D = Debug
- W = Warning
- E = Error
\n
Only ESci Admins can call

Edits Telemetry Code type
All fields optional
Results in error if duplicate code entered
severity categories:
- I = Information
- D = Debug
- W = Warning
- E = Error
\n
Only ESci Admins can call

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"96c44f97-9b4c-4909-b3aa-2577499c941b","id":"96c44f97-9b4c-4909-b3aa-2577499c941b","name":"ESci Cloud","type":"collection"}},"urlObject":{"path":["data","telemetry_codes","{{telemetry_code}}",""],"host":["api.esci.io"],"query":[],"variable":[]}},"response":[],"_postman_id":"3e9ae391-eb37-4090-a738-fbc023491401"},{"name":"Bulk Add Telemetry","id":"7d8a4d51-ce50-4e31-958c-cc6acb2e32c8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"node_esid\":\"123\",\r\n \"devices\":[\r\n {\r\n \"device_esid\":\"124\",\r\n \"telemetry\":[\r\n {\r\n \"code\":1001,\r\n \"timestamp\":\"2022-01-10T17:41:00+0800\",\r\n \"value\":2.910\r\n },\r\n {\r\n \"code\":1001,\r\n \"timestamp\":\"2022-01-10T17:41:00+0800\",\r\n \"value\":3.210\r\n },\r\n {\r\n \"code\":1002,\r\n \"timestamp\":\"2022-01-10T17:41:00+0800\",\r\n \"value\":4.991\r\n }\r\n ]\r\n },\r\n {\r\n \"device_esid\":\"125\",\r\n \"values\":[\r\n {\r\n \"code\":1023,\r\n \"timestamp\":\"2022-01-10T17:41:00+0800\",\r\n \"value\":5.610\r\n }\r\n ]\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"api.esci.io/data/telemetry/bulkadd/","description":"

Adds raw data in bulk
- See example body for full syntax
\n
Will add all telemetry except for telemetry under any esid that does not have a matching device or any telemetry data that does not have a matching telemetry code (reports the list of faulty esids in the 400 response)
Will automatically update any sensor's node to the new node if not updated already.
Results in error when...
- node_esid does not have a matching device
- Any fields missing or bad syntax
\n
Callable by anything

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"96c44f97-9b4c-4909-b3aa-2577499c941b","id":"96c44f97-9b4c-4909-b3aa-2577499c941b","name":"ESci Cloud","type":"collection"}},"urlObject":{"path":["data","telemetry","bulkadd",""],"host":["api.esci.io"],"query":[],"variable":[]}},"response":[],"_postman_id":"7d8a4d51-ce50-4e31-958c-cc6acb2e32c8"},{"name":"Bulk Add Positions","id":"ab45f578-a15e-487c-9cc9-5ddf6862fc48","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"node_esid\":\"123\",\r\n \"devices\":[\r\n {\r\n \"device_esid\":\"124\",\r\n \"positions\":[\r\n {\r\n \"timestamp\":\"2022-01-10T17:41:00+0800\",\r\n \"latitude\": 1029.3019291,\r\n \"longitude\": 291.010491,\r\n \"altitude\": 319.14991\r\n },\r\n {\r\n \"timestamp\":\"2022-01-11T17:41:00+0800\",\r\n \"latitude\": 519.3551,\r\n \"longitude\": 295.49191\r\n }\r\n ]\r\n },\r\n {\r\n \"device_esid\":\"125\",\r\n \"positions\":[\r\n {\r\n \"timestamp\":\"2022-01-10T17:41:00+0800\",\r\n \"latitude\": 591.102,\r\n \"longitude\": 331.184811,\r\n \"altitude\": 491.221\r\n }\r\n ]\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"api.esci.io/data/positions/bulkadd/","description":"

Adds device position in bulk
- See example body for full syntax
\n
Will add all positions except for positions under any esid that does not have a matching device (reports the list of faulty esids in the 400 response)
Will automatically update any sensor's node to the new node if not updated already.
Results in error when...
- node_esid does not have a matching device
- Any fields missing or bad syntax
\n
Callable by anything

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"96c44f97-9b4c-4909-b3aa-2577499c941b","id":"96c44f97-9b4c-4909-b3aa-2577499c941b","name":"ESci Cloud","type":"collection"}},"urlObject":{"path":["data","positions","bulkadd",""],"host":["api.esci.io"],"query":[],"variable":[]}},"response":[],"_postman_id":"ab45f578-a15e-487c-9cc9-5ddf6862fc48"}],"id":"1785c064-d4a0-4a51-997e-219b9428d5c7","_postman_id":"1785c064-d4a0-4a51-997e-219b9428d5c7","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"96c44f97-9b4c-4909-b3aa-2577499c941b","id":"96c44f97-9b4c-4909-b3aa-2577499c941b","name":"ESci Cloud","type":"collection"}}},{"name":"Authentication","item":[{"name":"JWT Access Token Request","id":"9ece5dff-0fed-4948-af97-35e1ed2403e2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"username\": \"{{username}}\", \r\n \"password\": \"{{password}}\"\r\n}\r\n\r\n/*\r\nOr\r\n{\r\n \"email\": \"{{email}}\", \r\n \"password\": \"{{password}}\"\r\n}\r\n*/","options":{"raw":{"language":"json"}}},"url":"api.esci.io/token/","description":"

Requests a JWT authentication token through verification of username or email and password
Returns an access token (\"access\") and refresh token (\"refresh\")

Requests a JWT authentication token through verification of username and password
Returns an access token (\"access\") and refresh token (\"refresh\")

Requests a JWT authentication token through verification of username and password
Returns an access token (\"access\") and refresh token (\"refresh\")

\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"d7970801-d862-4212-ac3e-50dc7ba573b9","id":"d7970801-d862-4212-ac3e-50dc7ba573b9","name":"Authentication","type":"folder"}},"urlObject":{"path":["token","refresh",""],"host":["api.esci.io"],"query":[],"variable":[]}},"response":[],"_postman_id":"2659c6e0-1336-46c3-ba93-8e604d61bde0"}],"id":"d7970801-d862-4212-ac3e-50dc7ba573b9","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"id":"7fd5aad7-1e5e-4874-bfa0-26282fd44495","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"ece3e0ad-3f36-45b1-802a-a444a013b891","type":"text/javascript","exec":[""]}}],"_postman_id":"d7970801-d862-4212-ac3e-50dc7ba573b9","description":""}],"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]}},"event":[{"listen":"prerequest","script":{"id":"e68c3da8-44bf-468b-b5aa-6cbcf70a2e03","type":"text/javascript","exec":["const tokenUrl = pm.environment.get(\"base_url\") + '/token/';","","const username = pm.environment.get(\"username\");","const password = pm.environment.get(\"password\");","","const getTokenRequest = {"," method: 'POST',"," url: tokenUrl,"," headers: {"," 'Content-Type': 'application/json'"," },"," body: {"," \"username\": username, "," \"password\": password"," }","};","console.log(\"getTokenRequest\")","console.log(getTokenRequest)","console.log(username)","console.log(password)","","","pm.sendRequest(getTokenRequest, (err, response) => {"," const jsonResponse = response.json();"," const newAccessToken = jsonResponse.access;",""," //pm.environment.set('access_token', newAccessToken);","});"]}},{"listen":"test","script":{"id":"ea3bea98-55f9-45d1-a06c-66cd7458f395","type":"text/javascript","exec":[""]}}],"variable":[{"key":"access_token","value":""},{"key":"base_url","value":"api.esci.io"}]}