API

/web_api/object_repository_element/update_property

/web_api/object_repository_element/update_property ​

This page is built from the JSON Schema snapshot in the documentation repository. The snapshot is updated by a separate command from the main app catalog and is not rewritten when the site is built.

Request ​

main-app://schemas/api_elements/object_repository_element/update_property.request.json

REQUEST /web_api/object_repository_element/update_property

NameTypeRequiredConstraint
object_repository_element_idintegerYesminimum 1
keyenumYes"project_id", "object_repository_folder_id", "object_repository_element_title", "locator_kind", "locator_value", "locator_name"
valueanyYes-

Other top-level fields are not allowed.

Response ​

main-app://schemas/api_elements/object_repository_element/update_property.response.json

RESPONSE /web_api/object_repository_element/update_property

NameTypeRequiredConstraint
api_codeintegerYesconst 200
api_resultobjectYesother fields allowed
emptybooleanNo-

Other top-level fields are not allowed.

api_result ​

NameTypeRequiredConstraint
object_repository_element_idintegerNominimum 0
team_idintegerNominimum 0
project_idintegerNominimum 0
object_repository_folder_idinteger | nullNominimum 0
object_repository_element_titlestringNomaxLength 500
locator_kindenumNo"ROLE", "LABEL", "PLACEHOLDER", "TESTID", "TEXT", "TITLE", "ALT", "CSS", "ID", "NAME", "XPATH", "SELECTOR"
locator_valuestringNomaxLength 2000
locator_namestring | nullNomaxLength 500
created_atstringNo-
updated_atstringNo-

Source schema ​

The files below are copied from the snapshot unchanged. A $ref fragment is a separate block. The schemas are not merged.

Request: main-app://schemas/api_elements/object_repository_element/update_property.request.json
json
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "main-app://schemas/api_elements/object_repository_element/update_property.request.json",
  "title": "REQUEST /web_api/object_repository_element/update_property",
  "$comment": "Generated from the DB model structure_scheme. Edit the model, then run node fill-from-structure-scheme.mjs.",
  "type": "object",
  "additionalProperties": false,
  "required": [
    "object_repository_element_id",
    "key",
    "value"
  ],
  "properties": {
    "object_repository_element_id": {
      "type": "integer",
      "minimum": 1
    },
    "key": {
      "type": "string",
      "enum": [
        "project_id",
        "object_repository_folder_id",
        "object_repository_element_title",
        "locator_kind",
        "locator_value",
        "locator_name"
      ]
    },
    "value": true
  }
}
Response: main-app://schemas/api_elements/object_repository_element/update_property.response.json
json
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "main-app://schemas/api_elements/object_repository_element/update_property.response.json",
  "title": "RESPONSE /web_api/object_repository_element/update_property",
  "$comment": "Generated from the DB model structure_scheme. Edit the model, then run node fill-from-structure-scheme.mjs.",
  "allOf": [
    {
      "$ref": "main-app://schemas/_shared/envelope-success.json"
    },
    {
      "type": "object",
      "properties": {
        "api_result": {
          "$ref": "main-app://schemas/api_elements/object_repository_element/row.json"
        }
      }
    }
  ]
}
Fragment: main-app://schemas/_shared/envelope-success.json
json
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "main-app://schemas/_shared/envelope-success.json",
  "title": "Canonical success envelope",
  "type": "object",
  "required": ["api_code", "api_result"],
  "properties": {
    "api_code": { "const": 200 },
    "api_result": true,
    "empty": { "type": "boolean" }
  },
  "additionalProperties": false
}
Fragment: main-app://schemas/api_elements/object_repository_element/row.json
json
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "main-app://schemas/api_elements/object_repository_element/row.json",
  "title": "Row object_repository_element",
  "$comment": "Generated from the DB model structure_scheme. Edit the model, then run node fill-from-structure-scheme.mjs.",
  "type": "object",
  "additionalProperties": true,
  "properties": {
    "object_repository_element_id": {
      "type": "integer",
      "minimum": 0
    },
    "team_id": {
      "type": "integer",
      "minimum": 0
    },
    "project_id": {
      "type": "integer",
      "minimum": 0
    },
    "object_repository_folder_id": {
      "type": [
        "integer",
        "null"
      ],
      "minimum": 0
    },
    "object_repository_element_title": {
      "type": "string",
      "maxLength": 500
    },
    "locator_kind": {
      "type": "string",
      "enum": [
        "ROLE",
        "LABEL",
        "PLACEHOLDER",
        "TESTID",
        "TEXT",
        "TITLE",
        "ALT",
        "CSS",
        "ID",
        "NAME",
        "XPATH",
        "SELECTOR"
      ]
    },
    "locator_value": {
      "type": "string",
      "maxLength": 2000
    },
    "locator_name": {
      "type": [
        "string",
        "null"
      ],
      "maxLength": 500
    },
    "created_at": {
      "type": "string",
      "description": "timestamp Y-m-d H:i:s"
    },
    "updated_at": {
      "type": "string",
      "description": "timestamp Y-m-d H:i:s"
    }
  }
}

Version 1.0.0 · Last updated 2026-10-07

Did this page help?