Collections

Collection model

Define a model for each collection (entity/type) you would like to store in the database.

A collection must have a unique name within the API. The name of the collection will be used as the path of the restful endpoint. The name may also be used as the type name for lookup properties in other collections.

The collection name is case-sensitive, and may include letters, digits, hyphens and the underscore character.

If you rename a collection, the path for the collection endpoint is changed accordingly.

Properties

A model consists of one or more properties (max 25 properties per model).

Each property must have a unique name within the collection.

Property names are case-sensitive, and may include letters, digits and the underscore character. Property names must begin with a letter.

Each property has a defined data type.

Lookup properties contain references/links to items in another collection.

Property defaults and validation rules

Default values can be defined for any property (except lookup properties). The default value is used for POST and PUT operations that are missing the specific property.

A property may be set to be required. Failure to submit a value for a required property will result in a 400 bad request response.

String properties may contain definitions for Minimum length and/or a Maximum length. Numeric properties (decimal and integer) may contain definitions for Minimum value and/or a Maximum value. Validation failures will result in a 400 bad request response.

Collection access