Task Type
This parameter defines the type of data query to execute against the Lansweeper API. It determines which data sets are collected and which additional parameters are applicable.
Technical Name |
type |
Category |
Functional |
Type |
Select |
Default Value |
n/a |
Available Options |
•all — Get all data at once •sites — Get sites •accounts — Get accounts •users — Get users •relations — Get relations •software — Get software •assets — Get assets •query — Free GraphQL query |
Asset Types
This parameter specifies a comma-separated list of asset types to filter the assets query. It is applicable only when the task type is set to assets.
Technical Name |
asset_types |
Category |
Technical |
Type |
String |
Default Value |
n/a |
Example Values |
Network device, Location |
Free GraphQL Query
This parameter contains a custom GraphQL query to execute against the Lansweeper API. It is applicable only when the task type is set to query.
Technical Name |
query |
Category |
Technical |
Type |
String |
Default Value |
n/a |
Example Values |
{empty} |
Free GraphQL Query Result Table
This parameter specifies the name for the result table of the free GraphQL query. It is applicable only when the task type is set to query.
Technical Name |
table_name |
Category |
Technical |
Type |
String |
Default Value |
n/a |
Example Values |
{empty} |
Free GraphQL Query Item Path
This parameter defines the path to the items within the result of the free GraphQL query. It is applicable only when the task type is set to query.
Technical Name |
collection_path |
Category |
Technical |
Type |
String |
Default Value |
n/a |
Example Values |
{empty} |
Page Size
This parameter defines the number of records retrieved per API request. It is applicable only when the task type is set to assets or software.
Technical Name |
page_size |
Category |
Technical |
Type |
Integer |
Default Value |
100 |
Example Values |
100 |
It is recommended to change this value only if there are connection issues or rate limitations. A higher page size reduces the number of requests but may increase the duration of each individual request.
|
Be aware: The Lansweeper API may impose limits on the maximum page size. Consult the Lansweeper API documentation for current limits. |
