API

/web_api/tag/create

/web_api/tag/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/tag/create.request.json

REQUEST /web_api/tag/create

NameTypeRequiredConstraint
team_idintegerYesminimum 0
project_idintegerYesminimum 0
namestringYesmaxLength 50
descriptionstringNomaxLength 2500
tag_color_idintegerYesminimum 0
created_atstringNo-
updated_atstringNo-

Other top-level fields are not allowed.

Response ​

main-app://schemas/api_elements/tag/create.response.json

RESPONSE /web_api/tag/create

NameTypeRequiredConstraint
api_codeintegerYesconst 200
api_resultobjectYesother fields allowed
emptybooleanNo-

Other top-level fields are not allowed.

api_result ​

NameTypeRequiredConstraint
tag_idintegerNominimum 0
team_idintegerNominimum 0
project_idintegerNominimum 0
namestringNomaxLength 50
descriptionstringNomaxLength 2500
tag_color_idintegerNominimum 0
created_atstringNo-
updated_atstringNo-

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/tag/create.request.json
json
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "main-app://schemas/api_elements/tag/create.request.json",
  "title": "REQUEST /web_api/tag/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": {
    "team_id": {
      "type": "integer",
      "minimum": 0
    },
    "project_id": {
      "type": "integer",
      "minimum": 0
    },
    "name": {
      "type": "string",
      "maxLength": 50
    },
    "description": {
      "type": "string",
      "maxLength": 2500,
      "description": "HTML subset b, i, p, a, strong, ul, ol, li"
    },
    "tag_color_id": {
      "type": "integer",
      "minimum": 0
    },
    "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": [
    "team_id",
    "project_id",
    "name",
    "tag_color_id"
  ]
}
Response: main-app://schemas/api_elements/tag/create.response.json
json
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "main-app://schemas/api_elements/tag/create.response.json",
  "title": "RESPONSE /web_api/tag/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/tag/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/tag/row.json
json
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "main-app://schemas/api_elements/tag/row.json",
  "title": "Row tag",
  "$comment": "Generated from the DB model structure_scheme. Edit the model, then run node fill-from-structure-scheme.mjs.",
  "type": "object",
  "additionalProperties": true,
  "properties": {
    "tag_id": {
      "type": "integer",
      "minimum": 0
    },
    "team_id": {
      "type": "integer",
      "minimum": 0
    },
    "project_id": {
      "type": "integer",
      "minimum": 0
    },
    "name": {
      "type": "string",
      "maxLength": 50
    },
    "description": {
      "type": "string",
      "maxLength": 2500,
      "description": "HTML subset b, i, p, a, strong, ul, ol, li"
    },
    "tag_color_id": {
      "type": "integer",
      "minimum": 0
    },
    "created_at": {
      "type": "string",
      "description": "timestamp Y-m-d H:i:s"
    },
    "updated_at": {
      "type": "string",
      "description": "timestamp Y-m-d H:i:s"
    }
  }
}

Version 1.0.0 · Last updated 2026-10-07

Did this page help?