@labkey/api
    Preparing search index...

    Interface Command

    interface Command {
        auditBehavior?: AuditBehaviorTypes;
        auditDetails?: Record<string, any>;
        auditUserComment?: string;
        command: CommandType;
        containerPath?: string;
        extraContext?: any;
        queryName: string;
        rows: any[];
        schemaName: string;
        skipReselectRows?: boolean;
    }
    Index

    Properties

    auditBehavior? auditDetails? auditUserComment? command containerPath? extraContext? queryName rows schemaName skipReselectRows?

    Properties

    auditBehavior?: AuditBehaviorTypes

    Can be used to override the audit behavior for the table the Command is acting on. SeeAuditBehaviorTypes.

    auditDetails?: Record<string, any>

    Optional audit details to record in the transaction audit log for this command.

    auditUserComment?: string

    Can be used to provide a comment from the user that will be attached to certain detailed audit log records.

    command: CommandType

    Name of the command to be performed. Must be one of "insert", "update", or "delete".

    containerPath?: string

    The container path in which the command is executed. If not supplied, the current container path will be used.

    extraContext?: any

    Experimental: Optional extra context object passed into the transformation/validation script environment.

    queryName: string

    Name of a query table associated with the chosen schema. See also: How To Find schemaName, queryName & viewName.

    rows: any[]

    An array of data for each row to be changed. See insertRows, updateRows, or deleteRows for requirements of what data must be included for each row.

    schemaName: string

    Name of a schema defined within the current container. See also: How To Find schemaName, queryName & viewName.

    skipReselectRows?: boolean

    Whether the full detailed response for the update/insert rows can be skipped. Defaults to false.

    Settings

    Member Visibility

    On This Page

    Properties