{"info":{"_postman_id":"9235eba1-7e9d-43b4-ac20-86855931def0","name":"Microshare™ Admin API","description":"<html><head></head><body><p>Dev Server : <a href=\"https://dapp.microshare.io/login\">dapp.microshare.io</a><br>\nProd Server : <a href=\"https://app.microshare.io/login\">app.microshare.io</a></p>\n<hr>\n<p>Before tackling the concepts on this page, please follow the <a href=\"https://docs.microshare.io/docs/2/technical/api/share-api/\">Microshare® Share API guide</a> first!</p>\n<p>These requests allow you to outsource actions made on the Microshare® Composer. Before exercising this ability, you must understand how an item works on Microshare® before using the corresponding APIs.</p>\n<p>For this part we will assume that you are comfortable with interacting with the Microshare® APIs, and the Microshare® platform.</p>\n<p><strong>Please Note:</strong> Any <code>recType</code>, <code>id</code> and <code>Tag</code> given are examples only, you will need to include your own identifiers for each request. </p>\n<p>Confused on any Microshare® terminology? <a href=\"https://docs.microshare.io/docs/2/general/quick-start/glossary/\">Visit our glossary of terms</a>.</p>\n<p>Have a question not answered here? Do not hesitate to contact us at <code>support@microshare.io</code>!</p>\n</body></html>","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"11447458","collectionId":"9235eba1-7e9d-43b4-ac20-86855931def0","publishedId":"TVsuDT1p","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"004360","highlight":"006383"},"publishDate":"2021-01-05T23:13:00.000Z"},"item":[{"name":"Authentication","item":[{"name":"Request Bearer Token","event":[{"listen":"test","script":{"id":"7eeb6fc6-5980-41d6-a43e-3ae8e3b95200","exec":["var jsonData = JSON.parse(responseBody);\r","postman.setEnvironmentVariable(\"token\", jsonData.access_token);\r","/*[[start postmanerator]]*/\r","function populateNewAPIStructures() {\r","    APIStructures['robot'] = {\r","        name: 'Robots',\r","        description: 'Robots allow you to write scripts against your data stored as Shares in Microshare&#39;s data lake',\r","        fields: [\r","            {name: '<code>recType</code>', description: 'Record type using the dot notation format (eg. io.microshare.test)', type: 'string'},\r","            {name: '<code>id</code>', description: 'An auto-generated unique identifier for the robot', type: 'ObjectId'},\r","            {name: '<code>name</code>', description: 'Name of the robot', type: 'string'},\r","            {name: '<code>desc</code>', description: 'Description of the robot', type: 'string'},\r","            {name: '<code>data</code>', description: 'The data object contains a <code>scope</code> array with a list of scopes, a token under the <code>auth</code> key, the script of the robot under the <code>script</code> key, and a boolean <code>isActive</code> flag to activate or deactivate the robot', type: 'JSON Object'}\r","        ]\r","    };\r","\r","    APIStructures['rule'] = {\r","        name: 'Rules',\r","        description: 'Rules allow you to limit the visibility of your data stored as Shares in Microshare&#39;s data lake',\r","        fields: [\r","            {name: '<code>recType', description: 'Record type using the dot notation format (eg. io.microshare.test)', type: 'string'},\r","            {name: '<code>id</code>', description: 'An auto-generated unique identifier for the rule', type: 'ObjectId'},\r","            {name: '<code>name</code>', description: 'Name of the rule', type: 'string'},\r","            {name: '<code>desc</code>', description: 'Description of the rule', type: 'string'},\r","            {name: '<code>data</code>', description: 'The data object contains an <code>operations</code> array with a list of operations, and other variables defining the restrictions the rule is going to apply. More information is available below in the <code>POST /rule</code>', type: 'JSON Object'}\r","        ]\r","    };\r","\r","    APIStructures['share'] = {\r","        name: 'Shares',\r","        description: 'Shares represent your data stored in Microshare&#39;s data lake',\r","        fields: [\r","            {name: '<code>recType</code>', description: 'Record type using the dot notation format (eg. io.microshare.test)', type: 'string'},\r","            {name: '<code>id</code>', description: 'An auto-generated unique identifier for the share', type: 'ObjectId'},\r","            {name: '<code>data</code>', description: 'The data object is where your data is stored in our data lake', type: 'JSON Object'}\r","        ]\r","    };\r","}\r","/*[[end postmanerator]]*/"],"type":"text/javascript"}}],"id":"579eb480-8558-493a-ba06-3fe815adf02c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n\t\"username\":\"{{username}}\",\r\n\t\"password\":\"{{password}}\",\r\n\t\"client_id\":\"{{apikey}}\",\r\n\t\"grant_type\":\"password\",\r\n\t\"identity\": \"pointdefau\",\r\n\t\"scope\":\"ALL:ALL\"\r\n}"},"url":"{{authHostname}}/oauth2/token","description":"<p>Request a Token for querying the Microshare® network valid for 24 hours. You will need to provide username, password, as well as a valid API Key. You can manage your API keys in our <a href=\"https://msaf.microshare.io/composer#/keys\">Keys Console</a>.</p>\n<p>Just press <code>Send</code> and Postman will automatically update your environment. If having trouble, you can also follow <a href=\"https://docs.microshare.io/docs/2/technical/api/quick-start/\">this guide</a> to get your Token using the Microshare® Composer. </p>\n<p>The default scope is <code>ALL:ALL</code>, but you can replace it to request tokens that will allow limited operations. For example, if the scope is <code>SHARE:READ</code> the token will only allow you to read Shares.</p>\n","urlObject":{"path":["oauth2","token"],"host":["{{authHostname}}"],"query":[{"disabled":true,"key":"username","value":"{{username}}"},{"disabled":true,"key":"password","value":"{{password}}"}],"variable":[]}},"response":[],"_postman_id":"579eb480-8558-493a-ba06-3fe815adf02c"},{"name":"Request Pipe Token","event":[{"listen":"test","script":{"id":"4aa071b7-cb1b-4995-8fef-159db1cef2a1","exec":["var jsonData = JSON.parse(responseBody);","postman.setEnvironmentVariable(\"token\", jsonData.access_token);","/*[[start postmanerator]]*/","function populateNewAPIStructures() {","    APIStructures['robot'] = {","        name: 'Robots',","        description: 'Robots allow you to write scripts against your data stored as Shares in Microshare&#39;s data lake',","        fields: [","            {name: '<code>recType</code>', description: 'Record type using the dot notation format (eg. io.microshare.test)', type: 'string'},","            {name: '<code>id</code>', description: 'An auto-generated unique identifier for the robot', type: 'ObjectId'},","            {name: '<code>name</code>', description: 'Name of the robot', type: 'string'},","            {name: '<code>desc</code>', description: 'Description of the robot', type: 'string'},","            {name: '<code>data</code>', description: 'The data object contains a <code>scope</code> array with a list of scopes, a token under the <code>auth</code> key, the script of the robot under the <code>script</code> key, and a boolean <code>isActive</code> flag to activate or deactivate the robot', type: 'JSON Object'}","        ]","    };","","    APIStructures['rule'] = {","        name: 'Rules',","        description: 'Rules allow you to limit the visibility of your data stored as Shares in Microshare&#39;s data lake',","        fields: [","            {name: '<code>recType', description: 'Record type using the dot notation format (eg. io.microshare.test)', type: 'string'},","            {name: '<code>id</code>', description: 'An auto-generated unique identifier for the rule', type: 'ObjectId'},","            {name: '<code>name</code>', description: 'Name of the rule', type: 'string'},","            {name: '<code>desc</code>', description: 'Description of the rule', type: 'string'},","            {name: '<code>data</code>', description: 'The data object contains an <code>operations</code> array with a list of operations, and other variables defining the restrictions the rule is going to apply. More information is available below in the <code>POST /rule</code>', type: 'JSON Object'}","        ]","    };","","    APIStructures['share'] = {","        name: 'Shares',","        description: 'Shares represent your data stored in Microshare&#39;s data lake',","        fields: [","            {name: '<code>recType</code>', description: 'Record type using the dot notation format (eg. io.microshare.test)', type: 'string'},","            {name: '<code>id</code>', description: 'An auto-generated unique identifier for the share', type: 'ObjectId'},","            {name: '<code>data</code>', description: 'The data object is where your data is stored in our data lake', type: 'JSON Object'}","        ]","    };","}","/*[[end postmanerator]]*/"],"type":"text/javascript"}}],"id":"1e89869e-12af-4a02-ab2f-199b8dddd22c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"{{authHostname}}/oauth2/token?username={{username}}&password={{password}}&client_id={{apikey}}&grant_type=pipe&scope=ALL:ALL","description":"<p>Request a pipe Authentification token, required to stream data to your Microshare® account. </p>\n<p>You will need to provide username, password, as well as a valid API Key. You can manage your API keys in our <a href=\"https://dapp.microshare.io/composer#/keys\">Keys Console</a>.</p>\n<p>The default scope is <code>ALL:ALL</code>, but you can replace it to request tokens that will allow limited operations. For example, if the scope is <code>SHARE:READ</code> the token will only allow you to read Shares.</p>\n","urlObject":{"path":["oauth2","token"],"host":["{{authHostname}}"],"query":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{password}}"},{"key":"client_id","value":"{{apikey}}"},{"key":"grant_type","value":"pipe"},{"key":"scope","value":"ALL:ALL"}],"variable":[]}},"response":[],"_postman_id":"1e89869e-12af-4a02-ab2f-199b8dddd22c"},{"name":"Refresh Password Token","event":[{"listen":"test","script":{"id":"0ea12c52-b370-40fb-99f6-69eac68f7082","exec":["var jsonData = JSON.parse(responseBody);\r","postman.setEnvironmentVariable(\"token\", jsonData.access_token);\r","postman.setEnvironmentVariable(\"refresh\", jsonData.refresh_token);\r","postman.setEnvironmentVariable(\"skey\", jsonData.extended.sessionkey);\r","/*[[start postmanerator]]*/\r","function populateNewAPIStructures() {\r","    APIStructures['robot'] = {\r","        name: 'Robots',\r","        description: 'Robots allow you to write scripts against your data stored as Shares in Microshare&#39;s data lake',\r","\t\t\t\tfields: [\r","\t\t\t\t    {name: '<code>recType</code>', description: 'Record type using the dot notation format (eg. io.microshare.test)', type: 'string'},\r","\t\t\t\t\t{name: '<code>id</code>', description: 'An auto-generated unique identifier for the robot', type: 'ObjectId'},\r","\t\t\t\t\t{name: '<code>name</code>', description: 'Name of the robot', type: 'string'},\r","\t\t\t\t\t{name: '<code>desc</code>', description: 'Description of the robot', type: 'string'},\r","\t\t\t\t\t{name: '<code>data</code>', description: 'The data object contains a <code>scope</code> array with a list of scopes, a token under the <code>auth</code> key, the script of the robot under the <code>script</code> key, and a boolean <code>isActive</code> flag to activate or deactivate the robot', type: 'JSON Object'}\r","\t\t\t\t ]\r","              };\r","            \r","              APIStructures['rule'] = {\r","\t\t\t\t\tname: 'Rules',\r","\t\t\t\t\tdescription: 'Rules allow you to limit the visibility of your data stored as Shares in Microshare&#39;s data lake',\r","\t\t\t\t    fields: [\r","\t\t\t\t        {name: '<code>recType', description: 'Record type using the dot notation format (eg. io.microshare.test)', type: 'string'},\r","\t\t\t\t\t\t{name: '<code>id</code>', description: 'An auto-generated unique identifier for the rule', type: 'ObjectId'},\r","\t\t\t\t\t\t{name: '<code>name</code>', description: 'Name of the rule', type: 'string'},\r","\t\t\t\t\t\t{name: '<code>desc</code>', description: 'Description of the rule', type: 'string'},\r","\t\t\t\t\t\t{name: '<code>data</code>', description: 'The data object contains an <code>operations</code> array with a list of operations, and other variables defining the restrictions the rule is going to apply. More information is available below in the <code>POST /rule</code>', type: 'JSON Object'}\r","\t\t\t\t  ]\r","                };\r","                APIStructures['share'] = {\r","\t\t\t\t\tname: 'Shares',\r","\t\t\t\t\tdescription: 'Shares represent your data stored in Microshare&#39;s data lake',\r","\t\t\t\t\tfields: [\r","\t\t\t\t\t   {name: '<code>recType</code>', description: 'Record type using the dot notation format (eg. io.microshare.test)', type: 'string'},\r","\t\t\t\t       {name: '<code>id</code>', description: 'An auto-generated unique identifier for the share', type: 'ObjectId'},\r","\t\t\t\t\t\t{name: '<code>data</code>', description: 'The data object is where your data is stored in our data lake', type: 'JSON Object'}\r","\t\t\t\t      ]\r","\t\t\t\t   };\r","        }\r"," /*[[end postmanerator]]*/"],"type":"text/javascript"}}],"id":"eeab3139-6f4a-47ee-8023-fe46800d646a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n\t\"username\":\"{{username}}\",\r\n\t\"password\":\"{{password}}\",\r\n\t\"client_id\":\"{{apikey}}\",\r\n\t\"grant_type\":\"password\",\r\n\t\"identity\": \"pointdefau\",\r\n\t\"scope\":\"ALL:ALL\"\r\n}\r\n\r\n","options":{"raw":{"language":"json"}}},"url":"{{authHostname}}/oauth2/token?username={{username}}&password={{password}}","description":"<p>Quickly refresh your Password Token by providing your username, password, as well as a valid API Key. You can manage your API keys in our <a href=\"https://msaf.microshare.io/composer#/keys\">Keys Console</a>. Just Press <code>Send</code> to refresh your Password Token valid for 24 hours.</p>\n","urlObject":{"path":["oauth2","token"],"host":["{{authHostname}}"],"query":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{password}}"}],"variable":[]}},"response":[],"_postman_id":"eeab3139-6f4a-47ee-8023-fe46800d646a"}],"id":"41d59874-01d5-4c38-b53b-478b60f22f7d","description":"<p><img src=\"https://www.microshare.io/wp-content/uploads/2017/06/microshare-data-page.png\" alt=\"alt text\" /></p>\n<p><strong>Request and revoke tokens used to authenticate to our API</strong></p>\n","_postman_id":"41d59874-01d5-4c38-b53b-478b60f22f7d"},{"name":"Shares","item":[{"name":"Get one Share","id":"d16758eb-0d69-4ab8-b3f0-f8860430613d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","type":"text","value":"Bearer {{token}}"}],"url":"{{hostname}}/share/:recType/:id?discover=true","description":"<p>Retrieve a specific Share by including the <code>recType</code> and/ or the object <code>id</code> number. </p>\n<h6 id=\"query-parameters-available\">Query parameters available</h6>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Parameter</th>\n<th>Type</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>discover</code></td>\n<td>boolean</td>\n<td><code>true</code> will include objects that are not created by your account</td>\n</tr>\n</tbody>\n</table>\n</div><p><strong>Note:</strong> You must have discover set to true to see the example Shares!</p>\n","urlObject":{"path":["share",":recType",":id"],"host":["{{hostname}}"],"query":[{"key":"discover","value":"true"}],"variable":[{"type":"string","value":"io.microshare.documentation","key":"recType"},{"type":"string","value":"601053356399e12ca5439277","key":"id"}]}},"response":[],"_postman_id":"d16758eb-0d69-4ab8-b3f0-f8860430613d"},{"name":"Get Shares by recType","id":"15e38f52-a0f4-49b8-8016-22400dd72f18","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{}},"request":{"method":"GET","header":[{"key":"Authorization","type":"text","value":"Bearer {{token}}"}],"url":"{{hostname}}/share/:recType?details=true&discover=true","description":"<p>Retrieve a specific Share by including its <code>recType</code>. </p>\n<h6 id=\"query-parameters-available\">Query parameters available</h6>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Parameter</th>\n<th>Type</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>details</code></td>\n<td>boolean</td>\n<td><code>true</code> will return matching objects with their details, <code>false</code> will only return main information</td>\n</tr>\n<tr>\n<td><code>discover</code></td>\n<td>boolean</td>\n<td><code>true</code> will include objects that are not created by your account</td>\n</tr>\n</tbody>\n</table>\n</div><p><strong>Note:</strong> You must have discover set to true to see the example Shares!</p>\n","urlObject":{"path":["share",":recType"],"host":["{{hostname}}"],"query":[{"key":"details","value":"true"},{"disabled":true,"key":"page","value":""},{"disabled":true,"key":"perPage","value":"100"},{"key":"discover","value":"true"}],"variable":[{"type":"string","value":"io.microshare.documentation","key":"recType"}]}},"response":[],"_postman_id":"15e38f52-a0f4-49b8-8016-22400dd72f18"},{"name":"Get Shares by Tags and recType","id":"aac93eca-da41-48c0-9d51-fd6c6b2edf29","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","type":"text","value":"Bearer {{token}}"}],"url":"{{hostname}}/share/:recType/tags/:tag1/:tag2?details=true&page=1&perPage=100","description":"<p>Retrieve all shares under a specific <code>recType</code> and containing one or several <code>Tags</code>. Specify as many <code>Tags</code> as you need, objects containing all of these tags will be returned.</p>\n<h6 id=\"query-parameters-available\">Query parameters available</h6>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Parameter</th>\n<th>Type</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>details</code></td>\n<td>boolean</td>\n<td><code>true</code> will return matching objects with their details, <code>false</code> will only return main information</td>\n</tr>\n<tr>\n<td><code>page</code></td>\n<td>int</td>\n<td>Specifies the requested page, defaults to 1</td>\n</tr>\n<tr>\n<td><code>perPage</code></td>\n<td>int</td>\n<td>Specifies the number of objects to be returned per page, defaults to 999</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"path":["share",":recType","tags",":tag1",":tag2"],"host":["{{hostname}}"],"query":[{"key":"details","value":"true"},{"key":"page","value":"1"},{"key":"perPage","value":"100"}],"variable":[{"type":"string","value":"io.microshare.test","key":"recType"},{"type":"string","value":"Building1","key":"tag1"},{"type":"string","value":"1st%20Floor","key":"tag2"}]}},"response":[],"_postman_id":"aac93eca-da41-48c0-9d51-fd6c6b2edf29"},{"name":"Get Latest Shares by recType","id":"0ca9b17d-6d4b-40c2-a872-f340cd3ed22d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","type":"text","value":"Bearer {{token}}"}],"url":"{{hostname}}/share/:recType/tags/latest?details=true&discover=true","description":"<p>Retrieve your most recent Share associated with the specified <code>recType</code>.</p>\n<h6 id=\"query-parameters-available\">Query parameters available</h6>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Parameter</th>\n<th>Type</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>details</code></td>\n<td>boolean</td>\n<td><code>true</code> will return matching objects with their details, <code>false</code> will only return main information</td>\n</tr>\n<tr>\n<td><code>page</code></td>\n<td>int</td>\n<td>Specifies the requested page, defaults to 1</td>\n</tr>\n<tr>\n<td><code>perPage</code></td>\n<td>int</td>\n<td>Specifies the number of objects to be returned per page, defaults to 999</td>\n</tr>\n<tr>\n<td><code>discover</code></td>\n<td>boolean</td>\n<td><code>true</code> will include objects that are not created by your account</td>\n</tr>\n</tbody>\n</table>\n</div><p><strong>Note:</strong> You must have discover set to true to see the example Shares!</p>\n","urlObject":{"path":["share",":recType","tags","latest"],"host":["{{hostname}}"],"query":[{"key":"details","value":"true"},{"disabled":true,"key":"page","value":"1"},{"disabled":true,"key":"perPage","value":"100"},{"key":"discover","value":"true"}],"variable":[{"type":"string","value":"io.microshare.documentation","key":"recType"}]}},"response":[],"_postman_id":"0ca9b17d-6d4b-40c2-a872-f340cd3ed22d"},{"name":"Get Shares Through a View","id":"fc1eb73c-3d88-4034-a2cc-36d39d8185b1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","type":"text","value":"Bearer {{token}}"}],"url":"{{hostname}}/share/:view_rectype?id=6010522c6399e12ca5439235&param1=&param2=&param3=","description":"<p>Get access to a specific Share using View credentials. Some Shares are only accessible to certain accounts, use the associated View to retrieve the intended Share. Include the <code>id</code> number and the <code>view_rectype</code>. </p>\n<h6 id=\"query-parameters-available\">Query parameters available</h6>\n<p>Include extra parameters for <code>param1</code>, <code>param2</code> and <code>param3</code> to find your desired Share. </p>\n","urlObject":{"path":["share",":view_rectype"],"host":["{{hostname}}"],"query":[{"key":"id","value":"6010522c6399e12ca5439235"},{"key":"param1","value":""},{"key":"param2","value":""},{"key":"param3","value":""}],"variable":[{"type":"string","value":"io.microshare.documentation","key":"view_rectype"}]}},"response":[],"_postman_id":"fc1eb73c-3d88-4034-a2cc-36d39d8185b1"},{"name":"Create Share","id":"ea018f00-1d7f-4a6d-b3a0-02b2184153e3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","type":"text","value":"Bearer {{token}}"}],"body":{"mode":"raw","raw":"{\r\n    \"hello\": \"world\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{hostname}}/share/:recType","description":"<p>With this request, create a piece of data to send into the Microshare® data lake. Switch over to the <code>Body</code> of the request to change the content of your Share.</p>\n<p>You must include a record type using the dot notation format (eg. <code>io.microshare.test</code>). </p>\n","urlObject":{"path":["share",":recType"],"host":["{{hostname}}"],"query":[],"variable":[{"type":"string","value":"io.microshare.test","key":"recType"}]}},"response":[],"_postman_id":"ea018f00-1d7f-4a6d-b3a0-02b2184153e3"},{"name":"Create Share with Tags","id":"c9e061f3-ce5f-45ab-9e9e-25b07875e6e9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","type":"text","value":"Bearer {{token}}"}],"body":{"mode":"raw","raw":"{\r\n    \"hello\": \"world\",\r\n    \"welcome\":\"to Microshare\",\r\n    \"now\": \"with tags\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{hostname}}/share/:recType/tags/:tag1/:tag2","description":"<p>Create a piece of data to send into the Microshare® data lake with <code>Tags</code> (identifiers helpful for searching for your share). Switch over to the <code>Body</code> of the request to change the content of your Share.</p>\n","urlObject":{"path":["share",":recType","tags",":tag1",":tag2"],"host":["{{hostname}}"],"query":[],"variable":[{"type":"string","value":"io.microshare.test","key":"recType"},{"type":"string","value":"Building1","key":"tag1"},{"description":{"content":"<p>Rm%20305</p>\n","type":"text/plain"},"type":"string","value":"1st%20Floor","key":"tag2"}]}},"response":[],"_postman_id":"c9e061f3-ce5f-45ab-9e9e-25b07875e6e9"},{"name":"Delete one Share","id":"fe364125-c6e2-48f9-97cf-3451aec6a281","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Authorization","type":"text","value":"Bearer {{token}}"}],"url":"{{hostname}}/share/:recType/:id","description":"<p>Permanently remove a Share by specifying its <code>recType</code> and its <code>id</code> number. Please note that this action is irreversible and should be performed with caution. </p>\n","urlObject":{"path":["share",":recType",":id"],"host":["{{hostname}}"],"query":[],"variable":[{"type":"string","value":"io.microshare.test","key":"recType"},{"type":"string","value":"5ffccde767614445a125c055","key":"id"}]}},"response":[],"_postman_id":"fe364125-c6e2-48f9-97cf-3451aec6a281"}],"id":"45e44014-1670-4563-904b-192194361e7c","description":"<p><img src=\"https://www.microshare.io/wp-content/uploads/2017/06/microshare-data-page.png\" alt=\"alt text\" /></p>\n<p><strong>Each piece of data is called a \"Share\", here you can find all the requests to access your data.</strong></p>\n","_postman_id":"45e44014-1670-4563-904b-192194361e7c"},{"name":"Device","item":[{"name":"Get All Devices","id":"a1f7999c-c47a-423b-bbb7-9e6d784890eb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","type":"text","value":"Bearer {{token}}"}],"url":"https://dapi.microshare.io/device/*?details=true&page=1&perPage=200&discover=true&field=name&search=","description":"<p>Retrieve all your Device Clusters and their specifications.</p>\n<h6 id=\"query-parameters-available\">Query parameters available</h6>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Parameter</th>\n<th>Type</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>details</code></td>\n<td>boolean</td>\n<td><code>true</code> will return matching objects with their details, <code>false</code> will only return main information</td>\n</tr>\n<tr>\n<td><code>page</code></td>\n<td>int</td>\n<td>Specifies the requested page, defaults to 1</td>\n</tr>\n<tr>\n<td><code>perPage</code></td>\n<td>int</td>\n<td>Specifies the number of objects to be returned per page, defaults to 999</td>\n</tr>\n<tr>\n<td><code>discover</code></td>\n<td>boolean</td>\n<td><code>true</code> will include objects that are not created by your account</td>\n</tr>\n<tr>\n<td><code>field</code></td>\n<td>char</td>\n<td>Set to \"name\"</td>\n</tr>\n</tbody>\n</table>\n</div><p><strong>Note:</strong> You must have discover set to true to see the example Shares!</p>\n","urlObject":{"protocol":"https","path":["device","*"],"host":["dapi","microshare","io"],"query":[{"key":"details","value":"true"},{"key":"page","value":"1"},{"key":"perPage","value":"200"},{"key":"discover","value":"true"},{"key":"field","value":"name"},{"key":"search","value":""}],"variable":[]}},"response":[],"_postman_id":"a1f7999c-c47a-423b-bbb7-9e6d784890eb"},{"name":"Get one Device","id":"0a502426-4293-43fa-96fe-3b7c32a7d182","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{token}}"}],"url":"{{hostname}}/device/:recType/:id?discover=true","description":"<p>Retrieve one Device Cluster by <code>recType</code> and object <code>id</code> number. </p>\n<h6 id=\"query-parameters-available\">Query parameters available</h6>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Parameter</th>\n<th>Type</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>discover</code></td>\n<td>boolean</td>\n<td><code>true</code> will include objects that are not created by your account</td>\n</tr>\n</tbody>\n</table>\n</div><p><strong>Note:</strong> You must have discover set to true to see the example Shares!</p>\n","urlObject":{"path":["device",":recType",":id"],"host":["{{hostname}}"],"query":[{"key":"discover","value":"true"}],"variable":[{"type":"string","value":"io.microshare.documentation","key":"recType"},{"type":"string","value":"60104ca9ccd26a1dd5c25d85","key":"id"}]}},"response":[],"_postman_id":"0a502426-4293-43fa-96fe-3b7c32a7d182"},{"name":"Get Device by recType","id":"3a908217-5f5a-4bfc-a7a7-322074940267","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{token}}"}],"url":"{{hostname}}/device/:recType?details=true&page=&perPage=&discover=true","description":"<p>Retrieve all Device Clusters under a specific <code>recType</code>. </p>\n<h6 id=\"query-parameters-available\">Query parameters available</h6>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Parameter</th>\n<th>Type</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>details</code></td>\n<td>boolean</td>\n<td><code>true</code> will return matching objects with their details, <code>false</code> will only return main information</td>\n</tr>\n<tr>\n<td><code>page</code></td>\n<td>int</td>\n<td>Specifies the requested page, defaults to 1</td>\n</tr>\n<tr>\n<td><code>perPage</code></td>\n<td>int</td>\n<td>Specifies the number of objects to be returned per page, defaults to 999</td>\n</tr>\n<tr>\n<td><code>discover</code></td>\n<td>boolean</td>\n<td><code>true</code> will include objects that are not created by your account</td>\n</tr>\n</tbody>\n</table>\n</div><p><strong>Note:</strong> You must have discover set to true to see the example Shares!</p>\n","urlObject":{"path":["device",":recType"],"host":["{{hostname}}"],"query":[{"key":"details","value":"true"},{"key":"page","value":""},{"key":"perPage","value":""},{"key":"discover","value":"true"}],"variable":[{"type":"string","value":"io.microshare.documentation","key":"recType"}]}},"response":[],"_postman_id":"3a908217-5f5a-4bfc-a7a7-322074940267"},{"name":"Get Devices by Tags and recType","id":"9ad8aa88-cf5f-47a1-a6a4-ef10d0556539","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{token}}"}],"url":"{{hostname}}/device/:recType/tags/:tag1/:tag2?details=true&page=&perPage=&discover=true","description":"<p>Retrieve all Device Clusters under a specific <code>recType</code> and containing one or several <code>Tags</code>. Specify as many <code>Tags</code> as you need, objects containing all of these tags will be returned.</p>\n<h6 id=\"query-parameters-available\">Query parameters available</h6>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Parameter</th>\n<th>Type</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>details</code></td>\n<td>boolean</td>\n<td><code>true</code> will return matching objects with their details, <code>false</code> will only return main information</td>\n</tr>\n<tr>\n<td><code>page</code></td>\n<td>int</td>\n<td>Specifies the requested page, defaults to 1</td>\n</tr>\n<tr>\n<td><code>perPage</code></td>\n<td>int</td>\n<td>Specifies the number of objects to be returned per page, defaults to 999</td>\n</tr>\n<tr>\n<td><code>discover</code></td>\n<td>boolean</td>\n<td><code>true</code> will include objects that are not created by your account</td>\n</tr>\n</tbody>\n</table>\n</div><p><strong>Note:</strong> You must have discover set to true to see the example Shares!</p>\n","urlObject":{"path":["device",":recType","tags",":tag1",":tag2"],"host":["{{hostname}}"],"query":[{"key":"details","value":"true"},{"key":"page","value":""},{"key":"perPage","value":""},{"key":"discover","value":"true"}],"variable":[{"type":"string","value":"io.microshare.documentation","key":"recType"},{"type":"string","value":"Building","key":"tag1"},{"type":"string","value":"","key":"tag2"}]}},"response":[],"_postman_id":"9ad8aa88-cf5f-47a1-a6a4-ef10d0556539"},{"name":"Get Latest Device by recType","id":"6e81bb44-ab4f-4390-99cd-871967c0edc3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{token}}"}],"url":"{{hostname}}/device/:recType/tags/latest?details=true&page=&perPage=&discover=true","description":"<p>Retrieve your most recent Device Cluster associated with the given <code>recType</code>.</p>\n<h6 id=\"query-parameters-available\">Query parameters available</h6>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Parameter</th>\n<th>Type</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>details</code></td>\n<td>boolean</td>\n<td><code>true</code> will return matching objects with their details, <code>false</code> will only return main information</td>\n</tr>\n<tr>\n<td><code>page</code></td>\n<td>int</td>\n<td>Specifies the requested page, defaults to 1</td>\n</tr>\n<tr>\n<td><code>perPage</code></td>\n<td>int</td>\n<td>Specifies the number of objects to be returned per page, defaults to 999</td>\n</tr>\n<tr>\n<td><code>discover</code></td>\n<td>boolean</td>\n<td><code>true</code> will include objects that are not created by your account</td>\n</tr>\n</tbody>\n</table>\n</div><p><strong>Note:</strong> You must have discover set to true to see the example Shares!</p>\n","urlObject":{"path":["device",":recType","tags","latest"],"host":["{{hostname}}"],"query":[{"key":"details","value":"true"},{"key":"page","value":""},{"key":"perPage","value":""},{"key":"discover","value":"true"}],"variable":[{"type":"string","value":"io.microshare.documentation","key":"recType"}]}},"response":[],"_postman_id":"6e81bb44-ab4f-4390-99cd-871967c0edc3"},{"name":"Create one Device","id":"ead79f8d-c818-4524-a1c3-c7100010ba78","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{token}}"}],"body":{"mode":"raw","raw":"{\n   \"desc\":\"Motion Cluster API\",\n   \"name\":\"Test Device Cluster - Created via Postman\",\n   \"data\":{\n      \"isActive\": true,\n      \"readAuth\": \"\",\n      \"writeAuth\": \"\",\n      \"devices\":[\n         {\n            \"id\":\"58-A0-CB-00-00-00-00-00\",\n            \"meta\":{\n               \"lora\":{\n                  \"AppKey\":\"GD711F6F52AE456IB95A1820EB36713A\",\n                  \"NwkKey\":\"235FBCC234ADAB685BCB23AA0923DCD32\",\n                  \"JoinEUI\":\"58-A0-CB-00-00-00-00-01\",\n                  \"DevEUI\":\"58-A0-CB-00-00-00-00-00\"\n               },\n               \"location\":[\n                  \"Building 1\",\n                  \"1st Floor\",\n                  \"Room 1\"\n               ]\n            }\n         }\n      ],\n      \"network\":{\n         \"network\":\"com.kerlink.wmc\"\n      },\n      \"meta\":{\n         \"type\":\"io.tracknet.healthy.TBHV100.Decoder\",\n         \"unpacker\":\"io.tracknet.healthy.TBHV100.Decoder\",\n         \"location\":\"Microshare, Demo, Environment\"\n      },\n      \"targetRecType\":\"io.microshare.test.unpacked\",\n      \"recType\": \"io.microshare.test\"\n   }\n}"},"url":"{{hostname}}/device/:recType","description":"<p>Create a new <strong>Device Cluster</strong> by <code>recType</code>. This creates a new Device Cluster (DC) to handle your device and start the unpacking process.</p>\n<p>You must include a record type using the dot notation format (eg. <code>io.microshare.test</code>).</p>\n<p>You must include the following information about your DC in the <code>Body</code> section of the request: </p>\n<ul>\n<li><code>name</code> : The name of your DC</li>\n<li><code>desc</code> : An optional description of your DC</li>\n<li><code>data</code> : All the data necessary to create your DC<ul>\n<li><code>isActive</code> : Set true if you want your data to be unpacked</li>\n<li><code>readAuth</code> &amp; <code>writeAuth</code>: <strong>Leave it like this</strong></li>\n<li><code>devices</code> : Include the device ids for your DC </li>\n<li><code>network</code> : the selected Network Server</li>\n<li><code>meta</code> : the selected unpacker</li>\n<li><code>recType</code> : recType</li>\n</ul>\n</li>\n</ul>\n<p>To see what you are filling out, <a href=\"https://dapp.microshare.io/composer#/devices\">create a device</a> on the Microshare® platform. </p>\n","urlObject":{"path":["device",":recType"],"host":["{{hostname}}"],"query":[],"variable":[{"type":"string","value":"io.microshare.test","key":"recType"}]}},"response":[],"_postman_id":"ead79f8d-c818-4524-a1c3-c7100010ba78"},{"name":"Create one Device with Tags","id":"17273052-339f-4918-8f9e-48779d5c6152","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{token}}"}],"body":{"mode":"raw","raw":"{\n   \"desc\":\"Motion Cluster API\",\n   \"name\":\"Test Device Cluster - Created via Postman\",\n   \"data\":{\n      \"isActive\": true,\n      \"readAuth\": \"\",\n      \"writeAuth\": \"\",\n      \"devices\":[\n         {\n            \"id\":\"58-A0-CB-00-00-00-00-00\",\n            \"meta\":{\n               \"lora\":{\n                  \"AppKey\":\"GD711F6F52AE456IB95A1820EB36713A\",\n                  \"NwkKey\":\"235FBCC234ADAB685BCB23AA0923DCD32\",\n                  \"JoinEUI\":\"58-A0-CB-00-00-00-00-01\",\n                  \"DevEUI\":\"58-A0-CB-00-00-00-00-00\"\n               },\n               \"location\":[\n                  \"Building 1\",\n                  \"1st Floor\",\n                  \"Room 1\"\n               ]\n            }\n         }\n      ],\n      \"network\":{\n         \"network\":\"com.kerlink.wmc\"\n      },\n      \"meta\":{\n         \"type\":\"io.tracknet.healthy.TBHV100.Decoder\",\n         \"unpacker\":\"io.tracknet.healthy.TBHV100.Decoder\",\n         \"location\":\"Microshare, Demo, Environment\"\n      },\n      \"targetRecType\":\"io.microshare.test.unpacked\",\n      \"recType\": \"io.microshare.test\"\n   }\n}"},"url":"{{hostname}}/device/:recType/tags/:tag1/:tag2","description":"<p>Just like the previous request, Create a Device Cluster to manage your devices and unpack your data. Include Tags to help identify your Device Cluster. Refer to the previous request for a breakdown on the required fields in the <code>Body</code> section. </p>\n","urlObject":{"path":["device",":recType","tags",":tag1",":tag2"],"host":["{{hostname}}"],"query":[],"variable":[{"type":"string","value":"io.microshare.feelycole.test","key":"recType"},{"type":"string","value":"foo","key":"tag1"},{"type":"string","value":"bar","key":"tag2"}]}},"response":[],"_postman_id":"17273052-339f-4918-8f9e-48779d5c6152"},{"name":"Delete Device","id":"1e7293ee-f252-44be-a116-b64906fe0819","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Authorization","value":"Bearer {{token}}"}],"body":{"mode":"raw","raw":""},"url":"{{hostname}}/device/:recType/:id","description":"<p>Permanently delete a Device Cluster from the data lake by including its <code>recType</code> an object <code>id</code> number. Please note that this action is irreversible and should be performed with caution. </p>\n","urlObject":{"path":["device",":recType",":id"],"host":["{{hostname}}"],"query":[],"variable":[{"type":"string","value":"io.microshare.feely.h.cole","key":"recType"},{"type":"string","value":"5ffcce4567614445a125c058","key":"id"}]}},"response":[],"_postman_id":"1e7293ee-f252-44be-a116-b64906fe0819"},{"name":"Update Device","id":"53ba1043-45b5-4a94-a3c6-5ebd1c6ccef3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer {{token}}"}],"body":{"mode":"raw","raw":"{\n   \"desc\":\"Motion Cluster API\",\n   \"name\":\"Updated Test Device Cluster - Created via Postman\",\n   \"data\":{\n      \"isActive\": true,\n      \"readAuth\": \"\",\n      \"writeAuth\": \"\",\n      \"devices\":[\n         {\n            \"id\":\"58-A0-CB-00-00-00-00-00\",\n            \"meta\":{\n               \"lora\":{\n                  \"AppKey\":\"GD711F6F52AE456IB95A1820EB36713A\",\n                  \"NwkKey\":\"235FBCC234ADAB685BCB23AA0923DCD32\",\n                  \"JoinEUI\":\"58-A0-CB-00-00-00-00-01\",\n                  \"DevEUI\":\"58-A0-CB-00-00-00-00-00\"\n               },\n               \"location\":[\n                  \"Building 1\",\n                  \"1st Floor\",\n                  \"Room 2\"\n               ]\n            }\n         }\n      ],\n      \"network\":{\n         \"network\":\"com.kerlink.wmc\"\n      },\n      \"meta\":{\n         \"type\":\"io.tracknet.healthy.TBHV100.Decoder\",\n         \"unpacker\":\"io.tracknet.healthy.TBHV100.Decoder\",\n         \"location\":\"Microshare, Demo, Environment\"\n      },\n      \"targetRecType\":\"io.microshare.test.unpacked\",\n      \"recType\": \"io.microshare.test\"\n   }\n}","options":{"raw":{"language":"json"}}},"url":"{{hostname}}/device/:recType/:id","description":"<p>Head over the the <code>Body</code> section of the request to change the contents of the Device Cluster. Make sure to include the <code>recType</code> and be careful as the changes are permanent.</p>\n","urlObject":{"path":["device",":recType",":id"],"host":["{{hostname}}"],"query":[],"variable":[{"type":"string","value":"io.microshare.test","key":"recType"},{"type":"string","value":"5ffccea167614445a125c05a","key":"id"}]}},"response":[],"_postman_id":"53ba1043-45b5-4a94-a3c6-5ebd1c6ccef3"}],"id":"ec375520-b07c-4a2e-a9de-4953edf76437","description":"<p><img src=\"https://www.microshare.io/wp-content/uploads/2017/06/microshare-data-page.png\" alt=\"alt text\" /></p>\n<p><strong>Upload your data and easily share it with the Share API</strong></p>\n","_postman_id":"ec375520-b07c-4a2e-a9de-4953edf76437"},{"name":"Rule","item":[{"name":"Get All Rules","id":"31e89a16-8111-486f-831d-f7a250252afa","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{token}}","type":"text"}],"url":"{{hostname}}/device/*?details=true&page=1&perPage=200&discover=false&field=name&search=","description":"<p>Retrieve all of your Rules and their specifications. </p>\n<h6 id=\"query-parameters-available\">Query parameters available</h6>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Parameter</th>\n<th>Type</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>details</code></td>\n<td>boolean</td>\n<td><code>true</code> will return matching objects with their details, <code>false</code> will only return main information</td>\n</tr>\n<tr>\n<td><code>page</code></td>\n<td>int</td>\n<td>Specifies the requested page, defaults to 1</td>\n</tr>\n<tr>\n<td><code>perPage</code></td>\n<td>int</td>\n<td>Specifies the number of objects to be returned per page, defaults to 999</td>\n</tr>\n<tr>\n<td><code>discover</code></td>\n<td>boolean</td>\n<td><code>true</code> will include objects that are not created by your account</td>\n</tr>\n<tr>\n<td><code>field</code></td>\n<td>char</td>\n<td>Set to \"name\"</td>\n</tr>\n</tbody>\n</table>\n</div><p><strong>Note:</strong> You must have discover set to true to see the example Shares!</p>\n","urlObject":{"path":["device","*"],"host":["{{hostname}}"],"query":[{"key":"details","value":"true"},{"key":"page","value":"1"},{"key":"perPage","value":"200"},{"key":"discover","value":"false"},{"key":"field","value":"name"},{"key":"search","value":""}],"variable":[]}},"response":[],"_postman_id":"31e89a16-8111-486f-831d-f7a250252afa"},{"name":"Get one Rule","id":"6644e661-1453-4dad-a039-cf9245589cb3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","type":"text","value":"Bearer {{token}}"}],"url":"{{hostname}}/rule/:recType/:id?discover=true","description":"<p>Retrieve one Rule by specifying the <code>recType</code> and object <code>id</code> number. </p>\n<h6 id=\"query-parameters-available\">Query parameters available</h6>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Parameter</th>\n<th>Type</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>discover</code></td>\n<td>boolean</td>\n<td><code>true</code> will include objects that are not created by your account</td>\n</tr>\n</tbody>\n</table>\n</div><p><strong>Note:</strong> You must have discover set to true to see the example Shares!</p>\n","urlObject":{"path":["rule",":recType",":id"],"host":["{{hostname}}"],"query":[{"key":"discover","value":"true"}],"variable":[{"type":"string","value":"io.microshare.documentation","key":"recType"},{"type":"string","value":"60104f4140f7415b71bfc17a","key":"id"}]}},"response":[],"_postman_id":"6644e661-1453-4dad-a039-cf9245589cb3"},{"name":"Get Rule by recType","id":"69d2e410-b21c-43dd-9e9f-7e25ea254d47","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","type":"text","value":"Bearer {{token}}"},{"key":"Content-Type","type":"text","value":"application/json"}],"url":"{{hostname}}/rule/:recType?details=true&page=&perPage=&discover=true","description":"<p>Get a specific Rule by including its <code>recType</code>. </p>\n<h6 id=\"query-parameters-available\">Query parameters available</h6>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Parameter</th>\n<th>Type</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>details</code></td>\n<td>boolean</td>\n<td><code>true</code> will return matching objects with their details, <code>false</code> will only return main information</td>\n</tr>\n<tr>\n<td><code>page</code></td>\n<td>int</td>\n<td>Specifies the requested page, defaults to 1</td>\n</tr>\n<tr>\n<td><code>perPage</code></td>\n<td>int</td>\n<td>Specifies the number of objects to be returned per page, defaults to 999</td>\n</tr>\n<tr>\n<td><code>discover</code></td>\n<td>boolean</td>\n<td><code>true</code> will include objects that are not created by your account</td>\n</tr>\n</tbody>\n</table>\n</div><p><strong>Note:</strong> You must have discover set to true to see the example Shares!</p>\n","urlObject":{"path":["rule",":recType"],"host":["{{hostname}}"],"query":[{"key":"details","value":"true"},{"key":"page","value":""},{"key":"perPage","value":""},{"key":"discover","value":"true"}],"variable":[{"type":"string","value":"io.microshare.documentation","key":"recType"}]}},"response":[],"_postman_id":"69d2e410-b21c-43dd-9e9f-7e25ea254d47"},{"name":"Get Latest Rules by recType","id":"3f7a328e-a14a-434e-a510-7219fdfc56da","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","type":"text","value":"Bearer {{token}}"}],"url":"{{hostname}}/rule/:recType/tags/latest?details=true&page=&perPage=&discover=true","description":"<p>Retrieve your most recent Rule associated with the given <code>recType</code>.</p>\n<h6 id=\"query-parameters-available\">Query parameters available</h6>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Parameter</th>\n<th>Type</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>details</code></td>\n<td>boolean</td>\n<td><code>true</code> will return matching objects with their details, <code>false</code> will only return main information</td>\n</tr>\n<tr>\n<td><code>page</code></td>\n<td>int</td>\n<td>Specifies the requested page, defaults to 1</td>\n</tr>\n<tr>\n<td><code>perPage</code></td>\n<td>int</td>\n<td>Specifies the number of objects to be returned per page, defaults to 999</td>\n</tr>\n<tr>\n<td><code>discover</code></td>\n<td>boolean</td>\n<td><code>true</code> will include objects that are not created by your account</td>\n</tr>\n</tbody>\n</table>\n</div><p><strong>Note:</strong> You must have discover set to true to see the example Shares!</p>\n","urlObject":{"path":["rule",":recType","tags","latest"],"host":["{{hostname}}"],"query":[{"key":"details","value":"true"},{"key":"page","value":""},{"key":"perPage","value":""},{"key":"discover","value":"true"}],"variable":[{"type":"string","value":"io.microshare.documentation","key":"recType"}]}},"response":[],"_postman_id":"3f7a328e-a14a-434e-a510-7219fdfc56da"},{"name":"Create one Rule","id":"8e6d482d-1bab-495a-b471-ed6f2e07d142","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","type":"text","value":"Bearer {{token}}"}],"body":{"mode":"raw","raw":"{\r\n   \"_id\":\"foobar\",\r\n   \"name\":\"test\",\r\n   \"desc\":\"\",\r\n   \"data\":{\r\n      \"resourceType\":\"objs\",\r\n      \"resourceId\":\"*\",\r\n      \"ownerUser\":\"email@owner.io\",\r\n      \"ownerOrg\":\"io.microshare\",\r\n      \"ownerApp\":\"*\",\r\n      \"callingUser\":\"*\",\r\n      \"callingOrg\":\"*\",\r\n      \"callingApp\":\"*\",\r\n      \"callingRole\":\"*\",\r\n      \"callingLoc\":\"*\",\r\n      \"operations\":[\r\n         \"Read\"\r\n      ]\r\n   }\r\n}","options":{"raw":{"language":"json"}}},"url":"{{hostname}}/rule/:recType","description":"<p>Rules dictate which users have access to certain Shares. With this request, create a Rule with a <code>recType</code>. Navigate over to the <code>Body</code> section of the request to specify your Rule's credentials. Confused on what the credentials mean? Use our <a href=\"https://docs.microshare.io/docs/2/technical/microshare-platform/rules-guide/\">Rules guide</a>. </p>\n<p>You must include a record type using the dot notation format (eg. <code>io.microshare.test</code>).</p>\n","urlObject":{"path":["rule",":recType"],"host":["{{hostname}}"],"query":[],"variable":[{"type":"string","value":"io.microshare.test","key":"recType"}]}},"response":[],"_postman_id":"8e6d482d-1bab-495a-b471-ed6f2e07d142"},{"name":"Delete Rule","id":"f2d0af1b-8af1-4f18-b3b2-46590514f71d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Authorization","type":"text","value":"Bearer {{token}}"}],"url":"{{hostname}}/rule/:recType/:id","description":"<p>Permanently remove a Rule by specifying its <code>recType</code> and its object <code>id</code> number. Please note that this action is irreversible and should be performed with caution.  </p>\n","urlObject":{"path":["rule",":recType",":id"],"host":["{{hostname}}"],"query":[],"variable":[{"type":"string","value":"io.microshare.test","key":"recType"},{"type":"string","value":"5ffcce4567614445a125c058","key":"id"}]}},"response":[],"_postman_id":"f2d0af1b-8af1-4f18-b3b2-46590514f71d"},{"name":"Update Rule","id":"0e9ecfc6-1a07-4d42-945b-b63f64013c25","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Authorization","type":"text","value":"Bearer {{token}}"}],"body":{"mode":"raw","raw":"{\r\n   \"_id\":\"foobar\",\r\n   \"name\":\"testv2\",\r\n   \"desc\":\"\",\r\n   \"data\":{\r\n      \"resourceType\":\"objs\",\r\n      \"resourceId\":\"*\",\r\n      \"ownerUser\":\"email@owner.io\",\r\n      \"ownerOrg\":\"io.microshare\",\r\n      \"ownerApp\":\"appid1\",\r\n      \"callingUser\":\"*\",\r\n      \"callingOrg\":\"*\",\r\n      \"callingApp\":\"*\",\r\n      \"callingRole\":\"*\",\r\n      \"callingLoc\":\"*\",\r\n      \"operations\":[\r\n         \"Read\"\r\n      ]\r\n   }\r\n}","options":{"raw":{"language":"json"}}},"url":"{{hostname}}/rule/:recType/:id","description":"<p>Permanently update the information within the body of your Rule by specifying the <code>recType</code>. Edit your Rule in the <code>Body</code> section of the request. </p>\n","urlObject":{"path":["rule",":recType",":id"],"host":["{{hostname}}"],"query":[],"variable":[{"type":"string","value":"io.microshare.test","key":"recType"},{"type":"string","value":"5ffccea167614445a125c05a","key":"id"}]}},"response":[],"_postman_id":"0e9ecfc6-1a07-4d42-945b-b63f64013c25"}],"id":"0c1db625-2320-4bfd-89bb-aaf1680aa41a","description":"<p><img src=\"https://www.microshare.io/wp-content/uploads/2017/06/microshare-data-page.png\" alt=\"alt text\" /></p>\n<p><strong>Access your Microshare® sharing Rules directly from the API, get the list of your rules, create or modify a rule and finally if necessary you can delete a Rule.</strong></p>\n","_postman_id":"0c1db625-2320-4bfd-89bb-aaf1680aa41a"},{"name":"Views","item":[{"name":"Get All Views","id":"486e1dd7-0a9f-4b3d-b11e-67fd0188b22f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","type":"text","value":"Bearer {{token}}"}],"url":"{{hostname}}/view/*?details=true","description":"<p>Retrieve all of your Views and their specifications. </p>\n<h6 id=\"query-parameters-available\">Query parameters available</h6>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Parameter</th>\n<th>Type</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>details</code></td>\n<td>boolean</td>\n<td><code>true</code> will return matching objects with their details, <code>false</code> will only return main information</td>\n</tr>\n<tr>\n<td><code>page</code></td>\n<td>int</td>\n<td>Specifies the requested page, defaults to 1</td>\n</tr>\n<tr>\n<td><code>perPage</code></td>\n<td>int</td>\n<td>Specifies the number of objects to be returned per page, defaults to 999</td>\n</tr>\n<tr>\n<td><code>discover</code></td>\n<td>boolean</td>\n<td><code>true</code> will include objects that are not created by your account</td>\n</tr>\n<tr>\n<td><code>field</code></td>\n<td>char</td>\n<td>Set to \"name\"</td>\n</tr>\n</tbody>\n</table>\n</div><p><strong>Note:</strong> You must have discover set to true to see the example Shares!</p>\n","urlObject":{"path":["view","*"],"host":["{{hostname}}"],"query":[{"key":"details","value":"true"}],"variable":[]}},"response":[],"_postman_id":"486e1dd7-0a9f-4b3d-b11e-67fd0188b22f"},{"name":"Get one View","id":"3e1a0a88-ef33-4b23-b3fa-f5cb7ecb6f4a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","type":"text","value":"Bearer {{token}}"}],"url":"{{hostname}}/view/:recType/:id?discover=true","description":"<p>Retrieve one View by specifying the <code>recType</code> and object <code>id</code> number. </p>\n<h6 id=\"query-parameters-available\">Query parameters available</h6>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Parameter</th>\n<th>Type</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>discover</code></td>\n<td>boolean</td>\n<td><code>true</code> will include objects that are not created by your account</td>\n</tr>\n</tbody>\n</table>\n</div><p><strong>Note:</strong> You must have discover set to true to see the example Shares!</p>\n","urlObject":{"path":["view",":recType",":id"],"host":["{{hostname}}"],"query":[{"key":"discover","value":"true"}],"variable":[{"type":"string","value":"io.microshare.documentation","key":"recType"},{"type":"string","value":"6010522c6399e12ca5439235","key":"id"}]}},"response":[],"_postman_id":"3e1a0a88-ef33-4b23-b3fa-f5cb7ecb6f4a"},{"name":"Get View by recType","id":"8865244d-0245-4eea-91f6-cdfef3696e21","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","type":"text","value":"application/json"},{"key":"Authorization","type":"text","value":"Bearer {{token}}"}],"url":"{{hostname}}/view/:recType?details=true&page=&perPage=&discover=true","description":"<p>Retrieve one View by specifying its <code>recType</code>.</p>\n<h6 id=\"query-parameters-available\">Query parameters available</h6>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Parameter</th>\n<th>Type</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>details</code></td>\n<td>boolean</td>\n<td><code>true</code> will return matching objects with their details, <code>false</code> will only return main information</td>\n</tr>\n<tr>\n<td><code>page</code></td>\n<td>int</td>\n<td>Specifies the requested page, defaults to 1</td>\n</tr>\n<tr>\n<td><code>perPage</code></td>\n<td>int</td>\n<td>Specifies the number of objects to be returned per page, defaults to 999</td>\n</tr>\n<tr>\n<td><code>discover</code></td>\n<td>boolean</td>\n<td><code>true</code> will include objects that are not created by your account</td>\n</tr>\n</tbody>\n</table>\n</div><p><strong>Note:</strong> You must have discover set to true to see the example Shares!</p>\n","urlObject":{"path":["view",":recType"],"host":["{{hostname}}"],"query":[{"key":"details","value":"true"},{"key":"page","value":""},{"key":"perPage","value":""},{"key":"discover","value":"true"}],"variable":[{"type":"string","value":"io.microshare.documentation","key":"recType"}]}},"response":[],"_postman_id":"8865244d-0245-4eea-91f6-cdfef3696e21"},{"name":"Get Latest View by recType","id":"ef9d3c15-db9d-4850-a5fc-45e133d419ab","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{token}}","type":"text"}],"url":"{{hostname}}/device/:recType/tags/latest?details=true&page=&perPage=&discover=true","description":"<p>Retrieve your most recent View associated with the specified recType. </p>\n<h6 id=\"query-parameters-available\">Query parameters available</h6>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Parameter</th>\n<th>Type</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>details</code></td>\n<td>boolean</td>\n<td><code>true</code> will return matching objects with their details, <code>false</code> will only return main information</td>\n</tr>\n<tr>\n<td><code>page</code></td>\n<td>int</td>\n<td>Specifies the requested page, defaults to 1</td>\n</tr>\n<tr>\n<td><code>perPage</code></td>\n<td>int</td>\n<td>Specifies the number of objects to be returned per page, defaults to 999</td>\n</tr>\n<tr>\n<td><code>discover</code></td>\n<td>boolean</td>\n<td><code>true</code> will include objects that are not created by your account</td>\n</tr>\n</tbody>\n</table>\n</div><p><strong>Note:</strong> You must have discover set to true to see the example Shares!</p>\n","urlObject":{"path":["device",":recType","tags","latest"],"host":["{{hostname}}"],"query":[{"key":"details","value":"true"},{"key":"page","value":""},{"key":"perPage","value":""},{"key":"discover","value":"true"}],"variable":[{"type":"string","value":"io.microshare.documentation","key":"recType"}]}},"response":[],"_postman_id":"ef9d3c15-db9d-4850-a5fc-45e133d419ab"},{"name":"Create one View","id":"fb5d734c-3af0-4d71-8497-deba3bf9cf0b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{token}}","type":"text"}],"body":{"mode":"raw","raw":"[\r\n  {\r\n    \"$match\": {\r\n      \"recType\": \"io.microshare.test\"\r\n    }\r\n  },\r\n  {\r\n    \"$limit\": 10\r\n  }\r\n]","options":{"raw":{"language":"json"}}},"url":"{{hostname}}/view/:recType","description":"<p>Create a view to help manage the availability of your data. Follow the <a href=\"https://docs.microshare.io/docs/2/technical/microshare-platform/views-guide/\">Views Guide</a> to customize what your view can do in the <code>Body</code> section of the request. </p>\n","urlObject":{"path":["view",":recType"],"host":["{{hostname}}"],"query":[],"variable":[{"type":"string","value":"io.microshare.cole.view","key":"recType"}]}},"response":[],"_postman_id":"fb5d734c-3af0-4d71-8497-deba3bf9cf0b"},{"name":"Delete one View","id":"038af196-4828-42b3-bf01-97ce4b3ffe5a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Authorization","type":"text","value":"Bearer {{token}}"}],"url":"{{hostname}}/view/:recType/:id","description":"<p>Permanently remove a View by specifying its <code>recType</code> and its <code>id</code> number. Please note that this action is irreversible and should be performed with caution.  </p>\n","urlObject":{"path":["view",":recType",":id"],"host":["{{hostname}}"],"query":[],"variable":[{"type":"string","value":"io.microshare.test","key":"recType"},{"type":"string","value":"5981f3c946e0fb00203b3796","key":"id"}]}},"response":[],"_postman_id":"038af196-4828-42b3-bf01-97ce4b3ffe5a"},{"name":"Update one View","id":"dae2461e-0e56-46e8-bb11-291ea3928866","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer {{token}}","type":"text"}],"body":{"mode":"raw","raw":"[\r\n  {\r\n    \"$match\": {\r\n      \"recType\": \"io.microshare.test\"\r\n    }\r\n  },\r\n  {\r\n    \"$limit\": 10\r\n  }\r\n]","options":{"raw":{"language":"json"}}},"url":"{{hostname}}/view/:recType/:id","description":"<p>Permanently update the information within the body of your View by specifying the <code>recType</code>. Edit your View in the <code>Body</code> section of the request. </p>\n","urlObject":{"path":["view",":recType",":id"],"host":["{{hostname}}"],"query":[],"variable":[{"type":"string","value":"io.microshare.test","key":"recType"},{"type":"string","value":"","key":"id"}]}},"response":[],"_postman_id":"dae2461e-0e56-46e8-bb11-291ea3928866"}],"id":"ced8ac46-cbbc-4779-b484-0a795dec9a76","description":"<p><img src=\"https://www.microshare.io/wp-content/uploads/2017/06/microshare-data-page.png\" alt=\"alt text\" /></p>\n<p><strong>Create and manage Views directly from the API</strong></p>\n","_postman_id":"ced8ac46-cbbc-4779-b484-0a795dec9a76"},{"name":"Robots","item":[{"name":"Get All Robots","id":"04283ec9-fbf6-4309-a574-c9d8ad394e43","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","type":"text","value":"Bearer {{token}}"}],"url":"{{hostname}}/robo/*?details=true&page=1&perPage=200&discover=false&field=name&search=","description":"<p>Retrieve all Robots under your jurisdiction.</p>\n<h6 id=\"query-parameters-available\">Query parameters available</h6>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Parameter</th>\n<th>Type</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>details</code></td>\n<td>boolean</td>\n<td><code>true</code> will return matching objects with their details, <code>false</code> will only return main information</td>\n</tr>\n<tr>\n<td><code>page</code></td>\n<td>int</td>\n<td>Specifies the requested page, defaults to 1</td>\n</tr>\n<tr>\n<td><code>perPage</code></td>\n<td>int</td>\n<td>Specifies the number of objects to be returned per page, defaults to 999</td>\n</tr>\n<tr>\n<td><code>discover</code></td>\n<td>boolean</td>\n<td><code>true</code> will include objects that are not created by your account</td>\n</tr>\n<tr>\n<td><code>field</code></td>\n<td>char</td>\n<td>Set to \"name\"</td>\n</tr>\n</tbody>\n</table>\n</div><p><strong>Note:</strong> You must have discover set to true to see the example Shares!</p>\n","urlObject":{"path":["robo","*"],"host":["{{hostname}}"],"query":[{"key":"details","value":"true"},{"key":"page","value":"1"},{"key":"perPage","value":"200"},{"key":"discover","value":"false"},{"key":"field","value":"name"},{"key":"search","value":""}],"variable":[]}},"response":[],"_postman_id":"04283ec9-fbf6-4309-a574-c9d8ad394e43"},{"name":"Get one Robot","id":"abc69462-7c5f-48ed-895e-bf905f874d07","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","type":"text","value":"Bearer {{token}}"}],"url":"{{hostname}}/robo/:recType/:id?discover=true","description":"<p>Retrieve one Robot by specifying its <code>recType</code> and object <code>id</code> number. </p>\n<h6 id=\"query-parameters-available\">Query parameters available</h6>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Parameter</th>\n<th>Type</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>discover</code></td>\n<td>boolean</td>\n<td><code>true</code> will include objects that are not created by your account</td>\n</tr>\n</tbody>\n</table>\n</div><p><strong>Note:</strong> You must have discover set to true to see the example Shares!</p>\n","urlObject":{"path":["robo",":recType",":id"],"host":["{{hostname}}"],"query":[{"key":"discover","value":"true"}],"variable":[{"type":"string","value":"io.microshare.documentation","key":"recType"},{"type":"string","value":"60185393df13650d9dd16b12","key":"id"}]}},"response":[],"_postman_id":"abc69462-7c5f-48ed-895e-bf905f874d07"},{"name":"Get Robot by recType","id":"9c279f7b-e3a3-4e18-8079-73ebaab5b66d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","type":"text","value":"Bearer {{token}}"}],"url":"{{hostname}}/device/:recType?details=true&page=&perPage=&discover=true","description":"<p>Retrieve all your Robots under a <code>recType</code>.</p>\n<h6 id=\"query-parameters-available\">Query parameters available</h6>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Parameter</th>\n<th>Type</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>details</code></td>\n<td>boolean</td>\n<td><code>true</code> will return matching objects with their details, <code>false</code> will only return main information</td>\n</tr>\n<tr>\n<td><code>page</code></td>\n<td>int</td>\n<td>Specifies the requested page, defaults to 1</td>\n</tr>\n<tr>\n<td><code>perPage</code></td>\n<td>int</td>\n<td>Specifies the number of objects to be returned per page, defaults to 999</td>\n</tr>\n<tr>\n<td><code>discover</code></td>\n<td>boolean</td>\n<td><code>true</code> will include objects that are not created by your account</td>\n</tr>\n</tbody>\n</table>\n</div><p><strong>Note:</strong> You must have discover set to true to see the example Shares!</p>\n","urlObject":{"path":["device",":recType"],"host":["{{hostname}}"],"query":[{"key":"details","value":"true"},{"key":"page","value":""},{"key":"perPage","value":""},{"key":"discover","value":"true"}],"variable":[{"type":"string","value":"io.microshare.documentation","key":"recType"}]}},"response":[],"_postman_id":"9c279f7b-e3a3-4e18-8079-73ebaab5b66d"},{"name":"Get Latest Robot by recType","id":"8f4112ce-2e61-4c4d-a9d6-68de3d1ba6b2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","type":"text","value":"Bearer {{token}}"}],"url":"{{hostname}}/robo/:recType/tags/latest?details=true&page=&perPage=&discover=true","description":"<p>Retrieve all your Robots by <code>recType</code> with specific <code>Tags</code>.</p>\n<h6 id=\"query-parameters-available\">Query parameters available</h6>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Parameter</th>\n<th>Type</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>details</code></td>\n<td>boolean</td>\n<td><code>true</code> will return matching objects with their details, <code>false</code> will only return main information</td>\n</tr>\n<tr>\n<td><code>page</code></td>\n<td>int</td>\n<td>Specifies the requested page, defaults to 1</td>\n</tr>\n<tr>\n<td><code>perPage</code></td>\n<td>int</td>\n<td>Specifies the number of objects to be returned per page, defaults to 999</td>\n</tr>\n<tr>\n<td><code>discover</code></td>\n<td>boolean</td>\n<td><code>true</code> will include objects that are not created by your account</td>\n</tr>\n</tbody>\n</table>\n</div><p><strong>Note:</strong> You must have discover set to true to see the example Shares!</p>\n","urlObject":{"path":["robo",":recType","tags","latest"],"host":["{{hostname}}"],"query":[{"key":"details","value":"true"},{"key":"page","value":""},{"key":"perPage","value":""},{"key":"discover","value":"true"}],"variable":[{"type":"string","value":"io.microshare.documentation","key":"recType"}]}},"response":[],"_postman_id":"8f4112ce-2e61-4c4d-a9d6-68de3d1ba6b2"},{"name":"Create one Robot","id":"e91fad67-2aa7-4a4b-a955-532125367f54","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{token}}"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n  \"name\": \"NEW ROBOT CONFIGURATION\",\n  \"desc\": \"\",\n  \"recType\": \"io.microshare.test\",\n  \"data\": {\n    \"scopes\": [\n      \"SHARE:READ\",\n      \"SHARE:WRITE\"\n    ],\n    \"auth\": \"test\",\n    \"script\": \"var lib = require('./libs/helpers');\\nfunction main(text, auth){\\n    var count = bindings.count;\\n    print('HELLO CUSTOM!!: ' + count);\\n    bindings.count = count + 1;\\n}\",\n    \"isActive\": true,\n    \"schedule\": {\n      \"delay\": 5000,\n      \"interval\": 5000\n    }\n  }\n}"},"url":"{{hostname}}/robo/:recType","description":"<p>Create a new Robot by <code>recType</code>. This creates a new Robot that automates the tasks associated with transforming, enriching, and annotating your data.</p>\n<p>You must include a record type using the dot notation format (eg. <code>io.microshare.test</code>) this is the data source you are going to trigger.</p>\n<p>Use the <code>Body</code> section to change the credentials and script of your robot. Confused on any credentials? Refer to our <a href=\"https://docs.microshare.io/docs/2/technical/microshare-platform-advanced/robots-guide/\">Robots Guide</a>.</p>\n","urlObject":{"path":["robo",":recType"],"host":["{{hostname}}"],"query":[],"variable":[{"type":"string","value":"io.microshare.test","key":"recType"}]}},"response":[],"_postman_id":"e91fad67-2aa7-4a4b-a955-532125367f54"},{"name":"Delete one Robot","id":"16c821bb-f29a-48da-9617-4de581285d1d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"{{hostname}}/robo/:recType/:id","description":"<p>Permanently remove a Robot by specifying its <code>recType</code> and its <code>id</code> number. Please note that this action is irreversible and should be performed with caution. </p>\n","urlObject":{"path":["robo",":recType",":id"],"host":["{{hostname}}"],"query":[],"variable":[{"type":"string","value":"io.microshare.test","key":"recType"},{"type":"string","value":"5ffcce4567614445a125c058","key":"id"}]}},"response":[],"_postman_id":"16c821bb-f29a-48da-9617-4de581285d1d"},{"name":"Update one Robot","id":"7e21aaac-8eb3-4c03-bfdb-2db92d5862de","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer {{token}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n  \"name\": \"UPDATED ROBOT CONFIGURATION\",\r\n  \"desc\": \"\",\r\n  \"recType\": \"io.microshare.test\",\r\n  \"data\": {\r\n    \"scopes\": [\r\n      \"SHARE:READ\",\r\n      \"SHARE:WRITE\"\r\n    ],\r\n    \"auth\": \"test\",\r\n    \"script\": \"var lib = require('./libs/helpers');\\nfunction main(text, auth){\\n    var count = bindings.count;\\n    print('HELLO CUSTOM!!: ' + count);\\n    bindings.count = count + 1;\\n}\",\r\n    \"isActive\": true,\r\n    \"schedule\": {\r\n      \"delay\": 5000,\r\n      \"interval\": 5000\r\n    }\r\n  }\r\n}","options":{"raw":{"language":"json"}}},"url":"{{hostname}}/robo/:recType/:id","description":"<p>Permanently update what your Robot can do in the body section of the request by specifying the <code>recType</code> and object <code>id</code> number. </p>\n","urlObject":{"path":["robo",":recType",":id"],"host":["{{hostname}}"],"query":[],"variable":[{"type":"string","value":"io.microshare.test","key":"recType"},{"type":"string","value":"5ffccea167614445a125c05a","key":"id"}]}},"response":[],"_postman_id":"7e21aaac-8eb3-4c03-bfdb-2db92d5862de"}],"id":"0f5fac3f-3216-4d83-8aa6-4ae8a32e5fd6","description":"<p><img src=\"https://www.microshare.io/wp-content/uploads/2017/06/microshare-data-page.png\" alt=\"alt text\" /></p>\n<p><strong>Create and manage Robots directly from the API</strong></p>\n","_postman_id":"0f5fac3f-3216-4d83-8aa6-4ae8a32e5fd6"},{"name":"Stream","item":[{"name":"Get All Streams","id":"5e221ec1-46d1-4051-b87e-8443f125e0a3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{token}}","type":"text"}],"url":"{{hostname}}/stream/*?details=true&page=1&perPage=200&discover=false&field=name&search=","description":"<p>Retrieve all of the Streams associated with your account. </p>\n","urlObject":{"path":["stream","*"],"host":["{{hostname}}"],"query":[{"key":"details","value":"true"},{"key":"page","value":"1"},{"key":"perPage","value":"200"},{"key":"discover","value":"false"},{"key":"field","value":"name"},{"key":"search","value":""}],"variable":[]}},"response":[],"_postman_id":"5e221ec1-46d1-4051-b87e-8443f125e0a3"},{"name":"Get one Stream","id":"31f31c70-3975-4e7a-a7d9-8c1e159b555f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{token}}"}],"url":"{{hostname}}/stream/:recType/:id?","description":"<p>Retrieve one Stream by <code>recType</code> and object <code>id</code> number. </p>\n<h6 id=\"query-parameters-available\">Query parameters available</h6>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Parameter</th>\n<th>Type</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>details</code></td>\n<td>boolean</td>\n<td><code>true</code> will return matching objects with their details, <code>false</code> will only return main information</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"path":["stream",":recType",":id"],"host":["{{hostname}}"],"query":[{"key":"","value":null}],"variable":[{"type":"string","value":"io.microshare.documentation","key":"recType"},{"type":"string","value":"60185607df13650d9dd16e19","key":"id"}]}},"response":[],"_postman_id":"31f31c70-3975-4e7a-a7d9-8c1e159b555f"},{"name":"Get Stream by recType","id":"c9d27cfe-03ab-4fb8-a9d5-523b2545e3b0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{token}}"}],"url":"{{hostname}}/stream/:recType?details=true&page=&perPage=","description":"<p>Retrieve all Streams under a specific <code>recType</code>.</p>\n<h6 id=\"query-parameters-available\">Query parameters available</h6>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Parameter</th>\n<th>Type</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>details</code></td>\n<td>boolean</td>\n<td><code>true</code> will return matching objects with their details, <code>false</code> will only return main information</td>\n</tr>\n<tr>\n<td><code>page</code></td>\n<td>int</td>\n<td>Specifies the requested page, defaults to 1</td>\n</tr>\n<tr>\n<td><code>perPage</code></td>\n<td>int</td>\n<td>Specifies the number of objects to be returned per page, defaults to 999</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"path":["stream",":recType"],"host":["{{hostname}}"],"query":[{"key":"details","value":"true"},{"key":"page","value":""},{"key":"perPage","value":""}],"variable":[{"type":"string","value":"io.microshare.test","key":"recType"}]}},"response":[],"_postman_id":"c9d27cfe-03ab-4fb8-a9d5-523b2545e3b0"},{"name":"Get Latest Stream by recType","id":"f39ad91d-1ca6-4935-9394-d93639c30ffb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{token}}"}],"url":"{{hostname}}/stream/:recType/tags/latest?details=true&page=&perPage=","description":"<p>Retrieve all Streams under a specific <code>recType</code>.</p>\n<h6 id=\"query-parameters-available\">Query parameters available</h6>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Parameter</th>\n<th>Type</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>details</code></td>\n<td>boolean</td>\n<td><code>true</code> will return matching objects with their details, <code>false</code> will only return main information</td>\n</tr>\n<tr>\n<td><code>page</code></td>\n<td>int</td>\n<td>Specifies the requested page, defaults to 1</td>\n</tr>\n<tr>\n<td><code>perPage</code></td>\n<td>int</td>\n<td>Specifies the number of objects to be returned per page, defaults to 999</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"path":["stream",":recType","tags","latest"],"host":["{{hostname}}"],"query":[{"key":"details","value":"true"},{"key":"page","value":""},{"key":"perPage","value":""}],"variable":[{"type":"string","value":"io.microshare.test","key":"recType"}]}},"response":[],"_postman_id":"f39ad91d-1ca6-4935-9394-d93639c30ffb"},{"name":"Create one Stream","id":"af00e892-f6fb-4d0e-be10-49d162341000","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{token}}"}],"body":{"mode":"raw","raw":"{\n   \"desc\":\"Motion Cluster API\",\n   \"name\":\"Test Device Cluster\",\n   \"recType\": \"io.microshare.test-only.test-only\",\n   \"data\":{\n      \"recTypes\": [\"com.test.test\"],\n      \"streamType\": \"kafka\",\n      \"targetType\": \"create\",\n      \"targetTopic\": \"foo.topic\",\n      \"isActive\": true,\n      \"server\":{\n         \"network\":\"example network\"\n      },\n      \"ownership\":[\n      \t{\n         \"appid\":\"*\",\n         \"org\":\"*\",\n         \"user\":\"owner@email.com\"\n    \t}\n      ]\n   }\n}"},"url":"{{hostname}}/stream/:recType","description":"<p>Create a new share by <code>recType</code>. This creates a new Streaming process into the Microshare® data management.</p>\n<p>You must include a record type using the dot notation format (eg. <code>io.microshare.test</code>).</p>\n","urlObject":{"path":["stream",":recType"],"host":["{{hostname}}"],"query":[],"variable":[{"id":"a5bfe098-9c3b-4365-a1da-8c621f209406","type":"string","value":"io.microshare.test","key":"recType"}]}},"response":[],"_postman_id":"af00e892-f6fb-4d0e-be10-49d162341000"},{"name":"Delete Stream","id":"c1bbf6a1-7262-49aa-9b7b-ac09d1d9a898","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Authorization","value":"Bearer {{token}}"}],"body":{"mode":"raw","raw":""},"url":"{{hostname}}/stream/:recType/:id","description":"<p>Permanently remove a Stream by specifying its <code>recType</code> and its <code>id</code> number. Please note that this action is irreversible and should be performed with caution. </p>\n","urlObject":{"path":["stream",":recType",":id"],"host":["{{hostname}}"],"query":[],"variable":[{"type":"string","value":"io.microshare.test","key":"recType"},{"type":"string","value":"0000","key":"id"}]}},"response":[],"_postman_id":"c1bbf6a1-7262-49aa-9b7b-ac09d1d9a898"},{"name":"Update Stream","id":"d54708d8-94b8-45f1-b7d6-7e6eb096ac56","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer {{token}}"}],"body":{"mode":"raw","raw":"{\n   \"desc\":\"Update from Postman\",\n   \"name\":\"Updated Test Device Cluster\",\n   \"data\":{\n      \"recTypes\": [\"test\",\"added\"],\n      \"streamType\": \"eventhub\",\n      \"targetType\": \"create\",\n      \"targetTopic\": \"foo.topic\",\n      \"isActive\": true,\n      \"server\":{\n         \"network\":\"example network\"\n      },\n      \"ownership\":[\n      \t{\n         \"appid\":\"*\",\n         \"org\":\"*\",\n         \"user\":\"owner@email.com\"\n    \t}\n      ]\n   }\n}"},"url":"{{hostname}}/stream/:recType/:id","description":"<p>Permanently update a Stream by <code>recType</code> and object <code>id</code> number. Edit your Stream's specifics in the <code>Body</code> section of the request.</p>\n","urlObject":{"path":["stream",":recType",":id"],"host":["{{hostname}}"],"query":[],"variable":[{"type":"string","value":"io.microshare.test","key":"recType"},{"type":"string","value":"5f9c9d6f3343a13b005fadab","key":"id"}]}},"response":[],"_postman_id":"d54708d8-94b8-45f1-b7d6-7e6eb096ac56"}],"id":"eaa424ce-b842-44ef-b1ee-cfc25461f557","description":"<p><img src=\"https://www.microshare.io/wp-content/uploads/2017/06/microshare-data-page.png\" alt=\"alt text\" /></p>\n<p><strong>Use the Microshare® Streaming option to directly push your data to your big data tenancy</strong></p>\n","_postman_id":"eaa424ce-b842-44ef-b1ee-cfc25461f557"}],"event":[{"listen":"prerequest","script":{"id":"1f3ceb42-e962-4553-9165-790349f71580","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"92658417-37ea-443f-afa5-7a25f2a26164","type":"text/javascript","exec":[""]}}]}