For the complete documentation index, see llms.txt. This page is also available as Markdown.

Rmfg Review Links

Blocks for handing a design to a person on rmfg.com. A review link opens the 3D configurator with a starting configuration; whatever the person saves can be read back and used for quoting.

What it is

Creates an RMFG review link so a person can inspect and adjust a design

How it works

Posts a design ID and configuration to /v1/review-links with an Idempotency-Key; optionally attach a dfm_id so the page opens with that report's exact configuration. The returned review_url is a private hand-off link: the viewer can change material, finish and hole operations and save. Every design also carries a default review_url.

An unknown design or DFM report, or a configuration that references invalid IDs, is rejected by RMFG and reported as RMFG <code>: <message> (field: <path>). Links carry an expires_at, and configuration_updated_at is empty until a person saves.

Inputs

Input
Description
Type
Required

design_id

Design ID from Analyze Design

str

Yes

configuration

Starting configuration shown on the page; may be empty.

ManufacturingConfiguration

No

dfm_id

Attach a DFM report so the page opens that report's exact configuration.

str

No

idempotency_key

Stable key for identical retries; defaults to the node execution ID.

str

No

Outputs

Output
Description
Type

error

Error message if the request failed

str

review_link

The review link resource

ReviewLink

link_id

Link ID, to read the saved result back

str

review_url

Website page for a person to inspect and configure the design; keep private

str

configuration

The configuration on the link, including any saved changes

ManufacturingConfiguration

configuration_updated_at

When a person last saved changes; empty until they do

str

status

open or expired

str

Possible use case

Complex Configuration: Hand an assembly with many holes to the customer to configure themselves instead of guessing.

Approval Before Ordering: Let a customer inspect and adjust the exact configuration before the agent quotes it.

Engineer Sign-Off: Send a DFM report's configuration to an engineer for review on rmfg.com.


What it is

Fetches an RMFG review link and the configuration a person saved on it

How it works

Fetches /v1/review-links/{id}. configuration_updated_at is set once a person has saved changes, and configuration then holds their choices, ready to pass into Create Quote or Create Cart; before that it is empty and configuration is the starting configuration.

An unknown ID is reported as RMFG not_found_error: <message>; a link past expires_at returns status expired, and a new link must be created for further edits.

Inputs

Input
Description
Type
Required

link_id

Link ID from Create Review Link, or a design's review_link_id

str

Yes

Outputs

Output
Description
Type

error

Error message if the request failed

str

review_link

The review link resource

ReviewLink

link_id

Link ID, to read the saved result back

str

review_url

Website page for a person to inspect and configure the design; keep private

str

configuration

The configuration on the link, including any saved changes

ManufacturingConfiguration

configuration_updated_at

When a person last saved changes; empty until they do

str

status

open or expired

str

Possible use case

Customer Done Signal: When the customer replies "done", read the link and quote the saved configuration.

Scheduled Check: Poll the link daily and continue once configuration_updated_at is set.

Change Summary: Compare the saved configuration with the original and tell the customer what changed.


Last updated

Was this helpful?