Reconciling Engineering Model API Exports
Specify which object types and states the extraction includes. Use the example below to practice the review and record an output that another reviewer can reproduce.
Inputs and Prerequisites
Read access to a test model, a known export manifest and vendor schema documentation.
Review Workflow
- Test model
- API fields
- Stable identifiers
- Reconciliation
- Specify which object types and states the extraction includes.
- Retain stable identifiers and canonical units in the output.
- Check row counts and totals against the native application.
Worked Example
A beam export expects 12 member IDs. The output has 12 rows but only 11 unique IDs. One identifier is duplicated, so reconcile missing and duplicate identifiers before comparing member forces.
Output Checks and Common Errors
Test a stable sample model with known units, duplicate handling and deliberately omitted objects.
Official References
- CSI developer documentation
Read the API documentation for the application, version and object type.