Namirasoft Workspace API V1

Namira Software Corporation Workspace API Version 1 (1.5.2)

Install


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

npm i -g namirasoft-workspace-api-v1

Copied!

Commands


Health

Liveness

Returns the application liveness status

ns-workspace health liveness

Copied!

Readiness

Returns the application readiness status

ns-workspace health readiness

Copied!

Metrics

Get

Returns the application metrics

ns-workspace metrics get

Copied!

Value

List

Returns the value list of a given table and column

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

Copied!

Overview

Count

Returns the row count of every entity across all databases, optionally grouped by workspace_id and filtered to specific workspaces

ns-workspace overview count

Copied!

--group_by_workspace (Boolean)

--workspace_ids (Array)

WorkspaceCategory

List

Returns the workspace category list

ns-workspace workspacecategory list {filters} {page} {size} {sorts} {all_workspaces}

Copied!

Get

Returns a workspace category by id.

ns-workspace workspacecategory get {id}

Copied!

Create

Creates a new workspace category for an entity

ns-workspace workspacecategory create

Copied!

--slot_id (String)

--category_id (String)

Delete

Deletes a workspace category by an id.

ns-workspace workspacecategory delete {id}

Copied!

WorkspaceField

List

Returns the workspace field list

ns-workspace workspacefield list {filters} {page} {size} {sorts} {all_workspaces}

Copied!

Get

Returns a workspace field by id.

ns-workspace workspacefield get {id}

Copied!

Create

Creates a new workspace field for an entity

ns-workspace workspacefield create

Copied!

--slot_id (String)

--field_id (String)

--value (Any)

Update

Updates a workspace field by an id for an entity

ns-workspace workspacefield update {id}

Copied!

--slot_id (String)

--field_id (String)

--value (Any)

Delete

Deletes a workspace field by an id.

ns-workspace workspacefield delete {id}

Copied!

WorkspaceTag

List

Returns the workspace tag list

ns-workspace workspacetag list {filters} {page} {size} {sorts} {all_workspaces}

Copied!

Get

Returns a workspace tag by id.

ns-workspace workspacetag get {id}

Copied!

Create

Creates a new workspace tag for an entity

ns-workspace workspacetag create

Copied!

--name (String)

--value (String)

Update

Updates a workspace tag by an id for an entity

ns-workspace workspacetag update {id}

Copied!

--name (String)

--value (String)

Delete

Deletes a workspace tag by an id.

ns-workspace workspacetag delete {id}

Copied!

Workspace

_GetDefaultFor

Returns the default workspace for an user_id

ns-workspace workspace _getdefaultfor {user_id}

Copied!

GetByProduct

Returns the workspace list

ns-workspace workspace getbyproduct {product_id} {filters} {page} {size} {sorts} {all_workspaces}

Copied!

GetDefault

Returns the default workspace of the current user

ns-workspace workspace getdefault

Copied!

List

Returns the workspace list

ns-workspace workspace list {filters} {page} {size} {sorts} {all_workspaces}

Copied!

GetCurrent

Returns the current workspace

ns-workspace workspace getcurrent

Copied!

SetCurrent

Returns a workspace by an id

ns-workspace workspace setcurrent {id}

Copied!

Get

Returns a workspace by an id

ns-workspace workspace get {id}

Copied!

Create

Creates a new workspace

ns-workspace workspace create

Copied!

--name (String)

--product_ids (Array)

--description (String)

--workspace_category (Array)

--workspace_field (Array)

--workspace_tag (Array)

Update

Updates a workspace by an id

ns-workspace workspace update {id}

Copied!

--name (String)

--product_ids (Array)

--description (String)

--workspace_category (Array)

--workspace_field (Array)

--workspace_tag (Array)

Delete

Deletes a workspace by an id

ns-workspace workspace delete {id}

Copied!

SetDefault

Sets the default workspace

ns-workspace workspace setdefault {id}

Copied!

Schemas


OverviewCountInput

{
    "name": "OverviewCountInput",
    "type": "Object",
    "required": true,
    "fields": {
        "group_by_workspace": {
            "type": "Boolean",
            "required": false
        },
        "workspace_ids": {
            "type": "Array",
            "required": false,
            "items": [
                {
                    "type": "String",
                    "required": true
                }
            ]
        }
    }
}

OverviewCountRow

{
    "name": "OverviewCountRow",
    "type": "Object",
    "required": true,
    "fields": {
        "database": {
            "type": "String",
            "required": true
        },
        "table": {
            "type": "String",
            "required": true
        },
        "total": {
            "type": "Integer",
            "required": true
        },
        "by_workspace": {
            "type": "Array",
            "required": false,
            "items": [
                {
                    "name": "OverviewCountByWorkspace",
                    "type": "Object",
                    "required": true,
                    "fields": {
                        "workspace_id": {
                            "type": "String",
                            "required": true
                        },
                        "count": {
                            "type": "Integer",
                            "required": true
                        }
                    }
                }
            ]
        }
    }
}

OverviewCountByWorkspace

{
    "name": "OverviewCountByWorkspace",
    "type": "Object",
    "required": true,
    "fields": {
        "workspace_id": {
            "type": "String",
            "required": true
        },
        "count": {
            "type": "Integer",
            "required": true
        }
    }
}

WorkspaceCategory

{
    "name": "WorkspaceCategory",
    "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
        },
        "slot_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": {
        "slot_id": {
            "type": "String",
            "required": true,
            "min": 20,
            "max": 20
        },
        "category_id": {
            "type": "String",
            "required": true,
            "min": 20,
            "max": 20
        }
    }
}

WorkspaceField

{
    "name": "WorkspaceField",
    "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
        },
        "slot_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": {
        "slot_id": {
            "type": "String",
            "required": true,
            "min": 20,
            "max": 20
        },
        "field_id": {
            "type": "String",
            "required": true,
            "min": 20,
            "max": 20
        },
        "value": {
            "type": "Any",
            "required": false
        }
    }
}

WorkspaceTag

{
    "name": "WorkspaceTag",
    "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
        }
    }
}

WorkspaceFull

{
    "name": "WorkspaceFull",
    "type": "Object",
    "required": true,
    "fields": {
        "id": {
            "type": "String",
            "required": true,
            "min": 20,
            "max": 20
        },
        "user_id": {
            "type": "String",
            "required": true,
            "min": 20,
            "max": 20
        },
        "name": {
            "type": "String",
            "required": true,
            "max": 255
        },
        "product_ids": {
            "type": "Array",
            "required": false,
            "items": [
                {
                    "type": "String",
                    "required": false
                }
            ]
        },
        "default": {
            "type": "Boolean",
            "required": true
        },
        "description": {
            "type": "String",
            "required": false
        },
        "created_at": {
            "type": "DateTime",
            "required": true
        },
        "updated_at": {
            "type": "DateTime",
            "required": true
        },
        "workspace_category": {
            "type": "Array",
            "required": true,
            "items": [
                {
                    "name": "EntityCategoryInput",
                    "type": "Object",
                    "required": false,
                    "fields": {
                        "slot_id": {
                            "type": "String",
                            "required": true,
                            "min": 20,
                            "max": 20
                        },
                        "category_id": {
                            "type": "String",
                            "required": true,
                            "min": 20,
                            "max": 20
                        }
                    }
                }
            ]
        },
        "workspace_field": {
            "type": "Array",
            "required": true,
            "items": [
                {
                    "name": "EntityFieldInput",
                    "type": "Object",
                    "required": false,
                    "fields": {
                        "slot_id": {
                            "type": "String",
                            "required": true,
                            "min": 20,
                            "max": 20
                        },
                        "field_id": {
                            "type": "String",
                            "required": true,
                            "min": 20,
                            "max": 20
                        },
                        "value": {
                            "type": "Any",
                            "required": false
                        }
                    }
                }
            ]
        },
        "workspace_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
                        }
                    }
                }
            ]
        }
    }
}

Workspace

{
    "name": "Workspace",
    "type": "Object",
    "required": true,
    "fields": {
        "id": {
            "type": "String",
            "required": true,
            "min": 20,
            "max": 20
        },
        "user_id": {
            "type": "String",
            "required": true,
            "min": 20,
            "max": 20
        },
        "name": {
            "type": "String",
            "required": true,
            "max": 255
        },
        "product_ids": {
            "type": "Any",
            "required": false
        },
        "default": {
            "type": "Boolean",
            "required": true
        },
        "description": {
            "type": "String",
            "required": false
        },
        "created_at": {
            "type": "DateTime",
            "required": true
        },
        "updated_at": {
            "type": "DateTime",
            "required": true
        }
    }
}

WorkspaceInput

{
    "name": "WorkspaceInput",
    "type": "Object",
    "required": true,
    "fields": {
        "name": {
            "type": "String",
            "required": true,
            "max": 255
        },
        "product_ids": {
            "type": "Array",
            "required": false,
            "items": [
                {
                    "type": "String",
                    "required": false
                }
            ]
        },
        "description": {
            "type": "String",
            "required": false
        },
        "workspace_category": {
            "type": "Array",
            "required": true,
            "items": [
                {
                    "name": "EntityCategoryInput",
                    "type": "Object",
                    "required": false,
                    "fields": {
                        "slot_id": {
                            "type": "String",
                            "required": true,
                            "min": 20,
                            "max": 20
                        },
                        "category_id": {
                            "type": "String",
                            "required": true,
                            "min": 20,
                            "max": 20
                        }
                    }
                }
            ]
        },
        "workspace_field": {
            "type": "Array",
            "required": true,
            "items": [
                {
                    "name": "EntityFieldInput",
                    "type": "Object",
                    "required": false,
                    "fields": {
                        "slot_id": {
                            "type": "String",
                            "required": true,
                            "min": 20,
                            "max": 20
                        },
                        "field_id": {
                            "type": "String",
                            "required": true,
                            "min": 20,
                            "max": 20
                        },
                        "value": {
                            "type": "Any",
                            "required": false
                        }
                    }
                }
            ]
        },
        "workspace_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 2026 Namira Software Corporation. All rights reserved.