Production group
Production groupings
INFO
Every response arrives in the shared envelope — code, message, messages, status_code, time — with the payload in data. The tables below describe what is inside data.
POST /production-group/create
Create a new production group (hierarchical grouping of tech-maps).
Request body
| Field | Type | Required | Description |
|---|---|---|---|
type | string | Yes | Category of tech-maps this group organises (tech_map or route_sheet). One of: tech_map, route_sheet |
name | string | Yes | Display name of the production group |
code | string | No | Optional short code for the group |
note | string | No | Optional free-text note |
parent_id | string | No | Parent production-group ObjectId for hierarchical grouping |
organization_ids | string[] | Yes | Organization ObjectIds this group is scoped to |
json
{
"type": "tech_map",
"name": "string",
"code": "string",
"note": "string",
"parent_id": "string",
"organization_ids": [
"string"
]
}Response
| Field | Type | Description |
|---|---|---|
type | string | Category of tech-maps this group organises (tech_map or route_sheet). One of: tech_map, route_sheet |
name | string | Display name of the production group |
code | string | Optional short code for the group |
note | string | Optional free-text note |
parent_id | string | Parent production-group ObjectId for hierarchical grouping |
organization_ids | string[] | Organization ObjectIds this group is scoped to |
_id | string | Production group ObjectId |
is_deleted | boolean | Soft-delete flag |
created_at | string (date-time) | Creation timestamp (ISO 8601) |
updated_at | string (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.
Path parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
id | string | Yes | Production-group ObjectId |
Request body
No request body.
Response
Same response shape as POST /production-group/create.
POST /production-group/get-paging
Paginated list of production groups, filterable by type and organization.
Request body
| Field | Type | Required | Description |
|---|---|---|---|
page | number | Yes | Default: 1 |
limit | number | Yes | Default: 20 |
search | string | No | Filter by name or code |
type | string | No | Filter by group type. One of: tech_map, route_sheet |
organization_id | string | No | Filter by organization ObjectId |
parent_id | string | No | Filter by parent group ObjectId |
json
{
"page": 1,
"limit": 20,
"search": "string",
"type": "tech_map",
"organization_id": "string",
"parent_id": "string"
}Response
| Field | Type | Description |
|---|---|---|
total | number | |
list | object[] | |
list[].type | string | Category of tech-maps this group organises (tech_map or route_sheet). One of: tech_map, route_sheet |
list[].name | string | Display name of the production group |
list[].code | string | Optional short code for the group |
list[].note | string | Optional free-text note |
list[].parent_id | string | Parent production-group ObjectId for hierarchical grouping |
list[].organization_ids | string[] | Organization ObjectIds this group is scoped to |
list[]._id | string | Production group ObjectId |
list[].is_deleted | boolean | Soft-delete flag |
list[].created_at | string (date-time) | Creation timestamp (ISO 8601) |
list[].updated_at | string (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.
Path parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
id | string | Yes | Production-group ObjectId |
Request body
| Field | Type | Required | Description |
|---|---|---|---|
type | string | No | Category of tech-maps this group organises. One of: tech_map, route_sheet |
name | string | No | Display name of the production group |
code | string | No | Optional short code for the group |
note | string | No | Optional free-text note |
parent_id | string | No | Parent production-group ObjectId for hierarchical grouping |
organization_ids | string[] | No | Organization ObjectIds this group is scoped to |
json
{
"type": "tech_map",
"name": "string",
"code": "string",
"note": "string",
"parent_id": "string",
"organization_ids": [
"string"
]
}Response
Same response shape as POST /production-group/create.
DELETE /production-group/delete/{id}
Soft-delete a production group by ObjectId.
Path parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
id | string | Yes | Production-group ObjectId |
Request body
No request body.
Response
json
{
"code": 0,
"message": "Success",
"status_code": 200,
"data": "ok",
"time": "2025-05-01T12:00:00Z"
}This page is generated from the OpenAPI spec.