Query operations
dataSource
Fetch a single data source with the given id
| Argument | Data type | Description |
|---|---|---|
| id | Int |
Returns: DataSource
dataSourceGroup
Fetch a single data source group with the given id
| Argument | Data type | Description |
|---|---|---|
| id | Int |
Returns: DataSourceGroup
dataSourceGroups
Fetch data source groups in the specified module
| Argument | Data type | Description |
|---|---|---|
| module | Int | The module to fetch data source groups from |
Returns: DataSourceGroup
dataSources
Fetch data sources in the specified module
| Argument | Data type | Description |
|---|---|---|
| module | Int | The module to fetch data sources from |
| parent | Int | Fetch data sources that are children of this parent, omit to fetch root level data sources |
Returns: DataSource
field
Fetch a single field definition with the given id
| Argument | Data type | Description |
|---|---|---|
| id | Int |
Returns: Field
fields
Fetch field definitions in the specified module
| Argument | Data type | Description |
|---|---|---|
| module | Int | The module to fetch field definitions from |
Returns: Field
fileEntries
Fetch file entries that belong to the specified item
| Argument | Data type | Description |
|---|---|---|
| deleted | Boolean | Whether to fetch deleted file entries or not |
| item | Int | The item to fetch file entries from |
| updatedAfter | DateTime | Only fetch file entries updated after this timestamp |
Returns: FileEntry
fileEntry
Fetch a single file entry with the given id
| Argument | Data type | Description |
|---|---|---|
| id | Int |
Returns: FileEntry
group
Fetch a single group with the given id
| Argument | Data type | Description |
|---|---|---|
| id | Int |
Returns: Group
groups
Fetch groups
| Argument | Data type | Description |
|---|---|---|
| Do not take any arguments |
Returns: Group
itemBySequenceId (Added in 2024.11)
Fetch a single item by id
| Argument | Data type | Description |
|---|---|---|
| sequenceId | Int | |
| module | Int |
Returns: Item
item
Fetch a single item by id
| Argument | Data type | Description |
|---|---|---|
| id | Int |
Returns: Item
itemType
Fetch a single item type with the given id
| Argument | Data type | Description |
|---|---|---|
| id | Int |
Returns: ItemType
itemTypes
Fetch available item types in the specified module
| Argument | Data type | Description |
|---|---|---|
| module | Int | The module to fetch item types from |
Returns: ItemType
items
Fetch items in the specified module
| Argument | Data type | Description |
|---|---|---|
| deleted | Boolean | Whether to fetch deleted items or not |
| itemType | Int | Only fetch items with this item type |
| limit | Int | The result limit for the query |
| module | Int | The module to fetch items from |
| offset | Int | The result offset for the query |
| updatedAfter | DateTime | Only fetch items updated after this timestamp |
Returns: Item
message
Fetch a single message with the given id
| Argument | Data type | Description |
|---|---|---|
| id | Int |
Returns: Message
messages
Fetch messages (emails) that belong to the specified item
| Argument | Data type | Description |
|---|---|---|
| deleted | Boolean | Whether to fetch deleted messages or not |
| item | Int | The item to fetch messages from |
| updatedAfter | DateTime | Only fetch messages updated after this timestamp |
Returns: Message
modules
Fetch available modules
| Argument | Data type | Description |
|---|---|---|
| Do not take any arguments |
Returns: Module
operation
Fetch a single operation role with the given id
| Argument | Data type | Description |
|---|---|---|
| id | Int |
Returns: OperationRole
operations
Fetch operation roles
| Argument | Data type | Description |
|---|---|---|
| Do not take any arguments |
Returns: OperationRole
role
Fetch a single role with the given id
| Argument | Data type | Description |
|---|---|---|
| id | Int |
Returns: Role
roles
Fetch roles
| Argument | Data type | Description |
|---|---|---|
| Do not take any arguments |
Returns: Role
transaction
Fetch a single transaction item with the given id
| Argument | Data type | Description |
|---|---|---|
| id | Int |
Returns: TransactionItem
transactions
Fetch transaction items that belong to the specified item
| Argument | Data type | Description |
|---|---|---|
| deleted | Boolean | Whether to fetch deleted transactions or not |
| includePreliminary | Boolean | Whether to include preliminary transaction items, defaults to false |
| item | Int | The item to fetch transaction items from |
| itemType | Int | Only fetch transaction items with this item type |
| limit | Int | The result limit for the query |
| offset | Int | The result offset for the query |
| updatedAfter | DateTime | Only fetch transactions updated after this timestamp |
Returns: TransactionItem
user
Fetch a single user with the given id
| Argument | Data type | Description |
|---|---|---|
| id | Int |
Returns: User
users
Fetch users
| Argument | Data type | Description |
|---|---|---|
| deleted | Boolean | Whether to fetch deleted users or not |
| limit | Int | The result limit for the query |
| offset | Int | The result offset for the query |
| updatedAfter | DateTime | Only fetch users updated after this timestamp |
Returns: User