REST Object URL Syntax
The REST URL syntax is as follows and is described in the table that follows.
http://[hostname]:[port]/[contextRoot]/rest/[repositoryId]/[projectName]/[type]/[objectName]?[request_parameter]=[value]
Parameter | Description |
[hostname]: | Name of server on which OneData is deployed. |
[port]/ | Port on which OneData is deployed (optional based on deployment). |
[contextRoot] | Context name of OneData in the application server. |
/rest/ | Name of the service provider bean as configured in web.xml. (This is a constant value.) |
[repositoryId] | Repository ID. |
[projectName] | Name of the project. |
[type] | [type] Type of object. The value is case sensitive.  CO. Conceptual object. DO. Data object. RO. Remote object. IM. Interchange mapping. |
[objectName] | Name of the data object, conceptual object, remote object, or interchange mapping. Note: | The RESTful web service URL does not support slashes (/ \) in an object name. If these characters are part of an object name, you will not be able to retrieve the object through an HTTP request to the OneData server. |
|
[parameter] | Use parameters to customize the request URL for REST. The format for the request parameter in a request URL. For information about the REST parameters, see REST URL Parameters. |
Object REST URL Examples
The following are examples of REST URLs:
Data Object. Where the object name is Employee.
http:// localhost:8080/onedata/rest/QA/StandardProject/DO/Employee
Conceptual Object. The object name is Employee CO.
http://localhost:8080/onedata/rest/QA/StandardProject/CO/Employee CO
Remote Object. The object name is CountryID RO
http://localhost:8080/onedata/rest/QA/StandardProject/RO/CountryID RO
Interchange Mapping. The interchange mapping name is Employee Interchange.
http://localhost:8080/onedata/rest/QA/StandardProject/IM/Employee Interchange
You can customize the REST URL with a filter and additional parameters. For more information, see
Using Filters in REST Services. For information about the REST parameters, see
REST URL Parameters.
