MBOM structure export API omits custom fields in exported JSON for downstream integration

PLM Aras Innovator
, , , , , , , ,
1

We’re exporting MBOM structures to our ERP system using the Aras REST API, but custom properties we added to the MBOM structure aren’t appearing in the JSON response. Standard fields like quantity and position export fine, but our custom attributes (tool_reference, supplier_code, lead_time_days) are completely missing from the payload.

Here’s our current export call:

const response = await fetch('/Server/odata/MBOM', {
  method: 'GET',
  headers: {'Authorization': token}
});

The MBOM export schema seems limited to core attributes. We need these custom fields for ERP integration - our manufacturing system relies on supplier codes and lead times for production planning. Has anyone successfully mapped custom MBOM attributes through the API? The standard export doesn’t capture our extended data model.

2

For MBOM relationships, the structure is actually stored in the MBOM Structure ItemType, not on MBOM itself. Your custom fields are probably on that relationship. Try querying /Server/odata/MBOM_Structure instead with your $select parameters. This is a common confusion point - the parent MBOM item holds metadata, but the actual BOM lines with quantities and positions live in the Structure relationship.

3

Custom properties in OData queries need the exact internal name from the Property definition. If you added them through the UI, check the name field (not label). Also, properties on relationship ItemTypes like MBOM Structure need the relationship context - you might need to query the MBOM Structure ItemType directly rather than just MBOM.

4

Thanks for the pointers. I checked the Property definitions and is_visible is set correctly. When I add $select with the custom field names, I’m getting a 400 error saying the properties don’t exist. Are there naming conventions for accessing custom properties through OData?

5

I hit this exact issue last quarter. The OData endpoint requires you to specify custom properties explicitly in the $select clause. Also check that your custom properties are set as is_visible=1 in the Property definition - hidden properties won’t appear even with $select. For relationship properties on MBOM structures, you might need to use $expand as well. Our ERP integration needed supplier data from related items, so we had to chain $expand and $select together to get the full attribute mapping working correctly.

6

The default MBOM endpoint only returns base properties defined in the core ItemType. Custom properties need explicit selection in your query. Try adding $select parameter with your custom field names.