Skip to content

Tag#

pyticktick.models.v2.responses.tag #

Response for a batch tag POST request via the V2 API.

Unofficial API

These models are part of the unofficial TickTick API. They were created by reverse engineering the API. They may be incomplete or inaccurate.

Classes:

Name Description
BatchTagRespV2

Model for the response of a batch tag request via the V2 API.

BatchTagRespV2 pydantic-model #

Bases: BaseModel

Model for the response of a batch tag request via the V2 API.

Since tags do not have an id field, the id2etag and id2error fields return the name field as the key instead. Otherwise, the structure is the same as the BatchRespV2 model.

Show JSON schema: 
{
  "additionalProperties": false,
  "description": "Model for the response of a batch tag request via the V2 API.\n\nSince tags do not have an `id` field, the `id2etag` and `id2error` fields return\nthe `name` field as the key instead. Otherwise, the structure is the same as the\n`BatchRespV2` model.",
  "properties": {
    "id2error": {
      "description": "Tag name to error message mapping",
      "patternProperties": {
        "^[^\\\\\\/\\\"#:*?<>|\\sA-Z]+$": {
          "pattern": "^[a-z0-9]{8}$",
          "type": "string"
        }
      },
      "title": "Id2Error",
      "type": "object"
    },
    "id2etag": {
      "description": "Tag name to ETag mapping of objects that were successfully created / updated",
      "patternProperties": {
        "^[^\\\\\\/\\\"#:*?<>|\\sA-Z]+$": {
          "pattern": "^[a-z0-9]{8}$",
          "type": "string"
        }
      },
      "title": "Id2Etag",
      "type": "object"
    }
  },
  "required": [
    "id2error",
    "id2etag"
  ],
  "title": "BatchTagRespV2",
  "type": "object"
}

Config:

  • extra: forbid

Fields:

etags property #

etags: list[str]

List of all the ETags in the response.

id2error pydantic-field #

id2error: dict[TagName, ETag]

Tag name to error message mapping

id2etag pydantic-field #

id2etag: dict[TagName, ETag]

Tag name to ETag mapping of objects that were successfully created / updated

ids property #

ids: list[str]

List of all the IDs in the response.