Skip to content

Production group ​

Production groupings

INFO

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

POST /production-group/create ​

Create a new production group (hierarchical grouping of tech-maps).

Тело запроса

ПолеТипОбязательноОписание
typestringДаCategory of tech-maps this group organises (tech_map or route_sheet). Допустимые значения: tech_map, route_sheet
namestringДаDisplay name of the production group
codestringНетOptional short code for the group
notestringНетOptional free-text note
parent_idstringНетParent production-group ObjectId for hierarchical grouping
organization_idsstring[]ДаOrganization ObjectIds this group is scoped to
json
{
  "type": "tech_map",
  "name": "string",
  "code": "string",
  "note": "string",
  "parent_id": "string",
  "organization_ids": [
    "string"
  ]
}

Ответ

ПолеТипОписание
typestringCategory of tech-maps this group organises (tech_map or route_sheet). Допустимые значения: tech_map, route_sheet
namestringDisplay name of the production group
codestringOptional short code for the group
notestringOptional free-text note
parent_idstringParent production-group ObjectId for hierarchical grouping
organization_idsstring[]Organization ObjectIds this group is scoped to
_idstringProduction group ObjectId
is_deletedbooleanSoft-delete flag
created_atstring (date-time)Creation timestamp (ISO 8601)
updated_atstring (date-time)Last update timestamp (ISO 8601)
json
{
  "code": 0,
  "message": "Success",
  "status_code": 200,
  "data": {
    "type": "tech_map",
    "name": "string",
    "code": "string",
    "note": "string",
    "parent_id": "string",
    "organization_ids": [
      "string"
    ],
    "_id": "string",
    "is_deleted": false,
    "created_at": "2025-05-01T12:00:00Z",
    "updated_at": "2025-05-01T12:00:00Z"
  },
  "time": "2025-05-01T12:00:00Z"
}

GET /production-group/get-by-id/{id} ​

Fetch a single production group by ObjectId.

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

ПараметрТипОбязательноОписание
idstringДаProduction-group ObjectId

Тело запроса

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

Ответ

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

POST /production-group/get-paging ​

Paginated list of production groups, filterable by type and organization.

Тело запроса

ПолеТипОбязательноОписание
pagenumberДаПо умолчанию: 1
limitnumberДаПо умолчанию: 20
searchstringНетFilter by name or code
typestringНетFilter by group type. Допустимые значения: tech_map, route_sheet
organization_idstringНетFilter by organization ObjectId
parent_idstringНетFilter by parent group ObjectId
json
{
  "page": 1,
  "limit": 20,
  "search": "string",
  "type": "tech_map",
  "organization_id": "string",
  "parent_id": "string"
}

Ответ

ПолеТипОписание
totalnumber
listobject[]
list[].typestringCategory of tech-maps this group organises (tech_map or route_sheet). Допустимые значения: tech_map, route_sheet
list[].namestringDisplay name of the production group
list[].codestringOptional short code for the group
list[].notestringOptional free-text note
list[].parent_idstringParent production-group ObjectId for hierarchical grouping
list[].organization_idsstring[]Organization ObjectIds this group is scoped to
list[]._idstringProduction group ObjectId
list[].is_deletedbooleanSoft-delete flag
list[].created_atstring (date-time)Creation timestamp (ISO 8601)
list[].updated_atstring (date-time)Last update timestamp (ISO 8601)
json
{
  "code": 0,
  "message": "Success",
  "status_code": 200,
  "data": {
    "total": 0,
    "list": [
      {
        "type": "tech_map",
        "name": "string",
        "code": "string",
        "note": "string",
        "parent_id": "string",
        "organization_ids": [],
        "_id": "string",
        "is_deleted": false,
        "created_at": "2025-05-01T12:00:00Z",
        "updated_at": "2025-05-01T12:00:00Z"
      }
    ]
  },
  "time": "2025-05-01T12:00:00Z"
}

PUT /production-group/update/{id} ​

Update an existing production group.

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

ПараметрТипОбязательноОписание
idstringДаProduction-group ObjectId

Тело запроса

ПолеТипОбязательноОписание
typestringНетCategory of tech-maps this group organises. Допустимые значения: tech_map, route_sheet
namestringНетDisplay name of the production group
codestringНетOptional short code for the group
notestringНетOptional free-text note
parent_idstringНетParent production-group ObjectId for hierarchical grouping
organization_idsstring[]НетOrganization ObjectIds this group is scoped to
json
{
  "type": "tech_map",
  "name": "string",
  "code": "string",
  "note": "string",
  "parent_id": "string",
  "organization_ids": [
    "string"
  ]
}

Ответ

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

DELETE /production-group/delete/{id} ​

Soft-delete a production group by ObjectId.

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

ПараметрТипОбязательноОписание
idstringДаProduction-group ObjectId

Тело запроса

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

Ответ

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

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

Bito 2.0 Integration API