Get Entity Type by Id

GET 
/api/workspaces/:workspace_id/entity_types/:id/

Get an entity type by its id.

Request

Path Parameters

workspace_id stringrequired
id integerrequired

A unique integer value identifying this entity type.

Responses

200

application/json

Schema

Schema

id integer
name string

Possible values: non-empty

class_name stringnullable

Possible values: non-empty

preprocess_method stringnullable

Possible values: non-empty

is_file boolean
has_designer boolean
show_children_as string

Possible values: non-empty

views object[]

Views definition

summary object[]

Summary definition

scope string

Possible values: non-empty and <= 15 characters

actions string

User permissions

child_entity_type_ids integer[]required

Ids of the child entity types

file_constraints object

Specifies the maximum size and allowed file types

viktor_store_table_option_field_value boolean

Migration flag: if true, the value of an option field within a table is stored instead of its label

viktor_enforce_field_constraints boolean

Migration flag: if true, violated field constraints block actions until they are resolved

parametrization_width integernullable
views_only boolean

Specifies whether entity type has only views (no parametrization)

show_file_manager boolean
navigate_to_editor boolean

If true, users will navigate directly to the editor of the entity instead of the browse screen

Example (from schema)

{
  "id": 0,
  "name": "string",
  "class_name": "string",
  "preprocess_method": "string",
  "is_file": true,
  "has_designer": true,
  "show_children_as": "string",
  "views": [
    {}
  ],
  "summary": [
    {}
  ],
  "scope": "string",
  "actions": "string",
  "child_entity_type_ids": [
    0
  ],
  "file_constraints": {},
  "viktor_store_table_option_field_value": true,
  "viktor_enforce_field_constraints": true,
  "parametrization_width": 0,
  "views_only": true,
  "show_file_manager": true,
  "navigate_to_editor": true
}

Loading...