Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

This section explains the following REST operations regarding the collection which have been secured with OAuth 2.0.

Table of Contents

Note

The following terms explains the meaning of the parameters passed with the below REST URIs

ParameterExplanation
collection pathPath of the resource
OAuth access tokenAuthorized access token per user for an hour by default
userusername of the user

When user adds a collection to the registry, user has to specify the Content-Type of the collection in the request. The Content-Type for the collection is "application/atomcoll+xml". If user specifies a different content-type for the collection, the resource  to be added wont be considered as a collection.

...

AttributesValues
HTTP MethodGET
Request URI/artifact/{ collection path }?user={ user name }
HTTP Request HeaderAuthorization: Bearer { OAuth access token }
Description                 Retrieves the content of the requested collection

Add a Collection

Attributesvalues
HTTP MethodPUT
Request URI/artifact/{ complete path of the collection to be added }?user={ user name }
HTTP Request HeaderAuthorization: Bearer { OAuth access token }
HTTP Request Content TypeHeaderMedia-Type: application/atomcoll+xml
DescriptionIt adds the specified collection

Delete a Collection

Attributesvalues
HTTP MethodDELETE
Request URI/artifact/{ collection path }?user={ user name }
HTTP Request HeaderAuthorization: Bearer { OAuth access token }
DescriptionIt deletes the requested collection if it exists.

...