REST API

The ODT Services are made accessible via a REST API. This is defined via an OpenAPI Specification

GET /sbds/create

Create empty SBD

Returns a json SchedulingBlockDefinition with empty or generated fields, to be populated and stored at a later point

Status Codes:
POST /sbds/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:
POST /sbds

Create a new SBDefinition

Creates a new SchedulingBlockDefinition in the underlying data store. The response contains the entity as it exists in the data store, with an sbd_id and metadata populated.

Status Codes:
GET /sbds/{identifier}

Get SB by identifier

Retrieves the SchedulingBlockDefinition with the given identifier from the underlying datas store, if available

Parameters:

  • identifier (string) –

Status Codes:
PUT /sbds/{identifier}

Update an SBDefinition by identifier

Updates the SchedulingBlockDefinition with the given identifier in the underlying data store to create a new version.

Parameters:

  • identifier (string) –

Status Codes: