{"_id":"588f722cbcace50f0052ba36","category":{"_id":"588f722bbcace50f0052b9e6","__v":0,"project":"565f5fa26bafd40d0030a064","version":"588f722bbcace50f0052b9e1","sync":{"url":"","isSync":false},"reference":true,"createdAt":"2016-02-25T18:09:36.891Z","from_sync":false,"order":4,"slug":"dashboard-api","title":"Dashboard API"},"parentDoc":null,"__v":0,"version":{"_id":"588f722bbcace50f0052b9e1","project":"565f5fa26bafd40d0030a064","__v":1,"createdAt":"2017-01-30T17:04:43.410Z","releaseDate":"2017-01-30T17:04:43.410Z","categories":["588f722bbcace50f0052b9e2","588f722bbcace50f0052b9e3","588f722bbcace50f0052b9e4","588f722bbcace50f0052b9e5","588f722bbcace50f0052b9e6","588f722bbcace50f0052b9e7"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"5.3.0","version":"5.3.0"},"user":"565f3941ea46251700972783","project":"565f5fa26bafd40d0030a064","updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-02-17T22:56:17.715Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[{"language":"curl","code":"curl -b cookies.txt -c cookies.txt -X GET \"https://api.nanoscale.io/apis/95/libraries\""}]},"method":"get","results":{"codes":[{"name":"","code":"{\n    \"libraries\": [\n        {\n            \"api_id\": 95,\n            \"id\": 112,\n            \"name\": \"Authentication Credentials\",\n            \"description\": \"\",\n            \"data\": \"var mock_authorization = \\\"Basic YW55cHJlc2VuY2U6cGFzc3dvcmQ=\\\";\\n\"\n        },\n        {\n            \"api_id\": 95,\n            \"id\": 113,\n            \"name\": \"Data Variables\",\n            \"description\": \"These are variables that hold static data.\",\n            \"data\": \"var news_response_data = [\\n  {\\n      \\\"alert_date\\\": \\\"2014-09-05\\\",\\n      \\\"created_at\\\": \\\"2014-09-05T15:12:16Z\\\",\\n      \\\"description\\\": \\\"Mark Kent made FORTUNE magazine's list of the top 50 business leaders of 2011, coming in at No. 9. FORTUNE had this to say about our Company's Chairman and CEO: \\\\\\\"Under his leadership, the company has invested heavily in emerging markets like China, India and Mexico, where rapid urbanization, population growth and rising per capita income are driving demand\\\\\\\".\\\",\\n      \\\"id\\\": 31,\\n      \\\"image_url\\\": \\\"http://anypresence-demo-data.s3.amazonaws.com/generic/images/award_image.png\\\",\\n      \\\"title\\\": \\\"FORTUNE Recognizes Mark Kent\\\",\\n      \\\"updated_at\\\": \\\"2014-09-05T15:12:16Z\\\"\\n  },\\n  {\\n      \\\"alert_date\\\": \\\"2014-08-26\\\",\\n      \\\"created_at\\\": \\\"2014-09-05T15:12:16Z\\\",\\n      \\\"description\\\": \\\"Customer service policy has been updated, please contact your manager for further details.\\\",\\n      \\\"id\\\": 32,\\n      \\\"image_url\\\": \\\"http://anypresence-demo-data.s3.amazonaws.com/generic/images/policy_image.png\\\",\\n      \\\"title\\\": \\\"Updated customer service policy\\\",\\n      \\\"updated_at\\\": \\\"2014-09-05T15:12:16Z\\\"\\n  },\\n  {\\n      \\\"alert_date\\\": \\\"2014-08-22\\\",\\n      \\\"created_at\\\": \\\"2014-09-05T15:12:16Z\\\",\\n      \\\"description\\\": \\\"Our Company made The Great Place to Work Institute's inaugural list of \\\\\\\"The World's Best Multinational Workplaces\\\\\\\" based on the work environments and practices of Dynacorp offices around the world, with particular praise for our efforts in Argentina, Australia, Brazil, Chile, Peru and Spain.\\\",\\n      \\\"id\\\": 33,\\n      \\\"image_url\\\": \\\"http://anypresence-demo-data.s3.amazonaws.com/generic/images/best_places_image.png\\\",\\n      \\\"title\\\": \\\"Best Multinational to Work For\\\",\\n      \\\"updated_at\\\": \\\"2014-09-05T15:12:16Z\\\"\\n  },\\n  {\\n      \\\"alert_date\\\": \\\"2014-08-22\\\",\\n      \\\"created_at\\\": \\\"2014-09-05T15:12:16Z\\\",\\n      \\\"description\\\": \\\"All Hands meeting for this quarter has been scheduled for next Friday at Bldg. 5. Please check your calendar.\\\",\\n      \\\"id\\\": 34,\\n      \\\"image_url\\\": \\\"http://anypresence-demo-data.s3.amazonaws.com/generic/images/meeting_image.png\\\",\\n      \\\"title\\\": \\\"All Hands meeting scheduled\\\",\\n      \\\"updated_at\\\": \\\"2014-09-05T15:12:16Z\\\"\\n  },\\n  {\\n      \\\"alert_date\\\": \\\"2014-08-22\\\",\\n      \\\"created_at\\\": \\\"2014-09-05T15:12:16Z\\\",\\n      \\\"description\\\": \\\"New location for the Florida satellite office has been announced and moving will begin at the end of this year.\\\",\\n      \\\"id\\\": 35,\\n      \\\"image_url\\\": \\\"http://anypresence-demo-data.s3.amazonaws.com/generic/images/location_image.png\\\",\\n      \\\"title\\\": \\\"New location announced for Florida office\\\",\\n      \\\"updated_at\\\": \\\"2014-09-05T15:12:16Z\\\"\\n  }\\n];\"\n        }\n    ]\n}","language":"json","status":200}]},"settings":"","auth":"required","params":[],"url":"/libraries"},"isReference":true,"order":26,"body":"Calling the `/libraries` endpoint will return a collection of the defined `libraries` sorted alphabetically by name in ascending order.\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"key\",\n    \"h-1\": \"type\",\n    \"h-2\": \"description\",\n    \"0-0\": \"`libraries`\",\n    \"0-1\": \"`array`\",\n    \"0-2\": \"array of the defined shared libraries\"\n  },\n  \"cols\": 3,\n  \"rows\": 1\n}\n[/block]\nEach `library` will have the following keys:\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"key\",\n    \"h-1\": \"type\",\n    \"h-2\": \"description\",\n    \"0-0\": \"api_id\",\n    \"1-0\": \"id\",\n    \"2-0\": \"name\",\n    \"3-0\": \"description\",\n    \"4-0\": \"data\",\n    \"4-1\": \"`string`\",\n    \"3-1\": \"`string`\",\n    \"2-1\": \"`string`\",\n    \"0-1\": \"`number`\",\n    \"1-1\": \"`number`\",\n    \"0-2\": \"The API identifier.\",\n    \"1-2\": \"The shared library identifier.\",\n    \"2-2\": \"The name of the shared library.\",\n    \"3-2\": \"The description of the shared library.\",\n    \"4-2\": \"The content of the shared library.\"\n  },\n  \"cols\": 3,\n  \"rows\": 5\n}\n[/block]","excerpt":"","slug":"libraries","type":"endpoint","title":"/libraries"}

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format


Documentation

Calling the `/libraries` endpoint will return a collection of the defined `libraries` sorted alphabetically by name in ascending order. [block:parameters] { "data": { "h-0": "key", "h-1": "type", "h-2": "description", "0-0": "`libraries`", "0-1": "`array`", "0-2": "array of the defined shared libraries" }, "cols": 3, "rows": 1 } [/block] Each `library` will have the following keys: [block:parameters] { "data": { "h-0": "key", "h-1": "type", "h-2": "description", "0-0": "api_id", "1-0": "id", "2-0": "name", "3-0": "description", "4-0": "data", "4-1": "`string`", "3-1": "`string`", "2-1": "`string`", "0-1": "`number`", "1-1": "`number`", "0-2": "The API identifier.", "1-2": "The shared library identifier.", "2-2": "The name of the shared library.", "3-2": "The description of the shared library.", "4-2": "The content of the shared library." }, "cols": 3, "rows": 5 } [/block]