Namirasoft Field API V1

Namira Software Corporation Field API Version 1 (1.4.13)

Install


To use this cli, we need to first Install Nodejs, then run the following command.

npm i -g namirasoft-field-api-v1

Copied!

Commands


Healthz

Get

Returns the application health status

ns-field healthz get

Copied!

Value

List

Returns the value list of a given table and column

ns-field value list {table} {column} {search} {field_id} {limit}

Copied!

FieldCategory

List

Returns the field category list

ns-field fieldcategory list {filters} {page} {size} {sorts} {user_id}

Copied!

Get

Returns a field category by id.

ns-field fieldcategory get {id}

Copied!

Create

Creates a new field category for an entity

ns-field fieldcategory create {entity_id}

Copied!

--category_id (String)

Delete

Deletes a field category by an id.

ns-field fieldcategory delete {entity_id} {id}

Copied!

FieldField

List

Returns the field field list

ns-field fieldfield list {filters} {page} {size} {sorts} {user_id}

Copied!

Get

Returns a field field by id.

ns-field fieldfield get {id}

Copied!

Create

Creates a new field field for an entity

ns-field fieldfield create {entity_id}

Copied!

--field_id (String)

--value (String)

Update

Updates a field field by an id for an entity

ns-field fieldfield update {entity_id} {id}

Copied!

--field_id (String)

--value (String)

Delete

Deletes a field field by an id.

ns-field fieldfield delete {entity_id} {id}

Copied!

FieldTag

List

Returns the field tag list

ns-field fieldtag list {filters} {page} {size} {sorts} {user_id}

Copied!

Get

Returns a field tag by id.

ns-field fieldtag get {id}

Copied!

Create

Creates a new field tag for an entity

ns-field fieldtag create {entity_id}

Copied!

--name (String)

--value (String)

Update

Updates a field tag by an id for an entity

ns-field fieldtag update {entity_id} {id}

Copied!

--name (String)

--value (String)

Delete

Deletes a field tag by an id.

ns-field fieldtag delete {entity_id} {id}

Copied!

Field

List

Returns the field list

ns-field field list {filters} {page} {size} {sorts} {user_id}

Copied!

Get

Returns a field by an id

ns-field field get {id}

Copied!

Create

Creates a new field

ns-field field create

Copied!

--product_id (String)

--entity (String)

--group (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}

Copied!

--product_id (String)

--entity (String)

--group (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}

Copied!

CategoryCategory

List

Returns the category category list

ns-field categorycategory list {filters} {page} {size} {sorts} {user_id}

Copied!

Get

Returns a category category by id.

ns-field categorycategory get {id}

Copied!

Create

Creates a new category category for an entity

ns-field categorycategory create {entity_id}

Copied!

--category_id (String)

Delete

Deletes a category category by an id.

ns-field categorycategory delete {entity_id} {id}

Copied!

CategoryField

List

Returns the category field list

ns-field categoryfield list {filters} {page} {size} {sorts} {user_id}

Copied!

Get

Returns a category field by id.

ns-field categoryfield get {id}

Copied!

Create

Creates a new category field for an entity

ns-field categoryfield create {entity_id}

Copied!

--field_id (String)

--value (String)

Update

Updates a category field by an id for an entity

ns-field categoryfield update {entity_id} {id}

Copied!

--field_id (String)

--value (String)

Delete

Deletes a category field by an id.

ns-field categoryfield delete {entity_id} {id}

Copied!

CategoryTag

List

Returns the category tag list

ns-field categorytag list {filters} {page} {size} {sorts} {user_id}

Copied!

Get

Returns a category tag by id.

ns-field categorytag get {id}

Copied!

Create

Creates a new category tag for an entity

ns-field categorytag create {entity_id}

Copied!

--name (String)

--value (String)

Update

Updates a category tag by an id for an entity

ns-field categorytag update {entity_id} {id}

Copied!

--name (String)

--value (String)

Delete

Deletes a category tag by an id.

ns-field categorytag delete {entity_id} {id}

Copied!

Category

List

Returns the category list

ns-field category list {filters} {page} {size} {sorts} {user_id}

Copied!

Get

Returns a category by an id

ns-field category get {id}

Copied!

Create

Creates a new category

ns-field category create

Copied!

--product_id (String)

--entity (String)

--group (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}

Copied!

--product_id (String)

--entity (String)

--group (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}

Copied!

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": "String",
      "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
    },
    "product_id": {
      "type": "String",
      "required": true,
      "min": 20,
      "max": 20
    },
    "entity": {
      "type": "String",
      "required": true,
      "max": 255
    },
    "group": {
      "type": "String",
      "required": true,
      "max": 255
    },
    "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
    },
    "product_id": {
      "type": "String",
      "required": true,
      "min": 20,
      "max": 20
    },
    "entity": {
      "type": "String",
      "required": true,
      "max": 255
    },
    "group": {
      "type": "String",
      "required": true,
      "max": 255
    },
    "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": "String",
              "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": {
    "product_id": {
      "type": "String",
      "required": true,
      "min": 20,
      "max": 20
    },
    "entity": {
      "type": "String",
      "required": true,
      "max": 255
    },
    "group": {
      "type": "String",
      "required": true,
      "max": 255
    },
    "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": "String",
              "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
    },
    "product_id": {
      "type": "String",
      "required": true,
      "min": 20,
      "max": 20
    },
    "entity": {
      "type": "String",
      "required": true,
      "max": 255
    },
    "group": {
      "type": "String",
      "required": true,
      "max": 255
    },
    "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
    },
    "product_id": {
      "type": "String",
      "required": true,
      "min": 20,
      "max": 20
    },
    "entity": {
      "type": "String",
      "required": true,
      "max": 255
    },
    "group": {
      "type": "String",
      "required": true,
      "max": 255
    },
    "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": "String",
              "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": {
    "product_id": {
      "type": "String",
      "required": true,
      "min": 20,
      "max": 20
    },
    "entity": {
      "type": "String",
      "required": true,
      "max": 255
    },
    "group": {
      "type": "String",
      "required": true,
      "max": 255
    },
    "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": "String",
              "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
            }
          }
        }
      ]
    }
  }
}

Enums

Namira Software Corporation

©Copyright 2010 to 2025 Namira Software Corporation. All rights reserved.