Namirasoft API Work V1
Namira Software Corporation API Work Version 1 (1.5.0)
Install
To use this cli, we need to first Install Nodejs, then run the following command.
npm i -g namirasoft-api-work-v1
Copied!
Commands
Health
Liveness
Returns the application liveness status
ns-api-work health liveness
Copied!
Readiness
Returns the application readiness status
ns-api-work health readiness
Copied!
Metrics
Get
Returns the application metrics
ns-api-work metrics get
Copied!
Category
List
Returns the category list
ns-api-work category list {filters} {page} {size} {sorts}
Copied!
Get
Returns a category by an id
ns-api-work category get {id}
Copied!
Owner
List
Returns the owner list
ns-api-work owner list {filters} {page} {size} {sorts}
Copied!
Get
Returns an owner by an id
ns-api-work owner get {id}
Copied!
Tech
List
Returns the tech list
ns-api-work tech list {filters} {page} {size} {sorts}
Copied!
Get
Returns a tech by an id
ns-api-work tech get {id}
Copied!
Work
List
Returns the work list
ns-api-work work list {filters} {page} {size} {sorts}
Copied!
Get
Returns a work by an id
ns-api-work work get {id}
Copied!
Schemas
Category
{ "name": "Category", "type": "Object", "required": true, "fields": { "id": { "type": "Integer", "required": true }, "name": { "type": "String", "required": true, "max": 255 }, "created_at": { "type": "DateTime", "required": true }, "updated_at": { "type": "DateTime", "required": true } }}
Owner
{ "name": "Owner", "type": "Object", "required": true, "fields": { "id": { "type": "Integer", "required": true }, "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 }, "created_at": { "type": "DateTime", "required": true }, "updated_at": { "type": "DateTime", "required": true } }}
Tech
{ "name": "Tech", "type": "Object", "required": true, "fields": { "id": { "type": "Integer", "required": true }, "name": { "type": "String", "required": true, "max": 255 }, "created_at": { "type": "DateTime", "required": true }, "updated_at": { "type": "DateTime", "required": true } }}
WorkFull
{ "name": "WorkFull", "type": "Object", "required": true, "fields": { "id": { "type": "Integer", "required": true }, "owner_id": { "type": "Integer", "required": true }, "category_id": { "type": "Integer", "required": true }, "name": { "type": "String", "required": true, "max": 255 }, "headline": { "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 }, "created_at": { "type": "DateTime", "required": true }, "updated_at": { "type": "DateTime", "required": true }, "owner": { "name": "Owner", "type": "Object", "required": false, "fields": { "id": { "type": "Integer", "required": true }, "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 }, "created_at": { "type": "DateTime", "required": true }, "updated_at": { "type": "DateTime", "required": true } } }, "category": { "name": "Category", "type": "Object", "required": true, "fields": { "id": { "type": "Integer", "required": true }, "name": { "type": "String", "required": true, "max": 255 }, "created_at": { "type": "DateTime", "required": true }, "updated_at": { "type": "DateTime", "required": true } } }, "work_tech": { "type": "Array", "required": false, "items": [ { "name": "WorkTechFull", "type": "Object", "required": false, "fields": { "id": { "type": "Integer", "required": true }, "work_id": { "type": "Integer", "required": true }, "tech_id": { "type": "Integer", "required": true }, "created_at": { "type": "DateTime", "required": true }, "updated_at": { "type": "DateTime", "required": true }, "tech": { "name": "Tech", "type": "Object", "required": false, "fields": { "id": { "type": "Integer", "required": true }, "name": { "type": "String", "required": true, "max": 255 }, "created_at": { "type": "DateTime", "required": true }, "updated_at": { "type": "DateTime", "required": true } } } } } ] } }}
WorkTechFull
{ "name": "WorkTechFull", "type": "Object", "required": false, "fields": { "id": { "type": "Integer", "required": true }, "work_id": { "type": "Integer", "required": true }, "tech_id": { "type": "Integer", "required": true }, "created_at": { "type": "DateTime", "required": true }, "updated_at": { "type": "DateTime", "required": true }, "tech": { "name": "Tech", "type": "Object", "required": false, "fields": { "id": { "type": "Integer", "required": true }, "name": { "type": "String", "required": true, "max": 255 }, "created_at": { "type": "DateTime", "required": true }, "updated_at": { "type": "DateTime", "required": true } } } }}
Enums
Namira Software Corporation
©Copyright 2010 to 2026 Namira Software Corporation. All rights reserved.