@oneblink/sdk
    Preparing search index...

    Type Alias SearchDataManagerRecordsOptions

    type SearchDataManagerRecordsOptions = {
        filters?: {
            dateTimeSubmitted?: {
                $eq?: string;
                $gt?: string;
                $gte?: string;
                $lt?: string;
                $lte?: string;
            };
            externalId?: DataManagerRegexFilter;
            submission?: Record<string, DataManagerSubmissionPropertyFilter>;
            submissionId?: DataManagerUUIDFilter;
            submittedBy?: DataManagerRegexFilter;
        };
        formId: number;
        paging?: { limit?: number; offset?: number };
        sorting?: { direction: "ascending" | "descending"; property: string }[];
        unwindRepeatableSets?: boolean;
    }
    Index

    Properties

    filters? formId paging? sorting? unwindRepeatableSets?

    Properties

    filters?: {
        dateTimeSubmitted?: {
            $eq?: string;
            $gt?: string;
            $gte?: string;
            $lt?: string;
            $lte?: string;
        };
        externalId?: DataManagerRegexFilter;
        submission?: Record<string, DataManagerSubmissionPropertyFilter>;
        submissionId?: DataManagerUUIDFilter;
        submittedBy?: DataManagerRegexFilter;
    }

    Type Declaration

    • OptionaldateTimeSubmitted?: { $eq?: string; $gt?: string; $gte?: string; $lt?: string; $lte?: string }

      Filter by dateTimeSubmitted. All values as a date ISO string: https://en.wikipedia.org/wiki/ISO_8601

      • Optional$eq?: string

        Equal to

      • Optional$gt?: string

        Greater than

      • Optional$gte?: string

        Greater than or Equal to

      • Optional$lt?: string

        Less than

      • Optional$lte?: string

        Less than or Equal to

    • OptionalexternalId?: DataManagerRegexFilter

      Filter by externalId.

    • Optionalsubmission?: Record<string, DataManagerSubmissionPropertyFilter>

      Filter by values in the submission.

    • OptionalsubmissionId?: DataManagerUUIDFilter

      Filter by submissionId. A uuid string.

    • OptionalsubmittedBy?: DataManagerRegexFilter

      Filter by submittedBy.

    formId: number
    paging?: { limit?: number; offset?: number }

    Type Declaration

    • Optionallimit?: number

      Limit results to between 1 and 50. Used for pagination. Default: 50

    • Optionaloffset?: number

      Offset results. Used for pagination. Default: 0

    sorting?: { direction: "ascending" | "descending"; property: string }[]

    Sort results.

    Type Declaration

    • direction: "ascending" | "descending"

      The direction to sort this property by.

    • property: string

      The property to sort by e.g. "submission.Element_Name"

    unwindRepeatableSets?: boolean

    Required for filtering by repeatableSets

    Settings

    Member Visibility

    On This Page

    Properties