Application API
  1. V2
Application API
  • V3 (AI-friendly-beta)
    • Overview
    • Field Type Comparison Table
    • Guidelines for Using Filters
    • Error Code
    • application
      • Get application information
    • worksheet
      • Get worksheet structure information
      • Edit the worksheet
      • Delete worksheets
      • Create worksheet
    • worksheet Row Records
      • Get a list of line records
      • Get line record details
      • Update line records
      • Delete line records
      • Get relation records
      • Create a new row record
      • Add new line records in batches
      • Batch update line records
      • Batch delete row records
      • Obtain line record perspective data
      • Get record sharing links
      • Get a row record log
      • Get line record discussion
    • option set
      • Get a list of option sets
      • Create an option set
      • Edit option set
      • Delete option set
    • workflow
      • Get a list of processes
      • Get process details
      • Trigger process
    • role
      • Get a list of roles
      • create role
      • Get role details
      • remove roles
      • Add role members
      • Remove role members
      • Members withdraw from all roles
    • public query
      • find members
      • Find departments
      • Get regional information
  • V2
    • Development Guide
    • ErrorCode
    • Filter Demo
    • Filter
    • Options Set
      • Add Option Set
      • Get Option Set
      • Edit Option Set
      • Delete Option Set
    • Application Role
      • Get Application Role List GET
      • Create Application Role
      • Delete Application Role
      • Add Application Role Member
      • Remove Application Role Member
      • Exit application
      • Get Role Details
    • worksheet
      • Create Worksheet
      • Get worksheet structure information
      • Get List
      • Create Row Record
      • Batch Create Row Records
      • Get Row Record Details
      • Get row record details
      • Update Row Record Details
      • Batch Update Row Record Details
      • Delete Row Record
      • Get associated record
      • Get Record Share Link
      • Get total row count of worksheet
      • Get Row Record Log
    • app
      • Get Application Information
    • Public Inquiries
      • Get regional Information
    • Get Row Record Discussions
      POST
  1. V2

Filter

Filter

Depending on the field type, filter is spliced ​​according to the following rules. Reference: Development Guide

ParameterRequiredTypeDescription
controlIdYesstringField ID
dataTypeYesnumberControl type number, enumeration value DataTypeEnum Please refer to the directory below
spliceTypeYesnumberSplicing method, 1:And 2:Or
filterTypeYesnumberFilter type, enumeration value FilterTypeEnum Please refer to the directory below
values ​​Nolist[string]According to the filter type, pass multiple values, pass special AccountID, please refer to the directory below
valueNostringAccording to the filter type, pass a single value, pass special AccountID, please refer to the directory below
dateRangeNonumberDate range, enumeration value DateRangeEnum Please refer to the directory below
dateRangeTypeNonumberDate range type, 1: day 2: week 3: month 4: quarter 5: year
minValueNostringMinimum value
maxValueNostringMaximum value
isAscNobooleanAscending order (false: descending order)
isGroupNobooleanWhether the current filter condition is a filter group. If true, the groupFilters parameter needs to be passed. Only one layer of filter groups is supported
groupFiltersNolist[object]Filter group list. The object is a filter object

DataTypeEnum

Enumeration valueControl typeDescription
2TextSingle line, multiple lines
3PhoneMobile phone
4PhoneLandline
5Email
6Value
7Certificate
8Amount
9Single choiceFlat
10Multiple choice
11Single choiceDrop-down
14Attachment
15DateDate: Year-Month-Day
16DateDate: Year-Month-Day Hour:Minute
19RegionRegion: Province
21Free connection
22Segmentation
23RegionRegion: Province/City
24RegionRegion: Province/City/County
25Amount in capital letters
26Member
27Department
28Level
29Related records
30Other table fields
31FormulaCalculation result is number
32Text combination
33Auto number
34Subtable
35Cascade selection
36Check box
37Summarize
38FormulaCalculation result is date
40Positioning
41Rich text
42Signature
45Embed
46Time
47Barcode
48Organization role
49API query
50API query
51Query record
10010Note

FilterTypeEnum

Enumeration valueEnumeration characterDescription
0Default
1LikeContains
2EqIs (equal to)
3StartStarts with
4EndEnds with
5NContainDoes not contain
6NeIs not (not equal to)
7IsNullIs Null
8HasValueIs not Null
11BetweenBetween
13Gt>
14Gte>=
15Lt<
16Lte<=
17DateEnumDate is
18NDateEnumDate is not
21MySelfWhat I own
22UnReadUnread
23SubSubordinate
24RCEqAssociated Control Is
25RCNeAssociated Control Is Not
26ArrEqArray Equals
27ArrNeArray Not Equals
31DateBetweenIn Range

Special AccountID

IDDescription
user-selfCurrent user
user-subSubordinate
user-workflowWorkflow
user-apiAPI
Modified at 2025-08-21 08:51:43
Previous
Filter Demo
Next
Add Option Set
Built with