TRANXACT.AI Help

Supply Chain · Product Configurator

Configurator · Rules

Two kinds of rule in one list. CONSTRAINT rules say what may be chosen, as explicit pairs, because a rule has to be explicable to a salesperson standing in front of a customer. PROCESS rules say what the choice MEANS — which component, in what quantity, through which operation, with which inspection — and carry a condition written in the ordinary expression language.

Type REST14 operationsBase path /api/scm/config-rulesPublished as /api/v1/config-rules

Download specification (OpenAPI 3.1) Screen: Configurator · Rules

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 › Configurator · Rules 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.
Tablecpq.rules · 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

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

GET/api/scm/config-rulesList configurator · rules

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",
      "model_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "code": "COD-000001",
      "name": "Example",
      "rule_type": "requires",
      "when_option_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "when_class_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "then_option_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "then_class_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "quantity": "12.0000",
      "message": "text",
      "severity": "error",
      "sort_order": 10,
      "is_active": true
    }
  ],
  "count": 1
}

Sample request

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

Path parameters

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

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "model_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "code": "COD-000001",
  "name": "Example",
  "rule_type": "requires",
  "when_option_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "when_class_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "then_option_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "then_class_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "quantity": "12.0000",
  "message": "text",
  "severity": "error",
  "sort_order": 10,
  "is_active": true
}

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

Sample request

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

Request body

The record as JSON. Fields marked Yes are required.

FieldTypeRequiredDescription
model_iduuidYesModel
codetextYesCode
nametextYesName
rule_typetextYesKind — Constraint rules: "requires" complains, "implies" adds it for them. Process rules: "calculates" works out a number, the "selects_" rules decide what the product is made of and how, and "defaults_value" fills in an answer (Locked: the person cannot change it). Rule actions: "propagates_value" writes a value into a sub-assembly (TG100.DIAL_SIZE = TG310.DIAL_SIZE); "excludes_component", "replaces_component" and "sets_component_qty" change a part already in the structure; "selects_bom", and "selects_routing" with "Instead of the base routing", choose a variant; "removes_operation", "sets_operation_time" and "sets_work_center" change an operation by its number; "validates" refuses (error) or warns when its condition holds. Faster: Configurator · Workbook › Rules as text, one IF … THEN … sentence per line.
Allowed: requires excludes implies recommends min_quantity max_quantity forces_eto calculates selects_component selects_operation selects_routing selects_inspection
when_option_iduuidNoWhen this option is chosen — Options of the chosen model. Type a material number to find the option that adds it.
when_class_iduuidNoWhen class id
then_option_iduuidNoThen this option — Not restricted to the same question as the "when" side — a rule that crosses the tree is the whole point of a rule.
then_class_iduuidNoThen class id
quantitynumericNoQuantity
messagetextNoWhat the person is told — A constraint rule that fires with no explanation is a configurator people stop using. A process rule uses this as the reason it writes beside every part and every operation it produced.
severitytextNoSeverity
Allowed: error warning info
sort_orderintegerNoOrder
is_activebooleanNoActive
effective_fromdateNoIn force from — The date this version of the row takes effect. Leave it as today unless you are dating a change ahead.
effective_todateNoUntil — Leave empty for open-ended. Setting it ends this version rather than deleting it.
condition_exprtextNoWhen (a condition) — Written like a formula, over the codes of the questions: steel_grade = 'A' and diameter = 12 and galvanizing = 'yes'. Leave it empty for a rule that always applies — which is how the standard components and standard operations of a model are expressed. A question holds the CODE of the option chosen (dial_size = 'DS-4IN'), or the number typed for one that takes a value; <question>_option always holds the code. Not prose: "When dial size is 4 inch" is refused. For process rules only — constraint rules use the two option boxes above. Configurator · Models › Check this model lists every name and code.
output_nametextNoName of the value it computes — For a "calculates" rule. Later rules address the result by this name.
output_labeltextNoHow to show that value
output_uomtextNoUnit of that value
value_formulatextNoFormula — e.g. length_mm + process_allowance + cutting_allowance
then_item_iduuidNoThen select this part — One part. For several under the same condition, save the rule and add them to its Components.
component_qtynumericNoQuantity (a constant)
qty_formulatextNoQuantity (a formula) — e.g. raw_mass_kg. Wins over the constant where both are given.
component_uomtextNoUnit of the quantity
scrap_pctnumericNoScrap %
alternate_item_iduuidNoAlternative part — What is used when the first choice cannot be had. Not a second component.
component_kindtextNoWhat kind of part — Decides which line of the cost sheet it lands on.
Allowed: raw component subassembly consumable packaging purchased
consumed_at_op_nointegerNoConsumed at operation
operation_nointegerNoOperation number
operation_nametextNoOperation
then_work_center_iduuidNoOn this work centre
setup_minutesnumericNoSetup (minutes)
run_minutes_per_unitnumericNoRun per one (minutes)
time_formulatextNoRun time (a formula) — e.g. round(2 + raw_length_mm / 2000, 3)
is_subcontractedbooleanNoPerformed outside — The routing is where subcontracting is decided. An operation marked here raises a purchase requisition rather than being scheduled on a machine.
subcontract_supplier_iduuidNoSubcontractor
subcontract_costnumericNoWhat they charge (a constant)
cost_formulatextNoWhat they charge (a formula) — Galvanizing is priced by the zinc deposited and machining by the hour — a flat figure makes every size cost the same to have treated.
subcontract_lead_daysintegerNoHow long they keep it (days)
predecessor_op_nointegerNoAfter operation
then_routing_iduuidNoThen routing id
then_inspection_plan_iduuidNoThen inspect to this plan
inspection_stagetextNoAt which stage
Allowed: incoming in_process final first_article pre_ship periodic audit returned
then_submodel_iduuidNoThen configure this sub-assembly
then_bom_iduuidNoThen use this bill of material — selects_bom: a variant bill that replaces the base one when the condition holds.
replace_item_iduuidNoPart it replaces — replaces_component: this part is taken out and "Then select this part" goes in its place.
target_codetextNoSub-assembly question — propagates_value: the question code on the sub-assembly ("Then configure this sub-assembly") that the Formula’s value is written into, e.g. DIAL_SIZE.
is_lockedbooleanNoLocked — defaults_value / propagates_value: on, the person cannot change what the rule sets; off, it is only a default.
replaces_basebooleanNoInstead of the base routing — selects_routing: on, the routing replaces the base routing; off, its operations are added.

Sample body

{
  "model_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "code": "COD-000001",
  "name": "Example",
  "rule_type": "requires",
  "when_option_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "when_class_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "then_option_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "then_class_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}

Response 201

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "model_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "code": "COD-000001",
  "name": "Example",
  "rule_type": "requires",
  "when_option_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "when_class_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "then_option_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "then_class_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "quantity": "12.0000",
  "message": "text",
  "severity": "error",
  "sort_order": 10,
  "is_active": true
}

Sample request

curl -X POST "https://demo.tranxact.ai/api/scm/config-rules" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"model_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","code":"COD-000001","name":"Example","rule_type":"requires","when_option_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","when_class_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","then_option_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","then_class_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"}'
PUT/api/scm/config-rules/{id}Change a config rules

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
model_iduuidYesModel
codetextYesCode
nametextYesName
rule_typetextYesKind — Constraint rules: "requires" complains, "implies" adds it for them. Process rules: "calculates" works out a number, the "selects_" rules decide what the product is made of and how, and "defaults_value" fills in an answer (Locked: the person cannot change it). Rule actions: "propagates_value" writes a value into a sub-assembly (TG100.DIAL_SIZE = TG310.DIAL_SIZE); "excludes_component", "replaces_component" and "sets_component_qty" change a part already in the structure; "selects_bom", and "selects_routing" with "Instead of the base routing", choose a variant; "removes_operation", "sets_operation_time" and "sets_work_center" change an operation by its number; "validates" refuses (error) or warns when its condition holds. Faster: Configurator · Workbook › Rules as text, one IF … THEN … sentence per line.
Allowed: requires excludes implies recommends min_quantity max_quantity forces_eto calculates selects_component selects_operation selects_routing selects_inspection
when_option_iduuidNoWhen this option is chosen — Options of the chosen model. Type a material number to find the option that adds it.
when_class_iduuidNoWhen class id
then_option_iduuidNoThen this option — Not restricted to the same question as the "when" side — a rule that crosses the tree is the whole point of a rule.
then_class_iduuidNoThen class id
quantitynumericNoQuantity
messagetextNoWhat the person is told — A constraint rule that fires with no explanation is a configurator people stop using. A process rule uses this as the reason it writes beside every part and every operation it produced.
severitytextNoSeverity
Allowed: error warning info
sort_orderintegerNoOrder
is_activebooleanNoActive
effective_fromdateNoIn force from — The date this version of the row takes effect. Leave it as today unless you are dating a change ahead.
effective_todateNoUntil — Leave empty for open-ended. Setting it ends this version rather than deleting it.
condition_exprtextNoWhen (a condition) — Written like a formula, over the codes of the questions: steel_grade = 'A' and diameter = 12 and galvanizing = 'yes'. Leave it empty for a rule that always applies — which is how the standard components and standard operations of a model are expressed. A question holds the CODE of the option chosen (dial_size = 'DS-4IN'), or the number typed for one that takes a value; <question>_option always holds the code. Not prose: "When dial size is 4 inch" is refused. For process rules only — constraint rules use the two option boxes above. Configurator · Models › Check this model lists every name and code.
output_nametextNoName of the value it computes — For a "calculates" rule. Later rules address the result by this name.
output_labeltextNoHow to show that value
output_uomtextNoUnit of that value
value_formulatextNoFormula — e.g. length_mm + process_allowance + cutting_allowance
then_item_iduuidNoThen select this part — One part. For several under the same condition, save the rule and add them to its Components.
component_qtynumericNoQuantity (a constant)
qty_formulatextNoQuantity (a formula) — e.g. raw_mass_kg. Wins over the constant where both are given.
component_uomtextNoUnit of the quantity
scrap_pctnumericNoScrap %
alternate_item_iduuidNoAlternative part — What is used when the first choice cannot be had. Not a second component.
component_kindtextNoWhat kind of part — Decides which line of the cost sheet it lands on.
Allowed: raw component subassembly consumable packaging purchased
consumed_at_op_nointegerNoConsumed at operation
operation_nointegerNoOperation number
operation_nametextNoOperation
then_work_center_iduuidNoOn this work centre
setup_minutesnumericNoSetup (minutes)
run_minutes_per_unitnumericNoRun per one (minutes)
time_formulatextNoRun time (a formula) — e.g. round(2 + raw_length_mm / 2000, 3)
is_subcontractedbooleanNoPerformed outside — The routing is where subcontracting is decided. An operation marked here raises a purchase requisition rather than being scheduled on a machine.
subcontract_supplier_iduuidNoSubcontractor
subcontract_costnumericNoWhat they charge (a constant)
cost_formulatextNoWhat they charge (a formula) — Galvanizing is priced by the zinc deposited and machining by the hour — a flat figure makes every size cost the same to have treated.
subcontract_lead_daysintegerNoHow long they keep it (days)
predecessor_op_nointegerNoAfter operation
then_routing_iduuidNoThen routing id
then_inspection_plan_iduuidNoThen inspect to this plan
inspection_stagetextNoAt which stage
Allowed: incoming in_process final first_article pre_ship periodic audit returned
then_submodel_iduuidNoThen configure this sub-assembly
then_bom_iduuidNoThen use this bill of material — selects_bom: a variant bill that replaces the base one when the condition holds.
replace_item_iduuidNoPart it replaces — replaces_component: this part is taken out and "Then select this part" goes in its place.
target_codetextNoSub-assembly question — propagates_value: the question code on the sub-assembly ("Then configure this sub-assembly") that the Formula’s value is written into, e.g. DIAL_SIZE.
is_lockedbooleanNoLocked — defaults_value / propagates_value: on, the person cannot change what the rule sets; off, it is only a default.
replaces_basebooleanNoInstead of the base routing — selects_routing: on, the routing replaces the base routing; off, its operations are added.

Sample body

{
  "model_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "code": "COD-000001"
}

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "model_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "code": "COD-000001",
  "name": "Example",
  "rule_type": "requires",
  "when_option_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "when_class_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "then_option_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "then_class_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "quantity": "12.0000",
  "message": "text",
  "severity": "error",
  "sort_order": 10,
  "is_active": true
}

Sample request

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

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/config-rules/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/scm/config-rules/parse-textParse text

Request body

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

modelId, model, text

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/config-rules/parse-text" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"modelId":"value","model":"value","text":"value"}'
POST/api/scm/config-rules/save-textSave text

Request body

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

modelId, model, text

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/config-rules/save-text" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"modelId":"value","model":"value","text":"value"}'
GET/api/scm/config-rules/as-textAs text

Response

200 with the data as JSON.

Sample request

curl "https://demo.tranxact.ai/api/scm/config-rules/as-text" \
  -H "Authorization: Bearer $TOKEN"
PATCH/api/scm/config-rules/{id}Patch configurator · rules

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):

model_id, rule_type, condition_expr, then_option_id, value_formula, then_submodel_id, target_code

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 PATCH "https://demo.tranxact.ai/api/scm/config-rules/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"model_id":"value","rule_type":"value","condition_expr":"value","then_option_id":"value","value_formula":"value","then_submodel_id":"value"}'
POST/api/scm/config-rules/{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/config-rules/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/copy" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"overrides":"value","preview":"value","withLines":"value"}'
GET/api/scm/config-rules/{parentId}/componentsComponents

Path parameters

NameTypeDescription
parentIdstring (uuid)The record's parentId, as a list returns it.

Response

200 with the data as JSON.

Sample request

curl "https://demo.tranxact.ai/api/scm/config-rules/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/components" \
  -H "Authorization: Bearer $TOKEN"
POST/api/scm/config-rules/{parentId}/componentsComponents

Path parameters

NameTypeDescription
parentIdstring (uuid)The record's parentId, as a list returns it.

No body is required.

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/config-rules/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/components" \
  -H "Authorization: Bearer $TOKEN"
PUT/api/scm/config-rules/{parentId}/components/{lineId}Components

Path parameters

NameTypeDescription
parentIdstring (uuid)The record's parentId, as a list returns it.
lineIdstring (uuid)The record's lineId, as a list returns it.

No body is required.

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 PUT "https://demo.tranxact.ai/api/scm/config-rules/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/components/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
DELETE/api/scm/config-rules/{parentId}/components/{lineId}Components

Path parameters

NameTypeDescription
parentIdstring (uuid)The record's parentId, as a list returns it.
lineIdstring (uuid)The record's lineId, as a list returns it.

No body is required.

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 DELETE "https://demo.tranxact.ai/api/scm/config-rules/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/components/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"

Data model

Every field of a config rules, 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
model_iduuidread, writeModel
codetextread, writeCode
nametextread, writeName
rule_typetextread, writeKind — Constraint rules: "requires" complains, "implies" adds it for them. Process rules: "calculates" works out a number, the "selects_" rules decide what the product is made of and how, and "defaults_value" fills in an answer (Locked: the person cannot change it). Rule actions: "propagates_value" writes a value into a sub-assembly (TG100.DIAL_SIZE = TG310.DIAL_SIZE); "excludes_component", "replaces_component" and "sets_component_qty" change a part already in the structure; "selects_bom", and "selects_routing" with "Instead of the base routing", choose a variant; "removes_operation", "sets_operation_time" and "sets_work_center" change an operation by its number; "validates" refuses (error) or warns when its condition holds. Faster: Configurator · Workbook › Rules as text, one IF … THEN … sentence per line.
Allowed: requires excludes implies recommends min_quantity max_quantity forces_eto calculates selects_component selects_operation selects_routing selects_inspection
when_option_iduuidread, writeWhen this option is chosen — Options of the chosen model. Type a material number to find the option that adds it.
when_class_iduuidread, writeWhen class id
then_option_iduuidread, writeThen this option — Not restricted to the same question as the "when" side — a rule that crosses the tree is the whole point of a rule.
then_class_iduuidread, writeThen class id
quantitynumericread, writeQuantity
messagetextread, writeWhat the person is told — A constraint rule that fires with no explanation is a configurator people stop using. A process rule uses this as the reason it writes beside every part and every operation it produced.
severitytextread, writeSeverity
Allowed: error warning info
sort_orderintegerread, writeOrder
is_activebooleanread, writeActive
effective_fromdateread, writeIn force from — The date this version of the row takes effect. Leave it as today unless you are dating a change ahead.
effective_todateread, writeUntil — Leave empty for open-ended. Setting it ends this version rather than deleting it.
condition_exprtextread, writeWhen (a condition) — Written like a formula, over the codes of the questions: steel_grade = 'A' and diameter = 12 and galvanizing = 'yes'. Leave it empty for a rule that always applies — which is how the standard components and standard operations of a model are expressed. A question holds the CODE of the option chosen (dial_size = 'DS-4IN'), or the number typed for one that takes a value; <question>_option always holds the code. Not prose: "When dial size is 4 inch" is refused. For process rules only — constraint rules use the two option boxes above. Configurator · Models › Check this model lists every name and code.
output_nametextread, writeName of the value it computes — For a "calculates" rule. Later rules address the result by this name.
output_labeltextread, writeHow to show that value
output_uomtextread, writeUnit of that value
value_formulatextread, writeFormula — e.g. length_mm + process_allowance + cutting_allowance
then_item_iduuidread, writeThen select this part — One part. For several under the same condition, save the rule and add them to its Components.
component_qtynumericread, writeQuantity (a constant)
qty_formulatextread, writeQuantity (a formula) — e.g. raw_mass_kg. Wins over the constant where both are given.
component_uomtextread, writeUnit of the quantity
scrap_pctnumericread, writeScrap %
alternate_item_iduuidread, writeAlternative part — What is used when the first choice cannot be had. Not a second component.
component_kindtextread, writeWhat kind of part — Decides which line of the cost sheet it lands on.
Allowed: raw component subassembly consumable packaging purchased
consumed_at_op_nointegerread, writeConsumed at operation
operation_nointegerread, writeOperation number
operation_nametextread, writeOperation
then_work_center_iduuidread, writeOn this work centre
setup_minutesnumericread, writeSetup (minutes)
run_minutes_per_unitnumericread, writeRun per one (minutes)
time_formulatextread, writeRun time (a formula) — e.g. round(2 + raw_length_mm / 2000, 3)
is_subcontractedbooleanread, writePerformed outside — The routing is where subcontracting is decided. An operation marked here raises a purchase requisition rather than being scheduled on a machine.
subcontract_supplier_iduuidread, writeSubcontractor
subcontract_costnumericread, writeWhat they charge (a constant)
cost_formulatextread, writeWhat they charge (a formula) — Galvanizing is priced by the zinc deposited and machining by the hour — a flat figure makes every size cost the same to have treated.
subcontract_lead_daysintegerread, writeHow long they keep it (days)
predecessor_op_nointegerread, writeAfter operation
then_routing_iduuidread, writeThen routing id
then_inspection_plan_iduuidread, writeThen inspect to this plan
inspection_stagetextread, writeAt which stage
Allowed: incoming in_process final first_article pre_ship periodic audit returned
then_submodel_iduuidread, writeThen configure this sub-assembly
created_attimestamp with time zoneread onlyCreated at
created_byuuidread onlyCreated by
updated_attimestamp with time zoneread onlyUpdated at
updated_byuuidread onlyUpdated by
then_bom_iduuidread, writeThen use this bill of material — selects_bom: a variant bill that replaces the base one when the condition holds.
replace_item_iduuidread, writePart it replaces — replaces_component: this part is taken out and "Then select this part" goes in its place.
target_codetextread, writeSub-assembly question — propagates_value: the question code on the sub-assembly ("Then configure this sub-assembly") that the Formula’s value is written into, e.g. DIAL_SIZE.
is_lockedbooleanread, writeLocked — defaults_value / propagates_value: on, the person cannot change what the rule sets; off, it is only a default.
replaces_basebooleanread, writeInstead of the base routing — selects_routing: on, the routing replaces the base routing; off, its operations are added.
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

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 › Configurator · Rules 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.