Types.get

Returns Type with given id

Responses

🟢200OK

application/json

Type data

Body

success

boolean

optional

True when response succeeded, false on error.

Example:

true

data

object (Type)

optional

is_delete_protected

boolean

read-onlyrequired

Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.

Example:

false

string

read-onlyrequired

Unique identifier of entity.

Example:

string

primitive_type

enum<string>

read-onlyrequired

Field whose values are strictly defined with an enumeration of values.

Allowed values:

blobbooldatedatetimedecimaldoubledynamicenumintlistobjectstringuuid

Example:

blob

validator

object

read-onlyoptional

Field containing json.

flag

integer <int32>

read-onlyrequired

This field is bit flag which determinate purpose of the field and his abilities on form, following options are allowed
CUSTOM_ALLOWED = 1 # field of this type can be created as new custom field
CALC_ALLOWED = 2 # field can have calculation formula defined
DEFAULT_ALLOWED = 4 # field can have default value defined
MOBILE_ALLOWED = 8 # field can be displayed on form
FIELD_MAP_REQUIRED = 16 # Obsolete
FORM_FORBIDDEN = 32 # field of this type can't be located on form
READONLY_ALLOWED = 64 # field can be defined as readonly on form
ONLY_MAIN_FORM = 128 # field can be only at FORM_EDIT form not on e.g FORM_LOST
ALLOWED_IN_CALC_FORMULA = 256 # field can be used within calculation expression
MUST_BE_ON_FORM = 512 # field of this type can't be removed from form

Example:

default_value

string

read-onlyoptional

Generic field wrapping sqlalchemy column, configurable by constructor.
Good for one-of fields / generated fields.

Example:

string

relation_type

enum<integer>

read-onlyrequired

Integer enum value: 0 - NO_RELATION, 1 - MANY_TO_ONE_SCALAR, 2 - MANY_TO_MANY_VECTOR

Allowed values:

012

Example:

container_size

integer <int32>

read-onlyrequired

Generic field wrapping sqlalchemy column, configurable by constructor.
Good for one-of fields / generated fields.

Example:

is_groupable

boolean

read-onlyrequired

Boolean value.

Example:

false

is_filterable

boolean

read-onlyrequired

Boolean value.

Example:

false

is_sortable

boolean

read-onlyrequired

Boolean value.

Example:

false

is_selectable

boolean

read-onlyrequired

Boolean value.

Example:

false

Example

{
    "success": true,
    "data": {
        "is_delete_protected": false,
        "id": "string",
        "primitive_type": "blob",
        "validator": {},
        "flag": 1,
        "default_value": "string",
        "relation_type": 0,
        "container_size": 1,
        "is_groupable": false,
        "is_filterable": false,
        "is_sortable": false,
        "is_selectable": false
    }
}

🟠404Record Not Found

🔴500Server Error

Request

Request samples

Responses