/namespaces/name/{name}/urns Resource

Returns all registered URNs in a namespace. The result set can be filtered using the q parameter.

The result set is paged. The count and offset parameters can be used to navigate through the result list. Alternatively, the Link header contains URLs for browsing through the result list.

Access: Unauthorized (public) access allowed.

GET /namespaces/name/{name}/urns

Returns all registered URNs in a namespace. The result set can be filtered using the q parameter.

The result set is paged. The count and offset parameters can be used to navigate through the result list. Alternatively, the Link header contains URLs for browsing through the result list.

Access: Unauthorized (public) access allowed.

Request Parameters
name type description default constraints
name path   required
count query number of entries to return. Maximum is 50, default is 1. 20 max: 1000, min: 0
offset query index of the first entry to return starting from 0. Default is 0. 0 min: 0
q query allows to filter the result set. The format of the filter query is “key:value”. Supported filter keys are urn, created and lastmodified    
runas query optional login name whose identity is used to execute the request (only available to users with the RunAs privilege)    
sortby query sort field. Supported field are urn, created and lastmodified urn "CREATED" or "LASTMODIFIED" or "URN"
sortorder query sort order. Must be either asc or desc asc "ASC" or "DESC"
Response Codes
code condition
200 if the request was completed successfully
400
  • if the search query was not valid (error code 400001) or
  • a parameter had an unsupported value (error code 400004)
401 if the user could not be authenticated (error code 401001)
403 if the user is not authorized to use a search key (error code 403001)
404 if the namespace does not exist (error code 404001)
Response Body
media type data type description
application/json Collection (JSON) a Collection of Urns
Response Headers
name description
Link contains links to the first, last, next and previous result pages

Example

Request
GET /namespaces/name/{name}/urns
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json
Link: ...

                
{
  "self" : "http://example.org/collection",
  "totalItems" : 42,
  "items" : [ { }, { } ]
}