@modelhealth/modelhealth
    Preparing search index...

    Interface SubjectListOptions

    Named filters for SubjectsResource.list.

    All fields are optional — omit any to leave that filter unconstrained.

    interface SubjectListOptions {
        activityComplete?: boolean;
        activityType?: number | ActivityTypeInfo;
        createdAfter?: string | Date;
        createdBefore?: string | Date;
        createdBy?: number[];
        groups?: string[];
        limit?: number;
        orderBy?: SubjectOrderBy;
        search?: string;
        session?: string | Session;
        tags?: string[];
    }
    Index
    activityComplete? activityType? createdAfter? createdBefore? createdBy? groups? limit? orderBy? search? session? tags?
    activityComplete?: boolean

    Only subjects whose activities have (true) or have not (false) all finished analysis.

    activityType?: number | ActivityTypeInfo

    Only subjects with at least one activity of this type. Accepts a type from ModelHealthClient.activityTypes or its id.

    createdAfter?: string | Date

    Only subjects created on or after this date (inclusive). A Date counts as the day it falls on in the local time zone, not in UTC. A string must read YYYY-MM-DD.

    createdBefore?: string | Date

    Only subjects created on or before this date (inclusive). A Date counts as the day it falls on in the local time zone, not in UTC. A string must read YYYY-MM-DD.

    createdBy?: number[]

    Only subjects belonging to one of these accounts, by numeric account id.

    groups?: string[]

    Only subjects belonging to one of these subject groups (group ids as strings).

    limit?: number

    Caps the total number of subjects the stream yields across the whole iteration. Omit to iterate every match.

    orderBy?: SubjectOrderBy

    Field to sort by. Defaults to "name".

    search?: string

    Free-text search against the subject's name.

    session?: string | Session

    Only the subject calibrated under this session. Accepts a Session or its id.

    tags?: string[]

    Only subjects carrying every tag in this list.

    Settings
    Member Visibility

    On This Page
    Properties