API
/web_api/execution_context/create
/web_api/execution_context/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/execution_context/create.request.json
REQUEST /web_api/execution_context/create
| Name | Type | Required | Constraint |
|---|---|---|---|
project_id | integer | Yes | minimum 0 |
team_id | integer | Yes | minimum 0 |
context_title | string | null | No | - |
context_description | string | null | No | - |
browser_context_id | integer | null | No | minimum 0 |
os_context_id | integer | null | No | minimum 0 |
screen_resolution_context_id | integer | null | No | minimum 0 |
device_context_id | integer | null | No | minimum 0 |
locale_context_id | integer | null | No | minimum 0 |
deployment_target_context_id | integer | null | No | minimum 0 |
user_agent_context_id | integer | null | No | minimum 0 |
protocol | enum | null | No | - |
host | string | null | No | maxLength 255 |
base_url | string | null | No | maxLength 2048 |
build_version | string | null | No | maxLength 128 |
context_snapshot | string | null | No | - |
custom_field_values | string | null | No | - |
created_at | string | No | - |
updated_at | string | No | - |
Other top-level fields are not allowed.
Response
main-app://schemas/api_elements/execution_context/create.response.json
RESPONSE /web_api/execution_context/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 |
|---|---|---|---|
execution_context_id | integer | No | minimum 0 |
project_id | integer | No | minimum 0 |
team_id | integer | No | minimum 0 |
context_title | string | null | No | - |
context_description | string | null | No | - |
browser_context_id | integer | null | No | minimum 0 |
os_context_id | integer | null | No | minimum 0 |
screen_resolution_context_id | integer | null | No | minimum 0 |
device_context_id | integer | null | No | minimum 0 |
locale_context_id | integer | null | No | minimum 0 |
deployment_target_context_id | integer | null | No | minimum 0 |
user_agent_context_id | integer | null | No | minimum 0 |
protocol | enum | null | No | - |
host | string | null | No | maxLength 255 |
base_url | string | null | No | maxLength 2048 |
build_version | string | null | No | maxLength 128 |
context_snapshot | string | null | No | - |
custom_field_values | 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/execution_context/create.request.json
json
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "main-app://schemas/api_elements/execution_context/create.request.json",
"title": "REQUEST /web_api/execution_context/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": {
"project_id": {
"type": "integer",
"minimum": 0
},
"team_id": {
"type": "integer",
"minimum": 0
},
"context_title": {
"type": [
"string",
"null"
]
},
"context_description": {
"type": [
"string",
"null"
]
},
"browser_context_id": {
"type": [
"integer",
"null"
],
"minimum": 0
},
"os_context_id": {
"type": [
"integer",
"null"
],
"minimum": 0
},
"screen_resolution_context_id": {
"type": [
"integer",
"null"
],
"minimum": 0
},
"device_context_id": {
"type": [
"integer",
"null"
],
"minimum": 0
},
"locale_context_id": {
"type": [
"integer",
"null"
],
"minimum": 0
},
"deployment_target_context_id": {
"type": [
"integer",
"null"
],
"minimum": 0
},
"user_agent_context_id": {
"type": [
"integer",
"null"
],
"minimum": 0
},
"protocol": {
"anyOf": [
{
"type": "string",
"enum": [
"HTTP",
"HTTPS"
]
},
{
"type": "null"
}
]
},
"host": {
"type": [
"string",
"null"
],
"maxLength": 255
},
"base_url": {
"type": [
"string",
"null"
],
"maxLength": 2048
},
"build_version": {
"type": [
"string",
"null"
],
"maxLength": 128
},
"context_snapshot": {
"type": [
"string",
"null"
]
},
"custom_field_values": {
"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"
}
},
"required": [
"project_id",
"team_id"
]
}Response: main-app://schemas/api_elements/execution_context/create.response.json
json
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "main-app://schemas/api_elements/execution_context/create.response.json",
"title": "RESPONSE /web_api/execution_context/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/execution_context/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/execution_context/row.json
json
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "main-app://schemas/api_elements/execution_context/row.json",
"title": "Row execution_context",
"$comment": "Generated from the DB model structure_scheme. Edit the model, then run node fill-from-structure-scheme.mjs.",
"type": "object",
"additionalProperties": true,
"properties": {
"execution_context_id": {
"type": "integer",
"minimum": 0
},
"project_id": {
"type": "integer",
"minimum": 0
},
"team_id": {
"type": "integer",
"minimum": 0
},
"context_title": {
"type": [
"string",
"null"
]
},
"context_description": {
"type": [
"string",
"null"
]
},
"browser_context_id": {
"type": [
"integer",
"null"
],
"minimum": 0
},
"os_context_id": {
"type": [
"integer",
"null"
],
"minimum": 0
},
"screen_resolution_context_id": {
"type": [
"integer",
"null"
],
"minimum": 0
},
"device_context_id": {
"type": [
"integer",
"null"
],
"minimum": 0
},
"locale_context_id": {
"type": [
"integer",
"null"
],
"minimum": 0
},
"deployment_target_context_id": {
"type": [
"integer",
"null"
],
"minimum": 0
},
"user_agent_context_id": {
"type": [
"integer",
"null"
],
"minimum": 0
},
"protocol": {
"anyOf": [
{
"type": "string",
"enum": [
"HTTP",
"HTTPS"
]
},
{
"type": "null"
}
]
},
"host": {
"type": [
"string",
"null"
],
"maxLength": 255
},
"base_url": {
"type": [
"string",
"null"
],
"maxLength": 2048
},
"build_version": {
"type": [
"string",
"null"
],
"maxLength": 128
},
"context_snapshot": {
"type": [
"string",
"null"
]
},
"custom_field_values": {
"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?