API

/web_api/autotest_run/update_property

/web_api/autotest_run/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/autotest_run/update_property.request.json

REQUEST /web_api/autotest_run/update_property

NameTypeRequiredConstraint
autotest_run_idintegerYesminimum 1
keyenumYes"autotest_run_name", "autotest_run_description", "project_id", "execution_context_id", "team_domain_id", "autotest_run_status", "max_threads", "retry_count", "step_timeout_ms", "case_timeout_ms", "run_timeout_ms", "screenshot_on_failure", "screenshot_on_result", "consecutive_error_stop", "created_by_user_id", "started_at", "finished_at"
valueanyYes-

Other top-level fields are not allowed.

Response ​

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

RESPONSE /web_api/autotest_run/update_property

NameTypeRequiredConstraint
api_codeintegerYesconst 200
api_resultobjectYesother fields allowed
emptybooleanNo-

Other top-level fields are not allowed.

api_result ​

NameTypeRequiredConstraint
autotest_run_idintegerNominimum 0
autotest_run_namestringNomaxLength 500
autotest_run_descriptionstring | nullNomaxLength 2500
team_idintegerNominimum 0
project_idintegerNominimum 0
execution_context_idintegerNominimum 0
team_domain_idintegerNominimum 0
autotest_run_statusenumNo"PENDING", "IN_PROGRESS", "COMPLETED", "CLOSED", "CANCELLED"
max_threadsintegerNominimum 0
retry_countintegerNominimum 0
step_timeout_msintegerNominimum 0
case_timeout_msintegerNominimum 0
run_timeout_msintegerNominimum 0
screenshot_on_failureinteger | stringNo-
screenshot_on_resultinteger | stringNo-
consecutive_error_stopintegerNominimum 0
created_by_user_idintegerNominimum 0
started_atstring | nullNo-
finished_atstring | nullNo-
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/autotest_run/update_property.request.json
json
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "main-app://schemas/api_elements/autotest_run/update_property.request.json",
  "title": "REQUEST /web_api/autotest_run/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": [
    "autotest_run_id",
    "key",
    "value"
  ],
  "properties": {
    "autotest_run_id": {
      "type": "integer",
      "minimum": 1
    },
    "key": {
      "type": "string",
      "enum": [
        "autotest_run_name",
        "autotest_run_description",
        "project_id",
        "execution_context_id",
        "team_domain_id",
        "autotest_run_status",
        "max_threads",
        "retry_count",
        "step_timeout_ms",
        "case_timeout_ms",
        "run_timeout_ms",
        "screenshot_on_failure",
        "screenshot_on_result",
        "consecutive_error_stop",
        "created_by_user_id",
        "started_at",
        "finished_at"
      ]
    },
    "value": true
  }
}
Response: main-app://schemas/api_elements/autotest_run/update_property.response.json
json
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "main-app://schemas/api_elements/autotest_run/update_property.response.json",
  "title": "RESPONSE /web_api/autotest_run/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/autotest_run/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/autotest_run/row.json
json
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "main-app://schemas/api_elements/autotest_run/row.json",
  "title": "Row autotest_run",
  "$comment": "Generated from the DB model structure_scheme. Edit the model, then run node fill-from-structure-scheme.mjs.",
  "type": "object",
  "additionalProperties": true,
  "properties": {
    "autotest_run_id": {
      "type": "integer",
      "minimum": 0
    },
    "autotest_run_name": {
      "type": "string",
      "maxLength": 500
    },
    "autotest_run_description": {
      "type": [
        "string",
        "null"
      ],
      "maxLength": 2500,
      "description": "HTML subset b, i, p, a, strong, ul, ol, li"
    },
    "team_id": {
      "type": "integer",
      "minimum": 0
    },
    "project_id": {
      "type": "integer",
      "minimum": 0
    },
    "execution_context_id": {
      "type": "integer",
      "minimum": 0
    },
    "team_domain_id": {
      "type": "integer",
      "minimum": 0
    },
    "autotest_run_status": {
      "type": "string",
      "enum": [
        "PENDING",
        "IN_PROGRESS",
        "COMPLETED",
        "CLOSED",
        "CANCELLED"
      ]
    },
    "max_threads": {
      "type": "integer",
      "minimum": 0
    },
    "retry_count": {
      "type": "integer",
      "minimum": 0
    },
    "step_timeout_ms": {
      "type": "integer",
      "minimum": 0
    },
    "case_timeout_ms": {
      "type": "integer",
      "minimum": 0
    },
    "run_timeout_ms": {
      "type": "integer",
      "minimum": 0
    },
    "screenshot_on_failure": {
      "type": [
        "integer",
        "string"
      ]
    },
    "screenshot_on_result": {
      "type": [
        "integer",
        "string"
      ]
    },
    "consecutive_error_stop": {
      "type": "integer",
      "minimum": 0
    },
    "created_by_user_id": {
      "type": "integer",
      "minimum": 0
    },
    "started_at": {
      "type": [
        "string",
        "null"
      ]
    },
    "finished_at": {
      "type": [
        "string",
        "null"
      ]
    },
    "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?