Out JSON Profiles

This page is accessed via Business Process Automation > Power Data > Integration > Out JSON Profiles.

Out JSON Profiles allow you to indicate what level of resource content is returned when REST resources are accessed. For example, you could get links for all child resource lines, statuses, reference numbers, and ship units, but not the complete details. You may want to get the complete details for multiple child resources, or not need to get all the attributes and children of a resource. Creating profiles helps you manage what level of data is returned for each resource.

Adding an Out JSON Profile

1. Enter an Out JSON Profile ID.
2. Select a Domain Name from the drop-down list.
3. Enter a Description.
4. Select the Expand All check box to get the child resources along with the parent resource when you query a hierarchical resource. If you select the Expand All field, all child resources are returned, so you cannot indicate specific child resources in the profile.
5. Select the Expand Reference check box to expand referenced resource information. For example, on an order release, you can show the source location ID or the entire source location information if you select this field.
6. Select the Expand References Full check box to control whether or not referenced resource attributes are shown when the Expand All field is selected. For example, if you have reference resources at a shipment stop, those reference resource details will be retrieved when both Expand All and Expand References Full are selected.
7. Select a Root Resource ID to limit the possible resource IDs available.
8. Select a Resource ID that you want to manage in this profile. For example, you can limit what it returned for this specific resource by selecting fields in the following section.

Fields

The fields displayed are determined by the resource ID you selected.

1. Enter a Field to include the returned data.

   Note: If you do not select any fields, then all fields are considered added.

2. Click Save for each record you define.

Child Resources

This section is not available if you selected the Expand All field. In that situation, all child resources will be returned. The section is also not available if there are no child resources available for the selected Resource ID.

1. Enter a Child Resource to include in the data returned.
2. Use a Child Out JSON Profile ID to add other out JSON profiles to this profile. For example, if you have a separate out JSON profile for shipment stops, you can reference it here in the profile for shipments, thereby including your shipment stop preferences with your shipment level preferences. If you do not first select a Child Resource, you cannot use the Child Out JSON Profile ID field.
3. Click Save for each record you define.
4. Click Finished.