Namirasoft Scheduler API V1

Namira Software Corporation Scheduler API Version 1 (1.4.10)

Install


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

npm i -g namirasoft-scheduler-api-v1

Copied!

Commands


Healthz

Get

Returns the application health status

ns-scheduler healthz get

Copied!

Health

Liveness

Returns the application liveness status

ns-scheduler health liveness

Copied!

Readiness

Returns the application readiness status

ns-scheduler health readiness

Copied!

Metrics

Get

Returns the application metrics

ns-scheduler metrics get

Copied!

Value

List

Returns the value list of a given table and column

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

Copied!

SchedulerCategory

List

Returns the scheduler category list

ns-scheduler schedulercategory list {filters} {page} {size} {sorts}

Copied!

Get

Returns a scheduler category by id.

ns-scheduler schedulercategory get {id}

Copied!

Create

Creates a new scheduler category for an entity

ns-scheduler schedulercategory create

Copied!

--entity_id (String)

--category_id (String)

Delete

Deletes a scheduler category by an id.

ns-scheduler schedulercategory delete {id}

Copied!

SchedulerField

List

Returns the scheduler field list

ns-scheduler schedulerfield list {filters} {page} {size} {sorts}

Copied!

Get

Returns a scheduler field by id.

ns-scheduler schedulerfield get {id}

Copied!

Create

Creates a new scheduler field for an entity

ns-scheduler schedulerfield create

Copied!

--entity_id (String)

--field_id (String)

--value (Any)

Update

Updates a scheduler field by an id for an entity

ns-scheduler schedulerfield update {id}

Copied!

--entity_id (String)

--field_id (String)

--value (Any)

Delete

Deletes a scheduler field by an id.

ns-scheduler schedulerfield delete {id}

Copied!

SchedulerTag

List

Returns the scheduler tag list

ns-scheduler schedulertag list {filters} {page} {size} {sorts}

Copied!

Get

Returns a scheduler tag by id.

ns-scheduler schedulertag get {id}

Copied!

Create

Creates a new scheduler tag for an entity

ns-scheduler schedulertag create

Copied!

--entity_id (String)

--name (String)

--value (String)

Update

Updates a scheduler tag by an id for an entity

ns-scheduler schedulertag update {id}

Copied!

--entity_id (String)

--name (String)

--value (String)

Delete

Deletes a scheduler tag by an id.

ns-scheduler schedulertag delete {id}

Copied!

Scheduler

List

Returns the scheduler list

ns-scheduler scheduler list {filters} {page} {size} {sorts}

Copied!

Get

Returns a scheduler by an id

ns-scheduler scheduler get {id}

Copied!

Create

Creates a new scheduler

ns-scheduler scheduler create

Copied!

--workspace_id (String)

--name (String)

--start_date_time (DateTime)

--end_date_time (DateTime)

--start_time (String)

--end_time (String)

--max_repeat_count (Integer)

--cron_minute (String)

--cron_hour (String)

--frequency_type (Enum)

--frequency_day_every (Integer)

--frequency_week_every (Integer)

--frequency_week_days (Array)

--frequency_month_names (Array)

--frequency_month_days (Array)

--frequency_month_on_week (Array)

--frequency_month_on_days (Array)

--frequency_cron_year (String)

--frequency_cron_month (String)

--frequency_cron_day (String)

--frequency_cron_day_of_week (String)

--repeat_every_value (Integer)

--repeat_every_unit (Enum)

--repeat_until_value (Integer)

--repeat_until_unit (Enum)

--random_delay_value (Integer)

--random_delay_unit (Enum)

--description (String)

Update

Updates a scheduler by an id

ns-scheduler scheduler update {id}

Copied!

--workspace_id (String)

--name (String)

--start_date_time (DateTime)

--end_date_time (DateTime)

--start_time (String)

--end_time (String)

--max_repeat_count (Integer)

--cron_minute (String)

--cron_hour (String)

--frequency_type (Enum)

--frequency_day_every (Integer)

--frequency_week_every (Integer)

--frequency_week_days (Array)

--frequency_month_names (Array)

--frequency_month_days (Array)

--frequency_month_on_week (Array)

--frequency_month_on_days (Array)

--frequency_cron_year (String)

--frequency_cron_month (String)

--frequency_cron_day (String)

--frequency_cron_day_of_week (String)

--repeat_every_value (Integer)

--repeat_every_unit (Enum)

--repeat_until_value (Integer)

--repeat_until_unit (Enum)

--random_delay_value (Integer)

--random_delay_unit (Enum)

--description (String)

Delete

Deletes a scheduler by an id

ns-scheduler scheduler delete {id}

Copied!

Schemas


SchedulerCategory

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

SchedulerField

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

SchedulerTag

{
  "name": "SchedulerTag",
  "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": {
    "entity_id": {
      "type": "String",
      "required": true,
      "min": 20,
      "max": 20
    },
    "name": {
      "type": "String",
      "required": true,
      "max": 255
    },
    "value": {
      "type": "String",
      "required": false
    }
  }
}

Scheduler

{
  "name": "Scheduler",
  "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
    },
    "start_date_time": {
      "type": "DateTime",
      "required": true
    },
    "end_date_time": {
      "type": "DateTime",
      "required": false
    },
    "start_time": {
      "type": "String",
      "required": false,
      "max": 255
    },
    "end_time": {
      "type": "String",
      "required": false,
      "max": 255
    },
    "max_repeat_count": {
      "type": "Integer",
      "required": false
    },
    "cron_minute": {
      "type": "String",
      "required": false,
      "max": 255
    },
    "cron_hour": {
      "type": "String",
      "required": false,
      "max": 255
    },
    "frequency_type": {
      "name": "SchedulerFrequencyType",
      "type": "Enum",
      "required": false,
      "valids": [
        "Daily",
        "Weekly",
        "Monthly",
        "Cron"
      ]
    },
    "frequency_day_every": {
      "type": "Integer",
      "required": false
    },
    "frequency_week_every": {
      "type": "Integer",
      "required": false
    },
    "frequency_week_days": {
      "type": "Array",
      "required": false,
      "items": [
        {
          "name": "FrequencyWeekDaysType",
          "type": "Enum",
          "required": true,
          "valids": [
            "Sun",
            "Mon",
            "Tue",
            "Wed",
            "Thu",
            "Fri",
            "Sat"
          ]
        }
      ]
    },
    "frequency_month_names": {
      "type": "Array",
      "required": false,
      "items": [
        {
          "name": "FrequencyMonthNamesType",
          "type": "Enum",
          "required": true,
          "valids": [
            "Jan",
            "Feb",
            "Mar",
            "Apr",
            "May",
            "Jun",
            "Jul",
            "Aug",
            "Sep",
            "Oct",
            "Nov",
            "Dec"
          ]
        }
      ]
    },
    "frequency_month_days": {
      "type": "Array",
      "required": false,
      "items": [
        {
          "name": "FrequencyMonthDaysType",
          "type": "Enum",
          "required": true,
          "valids": [
            "Day_1",
            "Day_2",
            "Day_3",
            "Day_4",
            "Day_5",
            "Day_6",
            "Day_7",
            "Day_8",
            "Day_9",
            "Day_10",
            "Day_11",
            "Day_12",
            "Day_13",
            "Day_14",
            "Day_15",
            "Day_16",
            "Day_17",
            "Day_18",
            "Day_19",
            "Day_20",
            "Day_21",
            "Day_22",
            "Day_23",
            "Day_24",
            "Day_25",
            "Day_26",
            "Day_27",
            "Day_28",
            "Day_29",
            "Day_30",
            "Day_31",
            "Last"
          ]
        }
      ]
    },
    "frequency_month_on_week": {
      "type": "Array",
      "required": false,
      "items": [
        {
          "name": "FrequencyMonthOnWeekType",
          "type": "Enum",
          "required": true,
          "valids": [
            "First",
            "Second",
            "Third",
            "Fourth",
            "Last"
          ]
        }
      ]
    },
    "frequency_month_on_days": {
      "type": "Array",
      "required": false,
      "items": [
        {
          "name": "FrequencyMonthOnDaysType",
          "type": "Enum",
          "required": true,
          "valids": [
            "Sun",
            "Mon",
            "Tue",
            "Wed",
            "Thu",
            "Fri",
            "Sat"
          ]
        }
      ]
    },
    "frequency_cron_year": {
      "type": "String",
      "required": false,
      "max": 255
    },
    "frequency_cron_month": {
      "type": "String",
      "required": false,
      "max": 255
    },
    "frequency_cron_day": {
      "type": "String",
      "required": false,
      "max": 255
    },
    "frequency_cron_day_of_week": {
      "type": "String",
      "required": false,
      "max": 255
    },
    "repeat_every_value": {
      "type": "Integer",
      "required": false
    },
    "repeat_every_unit": {
      "name": "SchedulerRepeatEveryUnit",
      "type": "Enum",
      "required": false,
      "valids": [
        "Minute",
        "Hour",
        "Day"
      ]
    },
    "repeat_until_value": {
      "type": "Integer",
      "required": false
    },
    "repeat_until_unit": {
      "name": "SchedulerRepeatUntilUnit",
      "type": "Enum",
      "required": false,
      "valids": [
        "Minute",
        "Hour",
        "Day"
      ]
    },
    "random_delay_value": {
      "type": "Integer",
      "required": false
    },
    "random_delay_unit": {
      "name": "SchedulerRandomDelayUnit",
      "type": "Enum",
      "required": false,
      "valids": [
        "Minute",
        "Hour",
        "Day"
      ]
    },
    "next_schedule": {
      "type": "DateTime",
      "required": false
    },
    "last_run": {
      "type": "DateTime",
      "required": false
    },
    "next_run": {
      "type": "DateTime",
      "required": false
    },
    "state": {
      "type": "Any",
      "required": false
    },
    "total_run": {
      "type": "Integer",
      "required": true
    },
    "finished": {
      "type": "Boolean",
      "required": true
    },
    "description": {
      "type": "String",
      "required": false,
      "max": 255
    },
    "created_at": {
      "type": "DateTime",
      "required": true
    },
    "updated_at": {
      "type": "DateTime",
      "required": true
    }
  }
}

SchedulerInput

{
  "name": "SchedulerInput",
  "type": "Object",
  "required": true,
  "fields": {
    "workspace_id": {
      "type": "String",
      "required": false,
      "min": 20,
      "max": 20
    },
    "name": {
      "type": "String",
      "required": true,
      "max": 255
    },
    "start_date_time": {
      "type": "DateTime",
      "required": true
    },
    "end_date_time": {
      "type": "DateTime",
      "required": false
    },
    "start_time": {
      "type": "String",
      "required": false,
      "max": 255
    },
    "end_time": {
      "type": "String",
      "required": false,
      "max": 255
    },
    "max_repeat_count": {
      "type": "Integer",
      "required": false
    },
    "cron_minute": {
      "type": "String",
      "required": false,
      "max": 255
    },
    "cron_hour": {
      "type": "String",
      "required": false,
      "max": 255
    },
    "frequency_type": {
      "name": "SchedulerFrequencyType",
      "type": "Enum",
      "required": false,
      "valids": [
        "Daily",
        "Weekly",
        "Monthly",
        "Cron"
      ]
    },
    "frequency_day_every": {
      "type": "Integer",
      "required": false
    },
    "frequency_week_every": {
      "type": "Integer",
      "required": false
    },
    "frequency_week_days": {
      "type": "Array",
      "required": false,
      "items": [
        {
          "name": "FrequencyWeekDaysType",
          "type": "Enum",
          "required": true,
          "valids": [
            "Sun",
            "Mon",
            "Tue",
            "Wed",
            "Thu",
            "Fri",
            "Sat"
          ]
        }
      ]
    },
    "frequency_month_names": {
      "type": "Array",
      "required": false,
      "items": [
        {
          "name": "FrequencyMonthNamesType",
          "type": "Enum",
          "required": true,
          "valids": [
            "Jan",
            "Feb",
            "Mar",
            "Apr",
            "May",
            "Jun",
            "Jul",
            "Aug",
            "Sep",
            "Oct",
            "Nov",
            "Dec"
          ]
        }
      ]
    },
    "frequency_month_days": {
      "type": "Array",
      "required": false,
      "items": [
        {
          "name": "FrequencyMonthDaysType",
          "type": "Enum",
          "required": true,
          "valids": [
            "Day_1",
            "Day_2",
            "Day_3",
            "Day_4",
            "Day_5",
            "Day_6",
            "Day_7",
            "Day_8",
            "Day_9",
            "Day_10",
            "Day_11",
            "Day_12",
            "Day_13",
            "Day_14",
            "Day_15",
            "Day_16",
            "Day_17",
            "Day_18",
            "Day_19",
            "Day_20",
            "Day_21",
            "Day_22",
            "Day_23",
            "Day_24",
            "Day_25",
            "Day_26",
            "Day_27",
            "Day_28",
            "Day_29",
            "Day_30",
            "Day_31",
            "Last"
          ]
        }
      ]
    },
    "frequency_month_on_week": {
      "type": "Array",
      "required": false,
      "items": [
        {
          "name": "FrequencyMonthOnWeekType",
          "type": "Enum",
          "required": true,
          "valids": [
            "First",
            "Second",
            "Third",
            "Fourth",
            "Last"
          ]
        }
      ]
    },
    "frequency_month_on_days": {
      "type": "Array",
      "required": false,
      "items": [
        {
          "name": "FrequencyMonthOnDaysType",
          "type": "Enum",
          "required": true,
          "valids": [
            "Sun",
            "Mon",
            "Tue",
            "Wed",
            "Thu",
            "Fri",
            "Sat"
          ]
        }
      ]
    },
    "frequency_cron_year": {
      "type": "String",
      "required": false,
      "max": 255
    },
    "frequency_cron_month": {
      "type": "String",
      "required": false,
      "max": 255
    },
    "frequency_cron_day": {
      "type": "String",
      "required": false,
      "max": 255
    },
    "frequency_cron_day_of_week": {
      "type": "String",
      "required": false,
      "max": 255
    },
    "repeat_every_value": {
      "type": "Integer",
      "required": false
    },
    "repeat_every_unit": {
      "name": "SchedulerRepeatEveryUnit",
      "type": "Enum",
      "required": false,
      "valids": [
        "Minute",
        "Hour",
        "Day"
      ]
    },
    "repeat_until_value": {
      "type": "Integer",
      "required": false
    },
    "repeat_until_unit": {
      "name": "SchedulerRepeatUntilUnit",
      "type": "Enum",
      "required": false,
      "valids": [
        "Minute",
        "Hour",
        "Day"
      ]
    },
    "random_delay_value": {
      "type": "Integer",
      "required": false
    },
    "random_delay_unit": {
      "name": "SchedulerRandomDelayUnit",
      "type": "Enum",
      "required": false,
      "valids": [
        "Minute",
        "Hour",
        "Day"
      ]
    },
    "description": {
      "type": "String",
      "required": false,
      "max": 255
    }
  }
}

Enums

SchedulerFrequencyType

Daily

Weekly

Monthly

Cron

FrequencyWeekDaysType

Sun

Mon

Tue

Wed

Thu

Fri

Sat

FrequencyMonthNamesType

Jan

Feb

Mar

Apr

May

Jun

Jul

Aug

Sep

Oct

Nov

Dec

FrequencyMonthDaysType

Day_1

Day_2

Day_3

Day_4

Day_5

Day_6

Day_7

Day_8

Day_9

Day_10

Day_11

Day_12

Day_13

Day_14

Day_15

Day_16

Day_17

Day_18

Day_19

Day_20

Day_21

Day_22

Day_23

Day_24

Day_25

Day_26

Day_27

Day_28

Day_29

Day_30

Day_31

Last

FrequencyMonthOnWeekType

First

Second

Third

Fourth

Last

FrequencyMonthOnDaysType

Sun

Mon

Tue

Wed

Thu

Fri

Sat

SchedulerRepeatEveryUnit

Minute

Hour

Day

SchedulerRepeatUntilUnit

Minute

Hour

Day

SchedulerRandomDelayUnit

Minute

Hour

Day

Namira Software Corporation

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