Get

[POST] .../v1/doctechmap/get

Returns documents technological cards. Use this method to list technological map documents before opening a tech map, checking its lock or posting state or selecting it for TechMapOperation and production workflows. The response returns paged DocTechMap records with next_offset and total, supports filters by id, firm_id, item_id, type, performed, blocked, date and search. Production must be enabled by the PRODUCTION_ALLOWED setting and the production tariff parameter and the current request user must have tech map select permission. Missing body, disabled production, denied access, invalid filters or sort_orders, unavailable tariff, database failures and display-period restrictions are returned as HTTP 200 ErrorResult business errors.

Request Parameters

Name Type Required Description
filters Array of Filter Optional Optional filters by fields available for this API method.
limit Int32 Optional Maximum number of records to return. Server settings define the effective maximum.
offset Int32 Optional Offset from the beginning of the result set. Negative values are treated as 0.
search String Optional Search by parameter values: code - tech map document code, Firm/name - company name, Item/name - item name, User/name - responsible person full name.
sort_orders Array of DocTechMapColumn Optional Output parameter sorting.

Filterable Fields

Field Type Description
blocked bool Tech map document edit lock state: true - locked for editing, false - unlocked for editing.
date int
end_date int Period end date as Unix time in seconds.
firm_id int Company IDs.
id int Tech map document IDs.
item_id int Item IDs.
performed bool Tech map document posting state: true - posted, false - not posted.
start_date int Period start date as Unix time in seconds.
type string Tech map type: Assemblable - assembly, Disassemblable - disassembly.

Sortable Fields

Field
blocked
code
date
id
item.name
last_update
performed
type

Request Example

{
  "filters": [
    {
      "field": "firm_id",
      "operator": "In",
      "value": "1"
    },
    {
      "field": "type",
      "operator": "Equal",
      "value": "Assemblable"
    },
    {
      "field": "performed",
      "operator": "Equal",
      "value": "false"
    }
  ],
  "sort_orders": [
    {
      "column": "date",
      "direction": "DESC"
    }
  ],
  "limit": 50,
  "offset": 0
}

Response Parameters

Name Type Description
next_offset Int32 Offset for the next data page.
ok Boolean Indicates whether the request completed successfully.
result Array of DocTechMap Result array.
total Int64 Total number of result items.

Response Example

{
  "ok": true,
  "result": [
    {
      "id": 7301,
      "date": 1767225600,
      "type": "Assemblable",
      "code": "TM-000073",
      "item_id": 2001,
      "item": {
        "id": 2001,
        "name": "Coffee gift set",
        "code": "SET-001"
      },
      "firm": {
        "id": 1,
        "name": "REGOS"
      },
      "performed": false,
      "blocked": true,
      "current_user_blocked": true,
      "autocalculate_part_cost": true,
      "last_update": 1767225600
    }
  ],
  "next_offset": 0,
  "total": 1
}