Update the properties of an existing Collection.
Collection content plus any additional metadata for the request.
OK
Invalid request
Not Authorized
Semantic error
Too Many Requests
{- "name": "string",
- "description": "string",
- "addedRoles": [
- {
- "sourceDocumentSpec": {
- "url": "string"
}, - "person": {
- "name": "George Clooney",
- "obfuscatedId": "abc123"
}, - "group": {
- "type": "DEPARTMENT",
- "id": "string",
- "name": "string"
}, - "role": "OWNER"
}
], - "removedRoles": [
- {
- "sourceDocumentSpec": {
- "url": "string"
}, - "person": {
- "name": "George Clooney",
- "obfuscatedId": "abc123"
}, - "group": {
- "type": "DEPARTMENT",
- "id": "string",
- "name": "string"
}, - "role": "OWNER"
}
], - "audienceFilters": [
- {
- "fieldName": "type",
- "values": [
- {
- "value": "Spreadsheet",
- "relationType": "EQUALS"
}, - {
- "value": "Presentation",
- "relationType": "EQUALS"
}
]
}
], - "icon": "string",
- "adminLocked": true,
- "parentId": 0,
- "thumbnail": {
- "photoId": "string",
- "url": "string"
}, - "allowedDatasource": "string",
- "id": 0
}
{- "name": "string",
- "description": "string",
- "addedRoles": [
- {
- "sourceDocumentSpec": {
- "url": "string"
}, - "person": {
- "name": "George Clooney",
- "obfuscatedId": "abc123"
}, - "group": {
- "type": "DEPARTMENT",
- "id": "string",
- "name": "string"
}, - "role": "OWNER"
}
], - "removedRoles": [
- {
- "sourceDocumentSpec": {
- "url": "string"
}, - "person": {
- "name": "George Clooney",
- "obfuscatedId": "abc123"
}, - "group": {
- "type": "DEPARTMENT",
- "id": "string",
- "name": "string"
}, - "role": "OWNER"
}
], - "audienceFilters": [
- {
- "fieldName": "type",
- "values": [
- {
- "value": "Spreadsheet",
- "relationType": "EQUALS"
}, - {
- "value": "Presentation",
- "relationType": "EQUALS"
}
]
}
], - "icon": "string",
- "adminLocked": true,
- "parentId": 0,
- "thumbnail": {
- "photoId": "string",
- "url": "string"
}, - "allowedDatasource": "string",
- "permissions": {
- "write": {
- "scopeType": "GLOBAL",
- "create": true,
- "update": true,
- "delete": true
}
}, - "id": 0,
- "createTime": "2019-08-24T14:15:22Z",
- "updateTime": "2019-08-24T14:15:22Z",
- "creator": {
- "name": "George Clooney",
- "obfuscatedId": "abc123"
}, - "updatedBy": {
- "name": "George Clooney",
- "obfuscatedId": "abc123"
}, - "itemCount": 0,
- "childCount": 0,
- "items": [
- {
- "name": "string",
- "description": "string",
- "icon": "string",
- "collectionId": 0,
- "documentId": "string",
- "url": "string",
- "itemId": "string",
- "createdBy": {
- "name": "George Clooney",
- "obfuscatedId": "abc123"
}, - "createdAt": "2019-08-24T14:15:22Z",
- "document": {
- "id": "string",
- "datasource": "string",
- "connectorType": "API_CRAWL",
- "docType": "string",
- "content": {
- "fullTextList": [
- "string"
]
}, - "containerDocument": { },
- "parentDocument": { },
- "title": "string",
- "url": "string",
- "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": "someCustomValue"
}
}, - "sections": [
- {
- "title": "string",
- "url": "string"
}
]
}, - "shortcut": {
- "id": 0,
- "inputAlias": "string",
- "destinationUrl": "string",
- "destinationDocumentId": "string",
- "description": "string",
- "unlisted": true,
- "urlTemplate": "string",
- "addedRoles": [
- {
- "sourceDocumentSpec": {
- "url": "string"
}, - "person": {
- "name": "George Clooney",
- "obfuscatedId": "abc123"
}, - "group": {
- "type": "DEPARTMENT",
- "id": "string",
- "name": "string"
}, - "role": "OWNER"
}
], - "removedRoles": [
- {
- "sourceDocumentSpec": {
- "url": "string"
}, - "person": {
- "name": "George Clooney",
- "obfuscatedId": "abc123"
}, - "group": {
- "type": "DEPARTMENT",
- "id": "string",
- "name": "string"
}, - "role": "OWNER"
}
], - "permissions": {
- "write": {
- "scopeType": "GLOBAL",
- "create": true,
- "update": true,
- "delete": true
}
}, - "createdBy": {
- "name": "George Clooney",
- "obfuscatedId": "abc123"
}, - "createTime": "2019-08-24T14:15:22Z",
- "updatedBy": {
- "name": "George Clooney",
- "obfuscatedId": "abc123"
}, - "updateTime": "2019-08-24T14:15:22Z",
- "destinationDocument": {
- "id": "string",
- "datasource": "string",
- "connectorType": "API_CRAWL",
- "docType": "string",
- "content": {
- "fullTextList": [
- "string"
]
}, - "containerDocument": { },
- "parentDocument": { },
- "title": "string",
- "url": "string",
- "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": "someCustomValue"
}
}, - "sections": [
- {
- "title": "string",
- "url": "string"
}
]
}, - "intermediateUrl": "string",
- "viewPrefix": "string",
- "isExternal": true,
- "editUrl": "string",
- "alias": "string",
- "title": "string",
- "roles": [
- {
- "sourceDocumentSpec": {
- "url": "string"
}, - "person": {
- "name": "George Clooney",
- "obfuscatedId": "abc123"
}, - "group": {
- "type": "DEPARTMENT",
- "id": "string",
- "name": "string"
}, - "role": "OWNER"
}
]
}, - "collection": null,
- "itemType": "DOCUMENT"
}
], - "pinMetadata": {
- "existingPins": [
- {
- "category": "COMPANY_RESOURCE",
- "value": "string",
- "target": "RESOURCE_CARD"
}
], - "eligiblePins": [
- {
- "id": 0,
- "target": {
- "category": "COMPANY_RESOURCE",
- "value": "string",
- "target": "RESOURCE_CARD"
}
}
]
}, - "shortcuts": [
- "string"
], - "children": [
- null
], - "roles": [
- {
- "sourceDocumentSpec": {
- "url": "string"
}, - "person": {
- "name": "George Clooney",
- "obfuscatedId": "abc123"
}, - "group": {
- "type": "DEPARTMENT",
- "id": "string",
- "name": "string"
}, - "role": "OWNER"
}
], - "errorCode": "NAME_EXISTS",
- "collection": {
- "name": "string",
- "description": "string",
- "addedRoles": [
- {
- "sourceDocumentSpec": {
- "url": "string"
}, - "person": {
- "name": "George Clooney",
- "obfuscatedId": "abc123"
}, - "group": {
- "type": "DEPARTMENT",
- "id": "string",
- "name": "string"
}, - "role": "OWNER"
}
], - "removedRoles": [
- {
- "sourceDocumentSpec": {
- "url": "string"
}, - "person": {
- "name": "George Clooney",
- "obfuscatedId": "abc123"
}, - "group": {
- "type": "DEPARTMENT",
- "id": "string",
- "name": "string"
}, - "role": "OWNER"
}
], - "audienceFilters": [
- {
- "fieldName": "type",
- "values": [
- {
- "value": "Spreadsheet",
- "relationType": "EQUALS"
}, - {
- "value": "Presentation",
- "relationType": "EQUALS"
}
]
}
], - "icon": "string",
- "adminLocked": true,
- "parentId": 0,
- "thumbnail": {
- "photoId": "string",
- "url": "string"
}, - "allowedDatasource": "string",
- "permissions": {
- "write": {
- "scopeType": "GLOBAL",
- "create": true,
- "update": true,
- "delete": true
}
}, - "id": 0,
- "createTime": "2019-08-24T14:15:22Z",
- "updateTime": "2019-08-24T14:15:22Z",
- "creator": {
- "name": "George Clooney",
- "obfuscatedId": "abc123"
}, - "updatedBy": {
- "name": "George Clooney",
- "obfuscatedId": "abc123"
}, - "itemCount": 0,
- "childCount": 0,
- "items": [
- {
- "name": "string",
- "description": "string",
- "icon": "string",
- "collectionId": 0,
- "documentId": "string",
- "url": "string",
- "itemId": "string",
- "createdBy": {
- "name": "George Clooney",
- "obfuscatedId": "abc123"
}, - "createdAt": "2019-08-24T14:15:22Z",
- "document": {
- "id": "string",
- "datasource": "string",
- "connectorType": "API_CRAWL",
- "docType": "string",
- "content": {
- "fullTextList": [
- "string"
]
}, - "containerDocument": { },
- "parentDocument": { },
- "title": "string",
- "url": "string",
- "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": "someCustomValue"
}
}, - "sections": [
- {
- "title": "string",
- "url": "string"
}
]
}, - "shortcut": {
- "id": 0,
- "inputAlias": "string",
- "destinationUrl": "string",
- "destinationDocumentId": "string",
- "description": "string",
- "unlisted": true,
- "urlTemplate": "string",
- "addedRoles": [
- {
- "sourceDocumentSpec": {
- "url": null
}, - "person": {
- "name": "George Clooney",
- "obfuscatedId": "abc123"
}, - "group": {
- "type": null,
- "id": null,
- "name": null
}, - "role": "OWNER"
}
], - "removedRoles": [
- {
- "sourceDocumentSpec": {
- "url": null
}, - "person": {
- "name": "George Clooney",
- "obfuscatedId": "abc123"
}, - "group": {
- "type": null,
- "id": null,
- "name": null
}, - "role": "OWNER"
}
], - "permissions": {
- "write": {
- "scopeType": "GLOBAL",
- "create": true,
- "update": true,
- "delete": true
}
}, - "createdBy": {
- "name": "George Clooney",
- "obfuscatedId": "abc123"
}, - "createTime": "2019-08-24T14:15:22Z",
- "updatedBy": {
- "name": "George Clooney",
- "obfuscatedId": "abc123"
}, - "updateTime": "2019-08-24T14:15:22Z",
- "destinationDocument": {
- "id": "string",
- "datasource": "string",
- "connectorType": "API_CRAWL",
- "docType": "string",
- "content": {
- "fullTextList": [
- null
]
}, - "containerDocument": { },
- "parentDocument": { },
- "title": "string",
- "url": "string",
- "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": "someCustomValue"
}
}, - "sections": [
- {
- "title": null,
- "url": null
}
]
}, - "intermediateUrl": "string",
- "viewPrefix": "string",
- "isExternal": true,
- "editUrl": "string",
- "alias": "string",
- "title": "string",
- "roles": [
- {
- "sourceDocumentSpec": {
- "url": null
}, - "person": {
- "name": "George Clooney",
- "obfuscatedId": "abc123"
}, - "group": {
- "type": null,
- "id": null,
- "name": null
}, - "role": "OWNER"
}
]
}, - "collection": null,
- "itemType": "DOCUMENT"
}
], - "pinMetadata": {
- "existingPins": [
- {
- "category": "COMPANY_RESOURCE",
- "value": "string",
- "target": "RESOURCE_CARD"
}
], - "eligiblePins": [
- {
- "id": 0,
- "target": {
- "category": "COMPANY_RESOURCE",
- "value": "string",
- "target": "RESOURCE_CARD"
}
}
]
}, - "shortcuts": [
- "string"
], - "children": [
- null
], - "roles": [
- {
- "sourceDocumentSpec": {
- "url": "string"
}, - "person": {
- "name": "George Clooney",
- "obfuscatedId": "abc123"
}, - "group": {
- "type": "DEPARTMENT",
- "id": "string",
- "name": "string"
}, - "role": "OWNER"
}
]
}, - "error": {
- "errorCode": "NAME_EXISTS"
}
}