Change control JSON export missing required fields when syncing to ERP

QMS Arena QMS (by PTC)
, , , , , , , ,
1

We’re using Arena QMS 2022.2 REST API to export change control records to our ERP system, but the JSON payload is consistently missing required fields that should be included based on our field export configuration.

Here’s a sample of what we’re getting:

{"changeId":"CHG-001","status":"Approved","effectiveDate":null}

The missing fields are: approverName, impactAssessment, and implementationCost - all of which are populated in Arena and marked as exportable in the field configuration. Our ERP integration fails validation because these are mandatory fields on their side.

We’ve verified the JSON schema mapping in Arena’s REST API configuration, and the data transformation rules appear correct. The REST API payload structure should include all fields marked with export flag, but something in the serialization process is dropping them. Is this a known issue with Arena’s JSON export in 2022.2, or are we missing a configuration step?

2

I’ve dealt with similar issues integrating Arena with SAP. The problem is usually in how Arena handles null vs missing fields in JSON. Your effectiveDate showing as null is a clue - Arena might be intentionally omitting fields that don’t have values rather than sending them as null. Check if those missing fields actually have data populated in the change control records you’re testing with.

3

Check your API endpoint URL. Are you using the full object expansion parameter? By default, Arena’s REST API only returns base fields unless you explicitly request related fields through query parameters like ?expand=all or ?fields=approverName,impactAssessment,implementationCost.

4

Good catch! I added the expand parameter but still getting null values for those specific fields. I’m using: /api/v1/change-controls/CHG-001?expand=all. Could this be a permissions issue where the API user doesn’t have access to certain field types?

5

Actually, I think the issue is more fundamental. In Arena 2022.2, there’s a distinction between object fields and workflow-related fields. ApproverName is typically a workflow attribute, not a direct object field, which means it won’t serialize in standard object exports. You need to query the workflow instance separately or use a composite endpoint that joins object and workflow data.