Column Help Text¶

POST /api/help

Authentication required.

Returns help text and tooltip descriptions for specified table column keys. Used to populate in-app help overlays without hard-coding content in the frontend.

Request Body¶

{
  "columns": [
    "PO List Number",
    "PO List Document Status",
    "PO Details ETA Date"
  ]
}

Field	Type	Required	Description
`columns`	array of strings	Yes	Column keys to retrieve help text for

Response¶

Returns help text only for columns that have documentation defined. Columns without help text are omitted from the response.

{
  "PO List Number": "The unique identifier for this purchase order. Assigned by your ERP or entered manually.",
  "PO Details ETA Date": "Estimated date the goods will arrive at the destination warehouse. Used for planning and delayed shipment analysis."
}

Code Example¶

CSRF=$(grep csrf_access_token cookies.txt | awk '{print $NF}')

curl -b cookies.txt -X POST https://acme.knosc.com/api/help \
  -H "Content-Type: application/json" \
  -H "X-XSRF-TOKEN: $CSRF" \
  -d '{"columns": ["PO List Number", "PO Details ETA Date"]}'