OpenMeta
HomeDocumentationOpenAPIAbout
HomeDocumentationOpenAPIAbout
Github
  1. Model APIs
  • Model APIs
    • copyById
      POST
    • copyByIdAndFetch
      POST
    • copyByIds
      POST
    • copyByIdsAndFetch
      POST
    • count
      POST
    • createList
      POST
    • createListAndFetch
      POST
    • createOne
      POST
    • createOneAndFetch
      POST
    • deleteById
      POST
    • deleteByIds
      POST
    • deleteBySliceId
      POST
    • getById
      POST
    • getByIds
      POST
    • getCopyableFields
      GET
    • getRowFiles
      GET
    • getUnmaskedField
      GET
    • getUnmaskedFields
      GET
    • searchList
      POST
    • searchName
      POST
    • searchPage
      POST
    • searchPivot
      POST
    • searchSimpleAgg
      POST
    • updateByFilter
      POST
    • updateList
      POST
    • updateListAndFetch
      POST
    • updateOne
      POST
    • updateOneAndFetch
      POST
    • uploadFile
      POST
    • uploadFileToRow
      POST
  • Toolkit
    • fixUnencryptedData
    • recompute
    • validateExpression
  • ChangeLog
    • getChangeLog
    • getSliceChangeLog
    • searchPage
    • searchPageByModel
  • File Record
    • getByFileId
  • Import Template
    • getTemplateFile
    • listByModel
  • SysPreData
    • loadData
    • uploadFile
  • SysView
    • getModelViews
    • setDefaultView
  • Data Export
    • dynamicExport
    • exportByFileTemplate
    • exportByTemplate
  • Import
    • importWithoutTemplate
    • importByTemplate
  • Metadata Upgrade API
    • reload
    • upgrade
  • Export Template
    • listByModel
  • DeptInfo
    • readCustomize
  • AiRobot
    • Chat API
    • Stream Chat
  • DocumentTemplate
    • generateDocument
  • FlowConfig
    • getByModel
    • getFlowById
  • SysCron
    • Execute multiple for once now
    • Execute once now
  • SysModel
    • getModelFields
  • SysOptionSet
    • getOptionSetItems
  • Flow Automation
    • API Event
    • Onchange Event
    • Simulate Event Message
  • DesignAppEnv
    • getNotVersionedChanges
    • mergeBetweenEnv
    • previewBetweenEnv
  • DesignAppVersion
    • createOne
    • publish
    • reloadAppVersion
  • DesignModel
    • downloadCode
    • downloadZip
    • previewCode
    • previewDDL
  1. Model APIs

updateByFilter

POST
/{modelName}/updateByFilter
Model APIs
Batch update data according to the filters, within the current user's permission scope.

Request

Path Params
modelName
string 
required
Body Params application/json
effectiveDate
string <date>
optional
Effective date for timeline model, default is Today.
filters
object (Filters) 
optional
Support nested filters, such as [a OR b] AND [c OR d OR [e AND f] OR g]
[]
["name", "=", "Tom"]
[["name", "=", "Tom"], ["version", "=", "6"]]
[["name", "=", "Tom"], "OR", ["code", "=", "A010"], "OR", ["version", "=", "2"]]
[["name", "=", "Tom"], "OR", ["code", "=", "A010"]], "AND", ["version", "=", "2"]]
Example:
["name","=","PM"]
values
object 
optional
Field values to be set.
Additional properties
object 
optional
Field values to be set.
Example
{
    "effectiveDate": "2019-08-24",
    "filters": [
        "name",
        "=",
        "PM"
    ],
    "values": {
        "property1": {},
        "property2": {}
    }
}

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST '//updateByFilter' \
--header 'Content-Type: application/json' \
--data-raw '{
    "effectiveDate": "2019-08-24",
    "filters": [
        "name",
        "=",
        "PM"
    ],
    "values": {
        "property1": {},
        "property2": {}
    }
}'

Responses

🟢200OK
*/*
OK
Body
code
integer <int32>
optional
Status Code
data
object (FileInfo) 
optional
Result Data
checksum
string 
optional
Checksum
fileId
string 
optional
File ID
fileName
string 
optional
File Name
fileType
enum<string> 
optional
File Type
Allowed values:
JPGPNGWEBPBMPTIFSVGGIFICOCSVTXTDOCDOCXPPTPPTXXLSXLSXPDFJSONXMLYAMLZIPGZIPTARRARGZMP3WAVAACOGGFLACMP4AVIMOVWMVFLV
size
integer <int32>
optional
File Size (KB)
url
string 
optional
Temporary Download URL
message
string 
optional
Common Message
Example
{
    "code": 0,
    "data": {
        "checksum": "string",
        "fileId": "string",
        "fileName": "string",
        "fileType": "JPG",
        "size": 0,
        "url": "string"
    },
    "message": "string"
}
Modified at 2025-04-04 11:36:48
Previous
searchSimpleAgg
Next
updateList
Built with