API
/web_api/autotest_run/create
/web_api/autotest_run/create
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/create.request.json
REQUEST /web_api/autotest_run/create
| Name | Type | Required | Constraint |
|---|---|---|---|
autotest_run_name | string | No | maxLength 500 |
autotest_run_description | string | null | No | maxLength 2500 |
team_id | integer | Yes | minimum 0 |
project_id | integer | Yes | minimum 0 |
execution_context_id | integer | Yes | minimum 0 |
team_domain_id | integer | Yes | minimum 0 |
autotest_run_status | enum | No | "PENDING", "IN_PROGRESS", "COMPLETED", "CLOSED", "CANCELLED" |
max_threads | integer | No | minimum 0 |
retry_count | integer | No | minimum 0 |
step_timeout_ms | integer | No | minimum 0 |
case_timeout_ms | integer | No | minimum 0 |
run_timeout_ms | integer | No | minimum 0 |
screenshot_on_failure | integer | string | No | - |
screenshot_on_result | integer | string | No | - |
consecutive_error_stop | integer | No | minimum 0 |
created_by_user_id | integer | Yes | minimum 0 |
started_at | string | null | No | - |
finished_at | string | null | No | - |
created_at | string | No | - |
updated_at | string | No | - |
autotest_case_ids | - | No | - |
Other top-level fields are not allowed.
Response
main-app://schemas/api_elements/autotest_run/create.response.json
RESPONSE /web_api/autotest_run/create
| 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 |
|---|---|---|---|
autotest_run_id | integer | No | minimum 0 |
autotest_run_name | string | No | maxLength 500 |
autotest_run_description | string | null | No | maxLength 2500 |
team_id | integer | No | minimum 0 |
project_id | integer | No | minimum 0 |
execution_context_id | integer | No | minimum 0 |
team_domain_id | integer | No | minimum 0 |
autotest_run_status | enum | No | "PENDING", "IN_PROGRESS", "COMPLETED", "CLOSED", "CANCELLED" |
max_threads | integer | No | minimum 0 |
retry_count | integer | No | minimum 0 |
step_timeout_ms | integer | No | minimum 0 |
case_timeout_ms | integer | No | minimum 0 |
run_timeout_ms | integer | No | minimum 0 |
screenshot_on_failure | integer | string | No | - |
screenshot_on_result | integer | string | No | - |
consecutive_error_stop | integer | No | minimum 0 |
created_by_user_id | integer | No | minimum 0 |
started_at | string | null | No | - |
finished_at | string | null | 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/autotest_run/create.request.json
json
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "main-app://schemas/api_elements/autotest_run/create.request.json",
"title": "REQUEST /web_api/autotest_run/create",
"$comment": "Generated from the DB model structure_scheme. Edit the model, then run node fill-from-structure-scheme.mjs.",
"type": "object",
"additionalProperties": false,
"properties": {
"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"
},
"autotest_case_ids": {
"description": "Accepted on create. Not a column."
}
},
"required": [
"team_id",
"project_id",
"execution_context_id",
"team_domain_id",
"created_by_user_id"
]
}Response: main-app://schemas/api_elements/autotest_run/create.response.json
json
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "main-app://schemas/api_elements/autotest_run/create.response.json",
"title": "RESPONSE /web_api/autotest_run/create",
"$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"
}
}
}Did this page help?