@labkey/api
    Preparing search index...

    Interface MoveRowsResponse

    Interface to describe the first object passed to the successCallback function by updateRows, insertRows or deleteRows. This object's properties are useful for matching requests to responses, as HTTP requests are typically processed asynchronously. Additional Documentation:

    {
     "schemaName": "lists",
     "queryName": "API Test List",
     "rowsAffected": 1,
     "command": "insert",
     "errors": [],
     "rows": [{ Key: 3, StringField: 'NewValue'}]
    }
    interface MoveRowsResponse {
        command: CommandType;
        containerPath?: string;
        error?: string;
        errors: any[];
        field?: string;
        queryName: string;
        rows: any[];
        rowsAffected: number;
        schemaName: string;
        success: boolean;
        updateCounts?: Record<string, number>;
    }

    Hierarchy (View Summary)

    Index

    Properties

    command containerPath? error? errors field? queryName rows rowsAffected schemaName success updateCounts?

    Properties

    command: CommandType

    Will be "update", "insert", or "delete" depending on the API called.

    containerPath?: string

    The container path in which the rows were moved.

    error?: string

    A string describing any error that occurred during the action.

    errors: any[]

    Objects will contain the properties 'id' (the field to which the error is related, if any), and 'msg' (the error message itself).

    field?: string
    queryName: string

    Contains the same queryName the client passed to the calling function.

    rows: any[]

    Array of rows with field values for the rows updated, inserted, or deleted, in the same order as the rows supplied in the request. For insert, the new key value for an auto-increment key will be in the returned row's field values. For insert or update, the other field values may also be different than those supplied as a result of database default expressions, triggers, or LabKey's automatic tracking feature, which automatically adjusts columns of certain names (e.g., Created, CreatedBy, Modified, ModifiedBy, etc.).

    rowsAffected: number

    Indicates the number of rows affected by the API action. This will typically be the same number of rows passed in to the calling function.

    schemaName: string

    Contains the same schemaName the client passed to the calling function.

    success: boolean

    Indicates if the action was successful.

    updateCounts?: Record<string, number>

    An object with key/value pairs describing the number of items moved during the action.

    Settings

    Member Visibility

    On This Page

    Properties