Append Refobject for Ref Attr Not Ending with GID

This feature enhances the REST API documentation to clearly shows reference resources (objects linked via foreign keys) alongside their ID fields. For example, instead of only showing an ID field like orderBaseGid, the documentation will also show the related object (for example, orderBases ) and explain when each one appears based on the expandRefs setting.  This feature also ensures the accuracy of pagination and result metadata (hasMore, limit, count, offset and totalResults) in REST child resource data.

The Optional Feature Append Refobject for Ref Attr Not Ending with GID, when enabled, will append RefObject to the JSON property name in the following scenario:

  1. It has a property type of object.
  2. It is an attribute of a resource that references another root resource.
  3. Its name does not end with "Gid".

Business Benefit: This enhancement makes REST API documentation more complete and easier to understand by clearly showing when related objects can be expanded versus when only their IDs are returned. It reduces confusion and rework for integrators, helping teams build and troubleshoot integrations faster.

Steps to enable and configure

If you need to change the Opt In state for this feature:

  • Go to the Optional Feature UI - Configuration and Administration > Property Management > Optional Features.

Your user must have the DBA.ADMIN user role to use this functionality.

  • Select the Append Refobject for Ref Attr Not Ending with GID feature.
  • Run the desired Action for the feature - Opt In or Opt Out.

Tips and considerations

  • Use expandRefs to control what you see:
    • When expandRefs=false, you will see the ID-style field (for example, orderBaseGid).
    • When expandRefs=true, you will see the expanded reference object (for example,orderBases) with descriptive text explaining it’s a referenced resource.
  • Watch for “RefObject” naming on certain fields: Some reference attributes don’t end with "Gid" (for example, equipmentDestination on shipments). In the documentation, these may appear with RefObject appended (for example, equipmentDestinationRefObject) to make it clear they are reference objects.
  • Optional feature: The documentation describes the RefObject naming behavior, but the actual JSON generation behavior for these non-Gid reference attributes only applies when the Optional Feature Append Refobject for Ref Attr Not Ending with GID is enabled. 
    • Note that when enabled the behavior for the non-Gid reference attributes is changed - this is why the change is controlled with an Optional Feature.

Key resources

For more information see the REST API for Fusion Cloud Transportation and Global Trade Management Business Object Resources documentation.