API
/web_api/test_case/search
/web_api/test_case/search
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/test_case/search.request.json
REQUEST /web_api/test_case/search
| Name | Type | Required | Constraint |
|---|---|---|---|
filters | array of object | No | - |
options | object | No | no other fields |
response | any | No | - |
Other top-level fields are not allowed.
filters[]
| Name | Type | Required | Constraint |
|---|---|---|---|
object | object | Yes | no other fields |
operator | enum | Yes | "LIKE", "NOT_LIKE", "EQUAL", "NOT_EQUAL", "GT", "GTE", "LT", "LTE", "IN", "NOT_IN", "IS_NULL", "IS_NOT_NULL" |
value | any | No | - |
filters[].object
| Name | Type | Required | Constraint |
|---|---|---|---|
element | string | Yes | - |
attribute | string | Yes | - |
options
| Name | Type | Required | Constraint |
|---|---|---|---|
limit | integer | No | minimum 1 |
order | object | No | no other fields |
add | array of enum | No | - |
options.order
| Name | Type | Required | Constraint |
|---|---|---|---|
attribute | enum | Yes | "test_case_id", "test_suite_id", "project_id", "team_id", "assigned_to", "functional_id", "test_case_status", "test_case_title", "test_case_description", "test_case_time_to_execute", "test_case_complexity", "test_case_importance", "preconditions", "expected_result", "created_at", "updated_at" |
direction | enum | No | "ASC", "DESC" |
Response
main-app://schemas/api_elements/test_case/search.response.json
RESPONSE /web_api/test_case/search
| Name | Type | Required | Constraint |
|---|---|---|---|
api_code | integer | Yes | const 200 |
api_result | array of object | boolean | Yes | - |
empty | boolean | No | - |
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/test_case/search.request.json
json
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "main-app://schemas/api_elements/test_case/search.request.json",
"title": "REQUEST /web_api/test_case/search",
"$comment": "Generated from the DB model structure_scheme. Edit the model, then run node fill-from-structure-scheme.mjs.",
"type": "object",
"additionalProperties": false,
"description": "Empty result is api_result false, not []. test_case_id GT the last test_case_id, with options.order on test_case_id ASC, is the next page. Repeat the other filters. There is no offset.",
"properties": {
"filters": {
"type": "array",
"items": {
"type": "object",
"required": [
"object",
"operator"
],
"additionalProperties": false,
"properties": {
"object": {
"type": "object",
"required": [
"element",
"attribute"
],
"additionalProperties": false,
"properties": {
"element": {
"type": "string"
},
"attribute": {
"type": "string",
"description": "Column of this element: test_case_id, test_suite_id, project_id, team_id, assigned_to, functional_id, test_case_status, test_case_title, test_case_description, test_case_time_to_execute, test_case_complexity, test_case_importance, preconditions, expected_result, created_at, updated_at. A custom property filter uses object.element custom and object.attribute equal to the property key."
}
}
},
"operator": {
"type": "string",
"enum": [
"LIKE",
"NOT_LIKE",
"EQUAL",
"NOT_EQUAL",
"GT",
"GTE",
"LT",
"LTE",
"IN",
"NOT_IN",
"IS_NULL",
"IS_NOT_NULL"
]
},
"value": true
}
}
},
"options": {
"type": "object",
"additionalProperties": false,
"properties": {
"limit": {
"type": "integer",
"minimum": 1
},
"order": {
"type": "object",
"required": [
"attribute"
],
"additionalProperties": false,
"properties": {
"attribute": {
"type": "string",
"enum": [
"test_case_id",
"test_suite_id",
"project_id",
"team_id",
"assigned_to",
"functional_id",
"test_case_status",
"test_case_title",
"test_case_description",
"test_case_time_to_execute",
"test_case_complexity",
"test_case_importance",
"preconditions",
"expected_result",
"created_at",
"updated_at"
]
},
"direction": {
"type": "string",
"enum": [
"ASC",
"DESC"
]
}
}
},
"add": {
"type": "array",
"items": {
"type": "string",
"enum": [
"custom_properties",
"projects",
"tags",
"test_steps"
]
}
}
}
},
"response": true
}
}Response: main-app://schemas/api_elements/test_case/search.response.json
json
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "main-app://schemas/api_elements/test_case/search.response.json",
"title": "RESPONSE /web_api/test_case/search",
"$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": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "main-app://schemas/api_elements/test_case/row.json"
}
},
{
"const": false
}
]
}
}
}
]
}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/test_case/row.json
json
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "main-app://schemas/api_elements/test_case/row.json",
"title": "Row test_case",
"$comment": "Generated from the DB model structure_scheme. Edit the model, then run node fill-from-structure-scheme.mjs.",
"type": "object",
"additionalProperties": true,
"properties": {
"test_case_id": {
"type": "integer",
"minimum": 0
},
"test_suite_id": {
"type": [
"integer",
"null"
],
"minimum": 0
},
"project_id": {
"type": "integer",
"minimum": 0
},
"team_id": {
"type": "integer",
"minimum": 0
},
"assigned_to": {
"type": [
"integer",
"null"
]
},
"functional_id": {
"type": "integer"
},
"test_case_status": {
"type": "string",
"enum": [
"PENDING",
"IN_PROGRESS",
"COMPLETED",
"CLOSED"
]
},
"test_case_title": {
"type": "string",
"maxLength": 90
},
"test_case_description": {
"type": [
"string",
"null"
],
"maxLength": 350,
"description": "HTML subset b, i, p, a, strong, ul, ol, li"
},
"test_case_time_to_execute": {
"type": "integer",
"description": "Minutes"
},
"test_case_complexity": {
"type": "string",
"enum": [
"LOW",
"NORMAL",
"HIGH"
]
},
"test_case_importance": {
"type": "string",
"enum": [
"LOW",
"NORMAL",
"HIGH"
]
},
"preconditions": {
"type": [
"string",
"null"
],
"maxLength": 2900,
"description": "HTML subset b, i, p, a, strong, ul, ol, li"
},
"expected_result": {
"type": [
"string",
"null"
],
"maxLength": 2900,
"description": "HTML subset b, i, p, a, strong, ul, ol, li"
},
"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?