UiPath · JSON Structure

Data Service Query Filter Structure

A single field comparison condition in a query

Type: object Properties: 3 Required: 3
AutomationRobotic Process AutomationRPAArtificial IntelligenceDocument ProcessingEnterprise AutomationOrchestrationTesting

QueryFilter is a JSON Structure definition published by UiPath, describing 3 properties, of which 3 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

fieldName operator value

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑ 
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/uipath/refs/heads/main/json-structure/data-service-query-filter-structure.json",
  "name": "QueryFilter",
  "description": "A single field comparison condition in a query",
  "type": "object",
  "required": [
    "fieldName",
    "operator",
    "value"
  ],
  "properties": {
    "fieldName": {
      "type": "string",
      "description": "Name of the entity field to filter on",
      "example": "Example Name"
    },
    "operator": {
      "type": "string",
      "enum": [
        "equals",
        "notEquals",
        "lessThan",
        "lessThanOrEquals",
        "greaterThan",
        "greaterThanOrEquals",
        "contains",
        "startsWith",
        "endsWith",
        "isNull",
        "isNotNull"
      ],
      "description": "Comparison operator for the filter condition",
      "example": "equals"
    },
    "value": {
      "description": "Value to compare against; type depends on the field type",
      "example": "example-value"
    }
  }
}