@labkey/api
    Preparing search index...

    Interface UpdateParticipantGroupOptions

    interface UpdateParticipantGroupOptions {
        containerPath?: string;
        deleteParticipantIds?: string[];
        description?: string;
        ensureParticipantIds?: string[];
        failure?: RequestFailure<any>;
        filters?: any;
        label?: string;
        participantIds?: string[];
        rowId: number;
        scope?: any;
        success?: RequestSuccess<any>;
    }

    Hierarchy (View Summary)

    Index

    Properties

    containerPath? deleteParticipantIds? description? ensureParticipantIds? failure? filters? label? participantIds? rowId scope? success?

    Properties

    containerPath?: string

    The container path in which the relevant study is defined. If not supplied, the current container path will be used.

    deleteParticipantIds?: string[]

    Set of IDs to be removed from the group if they are already members

    description?: string

    The new value for the description of the group

    ensureParticipantIds?: string[]

    Set of IDs to be added to the group if they are not already members

    failure?: RequestFailure<any>

    This will be called upon failure to complete a request.

    filters?: any
    label?: string

    The new value for the label of the group

    participantIds?: string[]

    Set of IDs to be members of the group

    rowId: number

    The integer ID of the desired participant group

    scope?: any

    A scoping object for the success and failure callback functions (default to this).

    success?: RequestSuccess<any>

    This will be called upon successfully completing a request.

    Settings

    Member Visibility

    On This Page

    Properties