API
/util/browser_tools/util_executions-delete
/util/browser_tools/util_executions-delete
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_util_browser_tools/util_executions-delete.request.json
POST util_executions/delete body
| Name | Type | Required | Constraint |
|---|---|---|---|
util_execution_id | integer | Yes | minimum 1 |
project_id | integer | Yes | minimum 1 |
Other top-level fields are not allowed.
Response
main-app://schemas/api_util_browser_tools/util_executions-delete.response.json
POST util_executions/delete success
| Name | Type | Required | Constraint |
|---|---|---|---|
api_code | integer | Yes | const 200 |
api_result | object | Yes | no other fields |
empty | boolean | No | - |
Other top-level fields are not allowed.
api_result
| Name | Type | Required | Constraint |
|---|---|---|---|
util_execution_id | integer | Yes | minimum 1 |
project_id | integer | Yes | minimum 1 |
delete_accepted | boolean | Yes | - |
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_util_browser_tools/util_executions-delete.request.json
json
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "main-app://schemas/api_util_browser_tools/util_executions-delete.request.json",
"title": "POST util_executions/delete body",
"type": "object",
"required": [
"util_execution_id",
"project_id"
],
"additionalProperties": false,
"properties": {
"util_execution_id": {
"type": "integer",
"minimum": 1
},
"project_id": {
"type": "integer",
"minimum": 1
}
}
}Response: main-app://schemas/api_util_browser_tools/util_executions-delete.response.json
json
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "main-app://schemas/api_util_browser_tools/util_executions-delete.response.json",
"title": "POST util_executions/delete success",
"allOf": [
{
"$ref": "main-app://schemas/_shared/envelope-success.json"
},
{
"type": "object",
"properties": {
"api_result": {
"type": "object",
"additionalProperties": false,
"required": [
"util_execution_id",
"project_id",
"delete_accepted"
],
"properties": {
"util_execution_id": {
"type": "integer",
"minimum": 1
},
"project_id": {
"type": "integer",
"minimum": 1
},
"delete_accepted": {
"type": "boolean"
}
}
}
}
}
]
}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
}Did this page help?