This section describes the technical specifications of the Model API v2.
The Model API is a REST API. It defines a set of web services that allow users and external systems to do GET requests to retrieve model data from the ModelStore. The requests and responses are sent via HTTP protocol.
More concretely, you can do the following actions in the Model API:
Retrieve the list of published models that are available for generation.
The actual generation is done by means of a Create request call in the Request API.
Retrieve the details of a specified model.
This call returns the XSD data, amongst other details. In the returned XSD data (XML Schema Definition) you'll find the structure to which the Input XMLs you will be sending must comply. This way, you can do an XML check, or configure your system to create XMLs on the fly based on the returned XSD.
Retrieve the details of a specified decision table.
The data retrieved by this call can be reused in other applications. For instance, to display the decision table values in a drop-down list on a web page.
In case of discrepancies between examples and the description of the parameters section, the description of the parameters section prevails.
The services are plain REST based services, maintaining no state whatsoever.
The default URL is:
The response body contains a representation of the requested resource.
Client Error responses
The request has not been applied because it lacks valid authentication credentials for the target resource.
The user action is not permitted.
404 Not Found
The origin server did not find a current representation of the target resource.
Server error responses
500 Internal Server Error
The server encountered an unexpected condition that prevented it from fulfilling the request.