Out JSON Profile Child Resource Filter Criteria

This feature enhances the Out JSON Profile feature to include filter criteria for Child Resources like remarks, reference numbers, and statuses. With Child Resource filters defined, only the records that satisfy the entered filter criteria will be included in the Out JSON Profile based REST resource response.

In the example below, Child Resource Filters have been configured for the Order Release Remarks, and Order Release Reference Numbers. In this example, the Child Resource Filters will limit the Child Resource responses to Order Release Remark Qualifiers of "COLOR", "ORDER_TYPE" and "OFFICE_CODE" and for the Order Release Reference Numbers, the responses will be limited to the Reference Number Qualifiers "BM", PO_NUMBER" and "DEPT".  Your Filter Criteria should be entered as comma-separated list of Qualifier IDs, as shown below.

Out JSON Profile Child Resource Filters

Out JSON Profile Child Resource Filters

The Child Resource section of the Out JSON Profile UI will not be available if there are no child resources available for the selected Resource ID.

The Child Resources Filter criteria is only supported for the following child resources:

  • orderReleases.remarks
  • orderReleases.refnums
  • orderReleases.statuses
  • orderReleases.lines.remarks
  • orderReleases.lines.refnums
  • shipments.remarks
  • shipments.refnums
  • shipments.statuses
  • shipments.stops.remarks
  • shipments.stops.refnums

Business Benefit: This feature allows you to filter your responses so that the most relevant/desired data are provided, improving both performance and efficiency in reporting and integration.

Steps to enable and configure

  1. You will need to enable the 26B Optional Feature - ENABLE APPLY CHILD FILTER ON OUT JSON PROFILE.  See the feature ENABLE APPLY CHILD FILTER ON OUT JSON PROFILE for more information.
  2. You will need to configure an Out JSON Profile to include your desired Child Resource Filter Criteria.  This page is accessed via Business Process Automation > Power Data > Integration > Out JSON Profiles.

Tips and considerations

The Child Resource section of the Out JSON Profile UI will not be available if there are no child resources available for the selected Resource ID.

The Child Resources Filter criteria is only supported for the following child resources:

  • orderReleases.remarks
  • orderReleases.refnums
  • orderReleases.statuses
  • orderReleases.lines.remarks
  • orderReleases.lines.refnums
  • shipments.remarks
  • shipments.refnums
  • shipments.statuses
  • shipments.stops.remarks
  • shipments.stops.refnums

Key resources

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