TRANXACT.AI Help

Supply Chain · Demand Planning

Forecast Models

How a statistical forecast is calculated. Held as data so a planner can add one without a deployment, and so a run can record which it used.

Type REST6 operationsBase path /api/scm/forecast-modelsPublished as /api/v1/forecast-models

Download specification (OpenAPI 3.1) Screen: Forecast Models

Overview

PackageSupply Chain
AuthenticationBearer token: a service account's token (POST /api/auth/service-token) or, for the published path, an API key
AuthorizationThe caller's roles must hold Supply Chain › Forecast Models on the Roles screen: display for GET, add for POST, change for PUT, delete for DELETE; an action needs the grant of the button that runs it on the screen.
Tablescm.forecast_models · kept per company (and organisational unit where it has one)
RecordCreated, changed and (where the screen allows) deleted; key id
RulesThe same as the screen: validation, numbering, approvals, posting, the company the caller belongs to, and the audit trail.

API reference

6 operations. Open one for its parameters, bodies, responses and a sample request.

GET/api/scm/forecast-modelsList forecast models

Query parameters

NameDescriptionExample
limitRows per page (50 by default, at most 200)limit=100
offsetRows to skipoffset=200
qFree-text search over the search columnsq=acme
sortcolumn:asc or column:desc, several separated by commassort=created_at:desc
filterA JSON condition or group (see the filter language), URL-encoded; any field below can be filtered and sortedfilter={"col":"status","op":"eq","value":"open"}
<field>=<value>Shorthand for "field is value" 

Response 200

{
  "rows": [
    {
      "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "code": "COD-000001",
      "name": "Example",
      "method": "text",
      "periods": 10,
      "alpha": "1250.00",
      "beta": "1250.00",
      "gamma": "1250.00",
      "season_length": 10,
      "damped_trend": true,
      "suits_pattern": "text",
      "outlier_treatment": "none",
      "outlier_sigma": "1250.00",
      "description": "text"
    }
  ],
  "count": 1
}

Sample request

curl "https://demo.tranxact.ai/api/scm/forecast-models?limit=20" \
  -H "Authorization: Bearer $TOKEN"
GET/api/scm/forecast-models/{id}Read one forecast model

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "code": "COD-000001",
  "name": "Example",
  "method": "text",
  "periods": 10,
  "alpha": "1250.00",
  "beta": "1250.00",
  "gamma": "1250.00",
  "season_length": 10,
  "damped_trend": true,
  "suits_pattern": "text",
  "outlier_treatment": "none",
  "outlier_sigma": "1250.00",
  "description": "text"
}

404 when no record with that id is visible to the caller.

Sample request

curl "https://demo.tranxact.ai/api/scm/forecast-models/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/scm/forecast-modelsCreate a forecast model

Request body

The record as JSON. Fields marked Yes are required.

FieldTypeRequiredDescription
codetextYesCode
nametextYesName
methodtextNoMethod
periodsintegerNoWindow (periods)
alphanumericNoAlpha (level) — Higher is more responsive and more nervous. 0.3 is the usual starting point.
betanumericNoBeta (trend)
gammanumericNoGamma (season)
season_lengthintegerNoSeason length
damped_trendbooleanNoDamp the trend
suits_patterntextNoSuits demand that is — A method chosen for the wrong shape of demand is the commonest reason a forecast is useless. Croston exists for intermittent demand; exponential smoothing is hopeless at it.
outlier_treatmenttextNoOutliers
Allowed: none clip winsorize exclude flag
outlier_sigmanumericNoOutlier threshold (sigma)
descriptiontextNoDescription
is_defaultbooleanNoDefault
is_activebooleanNoActive

Sample body

{
  "code": "COD-000001",
  "name": "Example",
  "method": "text",
  "periods": 10,
  "alpha": "1250.00",
  "beta": "1250.00"
}

Response 201

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "code": "COD-000001",
  "name": "Example",
  "method": "text",
  "periods": 10,
  "alpha": "1250.00",
  "beta": "1250.00",
  "gamma": "1250.00",
  "season_length": 10,
  "damped_trend": true,
  "suits_pattern": "text",
  "outlier_treatment": "none",
  "outlier_sigma": "1250.00",
  "description": "text"
}

Sample request

curl -X POST "https://demo.tranxact.ai/api/scm/forecast-models" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"code":"COD-000001","name":"Example","method":"text","periods":10,"alpha":"1250.00","beta":"1250.00"}'
PUT/api/scm/forecast-models/{id}Change a forecast model

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Request body

Only the fields to change; fields left out keep their value.

FieldTypeRequiredDescription
codetextYesCode
nametextYesName
methodtextNoMethod
periodsintegerNoWindow (periods)
alphanumericNoAlpha (level) — Higher is more responsive and more nervous. 0.3 is the usual starting point.
betanumericNoBeta (trend)
gammanumericNoGamma (season)
season_lengthintegerNoSeason length
damped_trendbooleanNoDamp the trend
suits_patterntextNoSuits demand that is — A method chosen for the wrong shape of demand is the commonest reason a forecast is useless. Croston exists for intermittent demand; exponential smoothing is hopeless at it.
outlier_treatmenttextNoOutliers
Allowed: none clip winsorize exclude flag
outlier_sigmanumericNoOutlier threshold (sigma)
descriptiontextNoDescription
is_defaultbooleanNoDefault
is_activebooleanNoActive

Sample body

{
  "code": "COD-000001",
  "name": "Example"
}

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "code": "COD-000001",
  "name": "Example",
  "method": "text",
  "periods": 10,
  "alpha": "1250.00",
  "beta": "1250.00",
  "gamma": "1250.00",
  "season_length": 10,
  "damped_trend": true,
  "suits_pattern": "text",
  "outlier_treatment": "none",
  "outlier_sigma": "1250.00",
  "description": "text"
}

Sample request

curl -X PUT "https://demo.tranxact.ai/api/scm/forecast-models/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"code":"COD-000001","name":"Example"}'
DELETE/api/scm/forecast-models/{id}Delete a forecast model

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Response 200

{ "deleted": true }

Many documents are cancelled or reversed instead; the API refuses a delete the screen would refuse.

Sample request

curl -X DELETE "https://demo.tranxact.ai/api/scm/forecast-models/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/scm/forecast-models/{id}/copyCopy

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Request body

The keys this action reads (* = required; "one of" lists the only values):

overrides, preview, withLines

Response

200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.

Sample request

curl -X POST "https://demo.tranxact.ai/api/scm/forecast-models/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/copy" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"overrides":"value","preview":"value","withLines":"value"}'

Data model

Every field of a forecast model, as the API returns it. Field names are the JSON keys; any of them can be filtered and sorted on a list.

FieldTypeAccessDescription
iduuidread onlyId
org_iduuidread onlyOrg id
codetextread, writeCode
nametextread, writeName
methodtextread, writeMethod
periodsintegerread, writeWindow (periods)
alphanumericread, writeAlpha (level) — Higher is more responsive and more nervous. 0.3 is the usual starting point.
betanumericread, writeBeta (trend)
gammanumericread, writeGamma (season)
season_lengthintegerread, writeSeason length
damped_trendbooleanread, writeDamp the trend
suits_patterntextread, writeSuits demand that is — A method chosen for the wrong shape of demand is the commonest reason a forecast is useless. Croston exists for intermittent demand; exponential smoothing is hopeless at it.
outlier_treatmenttextread, writeOutliers
Allowed: none clip winsorize exclude flag
outlier_sigmanumericread, writeOutlier threshold (sigma)
descriptiontextread, writeDescription
is_defaultbooleanread, writeDefault
is_activebooleanread, writeActive
created_attimestamp with time zoneread onlyCreated at
org_unit_iduuidread onlyOrg unit id
xf_text_1textread onlyXf text 1
xf_text_2textread onlyXf text 2
xf_text_3textread onlyXf text 3
xf_text_4textread onlyXf text 4
xf_text_5textread onlyXf text 5
xf_num_1numericread onlyXf num 1
xf_num_2numericread onlyXf num 2
xf_num_3numericread onlyXf num 3
xf_date_1dateread onlyXf date 1
xf_date_2dateread onlyXf date 2
created_byuuidread onlyCreated by
updated_attimestamp with time zoneread onlyUpdated at
updated_byuuidread onlyUpdated by

Errors

StatusMeaning
400The request could not be read: a filter that is not JSON, a bad parameter
401No credential, or it is wrong, revoked or expired
403The caller's roles do not hold Supply Chain › Forecast Models for this verb, or the address or origin is not allowed
404No record with that id is visible to the caller
409A conflict: a duplicate number, a document in a state that does not allow it, or a record changed or locked by someone else
422Refused by the same validation as the screen; the error names the field and why

Every error is JSON: {"error": "a sentence saying what was wrong"}, with field where it applies.