Namirasoft Content Template API V1

Namira Software Corporation Content Template API Version 1 (1.5.3)

Install


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

npm i -g namirasoft-content-template-api-v1

Copied!

Commands


Health

Liveness

Returns the application liveness status

ns-content-template health liveness

Copied!

Readiness

Returns the application readiness status

ns-content-template health readiness

Copied!

Metrics

Get

Returns the application metrics

ns-content-template metrics get

Copied!

Value

List

Returns the value list of a given table and column

ns-content-template 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-content-template overview count

Copied!

--group_by_workspace (Boolean)

--workspace_ids (Array)

ContentTemplateCategory

List

Returns the content template category list

ns-content-template contenttemplatecategory list {filters} {page} {size} {sorts} {all_workspaces}

Copied!

Get

Returns a content template category by id.

ns-content-template contenttemplatecategory get {id}

Copied!

Create

Creates a new content template category for an entity

ns-content-template contenttemplatecategory create

Copied!

--slot_id (String)

--category_id (String)

Delete

Deletes a content template category by an id.

ns-content-template contenttemplatecategory delete {id}

Copied!

ContentTemplateField

List

Returns the content template field list

ns-content-template contenttemplatefield list {filters} {page} {size} {sorts} {all_workspaces}

Copied!

Get

Returns a content template field by id.

ns-content-template contenttemplatefield get {id}

Copied!

Create

Creates a new content template field for an entity

ns-content-template contenttemplatefield create

Copied!

--slot_id (String)

--field_id (String)

--value (Any)

Update

Updates a content template field by an id for an entity

ns-content-template contenttemplatefield update {id}

Copied!

--slot_id (String)

--field_id (String)

--value (Any)

Delete

Deletes a content template field by an id.

ns-content-template contenttemplatefield delete {id}

Copied!

ContentTemplateTag

List

Returns the content template tag list

ns-content-template contenttemplatetag list {filters} {page} {size} {sorts} {all_workspaces}

Copied!

Get

Returns a content template tag by id.

ns-content-template contenttemplatetag get {id}

Copied!

Create

Creates a new content template tag for an entity

ns-content-template contenttemplatetag create

Copied!

--name (String)

--value (String)

Update

Updates a content template tag by an id for an entity

ns-content-template contenttemplatetag update {id}

Copied!

--name (String)

--value (String)

Delete

Deletes a content template tag by an id.

ns-content-template contenttemplatetag delete {id}

Copied!

ContentTemplate

List

Returns the content template list

ns-content-template contenttemplate list {filters} {page} {size} {sorts} {all_workspaces}

Copied!

Get

Returns a content template by an id

ns-content-template contenttemplate get {id}

Copied!

Create

Creates a new content template

ns-content-template contenttemplate create

Copied!

--workspace_id (String)

--name (String)

--type (Enum)

--content (String)

--parameters (Array)

--description (String)

--content_template_category (Array)

--content_template_field (Array)

--content_template_tag (Array)

Update

Updates a content template by an id

ns-content-template contenttemplate update {id}

Copied!

--workspace_id (String)

--name (String)

--type (Enum)

--content (String)

--parameters (Array)

--description (String)

--content_template_category (Array)

--content_template_field (Array)

--content_template_tag (Array)

Delete

Deletes a content template by an id

ns-content-template contenttemplate delete {id}

Copied!

Make

Returns the content of the ContentTemplate

ns-content-template contenttemplate make {id}

Copied!

--parameters (Object)

SendSMS

Sends an SMS with the content of the Content Template

ns-content-template contenttemplate sendsms {id} {provider_id}

Copied!

--phone (String)

--parameters (Object)

SendEmail

Sends an Email with the content of the Content Template

ns-content-template contenttemplate sendemail {id} {provider_id}

Copied!

--email (String)

--title (String)

--parameters (Object)

SendTelegram

Sends a Telegram message with the content of the Content Template

ns-content-template contenttemplate sendtelegram {id} {provider_id}

Copied!

--chat_id (String)

--message_thread_id (String)

--parameters (Object)

SendTeams

Sends a Teams message with the content of the Content Template

ns-content-template contenttemplate sendteams {id} {provider_id}

Copied!

--team_id (String)

--channel_id (String)

--parameters (Object)

SendSlack

Sends a Slack message with the content of the Content Template

ns-content-template contenttemplate sendslack {id} {provider_id}

Copied!

--channel (String)

--parameters (Object)

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

ContentTemplateCategory

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

ContentTemplateField

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

ContentTemplateTag

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

ContentTemplate

{
    "name": "ContentTemplate",
    "type": "Object",
    "required": true,
    "fields": {
        "id": {
            "type": "String",
            "required": true,
            "min": 20,
            "max": 20
        },
        "user_id": {
            "type": "String",
            "required": true,
            "min": 20,
            "max": 20
        },
        "workspace_id": {
            "type": "String",
            "required": true,
            "min": 20,
            "max": 20
        },
        "name": {
            "type": "String",
            "required": true,
            "max": 255
        },
        "type": {
            "name": "ContentTemplateType",
            "type": "Enum",
            "required": true,
            "valids": [
                "Plain",
                "Json",
                "Xml",
                "Html",
                "Yaml"
            ]
        },
        "content": {
            "type": "String",
            "required": true
        },
        "parameters": {
            "type": "Array",
            "required": false,
            "items": [
                {
                    "type": "Variable",
                    "required": false
                }
            ]
        },
        "description": {
            "type": "String",
            "required": false
        },
        "created_at": {
            "type": "DateTime",
            "required": true
        },
        "updated_at": {
            "type": "DateTime",
            "required": true
        }
    }
}

ContentTemplateFull

{
    "name": "ContentTemplateFull",
    "type": "Object",
    "required": true,
    "fields": {
        "id": {
            "type": "String",
            "required": true,
            "min": 20,
            "max": 20
        },
        "user_id": {
            "type": "String",
            "required": true,
            "min": 20,
            "max": 20
        },
        "workspace_id": {
            "type": "String",
            "required": true,
            "min": 20,
            "max": 20
        },
        "name": {
            "type": "String",
            "required": true,
            "max": 255
        },
        "type": {
            "name": "ContentTemplateType",
            "type": "Enum",
            "required": true,
            "valids": [
                "Plain",
                "Json",
                "Xml",
                "Html",
                "Yaml"
            ]
        },
        "content": {
            "type": "String",
            "required": true
        },
        "parameters": {
            "type": "Array",
            "required": false,
            "items": [
                {
                    "type": "Variable",
                    "required": false
                }
            ]
        },
        "description": {
            "type": "String",
            "required": false
        },
        "created_at": {
            "type": "DateTime",
            "required": true
        },
        "updated_at": {
            "type": "DateTime",
            "required": true
        },
        "content_template_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
                        }
                    }
                }
            ]
        },
        "content_template_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
                        }
                    }
                }
            ]
        },
        "content_template_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
                        }
                    }
                }
            ]
        }
    }
}

ContentTemplateInput

{
    "name": "ContentTemplateInput",
    "type": "Object",
    "required": true,
    "fields": {
        "workspace_id": {
            "type": "String",
            "required": false,
            "min": 20,
            "max": 20
        },
        "name": {
            "type": "String",
            "required": true,
            "max": 255
        },
        "type": {
            "name": "ContentTemplateType",
            "type": "Enum",
            "required": true,
            "valids": [
                "Plain",
                "Json",
                "Xml",
                "Html",
                "Yaml"
            ]
        },
        "content": {
            "type": "String",
            "required": true
        },
        "parameters": {
            "type": "Array",
            "required": false,
            "items": [
                {
                    "type": "Variable",
                    "required": false
                }
            ]
        },
        "description": {
            "type": "String",
            "required": false
        },
        "content_template_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
                        }
                    }
                }
            ]
        },
        "content_template_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
                        }
                    }
                }
            ]
        },
        "content_template_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

ContentTemplateType

Plain

Json

Xml

Html

Yaml

Namira Software Corporation

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