Table of contents

Description

The view object is responsible for determining the range of the search result.

Structure

Key JSONKey XMLOccursTypeFormatDescription
-offset0 - 1string

Defines the starting position of the returned result.

childrenchildren0 - 1boolean

Query subusers

  • false = Subusers are not queried
  • true = Subusers are queried

Default value = false

For XML, 0 (false) and 1 (true) can also be used.

limit limit0 - 1string
Maximum number of objects to be displayed.
fromto0 - 1stringdate-time

End Date - Required for Historical Task. 

e.g. 2021-01-01 00:00:00

toto0 - 1stringdate-time

Start Date - Required for Historical Task.

2022-01-01 00:00:00

XML Example

Request
"view": {
	 "children": true,
	 "limit": 10,
	 "offset": 0,
     "from": "2022-01-01 00:00:00",
	 "to": "2021-01-01 00:00:00"
}
XML
<view>
    <limit>10</limit>
    <offset>0</offset>
    <children>0</children>
	<from>2022-01-01 00:00:00</from>
	<to>2021-01-01 00:00:00</to>
</view>