@servicenow/sdk - v4.7.0
    Preparing search index...

    Type Alias ToolInputType

    Tool input configuration for CRUD operations. This is the user-facing API that gets transformed into the complex inputs JSON.

    Supports all CRUD operations: create, update, lookup, delete

    type ToolInputType = {
        inputFields: ToolInputField[];
        limit?: number;
        operationName: RecordOperationName;
        orderBy?: string;
        queryCondition?: string;
        returnFields?: ToolReturnField[];
        sortType?: SortType;
        table: string | Table | Record<"sys_db_object">;
    }
    Index

    Properties

    inputFields limit? operationName orderBy? queryCondition? returnFields? sortType? table

    Properties

    inputFields: ToolInputField[]

    Input fields that the user provides

    limit?: number

    Optional: Maximum number of records to return (alternative to pagination.limit)

    operationName: RecordOperationName

    CRUD operation name

    orderBy?: string

    Optional: Field name to order results by (alternative to pagination.orderBy)

    queryCondition?: string

    Query condition string (e.g., 'email={{email}}') - alternative to query object

    returnFields?: ToolReturnField[]

    Fields to return after the operation

    sortType?: SortType

    Optional: Sort direction (alternative to pagination.sortType)

    table: string | Table | Record<"sys_db_object">

    Target table reference - can be a simple string (table name) or a TableReference object

    Settings

    Member Visibility

    On This Page

    Properties