States settings

Kanban board column configuration

INFO

Каждый ответ приходит в общем конверте — code, message, messages, status_code, time — а полезная нагрузка лежит в data. Таблицы ниже описывают содержимое data.

POST /states-settings/create

Create a custom workflow state column for an organization and domain type.

Тело запроса

Поле	Тип	Обязательно	Описание
organization_id	string	Да	Organization ObjectId this state column belongs to
name	string	Да	Display name of the state column
type	string	Да	The domain this state column belongs to (STATE_TYPE). Допустимые значения: trades, saleOrders, deliveryOrders, purchases, purchaseOrders, purchaseRequests
order	number	Да	Display order within the same type; siblings are re-sequenced automatically
note	string	Нет	Optional descriptive note for the state column
bg_color	string	Нет	Background color hex code, e.g. #F1F2F4

{
  "organization_id": "string",
  "name": "string",
  "type": "trades",
  "order": 0,
  "note": "string",
  "bg_color": "string"
}

Ответ

Поле	Тип	Описание
_id	string
name	string
type	string
is_default	boolean
default_key	string
organization_id	string

{
  "code": 0,
  "message": "Success",
  "status_code": 200,
  "data": {
    "_id": "string",
    "name": "string",
    "type": "string",
    "is_default": false,
    "default_key": "string",
    "organization_id": "string"
  },
  "time": "2025-05-01T12:00:00Z"
}

GET /states-settings/get-by-id/{id}

Fetch a single workflow state column by ObjectId.

Параметры пути

Параметр	Тип	Обязательно	Описание
id	string	Да	State column ObjectId

Тело запроса

Тело запроса не требуется.

Ответ

Структура ответа совпадает с POST /states-settings/create.

POST /states-settings/get-paging

Flat sorted list of workflow state columns. Filterable by type, organization, and is_default. Returns a plain array sorted by {type, order} — not a {list, total} envelope.

Тело запроса

Поле	Тип	Обязательно	Описание
type	string	Нет	Filter by STATE_TYPE domain. Допустимые значения: trades, saleOrders, deliveryOrders, purchases, purchaseOrders, purchaseRequests
types	string[]	Нет	Filter by multiple STATE_TYPE values
organization_id	string	Нет	Filter by organization ObjectId
is_default	boolean	Нет	When true, return only default (system-seeded) columns; false returns custom ones only

{
  "type": "trades",
  "types": [
    "trades"
  ],
  "organization_id": "string",
  "is_default": false
}

Ответ

{
  "code": 0,
  "message": "Success",
  "status_code": 200,
  "data": [
    {
      "_id": "string",
      "name": "string",
      "type": "string",
      "is_default": false,
      "default_key": "string",
      "organization_id": "string"
    }
  ],
  "time": "2025-05-01T12:00:00Z"
}

PUT /states-settings/update/{id}

Update an existing workflow state column. Changing order re-sequences sibling columns of the same type. order is silently dropped for default (system-seeded) columns.

Параметры пути

Параметр	Тип	Обязательно	Описание
id	string	Да	State column ObjectId

Тело запроса

Поле	Тип	Обязательно	Описание
name	string	Нет	New display name
order	number	Нет	New display order. Silently dropped for default columns.
note	string	Нет	Updated note
bg_color	string	Нет	Updated background color hex code

{
  "name": "string",
  "order": 0,
  "note": "string",
  "bg_color": "string"
}

Ответ

Структура ответа совпадает с POST /states-settings/create.

DELETE /states-settings/delete/{id}

Soft-delete a workflow state column (sets is_deleted=true). Guarded: default columns cannot be deleted, and columns still referenced by trade/sale-order/delivery-order documents are rejected with an error.

Параметры пути

Параметр	Тип	Обязательно	Описание
id	string	Да	State column ObjectId

Тело запроса

Тело запроса не требуется.

Ответ

{
  "code": 0,
  "message": "Success",
  "status_code": 200,
  "data": "string",
  "time": "2025-05-01T12:00:00Z"
}

---

Эта страница сгенерирована из спецификации OpenAPI.