REST API
The ODT Services are made accessible via a REST API. This is defined via an OpenAPI Specification
- GET /sbd/create
Create empty SBD
Returns a json SchedulingBlockDefinition with empty or generated fields, to be populated and stored at a later point
- Status Codes:
200 OK – OK
- POST /sbd/validate
Validate an SBD
Validates the SchedulingBlockDefinition in the request body against the component definition (eg required fields, allowed ranges) and more complex business logic in the controller method.
- Status Codes:
200 OK – OK
- GET /sbd/{identifier}
Get SB by identifier
Retrieves the SchedulingBlockDefinition with the given identifier from the underlying datas store, if available
- Parameters:
identifier (string) –
- Status Codes:
200 OK – OK
404 Not Found – NotFound
- POST /sbd/{identifier}
Store SB by identifier
Stores the SchedulingBlockDefinition with the given identifier in the underlying data store. If the identifier does not exist in the data store, a new version 1 will be created. If a version does exist, an update will be performed. In this case, the metadata in the recieved SchedulingBlockDefinition should match the existing version - the user of this API should not edit metadata before sending.
- Parameters:
identifier (string) –
- Status Codes:
200 OK – OK
400 Bad Request – Bad Request, validation of SBDefinition failed
500 Internal Server Error – Internal Server Error