Namirasoft Workspace API V1

Namira Software Corporation Workspace API Version 1 (1.4.12)

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


Healthz

Get

Returns the application health status

ns-workspace healthz 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!

WorkspaceCategory

List

Returns the workspace category list

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

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 {entity_id}

Copied!

--category_id (String)

Delete

Deletes a workspace category by an id.

ns-workspace workspacecategory delete {entity_id} {id}

Copied!

WorkspaceField

List

Returns the workspace field list

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

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 {entity_id}

Copied!

--field_id (String)

--value (String)

Update

Updates a workspace field by an id for an entity

ns-workspace workspacefield update {entity_id} {id}

Copied!

--field_id (String)

--value (String)

Delete

Deletes a workspace field by an id.

ns-workspace workspacefield delete {entity_id} {id}

Copied!

WorkspaceTag

List

Returns the workspace tag list

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

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 {entity_id}

Copied!

--name (String)

--value (String)

Update

Updates a workspace tag by an id for an entity

ns-workspace workspacetag update {entity_id} {id}

Copied!

--name (String)

--value (String)

Delete

Deletes a workspace tag by an id.

ns-workspace workspacetag delete {entity_id} {id}

Copied!

Workspace

GetDefaultOf

Returns the default workspace of a user by a user_id

ns-workspace workspace getdefaultof {user_id}

Copied!

GetDefault

Returns a default workspace of the current user

ns-workspace workspace getdefault

Copied!

List

Returns the workspace list

ns-workspace workspace list {filters} {page} {size} {sorts} {user_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)

--link (String)

--logo (String)

--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)

--link (String)

--logo (String)

--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


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
    },
    "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
    }
  }
}

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
    },
    "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
    }
  }
}

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
    },
    "link": {
      "type": "String",
      "required": false,
      "max": 255
    },
    "logo": {
      "type": "String",
      "required": false,
      "max": 255
    },
    "default": {
      "type": "Boolean",
      "required": true
    },
    "description": {
      "type": "String",
      "required": false,
      "max": 4096
    },
    "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": {
            "category_id": {
              "type": "String",
              "required": true,
              "min": 20,
              "max": 20
            }
          }
        }
      ]
    },
    "workspace_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
            }
          }
        }
      ]
    },
    "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
    },
    "link": {
      "type": "String",
      "required": false,
      "max": 255
    },
    "logo": {
      "type": "String",
      "required": false,
      "max": 255
    },
    "default": {
      "type": "Boolean",
      "required": true
    },
    "description": {
      "type": "String",
      "required": false,
      "max": 4096
    },
    "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
    },
    "link": {
      "type": "String",
      "required": false,
      "max": 255
    },
    "logo": {
      "type": "String",
      "required": false,
      "max": 255
    },
    "description": {
      "type": "String",
      "required": false,
      "max": 4096
    },
    "workspace_category": {
      "type": "Array",
      "required": true,
      "items": [
        {
          "name": "EntityCategoryInput",
          "type": "Object",
          "required": false,
          "fields": {
            "category_id": {
              "type": "String",
              "required": true,
              "min": 20,
              "max": 20
            }
          }
        }
      ]
    },
    "workspace_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
            }
          }
        }
      ]
    },
    "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 2025 Namira Software Corporation. All rights reserved.