Collections
Add Collection item
Add items to a Collection.
post/rest/api/v1/addcollectionitems
Query parameters
localestring
The client's preferred locale in rfc5646 format (e.g. en, ja, pt-BR). If omitted, the Accept-Language will be used. If not present or not supported, defaults to the closest match or en.
Headers
X-Glean-ActAsstring email
Email address of a user on whose behalf the request is intended to be made (should be non-empty only for global tokens).
X-Glean-Auth-Typestring
Auth type being used to access the endpoint (should be non-empty only for global tokens).
Request body
Response
OK
Example response
{
"collection": {
"addedRoles": [
{
"person": {
"name": "George Clooney",
"obfuscatedId": "abc123"
}
}
],
"removedRoles": [
{
"person": {
"name": "George Clooney",
"obfuscatedId": "abc123"
}
}
],
"audienceFilters": [
{
"fieldName": "type",
"values": [
{
"value": "Spreadsheet",
"relationType": "EQUALS"
},
{
"value": "Presentation",
"relationType": "EQUALS"
}
]
}
],
"creator": {
"name": "George Clooney",
"obfuscatedId": "abc123"
},
"updatedBy": {
"name": "George Clooney",
"obfuscatedId": "abc123"
},
"items": [
{
"createdBy": {
"name": "George Clooney",
"obfuscatedId": "abc123"
},
"document": {
"metadata": {
"container": "container",
"parentId": "JIRA_EN-1337",
"createTime": "2000-01-23T04:56:07.000Z",
"datasource": "datasource",
"author": {
"name": "name"
},
"documentId": "documentId",
"updateTime": "2000-01-23T04:56:07.000Z",
"mimeType": "mimeType",
"objectType": "Feature Request",
"components": [
"Backend",
"Networking"
],
"status": "Done",
"customData": {
"someCustomField": {
"stringValue": "someCustomValue"
}
}
}
},
"shortcut": {
"addedRoles": [
{
"person": {
"name": "George Clooney",
"obfuscatedId": "abc123"
}
}
],
"removedRoles": [
{
"person": {
"name": "George Clooney",
"obfuscatedId": "abc123"
}
}
],
"createdBy": {
"name": "George Clooney",
"obfuscatedId": "abc123"
},
"updatedBy": {
"name": "George Clooney",
"obfuscatedId": "abc123"
},
"destinationDocument": {
"metadata": {
"container": "container",
"parentId": "JIRA_EN-1337",
"createTime": "2000-01-23T04:56:07.000Z",
"datasource": "datasource",
"author": {
"name": "name"
},
"documentId": "documentId",
"updateTime": "2000-01-23T04:56:07.000Z",
"mimeType": "mimeType",
"objectType": "Feature Request",
"components": [
"Backend",
"Networking"
],
"status": "Done",
"customData": {
"someCustomField": {
"stringValue": "someCustomValue"
}
}
}
},
"roles": [
{
"person": {
"name": "George Clooney",
"obfuscatedId": "abc123"
}
}
]
}
}
],
"roles": [
{
"person": {
"name": "George Clooney",
"obfuscatedId": "abc123"
}
}
]
}
}