Namirasoft Data API V1

Namira Software Corporation Data API Version 1 (1.3.34)

Install


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

npm i -g namirasoft-data-api-v1

Copied!

Commands


Healthz

Get

Returns the application health status

ns-data healthz get

Copied!

Value

List

Returns the value list of a given table and column

ns-data value list {table} {column}

Copied!

MetadataCategory

List

Returns the metadata category list

ns-data metadatacategory list {filters} {page} {size}

Copied!

Get

Returns a metadata category by id.

ns-data metadatacategory get {id}

Copied!

Create

Creates a new metadata category

ns-data metadatacategory create

Copied!

--entity_id (String)

--category_id (String)

Delete

Deletes a metadata category by an id.

ns-data metadatacategory delete {id}

Copied!

MetadataField

List

Returns the metadata field list

ns-data metadatafield list {filters} {page} {size}

Copied!

Get

Returns a metadata field by id.

ns-data metadatafield get {id}

Copied!

Create

Creates a new metadata field

ns-data metadatafield create

Copied!

--entity_id (String)

--field_id (String)

--value (String)

--description (String)

Update

Updates a metadata field by an id

ns-data metadatafield update {id}

Copied!

--entity_id (String)

--field_id (String)

--value (String)

--description (String)

Delete

Deletes a metadata field by an id.

ns-data metadatafield delete {id}

Copied!

MetadataTag

List

Returns the metadata tag list

ns-data metadatatag list {filters} {page} {size}

Copied!

Get

Returns a metadata tag by id.

ns-data metadatatag get {id}

Copied!

Create

Creates a new metadata tag

ns-data metadatatag create

Copied!

--entity_id (String)

--name (String)

--value (String)

--description (String)

Update

Updates a metadata tag by an id

ns-data metadatatag update {id}

Copied!

--entity_id (String)

--name (String)

--value (String)

--description (String)

Delete

Deletes a metadata tag by an id.

ns-data metadatatag delete {id}

Copied!

Data

Create

Creates a new data

ns-data data create {metadata_id}

Copied!

--rows (Array)

Delete

Deletes a data by an id

ns-data data delete {metadata_id} {id}

Copied!

List

Returns the data list

ns-data data list {metadata_id} {filters} {page} {size}

Copied!

Get

Returns a data by an id

ns-data data get {metadata_id} {id}

Copied!

Update

Updates a data by an id

ns-data data update {metadata_id} {id}

Copied!

--row (Array)

Metadata

Create

Creates a new metadata

ns-data metadata create

Copied!

--name (String)

--description (String)

--metadata_columns (Array)

Delete

Deletes a metadata by an id

ns-data metadata delete {id}

Copied!

List

Returns the metadata list

ns-data metadata list {filters} {page} {size}

Copied!

Get

Returns a metadata by an id

ns-data metadata get {id}

Copied!

Set

Set a metadata read and write permissions by an id

ns-data metadata set {id}

Copied!

--readable (Boolean)

--writable (Boolean)

Update

Updates a metadata by an id

ns-data metadata update {id}

Copied!

--name (String)

--description (String)

--metadata_columns (Array)

ListCategory

List

Returns the list category list

ns-data listcategory list {filters} {page} {size}

Copied!

Get

Returns a list category by id.

ns-data listcategory get {id}

Copied!

Create

Creates a new list category

ns-data listcategory create

Copied!

--entity_id (String)

--category_id (String)

Delete

Deletes a list category by an id.

ns-data listcategory delete {id}

Copied!

ListField

List

Returns the list field list

ns-data listfield list {filters} {page} {size}

Copied!

Get

Returns a list field by id.

ns-data listfield get {id}

Copied!

Create

Creates a new list field

ns-data listfield create

Copied!

--entity_id (String)

--field_id (String)

--value (String)

--description (String)

Update

Updates a list field by an id

ns-data listfield update {id}

Copied!

--entity_id (String)

--field_id (String)

--value (String)

--description (String)

Delete

Deletes a list field by an id.

ns-data listfield delete {id}

Copied!

ListTag

List

Returns the list tag list

ns-data listtag list {filters} {page} {size}

Copied!

Get

Returns a list tag by id.

ns-data listtag get {id}

Copied!

Create

Creates a new list tag

ns-data listtag create

Copied!

--entity_id (String)

--name (String)

--value (String)

--description (String)

Update

Updates a list tag by an id

ns-data listtag update {id}

Copied!

--entity_id (String)

--name (String)

--value (String)

--description (String)

Delete

Deletes a list tag by an id.

ns-data listtag delete {id}

Copied!

List

List

Returns the list list

ns-data list list {filters} {page} {size}

Copied!

Create

Creates a new list

ns-data list create

Copied!

--metadata_id (String)

--name (String)

--description (String)

Delete

Deletes a list by an id

ns-data list delete {id}

Copied!

Get

Returns a list by an id

ns-data list get {id}

Copied!

Update

Updates a list by an id

ns-data list update {id}

Copied!

--metadata_id (String)

--name (String)

--description (String)

Schemas


MetadataCategory

{
  "name": "MetadataCategory",
  "type": "Object",
  "required": true,
  "fields": {
    "id": {
      "type": "Integer",
      "required": true
    },
    "user_id": {
      "type": "String",
      "required": true,
      "min": 20,
      "max": 20,
      "allowEmpty": false
    },
    "entity_id": {
      "type": "String",
      "required": true,
      "min": 20,
      "max": 20,
      "allowEmpty": false
    },
    "category_id": {
      "type": "String",
      "required": true,
      "min": 20,
      "max": 20,
      "allowEmpty": false
    },
    "createdAt": {
      "type": "DateTime",
      "required": true
    },
    "updatedAt": {
      "type": "DateTime",
      "required": true
    }
  }
}

EntityCategoryInput

{
  "name": "EntityCategoryInput",
  "type": "Object",
  "required": true,
  "fields": {
    "entity_id": {
      "type": "String",
      "required": true,
      "min": 20,
      "max": 20,
      "allowEmpty": false
    },
    "category_id": {
      "type": "String",
      "required": true,
      "min": 20,
      "max": 20,
      "allowEmpty": false
    }
  }
}

MetadataField

{
  "name": "MetadataField",
  "type": "Object",
  "required": true,
  "fields": {
    "id": {
      "type": "Integer",
      "required": true
    },
    "user_id": {
      "type": "String",
      "required": true,
      "min": 20,
      "max": 20,
      "allowEmpty": false
    },
    "entity_id": {
      "type": "String",
      "required": true,
      "min": 20,
      "max": 20,
      "allowEmpty": false
    },
    "field_id": {
      "type": "String",
      "required": true,
      "min": 20,
      "max": 20,
      "allowEmpty": false
    },
    "value": {
      "type": "String",
      "required": true,
      "allowEmpty": false
    },
    "description": {
      "type": "String",
      "required": false,
      "allowEmpty": true
    },
    "createdAt": {
      "type": "DateTime",
      "required": true
    },
    "updatedAt": {
      "type": "DateTime",
      "required": true
    }
  }
}

EntityFieldInput

{
  "name": "EntityFieldInput",
  "type": "Object",
  "required": true,
  "fields": {
    "entity_id": {
      "type": "String",
      "required": true,
      "min": 20,
      "max": 20,
      "allowEmpty": false
    },
    "field_id": {
      "type": "String",
      "required": true,
      "min": 20,
      "max": 20,
      "allowEmpty": false
    },
    "value": {
      "type": "String",
      "required": true,
      "allowEmpty": false
    },
    "description": {
      "type": "String",
      "required": false,
      "allowEmpty": true
    }
  }
}

MetadataTag

{
  "name": "MetadataTag",
  "type": "Object",
  "required": true,
  "fields": {
    "id": {
      "type": "Integer",
      "required": true
    },
    "user_id": {
      "type": "String",
      "required": true,
      "min": 20,
      "max": 20,
      "allowEmpty": false
    },
    "entity_id": {
      "type": "String",
      "required": true,
      "min": 20,
      "max": 20,
      "allowEmpty": false
    },
    "name": {
      "type": "String",
      "required": true,
      "allowEmpty": false
    },
    "value": {
      "type": "String",
      "required": true,
      "allowEmpty": false
    },
    "description": {
      "type": "String",
      "required": false,
      "allowEmpty": true
    },
    "createdAt": {
      "type": "DateTime",
      "required": true
    },
    "updatedAt": {
      "type": "DateTime",
      "required": true
    }
  }
}

EntityTagInput

{
  "name": "EntityTagInput",
  "type": "Object",
  "required": true,
  "fields": {
    "entity_id": {
      "type": "String",
      "required": true,
      "min": 20,
      "max": 20,
      "allowEmpty": false
    },
    "name": {
      "type": "String",
      "required": true,
      "allowEmpty": false
    },
    "value": {
      "type": "String",
      "required": true,
      "allowEmpty": false
    },
    "description": {
      "type": "String",
      "required": false,
      "allowEmpty": true
    }
  }
}

Data

{
  "name": "Data",
  "type": "Object",
  "required": true,
  "fields": {
    "id": {
      "type": "String",
      "required": true,
      "allowEmpty": false
    },
    "user_id": {
      "type": "String",
      "required": true,
      "allowEmpty": false
    },
    "metadata_id": {
      "type": "String",
      "required": true,
      "allowEmpty": false
    },
    "product_id": {
      "type": "String",
      "required": false,
      "allowEmpty": true
    },
    "workspace_id": {
      "type": "String",
      "required": false,
      "allowEmpty": true
    },
    "level": {
      "type": "String",
      "required": true,
      "allowEmpty": false
    },
    "message": {
      "type": "String",
      "required": true,
      "allowEmpty": false
    },
    "created_at": {
      "type": "DateTime",
      "required": true
    }
  }
}

MetadataInput

{
  "name": "MetadataInput",
  "type": "Object",
  "required": true,
  "fields": {
    "name": {
      "type": "String",
      "required": false,
      "allowEmpty": true
    },
    "description": {
      "type": "String",
      "required": false,
      "allowEmpty": true
    },
    "metadata_columns": {
      "type": "Array",
      "required": true,
      "items": [
        {
          "name": "MetadataColumnInput",
          "type": "Object",
          "required": true,
          "fields": {
            "name": {
              "type": "String",
              "required": true,
              "allowEmpty": false
            },
            "type": {
              "name": "MetadataColumnType",
              "type": "Enum",
              "required": true,
              "valids": [
                "Boolean",
                "Number",
                "String",
                "Date",
                "Object"
              ]
            },
            "required": {
              "type": "Boolean",
              "required": true
            },
            "default": {
              "type": "String",
              "required": false,
              "allowEmpty": true
            }
          }
        }
      ]
    }
  }
}

MetadataColumnInput

{
  "name": "MetadataColumnInput",
  "type": "Object",
  "required": true,
  "fields": {
    "name": {
      "type": "String",
      "required": true,
      "allowEmpty": false
    },
    "type": {
      "name": "MetadataColumnType",
      "type": "Enum",
      "required": true,
      "valids": [
        "Boolean",
        "Number",
        "String",
        "Date",
        "Object"
      ]
    },
    "required": {
      "type": "Boolean",
      "required": true
    },
    "default": {
      "type": "String",
      "required": false,
      "allowEmpty": true
    }
  }
}

Metadata

{
  "name": "Metadata",
  "type": "Object",
  "required": true,
  "fields": {
    "id": {
      "type": "String",
      "required": true,
      "min": 20,
      "max": 20,
      "allowEmpty": false
    },
    "user_id": {
      "type": "String",
      "required": true,
      "min": 20,
      "max": 20,
      "allowEmpty": false
    },
    "name": {
      "type": "String",
      "required": false,
      "allowEmpty": true
    },
    "description": {
      "type": "String",
      "required": false,
      "allowEmpty": true
    },
    "readable": {
      "type": "Boolean",
      "required": true
    },
    "writable": {
      "type": "Boolean",
      "required": true
    },
    "createdAt": {
      "type": "DateTime",
      "required": true
    },
    "updatedAt": {
      "type": "DateTime",
      "required": true
    }
  }
}

MetadataFull

{
  "name": "MetadataFull",
  "type": "Object",
  "required": true,
  "fields": {
    "id": {
      "type": "String",
      "required": true,
      "min": 20,
      "max": 20,
      "allowEmpty": false
    },
    "user_id": {
      "type": "String",
      "required": true,
      "min": 20,
      "max": 20,
      "allowEmpty": false
    },
    "name": {
      "type": "String",
      "required": false,
      "allowEmpty": true
    },
    "description": {
      "type": "String",
      "required": false,
      "allowEmpty": true
    },
    "readable": {
      "type": "Boolean",
      "required": true
    },
    "writable": {
      "type": "Boolean",
      "required": true
    },
    "createdAt": {
      "type": "DateTime",
      "required": true
    },
    "updatedAt": {
      "type": "DateTime",
      "required": true
    },
    "metadata_columns": {
      "type": "Array",
      "required": true,
      "items": [
        {
          "name": "MetadataColumn",
          "type": "Object",
          "required": true,
          "fields": {
            "id": {
              "type": "Integer",
              "required": true
            },
            "metadata_id": {
              "type": "String",
              "required": true,
              "min": 20,
              "max": 20,
              "allowEmpty": false
            },
            "name": {
              "type": "String",
              "required": true,
              "allowEmpty": false
            },
            "type": {
              "name": "MetadataColumnType",
              "type": "Enum",
              "required": true,
              "valids": [
                "Boolean",
                "Number",
                "String",
                "Date",
                "Object"
              ]
            },
            "required": {
              "type": "Boolean",
              "required": true
            },
            "default": {
              "type": "String",
              "required": false,
              "allowEmpty": true
            },
            "createdAt": {
              "type": "DateTime",
              "required": true
            },
            "updatedAt": {
              "type": "DateTime",
              "required": true
            }
          }
        }
      ]
    }
  }
}

MetadataColumn

{
  "name": "MetadataColumn",
  "type": "Object",
  "required": true,
  "fields": {
    "id": {
      "type": "Integer",
      "required": true
    },
    "metadata_id": {
      "type": "String",
      "required": true,
      "min": 20,
      "max": 20,
      "allowEmpty": false
    },
    "name": {
      "type": "String",
      "required": true,
      "allowEmpty": false
    },
    "type": {
      "name": "MetadataColumnType",
      "type": "Enum",
      "required": true,
      "valids": [
        "Boolean",
        "Number",
        "String",
        "Date",
        "Object"
      ]
    },
    "required": {
      "type": "Boolean",
      "required": true
    },
    "default": {
      "type": "String",
      "required": false,
      "allowEmpty": true
    },
    "createdAt": {
      "type": "DateTime",
      "required": true
    },
    "updatedAt": {
      "type": "DateTime",
      "required": true
    }
  }
}

ListCategory

{
  "name": "ListCategory",
  "type": "Object",
  "required": true,
  "fields": {
    "id": {
      "type": "Integer",
      "required": true
    },
    "user_id": {
      "type": "String",
      "required": true,
      "min": 20,
      "max": 20,
      "allowEmpty": false
    },
    "entity_id": {
      "type": "String",
      "required": true,
      "min": 20,
      "max": 20,
      "allowEmpty": false
    },
    "category_id": {
      "type": "String",
      "required": true,
      "min": 20,
      "max": 20,
      "allowEmpty": false
    },
    "createdAt": {
      "type": "DateTime",
      "required": true
    },
    "updatedAt": {
      "type": "DateTime",
      "required": true
    }
  }
}

ListField

{
  "name": "ListField",
  "type": "Object",
  "required": true,
  "fields": {
    "id": {
      "type": "Integer",
      "required": true
    },
    "user_id": {
      "type": "String",
      "required": true,
      "min": 20,
      "max": 20,
      "allowEmpty": false
    },
    "entity_id": {
      "type": "String",
      "required": true,
      "min": 20,
      "max": 20,
      "allowEmpty": false
    },
    "field_id": {
      "type": "String",
      "required": true,
      "min": 20,
      "max": 20,
      "allowEmpty": false
    },
    "value": {
      "type": "String",
      "required": true,
      "allowEmpty": false
    },
    "description": {
      "type": "String",
      "required": false,
      "allowEmpty": true
    },
    "createdAt": {
      "type": "DateTime",
      "required": true
    },
    "updatedAt": {
      "type": "DateTime",
      "required": true
    }
  }
}

ListTag

{
  "name": "ListTag",
  "type": "Object",
  "required": true,
  "fields": {
    "id": {
      "type": "Integer",
      "required": true
    },
    "user_id": {
      "type": "String",
      "required": true,
      "min": 20,
      "max": 20,
      "allowEmpty": false
    },
    "entity_id": {
      "type": "String",
      "required": true,
      "min": 20,
      "max": 20,
      "allowEmpty": false
    },
    "name": {
      "type": "String",
      "required": true,
      "allowEmpty": false
    },
    "value": {
      "type": "String",
      "required": true,
      "allowEmpty": false
    },
    "description": {
      "type": "String",
      "required": false,
      "allowEmpty": true
    },
    "createdAt": {
      "type": "DateTime",
      "required": true
    },
    "updatedAt": {
      "type": "DateTime",
      "required": true
    }
  }
}

List

{
  "name": "List",
  "type": "Object",
  "required": true,
  "fields": {
    "id": {
      "type": "String",
      "required": true,
      "min": 20,
      "max": 20,
      "allowEmpty": false
    },
    "user_id": {
      "type": "String",
      "required": true,
      "min": 20,
      "max": 20,
      "allowEmpty": false
    },
    "metadata_id": {
      "type": "String",
      "required": true,
      "min": 20,
      "max": 20,
      "allowEmpty": false
    },
    "name": {
      "type": "String",
      "required": false,
      "allowEmpty": true
    },
    "description": {
      "type": "String",
      "required": false,
      "allowEmpty": true
    },
    "createdAt": {
      "type": "DateTime",
      "required": true
    },
    "updatedAt": {
      "type": "DateTime",
      "required": true
    }
  }
}

ListInput

{
  "name": "ListInput",
  "type": "Object",
  "required": true,
  "fields": {
    "metadata_id": {
      "type": "String",
      "required": true,
      "min": 20,
      "max": 20,
      "allowEmpty": false
    },
    "name": {
      "type": "String",
      "required": false,
      "allowEmpty": true
    },
    "description": {
      "type": "String",
      "required": false,
      "allowEmpty": true
    }
  }
}

Enums

MetadataColumnType

Boolean

Number

String

Date

Object

Namira Software Corporation

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