Appium · JSON Structure

Appium Server Find Element Request Structure

Request to find an element using a locator strategy

Type: object Properties: 2 Required: 2
AndroidCross-PlatformiOSMobile TestingOpen SourceOpenJS FoundationTest AutomationWebDriver

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

Properties

using 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/appium/refs/heads/main/json-structure/appium-server-find-element-request-structure.json",
  "name": "FindElementRequest",
  "description": "Request to find an element using a locator strategy",
  "type": "object",
  "properties": {
    "using": {
      "type": "string",
      "description": "The element locator strategy",
      "enum": [
        "accessibility id",
        "id",
        "xpath",
        "class name",
        "name",
        "css selector",
        "-android uiautomator",
        "-ios predicate string"
      ],
      "example": "accessibility id"
    },
    "value": {
      "type": "string",
      "description": "The selector value for the locator strategy",
      "example": "Login Button"
    }
  },
  "required": [
    "using",
    "value"
  ]
}