An array of action names, whose state is requested in the state object response.

Example

"actions": ["save","print"]

An array of child query definitions that specifies query requests for child resources.

• name - The alias name of the child resource for this query
• recursive - This Boolean parameter specifies whether the child resource is recursively expanded.
• queryDef - A query definition object for the child resource.

Example

"childDefs": [
   {
      "name":"transactionLines",
      "recursive":false,
      "queryDef": {
         "state" true,
         "fields":["lineField1","lineField2]
      }
   }
] 

This parameter is used to group Transaction Lines based on a Boolean value and menu options. It consists of the following properties:

• attributeName - The name of the attribute to group by (String).

• groupOffset - The starting point or offset for the group (Integer).

  Default value: 0

• groupLimit - The limit on the number of items to show in the group (Integer).

  Default value: 25

• expandGroups - A Boolean indicating whether to expand all groups. If false, only the first group will show items.

Example:

"childGroups": {"attributeName": "status_l", "groupOffset": 10, "groupLimit": 5, "expandGroups": true}

This Boolean parameter is used to enable hierarchical search and sort behaviors.

• true – hierarchical search and sort behaviors are enabled.

• false – standard search and sort behaviors are used. Default value is false.

This parameter allows exclusion of specified attribute types from the response.

View valid field types:

Example

"excludeFieldTypes": ["customerId","sequenceNumber"]

An array of child resource names that you want to expand so that the contents return with the parent in the same request.

"expand": ["transactionLines","accounts"]

A map of dynamic menu field names, whose expanded domains are requested in the state object response, to a map of criteria, which are meant for filtering dynamic menu options. The criteria map should contain the node(s) information when dynamic menus on LIG are expanded. The criteria map also contains the search string. The search strings support contains, and are case-insensitive.

An array of field names that returns expanded domains in the state object response. The field's domain object will be expanded to include an availableElements array.

Example

"expandedDomains": ["menuAttr1","menuAttr2"]

This Boolean parameter is used to expand nodes and is only be available when enableHierarchy is true.

• true All nodes will be expanded

• false All nodes will be collapsed. Default value is true.

An array of field names to be returned. The fields array values determine the "attributes" in the response's state object.

Example

"fields": ["field1","field2"]

An array of group names, whose state is requested in the state object response.
For example: group can correspond to UI tabs, and return the aggregated state information for all fields contained within the UI tab.

Example

"groups": ["tab_123","tab_234"]

This parameter specifies the state of layout rules which need to be fetched and executed.

By default, this value is set to NO_RULE indicating that layout rules is not executed. Allowed values: DEPLOYED, UNDEPLOYED, NO_RULE

A positive integer value that specifies the maximum number of items returned by the server.

An array of field names to specify the order of items returned in the response, each field name could optionally be followed by asc or desc. The default is "asc".

Example

"orderby": ["listPrice:asc","totalPrice:desc"]

An array of field names to include in the parentFields of each resource row.

This string declares a query specification expression in MongoDB format.

"q": "{'_part_number':{$eq:'part100'}}"

An array used to display specific fields of the root element for each row in the response, typically inside the _state attribute. Each item in this array corresponds to an attribute that is shown.

Example:

"rootFields": ["_part_number"]

This Boolean parameter specifies whether to include the state property.
By default, this value is set to false and the state property is not included.

Example

"state": false