State Object

Administration

The State Object queries allow filtering of state data in responses based on the query object provided in request body for action APIs.

Empty array fields are not allowed for attributes. When an empty array is used in the criteria object for actions, groups, the corresponding state object will be omitted from the response. When an empty array is used in the criteria object for expanded domains, all attribute domains returned in the state object will omit the "available" elements property.

Attributes: Returns the state data for specified attributes. Use the attribute variable names to specify arrays in the criteria "fields" property. State data for all attributes is returned when criteria "fields" are not specified in the request body.

Transaction Line Total Attribute Queries: When a layout has auto sum enabled for an attribute, all of the Transaction Line values for that attribute are added. The total displays at the bottom of Line Item Grid. Administrators can request total values by using the advanced query object and totals data returns as part of the state object.

Advanced Query Sample
The following sample shows the request and response for a "price_quantity" attribute query.

Request Sample
```
{
  "criteria": {
    "state": true,
    "childDefs": [{
        "name": "lineItem",
        "queryDef": {
          "state": true,
          "statistics": [{
              "attributeName": "_price_quantity",
              "type": ["unfilteredTotal"]
            }
          ]
        }
      }
    ]
  }
}
```
Response Sample
```
"lineItem": {
   ..."_state": {
      ..."statistics": [{
            attributeName: "_price_quantity",
            "unfilteredTotal": 100
         }],
      ...
   }
}
```
Actions: Returns the state data for specified actions. Use the action variable names to specify arrays in the criteria "actions" property. State data for all actions is returned when criteria "actions" are not specified in the request body.
Groups: Returns the state data for specified groups. Use group expressions to specify arrays in the criteria "groups" property. State data for all groups is returned when criteria "groups" are not specified in the request body. The expression for a group is the same as is returned in a response; for example, to refer to a tab with an id of 18253632, use the expression "tab_18253632".
Expanded Domains: Returns the available elements data for specified attributes. Use the attribute variable names to specify arrays in the criteria "expandedDomains" property. State data for all elements is returned when criteria "expandedDomains" are not specified in the request body.

State Object Support

Transaction data services can now return state objects, if requested in the request body. For example: {"criteria": "state": "true"}. For more information, refer to Data Service Actions and Criteria Parameter Queries. The following table lists the state objects that are returned for transactions, transaction line lists, transaction lines, actions, attributes, domains, and groups.

State Object	Transaction	Transaction Line List	Transaction Line	Action	Attribute	Domain	Group
actions	x		x
attributes	x		x
availableElements						x
constraintList						x
constraintType						x
defaultRowState		x
deletable			x
domain					x
enabled				x
groups	x		x
hasConstraintViolation					x
hasError	x		x		x		x
insertable		x
messages	x				x
queryable		x
required					x
sortable		x
updatable			x		x
visible				x	x		x

State Object

Administration

State Object Support

Related Topics