Collections with REST API

This section describes the REST URIs for working with the collections that have been secured with Basic Auth.

Query parameters

The collection path is the complete path to the collection. When you add a collection to the registry, you must specify the content type of the collection as application/atomcoll+xml in the request header. If you specify a different content-type for the collection, the resource to be added won't be considered a collection.

For details on security (the authorization header) and the URI syntax (port, context, etc.), see Registry REST API.

Get the content of a collection

Attributes	Values
HTTP Method	GET
Request URI	/artifact/{ collection path }
HTTP Request Header	Authorization: Basic { base64encoded(username:password) }
Response	HTTP 200 OK
Response type	application/json
Description	Retrieves the content the paths of the requested collection

Add a collection

Attributes	values
HTTP Method	PUT
Request URI	/artifact/{ complete path of the collection to be added }
HTTP Request Header	Authorization: Basic { base64encoded(username:password) } Content-Type: application/atomcoll+xml
Response	HTTP 204 No Content
Response type	application/json
Description	It adds the specified collection if doesn't exist.

Sample request

curl -v -k -X PUT -H "Authorization: Basic YWRtaW46YWRtaW4=" -H "Content-Type: application/atomcoll+xml" -d "https://localhost:9443/resource/1.0.0/artifact/_system/governance/permission/applications/TestSP/TestCol"

Delete a collection

Attributes	values
HTTP Method	DELETE
Request URI	/artifact/{ collection path }
HTTP Request Header	Authorization: Basic { base64encoded(username:password) }
Response	HTTP 204 No Content
Response type	application/json
Description	It deletes the requested collection if it exists.