To facilitate flexibility and scalability the Intent Registry API provides a discovery service. This service should be called when starting an application to retrieve the URI patterns associated with the data or services that the application will need to access. Endpoints are requested using the “endpoints” parameter. Each endpoint is associated with by a mime-type definition. When resolved from the discovery service each endpoint URI is returned as a RESTful URI pattern. In some cases, these URIs will contain placeholders for information that will need to be substituted.
Request Information
HTTP Method
GET
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
endpoints |
Collection of string |
Required |
Body Parameters
None.
Response Information
DiscoveryResponse
Name | Description | Type | Additional information |
---|---|---|---|
endpoints |
Provides a list of endpoints matching the user's search. | Collection of Endpoint |
None. |
Response Formats
application/json, text/json
{ "endpoints": [ { "name": "sample string 1", "uri": "sample string 2" }, { "name": "sample string 1", "uri": "sample string 2" } ] }
application/xml, text/xml
<discovery_response xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://intents.mitchell1.com/businessobjects/service/v1"> <endpoints> <endpoint> <name>sample string 1</name> <uri>sample string 2</uri> </endpoint> <endpoint> <name>sample string 1</name> <uri>sample string 2</uri> </endpoint> </endpoints> </discovery_response>