IGetAutomationsQueryOptions
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
Configuration options for loading automation metadata objects with query.
export interface IGetAutomationsQueryOptions
Properties
Property | Modifiers | Type | Description |
|---|---|---|---|
boolean | (ALPHA) (Optional) Specify if automationResult should be included in the response. | ||
boolean | (ALPHA) (Optional) Specify if referenced objects should be checked for access, so restricted ones appear in |
Property details
IGetAutomationsQueryOptions.includeAutomationResultpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
Specify if automationResult should be included in the response.
includeAutomationResult?: boolean;
Remarks
Defaults to false.
IGetAutomationsQueryOptions.includeUnavailableReferencespropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
Specify if referenced objects should be checked for access, so restricted ones appear in unavailable.
includeUnavailableReferences?: boolean;
Remarks
Covers visualizations, metrics, attributes, labels, facts and computed attributes. Defaults to false.