Querying Data by Condition

objectName

Yes

String

Explanation

Data object name. For details, see Logging In to the Application Designer. You can access the application designer and choose Data > Object to view data object names.

Constraints

None

Value

1–80 characters

Default value

None

base

No

String

Explanation

Query parameter, which is used to distinguish the data passed by objectName.

Constraints

None

Value

The options are as follows:

• I: ID of the corresponding object.
• N: An object name is transferred.

Default value

None

fields

No

Array

Explanation

Field displayed in an object. Set this parameter to the unique ID of a field. Use commas (,) to separate multiple fields. If this parameter is specified, only the specified fields and necessary information (for example, data record owner and the owner ID) are returned. If this parameter is left unspecified, the entire data record is returned.

1. Access the application designer by referring to Logging In to the Application Designer.
2. Choose Data > Object, click over the object, and choose Details.
3. On the Fields tab page of the object details page, view the unique identifiers of fields.

Constraints

None

condition

No

Object

Explanation

Query condition. If this parameter is left unspecified, all object data is queried. This parameter contains the following elements:

• conjunction: number of conditions to meet.
  • AND: All conditions must be met.
  • OR: At least one condition must be met.
• conditions: array of conditions. If this parameter is left unspecified, all object data is queried. If this parameter is specified, each element contains the following fields:
  • field: field name.
  • operator: operator, which can be: eq indicates equal to, ne indicates not equal to, gt indicates greater than, lt indicates less than, ge indicates greater than or equal to, and le indicates less than or equal to.
  • value: comparison value.
• relation: The array contains parents (upward query) and children (downward query).

  The parents field contains the condition array and relatedField (name of the associated field). The children field contains the condition array and relationName (name of the associated field).

Constraints

None

relation

No

Object

Explanation

Associated query, including parents (upward query) and children (downward query).

The parents field contains the condition array and relatedField (name of the associated field). The children field contains the condition array and relationName (name of the associated field).

The condition array contains conjunction, conditions, and relation. The parameter description is the same as that of condition.

{  
    //Upward query
    parents: [//Level-1 parent object
      {
        relatedField: "CarHolder__CST", // Current object field (Lookup/MasterDetail type), which is used to determine the parent object
        options: {
          fields: ["id", "name", "Age__CST"] // Field to be queried of the parent object
        },
        parents: [// (Optional) Level-2 parent object
          {
            relatedField: "cust__CST," // Parent object field (Lookup/MasterDetail type), which is used to determine the grandparent object
            options: {
              fields: ["id", "name", "Email__CST"] // Field to be queried of the grandparent object
            }
          }
        ]
      }
    ],
    //Downward query
    childs: [//Level-1 child object
      {
        relationName: "Contacts," // Child object relationship name (specified when Lookup/MasterDetail is defined for a child object). The child object is determined based on the relationship name.
        options: {
        fields: ["id", "name", "Age__CST", "cust__CST"] // Child object field to be queried
      },
      childs: [// (Optional) Level-2 child object
        {
            relationName: "ContactCars", // Relationship name of the grandchild object
            options: {
              fields: ["id", "name", "Price__CST", "CarHolder__CST"] // Grandchild object field to be queried
            }
        }
      ]
      }
    ]
  }

Constraints

None

options

No

Object

Explanation

Additional option, which is used to perform operations on the query result.

• orderBy: used to sort the query result by the value of a specific field. The value can be asc (ascending order) or desc (descending order).

  options: {
              orderby: [
                  {
                      field: "name",
                      order: db.Order.desc
                  }
              ],
            }
• groupby: used to group the query result based on specified fields.

  options: {
              groupby: [
                  {
                      field: "name",
                  }
              ],
            }
• distinct: used to deduplicate the query result.

  options: {
              distinct: true,
            }
• skip and limit: limit specifies the total number of records to be returned, and skip specifies the ID of the first record to be returned. They are used together to limit the number of returned records.

  {
            options: {
              skip: 100,
              limit: 100
            }
        }

Constraints

None

resCode

String

Explanation

Return code.

Value

If the request is successful, 0 is returned. For details about other error codes, see Error Codes.

resMsg

String

Explanation

Message returned.

Value

If the request is successful, Success is returned. In other cases, an error message is returned.

result

Array

Explanation

Returned object data.

count

number

Explanation

Total number of records that meet the conditions in the object.

Value

None