Namirasoft Field API V1
Namira Software Corporation Field API Version 1 (1.5.8)
Install
To use this cli, we need to first Install Nodejs, then run the following command.
npm i -g namirasoft-field-api-v1
Commands
Health
Liveness
Returns the application liveness status
ns-field health liveness
Readiness
Returns the application readiness status
ns-field health readiness
Metrics
Get
Returns the application metrics
ns-field metrics get
Value
List
Returns the value list of a given table and column
ns-field value list {table} {column} {search} {field_id} {limit}
FieldCategory
List
Returns the field category list
ns-field fieldcategory list {filters} {page} {size} {sorts} {all_workspaces}
Get
Returns a field category by id.
ns-field fieldcategory get {id}
Create
Creates a new field category for an entity
ns-field fieldcategory create
--category_id (String)
Delete
Deletes a field category by an id.
ns-field fieldcategory delete {id}
FieldField
List
Returns the field field list
ns-field fieldfield list {filters} {page} {size} {sorts} {all_workspaces}
Get
Returns a field field by id.
ns-field fieldfield get {id}
Create
Creates a new field field for an entity
ns-field fieldfield create
--field_id (String)
--value (Any)
Update
Updates a field field by an id for an entity
ns-field fieldfield update {id}
--field_id (String)
--value (Any)
Delete
Deletes a field field by an id.
ns-field fieldfield delete {id}
FieldTag
List
Returns the field tag list
ns-field fieldtag list {filters} {page} {size} {sorts} {all_workspaces}
Get
Returns a field tag by id.
ns-field fieldtag get {id}
Create
Creates a new field tag for an entity
ns-field fieldtag create
--name (String)
--value (String)
Update
Updates a field tag by an id for an entity
ns-field fieldtag update {id}
--name (String)
--value (String)
Delete
Deletes a field tag by an id.
ns-field fieldtag delete {id}
Field
List
Returns the field list
ns-field field list {filters} {page} {size} {sorts} {all_workspaces}
Get
Returns a field by an id
ns-field field get {id}
Create
Creates a new field
ns-field field create
--workspace_id (String)
--name (String)
--type (Variable)
--description (String)
--field_category (Array)
--field_field (Array)
--field_tag (Array)
Update
Updates a field by an id
ns-field field update {id}
--workspace_id (String)
--name (String)
--type (Variable)
--description (String)
--field_category (Array)
--field_field (Array)
--field_tag (Array)
Delete
Deletes a field by an id
ns-field field delete {id}
CategoryCategory
List
Returns the category category list
ns-field categorycategory list {filters} {page} {size} {sorts} {all_workspaces}
Get
Returns a category category by id.
ns-field categorycategory get {id}
Create
Creates a new category category for an entity
ns-field categorycategory create
--category_id (String)
Delete
Deletes a category category by an id.
ns-field categorycategory delete {id}
CategoryField
List
Returns the category field list
ns-field categoryfield list {filters} {page} {size} {sorts} {all_workspaces}
Get
Returns a category field by id.
ns-field categoryfield get {id}
Create
Creates a new category field for an entity
ns-field categoryfield create
--field_id (String)
--value (Any)
Update
Updates a category field by an id for an entity
ns-field categoryfield update {id}
--field_id (String)
--value (Any)
Delete
Deletes a category field by an id.
ns-field categoryfield delete {id}
CategoryTag
List
Returns the category tag list
ns-field categorytag list {filters} {page} {size} {sorts} {all_workspaces}
Get
Returns a category tag by id.
ns-field categorytag get {id}
Create
Creates a new category tag for an entity
ns-field categorytag create
--name (String)
--value (String)
Update
Updates a category tag by an id for an entity
ns-field categorytag update {id}
--name (String)
--value (String)
Delete
Deletes a category tag by an id.
ns-field categorytag delete {id}
Category
List
Returns the category list
ns-field category list {filters} {page} {size} {sorts} {all_workspaces}
Get
Returns a category by an id
ns-field category get {id}
Create
Creates a new category
ns-field category create
--workspace_id (String)
--category_scope_id (String)
--name (String)
--description (String)
--category_category (Array)
--category_field (Array)
--category_tag (Array)
Update
Updates a category by an id
ns-field category update {id}
--workspace_id (String)
--category_scope_id (String)
--name (String)
--description (String)
--category_category (Array)
--category_field (Array)
--category_tag (Array)
Delete
Deletes a category by an id
ns-field category delete {id}
CategoryScopeCategory
List
Returns the category scope category list
ns-field categoryscopecategory list {filters} {page} {size} {sorts} {all_workspaces}
Get
Returns a category scope category by id.
ns-field categoryscopecategory get {id}
Create
Creates a new category scope category for an entity
ns-field categoryscopecategory create
--category_id (String)
Delete
Deletes a category scope category by an id.
ns-field categoryscopecategory delete {id}
CategoryScopeField
List
Returns the category scope field list
ns-field categoryscopefield list {filters} {page} {size} {sorts} {all_workspaces}
Get
Returns a category scope field by id.
ns-field categoryscopefield get {id}
Create
Creates a new category scope field for an entity
ns-field categoryscopefield create
--field_id (String)
--value (Any)
Update
Updates a category scope field by an id for an entity
ns-field categoryscopefield update {id}
--field_id (String)
--value (Any)
Delete
Deletes a category scope field by an id.
ns-field categoryscopefield delete {id}
CategoryScopeTag
List
Returns the category scope tag list
ns-field categoryscopetag list {filters} {page} {size} {sorts} {all_workspaces}
Get
Returns a category scope tag by id.
ns-field categoryscopetag get {id}
Create
Creates a new category scope tag for an entity
ns-field categoryscopetag create
--name (String)
--value (String)
Update
Updates a category scope tag by an id for an entity
ns-field categoryscopetag update {id}
--name (String)
--value (String)
Delete
Deletes a category scope tag by an id.
ns-field categoryscopetag delete {id}
CategoryScope
List
Returns the category scope list
ns-field categoryscope list {filters} {page} {size} {sorts} {all_workspaces}
Get
Returns a category scope by an id
ns-field categoryscope get {id}
Create
Creates a new category scope
ns-field categoryscope create
--workspace_id (String)
--name (String)
--description (String)
--category_scope_category (Array)
--category_scope_field (Array)
--category_scope_tag (Array)
Update
Updates a category scope by an id
ns-field categoryscope update {id}
--workspace_id (String)
--name (String)
--description (String)
--category_scope_category (Array)
--category_scope_field (Array)
--category_scope_tag (Array)
Delete
Deletes a category scope by an id
ns-field categoryscope delete {id}
SlotCategory
List
Returns the slot category list
ns-field slotcategory list {filters} {page} {size} {sorts} {all_workspaces}
Get
Returns a slot category by id.
ns-field slotcategory get {id}
Create
Creates a new slot category for an entity
ns-field slotcategory create
--category_id (String)
Delete
Deletes a slot category by an id.
ns-field slotcategory delete {id}
SlotField
List
Returns the slot field list
ns-field slotfield list {filters} {page} {size} {sorts} {all_workspaces}
Get
Returns a slot field by id.
ns-field slotfield get {id}
Create
Creates a new slot field for an entity
ns-field slotfield create
--field_id (String)
--value (Any)
Update
Updates a slot field by an id for an entity
ns-field slotfield update {id}
--field_id (String)
--value (Any)
Delete
Deletes a slot field by an id.
ns-field slotfield delete {id}
SlotTag
List
Returns the slot tag list
ns-field slottag list {filters} {page} {size} {sorts} {all_workspaces}
Get
Returns a slot tag by id.
ns-field slottag get {id}
Create
Creates a new slot tag for an entity
ns-field slottag create
--name (String)
--value (String)
Update
Updates a slot tag by an id for an entity
ns-field slottag update {id}
--name (String)
--value (String)
Delete
Deletes a slot tag by an id.
ns-field slottag delete {id}
Slot
List
Returns the slot list
ns-field slot list {filters} {page} {size} {sorts} {all_workspaces}
Get
Returns a slot by an id
ns-field slot get {id}
Create
Creates a new slot
ns-field slot create
--workspace_id (String)
--product_id (String)
--entity (String)
--tab (String)
--name (String)
--entity_type (Enum)
--entity_id (String)
--position_side (Enum)
--position_target (String)
--size (Enum)
--required (Boolean)
--multiple (Boolean)
--description (String)
--slot_category (Array)
--slot_field (Array)
--slot_tag (Array)
Update
Updates a slot by an id
ns-field slot update {id}
--workspace_id (String)
--product_id (String)
--entity (String)
--tab (String)
--name (String)
--entity_type (Enum)
--entity_id (String)
--position_side (Enum)
--position_target (String)
--size (Enum)
--required (Boolean)
--multiple (Boolean)
--description (String)
--slot_category (Array)
--slot_field (Array)
--slot_tag (Array)
Delete
Deletes a slot by an id
ns-field slot delete {id}
Entity
Resolve
Returns all slots, category scopes, categories and fields for a product and entity
ns-field entity resolve {product_id}
Schemas
FieldCategory
{ "name": "FieldCategory", "type": "Object", "required": true, "fields": { "id": { "type": "Integer", "required": true }, "user_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "entity_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "category_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "created_at": { "type": "DateTime", "required": true }, "updated_at": { "type": "DateTime", "required": true } }}
EntityCategoryInput
{ "name": "EntityCategoryInput", "type": "Object", "required": true, "fields": { "category_id": { "type": "String", "required": true, "min": 20, "max": 20 } }}
FieldField
{ "name": "FieldField", "type": "Object", "required": true, "fields": { "id": { "type": "Integer", "required": true }, "user_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "entity_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "field_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "value": { "type": "String", "required": false }, "created_at": { "type": "DateTime", "required": true }, "updated_at": { "type": "DateTime", "required": true } }}
EntityFieldInput
{ "name": "EntityFieldInput", "type": "Object", "required": true, "fields": { "field_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "value": { "type": "Any", "required": false } }}
FieldTag
{ "name": "FieldTag", "type": "Object", "required": true, "fields": { "id": { "type": "Integer", "required": true }, "user_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "entity_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "name": { "type": "String", "required": true, "max": 255 }, "value": { "type": "String", "required": false }, "created_at": { "type": "DateTime", "required": true }, "updated_at": { "type": "DateTime", "required": true } }}
EntityTagInput
{ "name": "EntityTagInput", "type": "Object", "required": true, "fields": { "name": { "type": "String", "required": true, "max": 255 }, "value": { "type": "String", "required": false } }}
Field
{ "name": "Field", "type": "Object", "required": true, "fields": { "id": { "type": "String", "required": true, "min": 20, "max": 20 }, "user_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "workspace_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "name": { "type": "String", "required": true, "max": 255 }, "type": { "type": "Variable", "required": true }, "description": { "type": "String", "required": false }, "created_at": { "type": "DateTime", "required": true }, "updated_at": { "type": "DateTime", "required": true } }}
FieldFull
{ "name": "FieldFull", "type": "Object", "required": true, "fields": { "id": { "type": "String", "required": true, "min": 20, "max": 20 }, "user_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "workspace_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "name": { "type": "String", "required": true, "max": 255 }, "type": { "type": "Variable", "required": true }, "description": { "type": "String", "required": false }, "created_at": { "type": "DateTime", "required": true }, "updated_at": { "type": "DateTime", "required": true }, "field_category": { "type": "Array", "required": true, "items": [ { "name": "EntityCategoryInput", "type": "Object", "required": false, "fields": { "category_id": { "type": "String", "required": true, "min": 20, "max": 20 } } } ] }, "field_field": { "type": "Array", "required": true, "items": [ { "name": "EntityFieldInput", "type": "Object", "required": false, "fields": { "field_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "value": { "type": "Any", "required": false } } } ] }, "field_tag": { "type": "Array", "required": true, "items": [ { "name": "EntityTagInput", "type": "Object", "required": false, "fields": { "name": { "type": "String", "required": true, "max": 255 }, "value": { "type": "String", "required": false } } } ] } }}
FieldInput
{ "name": "FieldInput", "type": "Object", "required": true, "fields": { "workspace_id": { "type": "String", "required": false, "min": 20, "max": 20 }, "name": { "type": "String", "required": true, "max": 255 }, "type": { "type": "Variable", "required": true }, "description": { "type": "String", "required": false }, "field_category": { "type": "Array", "required": true, "items": [ { "name": "EntityCategoryInput", "type": "Object", "required": false, "fields": { "category_id": { "type": "String", "required": true, "min": 20, "max": 20 } } } ] }, "field_field": { "type": "Array", "required": true, "items": [ { "name": "EntityFieldInput", "type": "Object", "required": false, "fields": { "field_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "value": { "type": "Any", "required": false } } } ] }, "field_tag": { "type": "Array", "required": true, "items": [ { "name": "EntityTagInput", "type": "Object", "required": false, "fields": { "name": { "type": "String", "required": true, "max": 255 }, "value": { "type": "String", "required": false } } } ] } }}
CategoryCategory
{ "name": "CategoryCategory", "type": "Object", "required": true, "fields": { "id": { "type": "Integer", "required": true }, "user_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "entity_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "category_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "created_at": { "type": "DateTime", "required": true }, "updated_at": { "type": "DateTime", "required": true } }}
CategoryField
{ "name": "CategoryField", "type": "Object", "required": true, "fields": { "id": { "type": "Integer", "required": true }, "user_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "entity_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "field_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "value": { "type": "String", "required": false }, "created_at": { "type": "DateTime", "required": true }, "updated_at": { "type": "DateTime", "required": true } }}
CategoryTag
{ "name": "CategoryTag", "type": "Object", "required": true, "fields": { "id": { "type": "Integer", "required": true }, "user_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "entity_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "name": { "type": "String", "required": true, "max": 255 }, "value": { "type": "String", "required": false }, "created_at": { "type": "DateTime", "required": true }, "updated_at": { "type": "DateTime", "required": true } }}
Category
{ "name": "Category", "type": "Object", "required": true, "fields": { "id": { "type": "String", "required": true, "min": 20, "max": 20 }, "user_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "workspace_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "category_scope_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "name": { "type": "String", "required": true, "max": 255 }, "description": { "type": "String", "required": false }, "created_at": { "type": "DateTime", "required": true }, "updated_at": { "type": "DateTime", "required": true } }}
CategoryFull
{ "name": "CategoryFull", "type": "Object", "required": true, "fields": { "id": { "type": "String", "required": true, "min": 20, "max": 20 }, "user_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "workspace_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "category_scope_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "name": { "type": "String", "required": true, "max": 255 }, "description": { "type": "String", "required": false }, "created_at": { "type": "DateTime", "required": true }, "updated_at": { "type": "DateTime", "required": true }, "category_category": { "type": "Array", "required": true, "items": [ { "name": "EntityCategoryInput", "type": "Object", "required": false, "fields": { "category_id": { "type": "String", "required": true, "min": 20, "max": 20 } } } ] }, "category_field": { "type": "Array", "required": true, "items": [ { "name": "EntityFieldInput", "type": "Object", "required": false, "fields": { "field_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "value": { "type": "Any", "required": false } } } ] }, "category_tag": { "type": "Array", "required": true, "items": [ { "name": "EntityTagInput", "type": "Object", "required": false, "fields": { "name": { "type": "String", "required": true, "max": 255 }, "value": { "type": "String", "required": false } } } ] } }}
CategoryInput
{ "name": "CategoryInput", "type": "Object", "required": true, "fields": { "workspace_id": { "type": "String", "required": false, "min": 20, "max": 20 }, "category_scope_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "name": { "type": "String", "required": true, "max": 255 }, "description": { "type": "String", "required": false }, "category_category": { "type": "Array", "required": true, "items": [ { "name": "EntityCategoryInput", "type": "Object", "required": false, "fields": { "category_id": { "type": "String", "required": true, "min": 20, "max": 20 } } } ] }, "category_field": { "type": "Array", "required": true, "items": [ { "name": "EntityFieldInput", "type": "Object", "required": false, "fields": { "field_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "value": { "type": "Any", "required": false } } } ] }, "category_tag": { "type": "Array", "required": true, "items": [ { "name": "EntityTagInput", "type": "Object", "required": false, "fields": { "name": { "type": "String", "required": true, "max": 255 }, "value": { "type": "String", "required": false } } } ] } }}
CategoryScopeCategory
{ "name": "CategoryScopeCategory", "type": "Object", "required": true, "fields": { "id": { "type": "Integer", "required": true }, "user_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "entity_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "category_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "created_at": { "type": "DateTime", "required": true }, "updated_at": { "type": "DateTime", "required": true } }}
CategoryScopeField
{ "name": "CategoryScopeField", "type": "Object", "required": true, "fields": { "id": { "type": "Integer", "required": true }, "user_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "entity_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "field_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "value": { "type": "String", "required": false }, "created_at": { "type": "DateTime", "required": true }, "updated_at": { "type": "DateTime", "required": true } }}
CategoryScopeTag
{ "name": "CategoryScopeTag", "type": "Object", "required": true, "fields": { "id": { "type": "Integer", "required": true }, "user_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "entity_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "name": { "type": "String", "required": true, "max": 255 }, "value": { "type": "String", "required": false }, "created_at": { "type": "DateTime", "required": true }, "updated_at": { "type": "DateTime", "required": true } }}
CategoryScope
{ "name": "CategoryScope", "type": "Object", "required": true, "fields": { "id": { "type": "String", "required": true, "min": 20, "max": 20 }, "user_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "workspace_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "name": { "type": "String", "required": true, "max": 255 }, "description": { "type": "String", "required": false }, "created_at": { "type": "DateTime", "required": true }, "updated_at": { "type": "DateTime", "required": true } }}
CategoryScopeFull
{ "name": "CategoryScopeFull", "type": "Object", "required": true, "fields": { "id": { "type": "String", "required": true, "min": 20, "max": 20 }, "user_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "workspace_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "name": { "type": "String", "required": true, "max": 255 }, "description": { "type": "String", "required": false }, "created_at": { "type": "DateTime", "required": true }, "updated_at": { "type": "DateTime", "required": true }, "category_scope_category": { "type": "Array", "required": true, "items": [ { "name": "EntityCategoryInput", "type": "Object", "required": false, "fields": { "category_id": { "type": "String", "required": true, "min": 20, "max": 20 } } } ] }, "category_scope_field": { "type": "Array", "required": true, "items": [ { "name": "EntityFieldInput", "type": "Object", "required": false, "fields": { "field_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "value": { "type": "Any", "required": false } } } ] }, "category_scope_tag": { "type": "Array", "required": true, "items": [ { "name": "EntityTagInput", "type": "Object", "required": false, "fields": { "name": { "type": "String", "required": true, "max": 255 }, "value": { "type": "String", "required": false } } } ] } }}
CategoryScopeInput
{ "name": "CategoryScopeInput", "type": "Object", "required": true, "fields": { "workspace_id": { "type": "String", "required": false, "min": 20, "max": 20 }, "name": { "type": "String", "required": true, "max": 255 }, "description": { "type": "String", "required": false }, "category_scope_category": { "type": "Array", "required": true, "items": [ { "name": "EntityCategoryInput", "type": "Object", "required": false, "fields": { "category_id": { "type": "String", "required": true, "min": 20, "max": 20 } } } ] }, "category_scope_field": { "type": "Array", "required": true, "items": [ { "name": "EntityFieldInput", "type": "Object", "required": false, "fields": { "field_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "value": { "type": "Any", "required": false } } } ] }, "category_scope_tag": { "type": "Array", "required": true, "items": [ { "name": "EntityTagInput", "type": "Object", "required": false, "fields": { "name": { "type": "String", "required": true, "max": 255 }, "value": { "type": "String", "required": false } } } ] } }}
SlotCategory
{ "name": "SlotCategory", "type": "Object", "required": true, "fields": { "id": { "type": "Integer", "required": true }, "user_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "entity_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "category_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "created_at": { "type": "DateTime", "required": true }, "updated_at": { "type": "DateTime", "required": true } }}
SlotField
{ "name": "SlotField", "type": "Object", "required": true, "fields": { "id": { "type": "Integer", "required": true }, "user_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "entity_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "field_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "value": { "type": "String", "required": false }, "created_at": { "type": "DateTime", "required": true }, "updated_at": { "type": "DateTime", "required": true } }}
SlotTag
{ "name": "SlotTag", "type": "Object", "required": true, "fields": { "id": { "type": "Integer", "required": true }, "user_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "entity_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "name": { "type": "String", "required": true, "max": 255 }, "value": { "type": "String", "required": false }, "created_at": { "type": "DateTime", "required": true }, "updated_at": { "type": "DateTime", "required": true } }}
Slot
{ "name": "Slot", "type": "Object", "required": true, "fields": { "id": { "type": "String", "required": true, "min": 20, "max": 20 }, "user_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "workspace_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "product_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "entity": { "type": "String", "required": true, "max": 255 }, "tab": { "type": "String", "required": true, "max": 255 }, "name": { "type": "String", "required": true, "max": 255 }, "entity_type": { "name": "SlotEntityType", "type": "Enum", "required": true, "valids": [ "Field", "CategoryScope" ] }, "entity_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "position_side": { "name": "SlotPositionSide", "type": "Enum", "required": true, "valids": [ "Before", "After" ] }, "position_target": { "type": "String", "required": true, "max": 255 }, "size": { "name": "SlotSize", "type": "Enum", "required": true, "valids": [ "Small", "Medium", "Big" ] }, "required": { "type": "Boolean", "required": true }, "multiple": { "type": "Boolean", "required": true }, "description": { "type": "String", "required": false }, "created_at": { "type": "DateTime", "required": true }, "updated_at": { "type": "DateTime", "required": true } }}
SlotFull
{ "name": "SlotFull", "type": "Object", "required": true, "fields": { "id": { "type": "String", "required": true, "min": 20, "max": 20 }, "user_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "workspace_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "product_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "entity": { "type": "String", "required": true, "max": 255 }, "tab": { "type": "String", "required": true, "max": 255 }, "name": { "type": "String", "required": true, "max": 255 }, "entity_type": { "name": "SlotEntityType", "type": "Enum", "required": true, "valids": [ "Field", "CategoryScope" ] }, "entity_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "position_side": { "name": "SlotPositionSide", "type": "Enum", "required": true, "valids": [ "Before", "After" ] }, "position_target": { "type": "String", "required": true, "max": 255 }, "size": { "name": "SlotSize", "type": "Enum", "required": true, "valids": [ "Small", "Medium", "Big" ] }, "required": { "type": "Boolean", "required": true }, "multiple": { "type": "Boolean", "required": true }, "description": { "type": "String", "required": false }, "created_at": { "type": "DateTime", "required": true }, "updated_at": { "type": "DateTime", "required": true }, "slot_category": { "type": "Array", "required": true, "items": [ { "name": "EntityCategoryInput", "type": "Object", "required": false, "fields": { "category_id": { "type": "String", "required": true, "min": 20, "max": 20 } } } ] }, "slot_field": { "type": "Array", "required": true, "items": [ { "name": "EntityFieldInput", "type": "Object", "required": false, "fields": { "field_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "value": { "type": "Any", "required": false } } } ] }, "slot_tag": { "type": "Array", "required": true, "items": [ { "name": "EntityTagInput", "type": "Object", "required": false, "fields": { "name": { "type": "String", "required": true, "max": 255 }, "value": { "type": "String", "required": false } } } ] } }}
SlotInput
{ "name": "SlotInput", "type": "Object", "required": true, "fields": { "workspace_id": { "type": "String", "required": false, "min": 20, "max": 20 }, "product_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "entity": { "type": "String", "required": true, "max": 255 }, "tab": { "type": "String", "required": true, "max": 255 }, "name": { "type": "String", "required": true, "max": 255 }, "entity_type": { "name": "SlotEntityType", "type": "Enum", "required": true, "valids": [ "Field", "CategoryScope" ] }, "entity_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "position_side": { "name": "SlotPositionSide", "type": "Enum", "required": true, "valids": [ "Before", "After" ] }, "position_target": { "type": "String", "required": true, "max": 255 }, "size": { "name": "SlotSize", "type": "Enum", "required": true, "valids": [ "Small", "Medium", "Big" ] }, "required": { "type": "Boolean", "required": true }, "multiple": { "type": "Boolean", "required": true }, "description": { "type": "String", "required": false }, "slot_category": { "type": "Array", "required": true, "items": [ { "name": "EntityCategoryInput", "type": "Object", "required": false, "fields": { "category_id": { "type": "String", "required": true, "min": 20, "max": 20 } } } ] }, "slot_field": { "type": "Array", "required": true, "items": [ { "name": "EntityFieldInput", "type": "Object", "required": false, "fields": { "field_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "value": { "type": "Any", "required": false } } } ] }, "slot_tag": { "type": "Array", "required": true, "items": [ { "name": "EntityTagInput", "type": "Object", "required": false, "fields": { "name": { "type": "String", "required": true, "max": 255 }, "value": { "type": "String", "required": false } } } ] } }}
EntityResolveResponse
{ "name": "EntityResolveResponse", "type": "Object", "required": true, "fields": { "slots": { "type": "Array", "required": true, "items": [ { "name": "Slot", "type": "Object", "required": true, "fields": { "id": { "type": "String", "required": true, "min": 20, "max": 20 }, "user_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "workspace_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "product_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "entity": { "type": "String", "required": true, "max": 255 }, "tab": { "type": "String", "required": true, "max": 255 }, "name": { "type": "String", "required": true, "max": 255 }, "entity_type": { "name": "SlotEntityType", "type": "Enum", "required": true, "valids": [ "Field", "CategoryScope" ] }, "entity_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "position_side": { "name": "SlotPositionSide", "type": "Enum", "required": true, "valids": [ "Before", "After" ] }, "position_target": { "type": "String", "required": true, "max": 255 }, "size": { "name": "SlotSize", "type": "Enum", "required": true, "valids": [ "Small", "Medium", "Big" ] }, "required": { "type": "Boolean", "required": true }, "multiple": { "type": "Boolean", "required": true }, "description": { "type": "String", "required": false }, "created_at": { "type": "DateTime", "required": true }, "updated_at": { "type": "DateTime", "required": true } } } ] }, "category_scopes": { "type": "Array", "required": true, "items": [ { "name": "CategoryScope", "type": "Object", "required": true, "fields": { "id": { "type": "String", "required": true, "min": 20, "max": 20 }, "user_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "workspace_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "name": { "type": "String", "required": true, "max": 255 }, "description": { "type": "String", "required": false }, "created_at": { "type": "DateTime", "required": true }, "updated_at": { "type": "DateTime", "required": true } } } ] }, "categories": { "type": "Array", "required": true, "items": [ { "name": "Category", "type": "Object", "required": true, "fields": { "id": { "type": "String", "required": true, "min": 20, "max": 20 }, "user_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "workspace_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "category_scope_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "name": { "type": "String", "required": true, "max": 255 }, "description": { "type": "String", "required": false }, "created_at": { "type": "DateTime", "required": true }, "updated_at": { "type": "DateTime", "required": true } } } ] }, "fields": { "type": "Array", "required": true, "items": [ { "name": "Field", "type": "Object", "required": true, "fields": { "id": { "type": "String", "required": true, "min": 20, "max": 20 }, "user_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "workspace_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "name": { "type": "String", "required": true, "max": 255 }, "type": { "type": "Variable", "required": true }, "description": { "type": "String", "required": false }, "created_at": { "type": "DateTime", "required": true }, "updated_at": { "type": "DateTime", "required": true } } } ] } }}
Enums
SlotEntityType
Field
CategoryScope
SlotPositionSide
Before
After
SlotSize
Small
Medium
Big
Namira Software Corporation
©Copyright 2010 to 2026 Namira Software Corporation. All rights reserved.