API
/api/reference/tag_template/search
/api/reference/tag_template/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_references/tag_template/search.request.json
REQUEST /api/reference/tag_template/search
| Name | Type | Required | Constraint |
|---|---|---|---|
filters | array of object | No | - |
options | object | No | other fields allowed |
response | any | No | - |
Other top-level fields are allowed.
filters[]
| Name | Type | Required | Constraint |
|---|---|---|---|
object | object | Yes | other fields allowed |
operator | string | Yes | - |
value | any | No | - |
filters[].object
| Name | Type | Required | Constraint |
|---|---|---|---|
element | string | Yes | - |
attribute | string | Yes | - |
options
| Name | Type | Required | Constraint |
|---|---|---|---|
add | array of string | No | - |
Response
main-app://schemas/api_references/tag_template/search.response.json
RESPONSE /api/reference/tag_template/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_references/tag_template/search.request.json
json
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "main-app://schemas/api_references/tag_template/search.request.json",
"title": "REQUEST /api/reference/tag_template/search",
"$ref": "main-app://schemas/_shared/search.request.json"
}Fragment: main-app://schemas/_shared/search.request.json
json
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "main-app://schemas/_shared/search.request.json",
"title": "Typical /web_api/{entity}/search body",
"type": "object",
"properties": {
"filters": {
"type": "array",
"items": {
"type": "object",
"required": ["object", "operator"],
"properties": {
"object": {
"type": "object",
"required": ["element", "attribute"],
"properties": {
"element": { "type": "string" },
"attribute": { "type": "string" }
},
"additionalProperties": true
},
"operator": { "type": "string" },
"value": true
},
"additionalProperties": true
}
},
"options": {
"type": "object",
"properties": {
"add": {
"type": "array",
"items": { "type": "string" }
}
},
"additionalProperties": true
},
"response": true
},
"additionalProperties": true
}Response: main-app://schemas/api_references/tag_template/search.response.json
json
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "main-app://schemas/api_references/tag_template/search.response.json",
"title": "RESPONSE /api/reference/tag_template/search",
"$ref": "main-app://schemas/_shared/search.response.json"
}Fragment: main-app://schemas/_shared/search.response.json
json
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "main-app://schemas/_shared/search.response.json",
"title": "Typical search success. Empty list is api_result false, not [].",
"allOf": [
{ "$ref": "main-app://schemas/_shared/envelope-success.json" },
{
"type": "object",
"properties": {
"api_result": {
"anyOf": [
{
"type": "array",
"items": {
"type": "object",
"additionalProperties": true
}
},
{ "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
}Did this page help?