/auth/v1/collections/<collection_ID>: PATCH

Updates the attributes of an existing collection.

The following table shows which roles can access this REST API endpoint:
Table 1. Access by role
Data admin Data user Collection Admin Admin Service user
✓ Χ ✓ ✓ Χ

Synopsis of the request URL

curl -k -H 'Content-Type: application/json' -H ‘Authorization: Bearer <token>’ 
https://<spectrum_discover_host>/auth/v1/collections/<collection_ID> -X PATCH 
-d ‘<json_details_to_update>'

Supported request types and response formats

You can update the following attributes of a collection.
  • Name
  • Description
  • Tags
You can update one or more attributes in a single call.
Supported request types:
  • PATCH
Supported response formats:
  • JSON

Examples

The following example shows how to update the attributes of a collection:

Request: 
curl -k -H 'Content-Type: application/json' -H ‘Authorization: Bearer <token>’ 
https://<spectrum_discover_host>/auth/v1/collections/a51f84bfeb034b12a9a362109d78bec3 
-X PATCH -d ‘{"name": "General", "description":"ThirdQuarter", "tags": {"ProjectNumber":"1404", "DepartmentCode":"H8AC"}’

Response:

200 OK