IoTDB RESTful API
\n\n\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"12320024","collectionId":"c4954ebd-6d01-41ac-90af-7d36aeb0debd","publishedId":"T1LLDnuj","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2020-08-11T03:18:29.000Z"},"item":[{"name":"user","item":[{"name":"Login IoTDB","event":[{"listen":"test","script":{"id":"103c65f8-78fc-49f0-8b34-a045017c6aa8","exec":[""],"type":"text/javascript"}}],"id":"479c0fc2-8df7-4373-bd94-11c08ba6bd9e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[],"url":"{{baseUrl}}/user/login?username=root&password=root","description":"Before you use IoTDB RESTful API, you have to login IoTDB through RESTful API.
\n
login IoTDB
\n","urlObject":{"path":["user","login"],"host":["{{baseUrl}}"],"query":[{"key":"username","value":"root"},{"key":"password","value":"root"}],"variable":[]}},"response":[{"id":"60b2821b-8a26-4454-8694-ae8fe18d3e54","name":"500 Internal Server Error","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/user/login?username=root&password=hello","host":["{{baseUrl}}"],"path":["user","login"],"query":[{"key":"username","value":"root"},{"key":"password","value":"hello"}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"content-type","value":"application/json; charset=UTF-8"},{"key":"connection","value":"keep-alive"},{"key":"content-encoding","value":"gzip"},{"key":"content-length","value":"101"}],"cookie":[],"responseTime":null,"body":"{\n \"errorClass\": \"org.apache.iotdb.db.auth.AuthException\",\n \"error\": \"root can't log in\"\n}"},{"id":"a7473d8b-9bbb-49cf-bd23-1bb42c55ab4d","name":"200 OK","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/user/login?username=root&password=root","host":["{{baseUrl}}"],"path":["user","login"],"query":[{"key":"username","value":"root"},{"key":"password","value":"root"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"content-type","value":"application/json; charset=UTF-8"},{"key":"connection","value":"keep-alive"},{"key":"content-encoding","value":"gzip"},{"key":"content-length","value":"59"}],"cookie":[],"responseTime":null,"body":"{\n \"result\": \"successful operation\"\n}"}],"_postman_id":"479c0fc2-8df7-4373-bd94-11c08ba6bd9e"},{"name":"Logout IoTDB","event":[{"listen":"test","script":{"id":"dfd996a9-585d-4a3e-9fcb-14cf0101c8a3","exec":[""],"type":"text/javascript"}}],"id":"101b947a-4bed-4c00-b85f-099a0b72ad60","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[],"url":"{{baseUrl}}/user/logout?username=root","description":"logout IoTDB
\n","urlObject":{"path":["user","logout"],"host":["{{baseUrl}}"],"query":[{"key":"username","value":"root"}],"variable":[]}},"response":[{"id":"a2b8965a-7f6c-4b17-b3bf-eef5a201d7f0","name":"200 OK","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/user/logout?username=root","host":["{{baseUrl}}"],"path":["user","logout"],"query":[{"key":"username","value":"root"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"content-type","value":"application/json; charset=UTF-8"},{"key":"connection","value":"keep-alive"},{"key":"content-encoding","value":"gzip"},{"key":"content-length","value":"59"}],"cookie":[],"responseTime":null,"body":"{\n \"result\": \"successful operation\"\n}"},{"id":"e9f5a54b-f045-4dc2-a8ba-8117f20456db","name":"500 Internal Server Error","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/user/logout?username=hello","host":["{{baseUrl}}"],"path":["user","logout"],"query":[{"key":"username","value":"hello"}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"content-type","value":"application/json; charset=UTF-8"},{"key":"connection","value":"keep-alive"},{"key":"content-encoding","value":"gzip"},{"key":"content-length","value":"98"}],"cookie":[],"responseTime":null,"body":"{\n \"errorClass\": \"org.apache.iotdb.db.auth.AuthException\",\n \"error\": \"wrong username\"\n}"}],"_postman_id":"101b947a-4bed-4c00-b85f-099a0b72ad60"}],"id":"6192fc74-3f41-4688-b22b-ad0561c3efe6","description":"login to IoTDB or logout for one session.
\n","_postman_id":"6192fc74-3f41-4688-b22b-ad0561c3efe6"},{"name":"storageGroups","item":[{"name":"Set storage groups to the IoTDB","event":[{"listen":"test","script":{"id":"a0689a9a-8af5-4935-a5be-f652098a9e6b","exec":[""],"type":"text/javascript"}}],"id":"6aa805ae-967c-4f1e-b98a-83ffbf331e6b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"[\n \"root.ln\",\n \"root.sg\"\n]","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/storageGroups","description":"Set storage groups to the IoTDB. You can set multiple storage groups.
\n","urlObject":{"path":["storageGroups"],"host":["{{baseUrl}}"],"query":[],"variable":[]}},"response":[{"id":"a30621e4-27f6-4b82-9d1d-75c99cf3b23d","name":"500 Internal Server Error","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"[\n \"root.ln\",\n \"root.sg\"\n]","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/storageGroups"},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"content-type","value":"application/json; charset=UTF-8"},{"key":"connection","value":"keep-alive"},{"key":"content-encoding","value":"gzip"},{"key":"content-length","value":"152"}],"cookie":[],"responseTime":null,"body":"{\n \"errorClass\": \"org.apache.iotdb.db.exception.query.QueryProcessException\",\n \"error\": \"org.apache.iotdb.db.exception.metadata.StorageGroupAlreadySetException: root.ln has already been set to storage group\"\n}"},{"id":"cc85bb7d-75cc-4f69-be66-9875c53258da","name":"200 OK","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"[\n \"root.ln\",\n \"root.sg\"\n]","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/storageGroups"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"content-type","value":"application/json; charset=UTF-8"},{"key":"connection","value":"keep-alive"},{"key":"content-encoding","value":"gzip"},{"key":"content-length","value":"59"}],"cookie":[],"responseTime":null,"body":"{\n \"result\": \"successful operation\"\n}"}],"_postman_id":"6aa805ae-967c-4f1e-b98a-83ffbf331e6b"},{"name":"Get all storage groups from the IoTDB","event":[{"listen":"test","script":{"id":"f5457f51-d5db-4b9e-b19b-dac1527141e6","exec":[""],"type":"text/javascript"}}],"id":"b73cfa68-9e6a-4c5e-9d11-a125c1561bf6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[],"url":"{{baseUrl}}/storageGroups","description":"Get all storage groups from the IoTDB
\n","urlObject":{"path":["storageGroups"],"host":["{{baseUrl}}"],"query":[],"variable":[]}},"response":[{"id":"5d238f36-87fe-4608-887f-939096cb47a3","name":"500 Internal Server Error","originalRequest":{"method":"GET","header":[],"url":"{{baseUrl}}/storageGroups"},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"content-type","value":"application/json; charset=UTF-8"},{"key":"connection","value":"keep-alive"},{"key":"content-encoding","value":"gzip"},{"key":"content-length","value":"124"}],"cookie":[],"responseTime":null,"body":"{\n \"errorClass\": \"org.apache.iotdb.db.exception.UnsupportedHttpMethod\",\n \"error\": \"/storageGroup can't be found\"\n}"},{"id":"b1969ce6-b064-4ad5-8f65-a3b212d1ea38","name":"200 OK","originalRequest":{"method":"GET","header":[],"url":"{{baseUrl}}/storageGroups"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"content-type","value":"application/json; charset=UTF-8"},{"key":"connection","value":"keep-alive"},{"key":"content-encoding","value":"gzip"},{"key":"content-length","value":"62"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"storage group\": \"root.ln\"\n },\n {\n \"storage group\": \"root.sg\"\n }\n]"}],"_postman_id":"b73cfa68-9e6a-4c5e-9d11-a125c1561bf6"},{"name":"Delete storage groups in the IoTDB","event":[{"listen":"test","script":{"id":"7448eb9f-10b1-4fd6-9761-e23fdee007a6","exec":[""],"type":"text/javascript"}}],"id":"d4996232-e93b-471e-b133-1d62c19e5738","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"[\n \"root.ln\",\n \"root.sg\"\n]","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/storageGroups/delete","description":"Delete storage groups in the IoTDB.
\n","urlObject":{"path":["storageGroups","delete"],"host":["{{baseUrl}}"],"query":[],"variable":[]}},"response":[{"id":"a041b717-ecd1-4cce-9b6f-afbcb919caf7","name":"500 Internal Server Error","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"[\n \"root.ln\",\n \"root.sg\"\n]","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/storageGroups/delete"},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"content-type","value":"application/json; charset=UTF-8"},{"key":"connection","value":"keep-alive"},{"key":"content-encoding","value":"gzip"},{"key":"content-length","value":"141"}],"cookie":[],"responseTime":null,"body":"{\n \"errorClass\": \"org.apache.iotdb.db.exception.query.QueryProcessException\",\n \"error\": \"org.apache.iotdb.db.exception.metadata.PathNotExistException: Path [root.ln] does not exist\"\n}"},{"id":"ef4d88bf-fdcd-4faf-a333-4b1c52eca2f7","name":"200 OK","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"[\n \"root.ln\",\n \"root.sg\"\n]","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/storageGroups/delete"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"content-type","value":"application/json; charset=UTF-8"},{"key":"connection","value":"keep-alive"},{"key":"content-encoding","value":"gzip"},{"key":"content-length","value":"59"}],"cookie":[],"responseTime":null,"body":"{\n \"result\": \"successful operation\"\n}"}],"_postman_id":"d4996232-e93b-471e-b133-1d62c19e5738"}],"id":"b6b4c341-e168-4fd1-9578-3a6e95007500","description":"operations about the storage group in IoTDB.
\n","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"id":"19d649b5-7233-43d2-8577-a9877be7f038","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"34003259-7387-482b-be0c-81ecfb17d500","type":"text/javascript","exec":[""]}}],"_postman_id":"b6b4c341-e168-4fd1-9578-3a6e95007500"},{"name":"timeSeries","item":[{"name":"Create timeSeries in the IoTDB","event":[{"listen":"test","script":{"id":"c54a7824-45b8-43ae-8275-7b4e5866d15e","exec":[""],"type":"text/javascript"}}],"id":"6b469f4c-0590-444b-8459-4fb43136961e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"[\n {\n \"timeSeries\": \"root.sg.d1.s1\",\n \"alias\": \"temperature\",\n \"dataType\": \"DOUBLE\",\n \"encoding\": \"PLAIN\"\n },\n {\n \"timeSeries\": \"root.sg.d1.s2\",\n \"dataType\": \"BOOLEAN\",\n \"encoding\": \"PLAIN\"\n }\n]","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/timeSeries","description":"Create timeSeries in the IoTDB.
\n","urlObject":{"path":["timeSeries"],"host":["{{baseUrl}}"],"query":[],"variable":[]}},"response":[{"id":"3c7211f0-55a1-4e13-8d6a-5b6f316fa27a","name":"500 Internal Server Error","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"[\n {\n \"timeSeries\": \"root.sg.d1.s1\",\n \"alias\": \"temperature\",\n \"dataType\": \"DOUBLE\",\n \"encoding\": \"PLAIN\"\n },\n {\n \"timeSeries\": \"root.sg.d1.s2\",\n \"dataType\": \"BOOLEAN\",\n \"encoding\": \"PLAIN\"\n }\n]","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/timeSeries"},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"content-type","value":"application/json; charset=UTF-8"},{"key":"connection","value":"keep-alive"},{"key":"content-encoding","value":"gzip"},{"key":"content-length","value":"144"}],"cookie":[],"responseTime":null,"body":"{\n \"errorClass\": \"org.apache.iotdb.db.exception.query.QueryProcessException\",\n \"error\": \"org.apache.iotdb.db.exception.metadata.PathAlreadyExistException: Path [root.sg.d1.s1] already exist\"\n}"},{"id":"3d37fc0a-c371-490c-9aaa-4d04e05be430","name":"200 OK","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"[\n {\n \"timeSeries\": \"root.sg.d1.s1\",\n \"alias\": \"temperature\",\n \"dataType\": \"DOUBLE\",\n \"encoding\": \"PLAIN\"\n },\n {\n \"timeSeries\": \"root.sg.d1.s2\",\n \"dataType\": \"BOOLEAN\",\n \"encoding\": \"PLAIN\"\n }\n]","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/timeSeries"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"content-type","value":"application/json; charset=UTF-8"},{"key":"connection","value":"keep-alive"},{"key":"content-encoding","value":"gzip"},{"key":"content-length","value":"59"}],"cookie":[],"responseTime":null,"body":"{\n \"result\": \"successful operation\"\n}"}],"_postman_id":"6b469f4c-0590-444b-8459-4fb43136961e"},{"name":"Get timeSeries in the IoTDB","event":[{"listen":"test","script":{"id":"9cd49100-07c3-4520-9995-fc49deed9ef3","exec":[""],"type":"text/javascript"}}],"id":"071ffaa0-3bea-46e5-979f-1221dc3bf9b2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"[\n \"root.sg.d1.s1\",\n \"root.sg.d1.s2\"\n]","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/getTimeSeries","description":"get information about time-series in IoTDB.
\n","urlObject":{"path":["getTimeSeries"],"host":["{{baseUrl}}"],"query":[],"variable":[]}},"response":[{"id":"35e656bc-efed-4d47-ac61-a84d771e6d9b","name":"500 Internal Server Error","originalRequest":{"method":"GET","header":[],"body":{"mode":"raw","raw":"[\n \"root.sg.d2.s5\",\n \"root.sg.d1.s2\"\n]","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/getTimeSeries"},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"content-type","value":"application/json; charset=UTF-8"},{"key":"connection","value":"keep-alive"},{"key":"content-encoding","value":"gzip"},{"key":"content-length","value":"129"}],"cookie":[],"responseTime":null,"body":"{\n \"errorClass\": \"org.apache.iotdb.db.exception.metadata.PathNotExistException\",\n \"error\": \"Path [root.sg.d2.s5] does not exist\"\n}"},{"id":"4a3780f9-3d16-4218-a19b-09b406d113d8","name":"200 OK","originalRequest":{"method":"GET","header":[],"body":{"mode":"raw","raw":"[\n \"root.sg.d1.s1\",\n \"root.sg.d1.s2\"\n]","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/getTimeSeries"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"content-type","value":"application/json; charset=UTF-8"},{"key":"connection","value":"keep-alive"},{"key":"content-encoding","value":"gzip"},{"key":"content-length","value":"106"}],"cookie":[],"responseTime":null,"body":"[\n [\n \"root.sg.d1.s1\",\n \"temperature\",\n \"root.sg\",\n \"DOUBLE\",\n \"PLAIN\",\n \"SNAPPY\"\n ],\n [\n \"root.sg.d1.s2\",\n \"null\",\n \"root.sg\",\n \"BOOLEAN\",\n \"PLAIN\",\n \"SNAPPY\"\n ]\n]"}],"_postman_id":"071ffaa0-3bea-46e5-979f-1221dc3bf9b2"},{"name":"Delete timeSeries in the IoTDB","event":[{"listen":"test","script":{"id":"f7a5c7ed-9d2c-4118-97ef-4e8b2fe5b04c","exec":[""],"type":"text/javascript"}}],"id":"2b6d6861-443c-42a3-9982-b52b1b7f87a6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"[\n \"root.sg.d1.s1\",\n \"root.sg.d1.s2\"\n]","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/timeSeries/delete","description":"Delete time-series in the IoTDB.
\n","urlObject":{"path":["timeSeries","delete"],"host":["{{baseUrl}}"],"query":[],"variable":[]}},"response":[{"id":"9ccf0652-9068-4374-9ae0-1ff22e993c97","name":"200 OK","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"[\n \"root.sg.d1.s1\",\n \"root.sg.d1.s2\"\n]","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/timeSeries/delete"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"content-type","value":"application/json; charset=UTF-8"},{"key":"connection","value":"keep-alive"},{"key":"content-encoding","value":"gzip"},{"key":"content-length","value":"59"}],"cookie":[],"responseTime":null,"body":"{\n \"result\": \"successful operation\"\n}"},{"id":"a1c838a2-c65b-4a28-8be9-6fd7cd751a0e","name":"500 Internal Server Error","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"[\n \"root.sg.d1.s1\",\n \"root.sg.d1.s2\"\n]","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/timeSeries/delete"},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"content-type","value":"application/json; charset=UTF-8"},{"key":"connection","value":"keep-alive"},{"key":"content-encoding","value":"gzip"},{"key":"content-length","value":"127"}],"cookie":[],"responseTime":null,"body":"{\n \"errorClass\": \"org.apache.iotdb.db.exception.metadata.PathNotExistException\",\n \"error\": \"Path [root.sg.d1.s1] does not exist\"\n}"}],"_postman_id":"2b6d6861-443c-42a3-9982-b52b1b7f87a6"}],"id":"d91c30ed-9294-4d4c-aea4-8792b49d1e0a","description":"operations about the timeSeries in IoTDB.
\n","_postman_id":"d91c30ed-9294-4d4c-aea4-8792b49d1e0a"},{"name":"insert","item":[{"name":"insert data into IoTDB","id":"3e77b1f0-a00a-4d9f-b549-8c8909c1bffb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"[\n {\n \"deviceId\": \"root.ln.wf01.wt01\",\n \"measurements\": [\n \"temperature\",\n \"status\"\n ],\n \"timestamps\": 1,\n \"values\": [\n 1.1,\n false\n ]\n },\n {\n \"deviceId\": \"root.ln.wf01.wt01\",\n \"measurements\": [\n \"hardware\",\n \"status\"\n ],\n \"timestamp\": 1,\n \"values\": [\n 1.1,\n false\n ]\n }\n]","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/insert","description":"insert data into IoTDB. When isNeedInferType is false, the JSON string datatype will be recognized as IoTDB TEXT type. The number type will be recognized as IoTDB INT32 type or IoTDB FLOAT.
operations about write data into the IoTDB.
\n","_postman_id":"2bb62e61-b317-45c6-b6cd-cf80cd10e5ca"},{"name":"query","item":[],"id":"d7b91bfa-4eab-46cf-9722-bc3e773d759c","description":"operations about query data from the IoTDB.
\n","_postman_id":"d7b91bfa-4eab-46cf-9722-bc3e773d759c"},{"name":"metadata","item":[],"id":"c15a4783-f0fa-4632-b52a-0f9470998252","_postman_id":"c15a4783-f0fa-4632-b52a-0f9470998252","description":""},{"name":"sql","id":"80ca8592-ba11-42e2-bf7b-679616911a78","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"sql\" : \"select * from root\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/sql","urlObject":{"path":["sql"],"host":["{{baseUrl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"80ca8592-ba11-42e2-bf7b-679616911a78"}]}