ebXML RegRep WADL


This wadl document decsribes the REST interface description for ebXML RegRep 4.0 server.

Summary

ResourceMethodDescription
http://www.example.com/regrep-server/rest/searchGET

Executes a parameterized query. In addition to the standard parameters below their may be any number of query-specific parameters. Such parameterized are defined by the query specification.
http://www.example.com/regrep-server/rest/registryObjects/{id:.*}GET

Get a RegistryObject by its id.
http://www.example.com/regrep-server/rest/repositoryItems/{id:.*}GET

Get a RepositoryItem by the id of its ExtrinsicObject. The repository item may be of an arbitrary media type.
http://www.example.com/regrep-server/rest/registryObjectsPUT

POST

Creates multiple RegistryObjects.

Creates a single RegistryObject.
http://www.example.com/regrep-server/rest/registryObjects/{id}DELETE

Delete a RegistryObject by its id.
http://www.example.com/regrep-server/rest/requestsPUT

Submits a registry request encoded as a string to the server for processing. This is an alternative that allows submitting any legal RegistryRequestTYpe to the server and returns its RegistryResponse.
http://www.example.com/regrep-server/rest/queriesGET

Gets all queries configured in the server.
http://www.example.com/regrep-server/rest/eventBus/eventGET

Publishes an event to a topic in the server. Topic in the server may be server-specific and often administrative in nature. For example a topic "policy-cache" may be sent a parameter "invalidate" to instruct server to invalidate (flush) its policy cache.

Resources


http://www.example.com/regrep-server/rest/search

Methods
GETsearch()

Executes a parameterized query. In addition to the standard parameters below their may be any number of query-specific parameters. Such parameterized are defined by the query specification.

request
query params
langstringthe language identifier
formatstringspecifies the format of the response desired by the client. If unspecified, the default value is "application/xml" which returns the response in ebRS QueryResponse format
queryIdstringthe id of the query being executed
startIndexintthis optional integer value is used to indicate which result must be returned as the first result when iterating over a large result set. The default value is 0, which returns the result set starting with index 0 (first result).
maxResultsintthis optional attribute specifies a limit on the maximum number of results the client wishes the query to return. If unspecified, the server SHOULD return either all the results, or in case the result set size exceeds a server specific limit, the server SHOULD return a sub-set of results that are within the bounds of the server specific limit.
federatedbooleanthis optional attribute specifies that the server must process this query as a federated query. By default its value is false.
federationstringthis optional attribute specifies the id of the target Federation for a federated query in case the server is a member of multiple federations. In the absence of this attribute a server must route the federated query to all registries that are a member of all federations configured within the local server.
matchOlderVersionsbooleanthis optional attribute specifies the behavior when multiple versions of the same object are matched by a query. When the value of this attribute is specified as false (the default) then a server MUST only return the latest matched version for any object and MUST not return older versions of such objects even though they may match the query. When the value of this attribute is specified as true then a server MUST return all matched versions of all objects.
depthintThis optional attribute specifies the pre-fetch depth of the response desired by the client. A depth of 0 (default) indicates that the server MUST return only those objects that match the query. A depth of N where N is greater that 0 indicates that the server MUST also return objects that are reachable by N levels of references via attributes that reference other objects. A depth of -1 indicates that the server MUST return all objects within the transitive closure of all references from objects that matches the query.

responses
status:
200 - the response to the query. Representation of response is controlled by the format parameter
representations
application/xml, application/json, application/htmlQueryResponse

http://www.example.com/regrep-server/rest/registryObjects/{id:.*}

Methods
GETgetRegistryObject()

Get a RegistryObject by its id.

request
template params
idstringthe id of the RegistryObject to get

query params
langstringthe language identifier
formatstringspecifies the format of the response desired by the client. If unspecified, the default value is "application/xml" which returns the response in ebRS QueryResponse format

responses
status:
200 - the RegistryObject matching specified id. Representation of response is controlled by the format parameter
representations
application/xml, application/json, application/htmlRegistryObject

http://www.example.com/regrep-server/rest/repositoryItems/{id:.*}

Methods
GETgetRepositoryItem()

Get a RepositoryItem by the id of its ExtrinsicObject. The repository item may be of an arbitrary media type.

request
template params
idstringthe id of the ExtrinsicObject for this RepositoryItem

responses
status:
200 - OK
representations
*/*

http://www.example.com/regrep-server/rest/registryObjects

Methods
PUTcreateRegistryObjects()

Creates multiple RegistryObjects.

request
query params
langstringthe language identifier
formatstringspecifies the format of the response desired by the client. If unspecified, the default value is "application/xml" which returns the response in ebRS QueryResponse format

representations
application/xmlRegistryObjectList
application/jsonRegistryObjectList
responses
status:
200 - the response to the request. Representation of response is controlled by the format parameter
representations
application/xml, application/json, application/htmlRegistryResponse
POSTcreateRegistryObject()

Creates a single RegistryObject.

request
representations
application/xmlRegistryObject
application/jsonRegistryObject
responses
status:
200 - OK
representations
*/*

http://www.example.com/regrep-server/rest/registryObjects/{id}

Methods
DELETEdeleteRegistryObject()

Delete a RegistryObject by its id.

request
template params
idstringthe id of the RegistryObject to delete

responses
status:
200 - OK
representations
*/*

http://www.example.com/regrep-server/rest/requests

Methods
PUTdoRegistryRequest()

Submits a registry request encoded as a string to the server for processing. This is an alternative that allows submitting any legal RegistryRequestTYpe to the server and returns its RegistryResponse.

request
query params
langstringthe language identifier
formatstringspecifies the format of the response desired by the client. If unspecified, the default value is "application/xml" which returns the response in ebRS QueryResponse format

representations
application/xmlRegistryRequestType
application/jsonRegistryRequestType
responses
status:
200 - the response to the request. Representation of response is controlled by the format parameter
representations
application/xml, application/json, application/htmlRegistryResponseType

http://www.example.com/regrep-server/rest/queries

Methods
GETgetQueries()

Gets all queries configured in the server.

request
query params
langstringthe language identifier
formatstringspecifies the format of the response desired by the client. If unspecified, the default value is "application/xml" which returns the response in ebRS QueryResponse format

responses
status:
200 - the QueryResponse containing all configured queries. Representation of response is controlled by the format parameter
representations
application/xmlQueryResponse

http://www.example.com/regrep-server/rest/eventBus/event

Methods
GETpublishEventToEventBus()

Publishes an event to a topic in the server. Topic in the server may be server-specific and often administrative in nature. For example a topic "policy-cache" may be sent a parameter "invalidate" to instruct server to invalidate (flush) its policy cache.

request
query params
topicstringthe topic to publish an event to (e.g. "policy-cache")
paramterstringthe identifier for an event (e.g. "invalidate")

responses
status:
200 - OK
representations
*/*