UiPath · Schema

EntityQueryRequest

Advanced query request with structured filter conditions

AutomationRobotic Process AutomationRPAArtificial IntelligenceDocument ProcessingEnterprise AutomationOrchestrationTesting

Properties

Name Type Description
filterGroup object
selectedFields array List of field names to include in the response
orderBy array
start integer Zero-based offset for pagination
limit integer Maximum number of records to return
View JSON Schema on GitHub

JSON Schema

data-service-entity-query-request-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/uipath/refs/heads/main/json-schema/data-service-entity-query-request-schema.json",
  "title": "EntityQueryRequest",
  "description": "Advanced query request with structured filter conditions",
  "type": "object",
  "properties": {
    "filterGroup": {
      "$ref": "#/components/schemas/FilterGroup"
    },
    "selectedFields": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "List of field names to include in the response",
      "example": []
    },
    "orderBy": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/OrderByClause"
      },
      "example": []
    },
    "start": {
      "type": "integer",
      "minimum": 0,
      "description": "Zero-based offset for pagination",
      "example": 1
    },
    "limit": {
      "type": "integer",
      "minimum": 1,
      "maximum": 1000,
      "description": "Maximum number of records to return",
      "example": 1
    }
  }
}