Documentation
Reference
Javadocs
REST API
|
No results found.
SDK version
Simudyne REST API
Server Rest API
/api/models/api/models/schema/api/server-info
Interactive Rest API
/api/simulations/interactive/api/simulations/interactive/{id}/config/api/simulations/interactive/{id}/api/simulations/interactive/{id}/ticks
Batch Rest API
/api/simulations/batch/api/simulations/batch/{id}/config/api/simulations/batch/{id}/api/simulations/batch/{id}/ticks
Scenario Rest API
/api/simulations/scenario/api/simulations/scenario/{id}/api/simulations/scenario/{id}/config
Model Sampler Rest API
/api/simulations/model-sampler/api/simulations/model-sampler/{id}

/api/models/schema

Last updated on 16th July 2024

GET

Returns the schema and initial data associated to a particular model.

Request

Example request

curl -X GET http://localhost:8080/api/models/schema\?name=<model_name> -H 'Accept: application/json'

Status Code 200

This REST-ful call returns a schema, and data representing the simulation. By default the avro schema is not returned, if you require this include the query parameter `format=avro`. For more information on the avro schema, see here.

Status Code 404

Name Type Required
message string true

Example 404 response body

{
  "message": "SimulationRegistry: Could not find requested simulation '<model_name>'"
}
/api/models/api/server-info