Collection
Via this method you are able to search on specific groups. You are able to find only groups which contain a 'Organization ID'.
Get /collections/{externalId}
Header
| Name | Data Type | Description |
|---|---|---|
| Content-type: | application/json | for all requests |
| Authorization: | EAPI {token} | for all requests |
Request Parameters
Parameters indicated with a * are mandatory
| Parameter | Type | Description |
|---|---|---|
| externalId | String(64) | Collection external id (prefix) |
Sample Request URL
https://api.cirrusplatform.com/api/v1/integrations/collections/ColExt1
Sample successfull Response
{
"Content":{
"ExternalId": "ColExt1",
"Title": "Collection1",
"Owner": "User1 User1",
"Taxonomies": [
{"ExternalId": "TaxExt1", "Title": "Taxonomy_1"}
],
"ObjectiveRepositories": [
{"ExternalId": "ObjRepExt1", "Title": "Repository_1"}
],
"SharingInfo":[
{"UserName": "User1 User1", "CollectionRole": "Author", "AccessToCollection": true, "AccessToQuestions": true},
{"UserName": "User2 User2","CollectionRole": "Co-author", "AccessToCollection": true, "AccessToQuestions": false},
{"UserName": "User3 User3", "CollectionRole": null, "AccessToCollection": null, "AccessToQuestions": true}
]
},
"Success": true,
"Errors": null
}
Responses
| Code | Description |
|---|---|
| 200 | Successful operation |
| 400 | Possible codes: 801: Collection has not been found |
| 403 | Not allowed to use external API |
| 500 | Internal server error |