API

/web_api/custom_property_value/add

/web_api/custom_property_value/add ​

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/custom_property_value/add.request.json

REQUEST /web_api/custom_property_value/add

NameTypeRequiredConstraint
custom_property_idintegerYesminimum 1
element_typeenumYes"test_case", "bug", "autotest_case", "autotest_run", "object_repository_page", "object_repository_element", "object_repository_folder", "test_run", "test_run_result", "test_account", "execution_context", "text_document", "checklist_id", "checklist_result_id"
element_idintegerYesminimum 1
checkbox_valueanyNo-
date_valueanyNo-
integer_valueanyNo-
option_idanyNo-
string_valueanyNo-
text_valueanyNo-
urlanyNo-
user_id_valueanyNo-
value-No-

Other top-level fields are allowed.

Response ​

main-app://schemas/api_elements/custom_property_value/add.response.json

POST /web_api/custom_property_value/add success

NameTypeRequiredConstraint
api_codeintegerYesconst 200
api_resultobjectYesother fields allowed
emptybooleanNo-

Other top-level fields are not allowed.

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/custom_property_value/add.request.json
json
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "main-app://schemas/api_elements/custom_property_value/add.request.json",
  "title": "REQUEST /web_api/custom_property_value/add",
  "$comment": "Generated from CustomPropertyValueType and the value writers. Edit those, then run node fill-from-structure-scheme.mjs.",
  "type": "object",
  "additionalProperties": true,
  "required": [
    "custom_property_id",
    "element_type",
    "element_id"
  ],
  "properties": {
    "custom_property_id": {
      "type": "integer",
      "minimum": 1
    },
    "element_type": {
      "type": "string",
      "enum": [
        "test_case",
        "bug",
        "autotest_case",
        "autotest_run",
        "object_repository_page",
        "object_repository_element",
        "object_repository_folder",
        "test_run",
        "test_run_result",
        "test_account",
        "execution_context",
        "text_document",
        "checklist_id",
        "checklist_result_id"
      ]
    },
    "element_id": {
      "type": "integer",
      "minimum": 1
    },
    "checkbox_value": true,
    "date_value": true,
    "integer_value": true,
    "option_id": true,
    "string_value": true,
    "text_value": true,
    "url": true,
    "user_id_value": true,
    "value": {
      "description": "Same value as the typed column for this value_type."
    }
  }
}
Response: main-app://schemas/api_elements/custom_property_value/add.response.json
json
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "main-app://schemas/api_elements/custom_property_value/add.response.json",
  "title": "POST /web_api/custom_property_value/add success",
  "allOf": [
    {
      "$ref": "main-app://schemas/_shared/envelope-success.json"
    },
    {
      "type": "object",
      "properties": {
        "api_result": {
          "type": "object",
          "additionalProperties": true
        }
      }
    }
  ]
}
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
}

Version 1.0.0 · Last updated 2026-10-07

Did this page help?