IGetAutomationsOptions
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
Configuration options for loading automation metadata objects.
export interface IGetAutomationsOptions
Properties
Property | Modifiers | Type | Description |
|---|---|---|---|
number | (ALPHA) (Optional) Specify number of items per page. Default: 50 | ||
boolean | (ALPHA) (Optional) Specify if information about the users that created/modified the exportDefinitions should be loaded for each exportDefinition. | ||
number | (ALPHA) (Optional) Specify (zero-based) starting offset for the results. Default: 0 |
Property details
IGetAutomationsOptions.limitpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
Specify number of items per page. Default: 50
limit?: number;
IGetAutomationsOptions.loadUserDatapropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
Specify if information about the users that created/modified the exportDefinitions should be loaded for each exportDefinition.
loadUserData?: boolean;
Remarks
Defaults to false.
IGetAutomationsOptions.offsetpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
Specify (zero-based) starting offset for the results. Default: 0
offset?: number;