forInsightByRef()
Home > @gooddata/sdk-backend-spi > IExecutionFactory > forInsightByRef
IExecutionFactory.forInsightByRef() method
Prepares new, by-reference execution for an existing insight.
Signature:
forInsightByRef(insight: IInsight, filters?: INullableFilter[], options?: IPreparedExecutionOptions): IPreparedExecution;
Parameters
| Parameter | Type | Description |
|---|---|---|
| insight | IInsight | saved insight |
| filters | INullableFilter[] | (Optional) optional list of filters to merge with filters already defined in the insight, may contain null or undefined values which must be ignored |
| options | IPreparedExecutionOptions | (Optional) additional options for the prepared execution |
Returns:
Remarks
Execution prepared using this method MAY be realized using different backend API than the executions where attributes and measures are provided 'freeform'. In return, this different backend API may provide additional authorization guarantees - for instance the backend MAY only allow end user to execute these stored insights and not do any 'freeform' execution.
If the backend does not support execution by reference, then it MUST fall back to freeform execution.
The contract is that prepared executions created by this method MUST be executable and MUST come with pre-filled dimensions created using the defaultDimensionsGenerator().