API
/web_api/custom_property/clone_element
/web_api/custom_property/clone_element
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/clone_element.request.json
REQUEST /web_api/custom_property/clone_element
| Name | Type | Required | Constraint |
|---|---|---|---|
custom_property_id | integer | Yes | minimum 1 |
Other top-level fields are allowed.
Response
main-app://schemas/api_elements/custom_property/clone_element.response.json
RESPONSE /web_api/custom_property/clone_element
| Name | Type | Required | Constraint |
|---|---|---|---|
api_code | integer | Yes | const 200 |
api_result | object | Yes | other fields allowed |
empty | boolean | No | - |
Other top-level fields are not allowed.
api_result
| Name | Type | Required | Constraint |
|---|---|---|---|
custom_property_id | integer | No | minimum 0 |
team_id | integer | No | minimum 0 |
element_type | enum | No | "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" |
property_key | string | No | maxLength 64; pattern [1][A-Z0-9_]*$ |
value_type | enum | No | "STRING", "TEXT", "INTEGER", "DATE", "URL", "USER", "DROPDOWN", "CHECKBOX", "MULTISELECT" |
cardinality | enum | No | "SINGLE", "MULTIPLE" |
name | string | No | maxLength 120 |
description | string | null | No | maxLength 2500 |
is_required | integer | No | - |
is_enabled | integer | No | - |
is_searchable | integer | No | - |
sort_order | integer | No | - |
created_at | string | No | - |
updated_at | string | No | - |
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/clone_element.request.json
json
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "main-app://schemas/api_elements/custom_property/clone_element.request.json",
"title": "REQUEST /web_api/custom_property/clone_element",
"$comment": "Generated from the DB model structure_scheme. Edit the model, then run node fill-from-structure-scheme.mjs.",
"type": "object",
"additionalProperties": true,
"required": [
"custom_property_id"
],
"properties": {
"custom_property_id": {
"type": "integer",
"minimum": 1
}
}
}Response: main-app://schemas/api_elements/custom_property/clone_element.response.json
json
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "main-app://schemas/api_elements/custom_property/clone_element.response.json",
"title": "RESPONSE /web_api/custom_property/clone_element",
"$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/custom_property/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/custom_property/row.json
json
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "main-app://schemas/api_elements/custom_property/row.json",
"title": "Row custom_property",
"$comment": "Generated from the DB model structure_scheme. Edit the model, then run node fill-from-structure-scheme.mjs.",
"type": "object",
"additionalProperties": true,
"properties": {
"custom_property_id": {
"type": "integer",
"minimum": 0
},
"team_id": {
"type": "integer",
"minimum": 0
},
"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"
]
},
"property_key": {
"type": "string",
"maxLength": 64,
"pattern": "^[A-Z][A-Z0-9_]*$",
"description": "Latin letters, digits, underscore, uppercase. Unique for the team and element_type."
},
"value_type": {
"type": "string",
"enum": [
"STRING",
"TEXT",
"INTEGER",
"DATE",
"URL",
"USER",
"DROPDOWN",
"CHECKBOX",
"MULTISELECT"
]
},
"cardinality": {
"type": "string",
"enum": [
"SINGLE",
"MULTIPLE"
]
},
"name": {
"type": "string",
"maxLength": 120
},
"description": {
"type": [
"string",
"null"
],
"maxLength": 2500
},
"is_required": {
"type": "integer"
},
"is_enabled": {
"type": "integer"
},
"is_searchable": {
"type": "integer"
},
"sort_order": {
"type": "integer"
},
"created_at": {
"type": "string",
"description": "timestamp Y-m-d H:i:s"
},
"updated_at": {
"type": "string",
"description": "timestamp Y-m-d H:i:s"
}
}
}A-Z ↩︎
Did this page help?