Versions Compared

Key

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

This section

...

describes the

...

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

Table of Contents

...

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

ParameterExplanation
Collection pathPath of the resource

...

maxLevel3

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

AttributesValues
HTTP MethodGET
Request URI/artifact/{ collection path }
HTTP Request HeaderAuthorization: Basic { base64encoded(username:password) }
ResponseHTTP 200 OK
Response typeapplication/json
Description                 Retrieves the content the paths of the requested collection

Add a

...

collection

Attributesvalues
HTTP MethodPUT
Request URI/artifact/{ complete path of the collection to be added }
HTTP Request Header

Authorization: Basic { base64encoded(username:password) }

Content-Type: application/atomcoll+xml

ResponseHTTP 204 No Content
Response typeapplication/json
DescriptionIt 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

Attributesvalues
HTTP MethodDELETE
Request URI/artifact/{ collection path }
HTTP Request HeaderAuthorization: Basic { base64encoded(username:password) }
ResponseHTTP 204 No Content
Response typeapplication/json
DescriptionIt deletes the requested collection if it exists.