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 full)

Properties

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

Properties

OptionalcontainerPath

containerPath?: string

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

OptionaldeleteParticipantIds

deleteParticipantIds?: string[]

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

Optionaldescription

description?: string

The new value for the description of the group

OptionalensureParticipantIds

ensureParticipantIds?: string[]

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

Optionalfailure

failure?: RequestFailure<any>

This will be called upon failure to complete a request.

Optionalfilters

filters?: any

Optionallabel

label?: string

The new value for the label of the group

OptionalparticipantIds

participantIds?: string[]

Set of IDs to be members of the group

rowId

rowId: number

The integer ID of the desired participant group

Optionalscope

scope?: any

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

Optionalsuccess

success?: RequestSuccess<any>

This will be called upon successfully completing a request.

Settings

Member Visibility

On This Page

Properties