BoApiRequestEntities

A encrypted value that contains sensitive information required to make api calls.

A language in which response data will be returned.

Fields that will be returned in response by querying specific entity. Fields are defined in the form of a list.

The fields of the linked entities are written in JSON format in the form: {"[Entity1]": "[Entity1].[FieldName1],[Entity1].[FieldName2]", "[Entity2]": "[Entity2].[FieldName1]"...}.

Filters can more deeply filter requested data by applying custom rules. Filters contain specific syntax that must be followed in order for the data to be filtered correctly. The syntax is as follows: { "AND"/"OR": [ [ { "FIELD1": { "is": "123" } }, { "FIELD2": { "ilike": "%abc%" } } ] ], "AND" / "OR": [ [ { "FIELD3": { "in": "127999" } } ] ] } Supported equality operators are: IN, ILIKE, ISNOT, LTE, GTE, LT, GT, IS

It will additionally filter each instance retrieved by the request with the corresponding active period set on the specific instance.

Will return all media data that any entity instance contains for specified media types. Media types are defined in the form of a list.

All returned data can be sort by specifing fields to sort. Sorting can only be possible for main entities, not related entities. Sorting is defined in the form of a JSON list by specifing name of field and direction as "ASC" for ascending and "DESC" for descending: [{"Field": "Field1,"Direction": "ASC/DESC"},{"Field": "Field2","Direction": "ASC/DESC"}]

Pagination functionality used to get virtually paginate data by combining elements: Total, Offset, Limit. Pagination example for 2 virtual pages: { "Total": 6, "Offset": 0, "Limit": 3}