Member Junction
    Preparing search index...

    Interface RunViewByIDSystemUserInput

    Input type for RunViewByIDSystemUser method calls - executes a saved view by its unique ID

    interface RunViewByIDSystemUserInput {
        AlternateBaseView?: string;
        AuditLogDescription?: string;
        DataSource?: "Live" | "Materialized";
        ExcludeDataFromAllPriorViewRuns?: boolean;
        ExcludeUserViewRunID?: string;
        ExtraFilter?: string | PlatformSQL;
        Fields?: string[];
        ForceAuditLog?: boolean;
        IgnoreMaxRows?: boolean;
        MaxRows?: number;
        OrderBy?: string | PlatformSQL;
        OverrideExcludeFilter?: string;
        ResultType?: string;
        SaveViewResults?: boolean;
        StartRow?: number;
        UserSearchString?: string;
        ViewID: string;
    }
    Index

    Properties

    AlternateBaseView? AuditLogDescription? DataSource? ExcludeDataFromAllPriorViewRuns? ExcludeUserViewRunID? ExtraFilter? Fields? ForceAuditLog? IgnoreMaxRows? MaxRows? OrderBy? OverrideExcludeFilter? ResultType? SaveViewResults? StartRow? UserSearchString? ViewID

    Properties

    AlternateBaseView?: string

    Optional registered Alternate Base View logical Name (from EntityAlternateBaseView.Name) for this entity.

    AuditLogDescription?: string

    Description for the audit log entry if ForceAuditLog is true (optional)

    DataSource?: "Live" | "Materialized"

    Optional source-of-truth selector ('Live' or 'Materialized').

    ExcludeDataFromAllPriorViewRuns?: boolean

    Whether to exclude data from all prior view runs (optional)

    ExcludeUserViewRunID?: string

    ID of a previous view run to exclude results from (optional)

    ExtraFilter?: string | PlatformSQL

    Additional WHERE clause conditions to apply (optional). Accepts a plain string or a PlatformSQL object for multi-platform support. PlatformSQL objects are resolved to strings before GraphQL transport.

    Fields?: string[]

    Specific fields to return, if not specified returns all fields (optional)

    ForceAuditLog?: boolean

    Whether to force audit logging for this view execution (optional)

    IgnoreMaxRows?: boolean

    Whether to ignore the view's MaxRows setting and return all results (optional)

    MaxRows?: number

    Maximum number of rows to return, overrides view setting if specified (optional)

    OrderBy?: string | PlatformSQL

    ORDER BY clause for sorting results (optional). Accepts a plain string or a PlatformSQL object for multi-platform support. PlatformSQL objects are resolved to strings before GraphQL transport.

    OverrideExcludeFilter?: string

    Override the exclude filter with custom logic (optional)

    ResultType?: string

    Type of result format: "simple", "entity_object", etc. (optional)

    SaveViewResults?: boolean

    Whether to save the view execution results for future reference (optional)

    StartRow?: number

    Starting row number for pagination (optional, 0-based)

    UserSearchString?: string

    Search string to filter results across searchable fields (optional)

    ViewID: string

    Unique identifier of the saved view to execute

    Settings

    Member Visibility

    On This Page

    Properties