English
Query List of Goal Value Objects Based on Conditions
About 565 wordsAbout 2 min
2026-01-19
Description
Query a list of goal value objects based on specified conditions.
Request Specification
HTTP Method: POST + application/json
Request Path: https://${cloud domain}/cgi/crm/v2/data/query?thirdTraceId=${random string}
Request 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: GoalValueObj) |
| 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 Condition Specification |
| limit | Int | Yes | Pagination size (max: 100) |
| offset | Int | Yes | Offset (starts from 0, must be multiple of limit) |
| filters | List | Yes | Filter conditions list |
| field_name | String | Yes | Field name(If the filtering rule involves the assessment dimension, the check_dimension_valueX function must be used. For example, when assessing rules based on the department + person dimension, the target values of personnel need to be filtered, and the check_dimension_value2 function is applicable for filtering personnel data) |
| field_values | List[String] | Yes | Field values |
| operator | String | Yes | Operator (see operator parameter details below) |
| orders | List | Yes | Sorting conditions |
| fieldName | String | Yes | Field name |
| isAsc | Boolean | Yes | Sort order (true: ascending, false: descending) |
| fieldProjection | List[String] | Yes | Return fields list (use apiName from object fields) Monthly Target Value Columns: january_value, february_value, march_value, ..., december_value Weekly Target Value Columns: week_1_value, week_2_value, week_3_value, ..., week_52_value Quarterly Target Value Columns: quarter_1_value, quarter_2_value, quarter_3_value, quarter_4_value Annual Target Value Columns: year_valueIf the second metric target value is to be taken, the corresponding target value columns are prefixed with agg2_, e.g. agg2_january_value |
Operator Parameter Specification
Operators can be directly used from the object list page. See How to Get List Query Conditions
| Parameter | Meaning | Description | Parameter | Meaning | Description |
|---|---|---|---|---|---|
| EQ | Equal | N | Not Equal | Can query null values | |
| GT | Greater Than | GTE | Greater Than or Equal | ||
| LT | Less Than | LTE | Less Than or Equal | ||
| LIKE | Contains | NLIKE | Not Contains | ||
| 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 Overlapping |
Request Example
{
"includeNull": true,
"data": {
"find_explicit_total_num": true,
"search_query_info": {
"offset": 0,
"limit": 1,
"orders": [
{
"fieldName": "create_time",
"isAsc": true
}
],
"fieldProjection": [
"january_value","february_value","march_value"
],
"filters": [
{
"operator": "EQ",
"field_name": "goal_rule_id",
"field_values": [
"603dabc14ae65400011aec90"
]
},
{
"operator": "EQ",
"field_name": "fiscal_year",
"field_values": [
"2025"
]
},
{
"operator": "EQ",
"field_name": "check_dimension_value1",
"field_values": [
"1000"
]
}
]
},
"dataObjectApiName": "GoalValueObj"
}
}Response Parameters
| Parameter | Type | Description |
|---|---|---|
| traceId | string | Unique request ID |
| errorDescription | string | Error description |
| data | Map | Parameter details (call Object Description Query API) |
| errorMessage | string | Error message |
| errorCode | Int | Error Codes Reference |
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 in response for logical judgment (errorMessage may change);
- Empty-valued fields will not be returned;
