{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/access-catalog/","auth":"required","method":"get","params":[{"name":"type","type":"string","default":"","desc":"resource/collection","required":false,"in":"path","ref":"","_id":"582c0dd6d2e3680f00df40d2"},{"name":"Authorization","type":"string","default":"","desc":"API Key should be passed in authorization header. Contact support:::at:::gooru.org for API Key","required":false,"in":"header","ref":"","_id":"582c0dd6d2e3680f00df40d1"}],"results":{"codes":[{"code":"{\n\"status\":\"in-progress\",\n\"message\":\"Requested file is being generated and will take about 30 minutes approximately. Please check back.\"\n}\n","language":"json","status":202,"name":"In Progress Response"},{"language":"json","code":"{\n\"status\":\"ready\",\n\"message\":\"https://gooru-itsl-org.s3.amazonaws.com/ac7f638f-7c74-314c-b054-c83c1824e329-catalog.json?AWSAccessKeyId=AKIAJJL4EZAFEY3ZQTIA&Expires=1478672500&Signature=z8y7iHZpSFjwL32aFH7pMegsvTg%3D\"\n}\n","name":"Completion Response","status":200},{"code":"{\n\"status\":\"unavailable\",\n\"message\":\"Requested catalog is unavailable for your request. Please contact our [email protected]\"\n}\n","name":"Unavailable Response","status":404,"language":"json"}]},"settings":"582c0d1ad2e3680f00df40cf","examples":{"codes":[{"language":"curl","code":"curl -i -H \"Content-Type: application/json\" -H \"Authorization:k4/foWLjBSwFJeug9gvzkfR9ieI=\" -X GET 'http://www.gooru.org/api/nucleus-index-tracker/v1/access-catalog/resource"}]}},"next":{"description":"","pages":[]},"title":"Download Catalog","type":"endpoint","slug":"download-catalog","excerpt":"Given a content type, catalog export starts and returns the status and message to check back after sometime. When user checks back again after sometime using the same API, returns the current status and message. If file is ready, message will include download URL to download the exported catalog file.","body":"Once you get the \"ready\" status in response, you can use the URL contained in \"message\" field and download the file.","updates":[],"order":0,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"582c0b06e4a4920f00feff80","category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"Access Catalog","slug":"access-catalog","order":9999,"from_sync":false,"reference":false,"_id":"582c0af888708a0f00570a69","createdAt":"2016-11-16T07:30:00.442Z","__v":0,"project":"56439dfe9eebf70d00490d54","version":"56439dff9eebf70d00490d57"},"__v":1,"project":"56439dfe9eebf70d00490d54","user":"5706dce42138ed0e0060f8ab","version":{"version":"1","version_clean":"1.0.0","codename":"","is_stable":false,"is_beta":true,"is_hidden":false,"is_deprecated":false,"categories":["56439dff9eebf70d00490d58","56439e17c92c470d002dec71","564ce88e802cd02100444274","564d07ff3657c43500bf1d33","564d0a312da1982d00b19b64","564d2aa92da1982d00b19b8c","564d30a8b88a37210082253e","564d362c2da1982d00b19ba0","569d664371e3650d00acf018","569d7eacec29360d00f667c9","569d8006ec29360d00f667cb","569d855e0306a10d00ce99b9","569d91d571e3650d00acf04c","569d91eeceb7510d00f2a6a3","569e8c262d320817003b806d","569e8f802d320817003b8072","56b038c914dfea0d0007cf05","5717b4f0681bb41900fc575a","5718e0a4cd483219007c2c9a","571924c8e967cb1700d078e9","571e2648edc4a92b00a4cc65","576a677a6f15260e001f899b","576c5eaf5738570e00ff070f","578d127ed9c55c2000d4f213","579f90927ebe9b0e00059c50","582c0af888708a0f00570a69"],"_id":"56439dff9eebf70d00490d57","createdAt":"2015-11-11T19:58:55.144Z","project":"56439dfe9eebf70d00490d54","releaseDate":"2015-11-11T19:58:55.144Z","__v":26},"parentDoc":null,"createdAt":"2016-11-16T07:30:14.049Z","githubsync":""}
getDownload Catalog
Given a content type, catalog export starts and returns the status and message to check back after sometime. When user checks back again after sometime using the same API, returns the current status and message. If file is ready, message will include download URL to download the exported catalog file.
Definition
{{ api_url }}{{ page_api_url }}
Parameters
Path Params
type:
string
resource/collection
Headers
Authorization:
string
API Key should be passed in authorization header. Contact [email protected] for API Key