English
Query Approval Task Object List by Conditions
About 691 wordsAbout 2 min
2026-01-19
Description
Query a list of approval task objects based on specified conditions.
Request Specification
Method: POST + application/json
Path: https://${cloud domain}/cgi/crm/v2/data/query?thirdTraceId=${random string}
Headers: Refer to Common Parameters
Request Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| includeNull | Boolean | No | Whether to include null fields. false: not returned, true: returned. Default is false |
| data | Map | Yes | Data map |
| dataObjectApiName | String | Yes | Object API name, fixed value: ApprovalTaskObj |
| find_explicit_total_num | Boolean | No | Whether to return total count (true: returns total, false: skips total count. Default: true. Setting false improves response speed) |
| search_query_info | Map | Yes | Query Conditions |
| limit | Int | Yes | Page size (max: 100) |
| offset | Int | Yes | Offset (starts from 0; must be a multiple of limit) |
| filters | List | Yes | Filter conditions list |
| field_name | String | Yes | Field name |
| field_values | List[String] | Yes | Field values |
| operator | String | Yes | Operator, see [operator parameter description] below |
| orders | List | Yes | Query conditions |
| fieldName | String | Yes | Field name |
| isAsc | Boolean | Yes | Ascending order (true: ascending, false: descending) |
| fieldProjection | List[String] | Yes | Return fields list, use apiName from object fields |
| data | Map | Yes | |
| dataObjectApiName | String | Yes | Object API name |
| find_explicit_total_num | Boolean | Yes | true: returns total, false: skips total count. Default: true. Setting false improves response speed |
| search_query_info | Map | Yes | Query Conditions |
| limit | Int | Yes | Data count per request, max: 100 |
| filters | No | Filter conditions list | |
| field_name | String | Yes | Field name |
| field_values | List | Yes | Value range |
| operator | String | Yes | Supported operations |
| orders | List | No | Sorting |
| fieldName | String | Yes | Field name |
| isAsc | Boolean | Yes | true: ascending, false: descending |
| fieldProjection | List | Yes | Return fields list |
| offset | Int | Yes | Offset, starts from 0; must be a multiple of limit |
operator Parameter Description
You can directly use query conditions from the object list page, see How to get query conditions from the list
| Parameter | Meaning | Description | Parameter | Meaning | Description |
|---|---|---|---|---|---|
| EQ | Equals | N | Not equals | Can query null values | |
| GT | Greater than | GTE | Greater than or equal | ||
| LT | Less than | LTE | Less than or equal | ||
| LIKE | Contains | NLIKE | Does not contain | ||
| IS | Is null | ISN | Is not null | ||
| IN | In | NIN | Not in | ||
| BETWEEN | Between | NBETWEEN | Not between | ||
| STARTWITH | Starts with | ENDWITH | Ends with | ||
| HASANYOF | Has overlapping elements | NHASANYOF | No overlap |
Request Example
{
"includeNull": true,
"data": {
"find_explicit_total_num": "",
"search_query_info": {
"limit": 5.0,
"orders": [
{
"fieldName": "payment_amount",
"isAsc": false
}
],
"fieldProjection": [
"_id",
"name"
],
"filters": {
"operator": "IN",
"field_name": "owner",
"field_values": [
"FSUID_7B8A3925E40FA68630C0D7E9C3XXXXXX"
]
}
},
"dataObjectApiName": "ApprovalTaskObj"
},
"offset": 0.0
}Response Parameters
| Parameter | Type | Description |
|---|---|---|
| traceId | string | Request unique ID |
| errorDescription | string | Error description |
| data | Map | For detailed parameter information, call the Query Object Description interface |
| errorMessage | string | Error message |
| errorCode | Int | View error codes |
Response Example
{
"traceId": "E-O.827xxxxxx",
"errorDescription": "success",
"data": {
"created_by__r": {},
"lock_status": "0",
"is_deleted": false,
"create_time": 1612247399397,
"name": "xxxxxx",
"_id": "69046aexxxxxxx"
},
"errorMessage": "OK",
"errorCode": 0
}Notes
- Do not use the message field of the return value for logic judgment, errorMessage may change;
- If the field value is null, this field will not be returned;
operator Parameter Description
The return values of this interface correspond to object-related fields, see About Approval Task Object Fields for details. The following parameters are specific return values for this interface. For error codes, please refer to Global Error Codes
|Parameter |Meaning |Parameter |Meaning | |:--| |EQ |= |GT |> | |LT |< |GTE |>= | |LTE |<= |N |<> | |LIKE |LIKE |NLIKE |NOT LIKE | |IS |IS |ISN |IS NOT | |IN |IN |NIN |NOT IN | |BETWEEN |BETWEEN |NBETWEEN |NOT BETWEEN | |STARTWITH |LIKE% |ENDWITH |%LIKE | |CONTAINS |Array Contains | |
