{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/collections-external","auth":"required","method":"post","examples":{"codes":[{"language":"json","code":"{\t\n\t\t\t\"title\":\"Green\tChemistry\",\t\n\t\t\t\"url\":\"\thttp://example.com\t”,\t\n\t\t\t\"metadata\":{\t\n\t\t\t\t\t\t\"audience\":[\t\n  \t\t\t\t\t\t\t\t\t4\t\n\t\t\t\t\t\t]\t\n\t\t\t},\t\n\t\t\t\"taxonomy\":{\t\n\t\t\t\t\t\t\"SKHOS.HOS.HOS-DL-CSS-01\":{\t\n\t\t\t\t\t\t\t\t\t\"code\":\"DL.CSS.1\",\t\n\t\t\t\t\t\t\t\t\t\"title\":\"Ability\tto\tformulate\ta\tProblem\",\t\n\t\t\t\t\t\t\t\t\t\"parent_title\":\"Habits\tof\tsuccess-\tSoft\tskills/Non-Cog\",\t\n\t\t\t\t\t\t\t\t\t\"description\":\"\",\t\n\t\t\t\t\t\t\t\t\t\"framework_code\":\"SKHOS\"\t\n\t\t\t\t\t\t}\t\n\t\t\t},\t\n\t\t\t\"learning_objective\":\"learn\tthe\tbasics of\tgreen\tchemistry\"\t\n} \t"}]},"results":{"codes":[]},"settings":"","params":[{"name":"title","type":"string","default":"","desc":"Title\tof the external\tcontent","required":true,"in":"body","ref":"","_id":"5d42b67acba0b30128cf9f8e"},{"name":"learning_objective","type":"string","default":"","desc":"Description of the external content","required":false,"in":"body","ref":"","_id":"5d42b67acba0b30128cf9f8d"},{"name":"taxonomy","type":"array_object","default":"null","desc":"Taxonomy for\tthe external content","required":false,"in":"body","ref":"","_id":"5d42b67acba0b30128cf9f8c"},{"name":"metadata","type":"string","default":"null","desc":"Metadata\tof the external\tcontent","required":false,"in":"body","ref":"","_id":"5d42b67acba0b30128cf9f8b"},{"name":"thumbnail","type":"string","default":"null","desc":"Path\tof the thumbnail","required":false,"in":"body","ref":"","_id":"5d42b67acba0b30128cf9f8a"},{"name":"primary_language","type":"int","default":"1","desc":"Primary Language of the external content","required":false,"in":"body","ref":"","_id":"5d42b67acba0b30128cf9f89"},{"name":"visible_on_profile","type":"boolean","default":"","desc":"","required":false,"in":"body","ref":"","_id":"5d42b67acba0b30128cf9f88"},{"name":"url","type":"string","default":"","desc":"URL\tof the external\tcontent","required":false,"in":"body","ref":"","_id":"5d42b67acba0b30128cf9f87"},{"name":"login_required","type":"boolean","default":"","desc":"Login requirement of the\texternal  content","required":false,"in":"body","ref":"","_id":"5d42b67acba0b30128cf9f86"}]},"next":{"description":"","pages":[]},"title":"Create a new External Collection","type":"endpoint","slug":"create-a-new-external-collection-1","excerpt":"","body":"[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Header Name\",\n    \"h-1\": \"Value\",\n    \"0-0\": \"Authorization\",\n    \"0-1\": \"Token{TOKEN}\",\n    \"1-0\": \"Content-Type\",\n    \"1-1\": \"application/json\"\n  },\n  \"cols\": 2,\n  \"rows\": 2\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Note:\",\n  \"body\": \"Response Header:  (If Response Code\\tis 200 OK)\"\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Header Name\",\n    \"h-1\": \"Value\",\n    \"h-2\": \"Description\",\n    \"0-0\": \"Location\",\n    \"0-2\": \"ID\\tof\\tthe\\tnewly\\tcreated external content\",\n    \"0-1\": \"UUID\"\n  },\n  \"cols\": 3,\n  \"rows\": 1\n}\n[/block]","updates":[],"order":6,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5d42b67acba0b30128cf9f85","project":"56439dfe9eebf70d00490d54","version":{"version":"2","version_clean":"2.0.0","codename":"","is_stable":true,"is_beta":true,"is_hidden":false,"is_deprecated":false,"categories":["5864d2df79ce642d00f0fec8","5864d2df79ce642d00f0fec9","5864d2df79ce642d00f0feca","5864d2df79ce642d00f0fecb","5864d2df79ce642d00f0fecc","5864d2df79ce642d00f0fecd","5864d2df79ce642d00f0fece","5864d2df79ce642d00f0fecf","5864d2df79ce642d00f0fed0","5864d2df79ce642d00f0fed1","5864d2df79ce642d00f0fed2","5864d2df79ce642d00f0fed3","5864d2df79ce642d00f0fed4","5864d2df79ce642d00f0fed5","5864d2df79ce642d00f0fed6","5864d2df79ce642d00f0fed7","5864d2df79ce642d00f0fed8","5864d2df79ce642d00f0fed9","5864d2df79ce642d00f0feda","5864d2df79ce642d00f0fedb","5864d2df79ce642d00f0fedc","5864d2df79ce642d00f0fedd","5864d2df79ce642d00f0fede","598aa64f4b6e990019b7a2d2","599bc76bc03fa2000f83db2a","599bcc3c3c5bf7000f3434fc","5d427dc9fa56fa0011135058","5d429c616863d5003af785a7","5d429e0889418f00c5e95d3f","5d42b5f098b05e003acb08b4","5d43c16985775c00ebeede3b","5d43d15446d584003da91e6d","5d43d61a5bdac50011b6f234","5d43d7c2db365100640dbc58","5d43d954bffa8400ff7efa78","5d43e414cf4f03005944344c","5d43eb42db365100640dbe4a","5d43ee6c78121b0057bc1dbf","5d9a18b4afc33400126c4e6f","5dc4f96dbb5da3006c8f5660"],"_id":"5864d2df79ce642d00f0fec7","createdAt":"2016-12-29T09:09:51.074Z","project":"56439dfe9eebf70d00490d54","releaseDate":"2016-12-29T09:09:51.074Z","__v":18},"category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"Gooru External Contents CRUD API","slug":"gooru-external-contents-crud-api","order":28,"from_sync":false,"reference":false,"_id":"5d429e0889418f00c5e95d3f","project":"56439dfe9eebf70d00490d54","version":"5864d2df79ce642d00f0fec7","createdAt":"2019-08-01T08:08:40.230Z","__v":0},"user":"5d411a29005b9600113731fd","createdAt":"2019-08-01T09:52:58.625Z","__v":2,"parentDoc":null}

postCreate a new External Collection


Definition

{{ api_url }}{{ page_api_url }}

Parameters

Body Params

title:
required
string
Title of the external content
learning_objective:
string
Description of the external content
taxonomy:
array of objectsnull
Taxonomy for the external content
metadata:
stringnull
Metadata of the external content
thumbnail:
stringnull
Path of the thumbnail
primary_language:
integer1
Primary Language of the external content
visible_on_profile:
boolean
url:
string
URL of the external content
login_required:
boolean
Login requirement of the external content

Examples


Documentation

[block:parameters] { "data": { "h-0": "Header Name", "h-1": "Value", "0-0": "Authorization", "0-1": "Token{TOKEN}", "1-0": "Content-Type", "1-1": "application/json" }, "cols": 2, "rows": 2 } [/block] [block:callout] { "type": "info", "title": "Note:", "body": "Response Header: (If Response Code\tis 200 OK)" } [/block] [block:parameters] { "data": { "h-0": "Header Name", "h-1": "Value", "h-2": "Description", "0-0": "Location", "0-2": "ID\tof\tthe\tnewly\tcreated external content", "0-1": "UUID" }, "cols": 3, "rows": 1 } [/block]

User Information

Try It Out

post
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}