PATCH

/api/v1/tags/{id}

Tag ändern

Anfrage#

POSIX-Shell · curl

curl --fail-with-body --request PATCH \
  "$ADBR_API_URL/api/v1/tags/{id}" \
  -H "Authorization: Bearer $ADBR_API_TOKEN" \
  -H "Content-Type: application/json" \
  --data @request.json

Verwende lokale Adresse und Token aus API & MCP. Ersetze Pfadplatzhalter wie {id} durch tatsächliche IDs. Erstelle request.json anhand des folgenden Körperschemas, bevor du den Befehl ausführst.

Authentifizierung und Rechte#

Authentifizierung: Bearer-Token

Scopes: profiles:write

Alle aufgeführten Scopes sind erforderlich; admin erfüllt Scope-Prüfungen. Kontorechte, Anfrageinhalt, Tresorzustand und Ressourcenrechte können weitere Voraussetzungen setzen.

Parameter#

Parameter	Ort	Pflicht	Beschreibung
`id`	path	Ja

Vollständige Parameterschemas

OpenAPI JSON

[
  {
    "schema": {
      "type": "string",
      "minLength": 1,
      "maxLength": 64
    },
    "in": "path",
    "name": "id",
    "required": true
  }
]

Anfragekörper#

Erforderlich.

Feld	Typ	Pflicht	Beschreibung
`name`	`string`	Nein
`color`	`union`	Nein

Vollständiges Körperschema

OpenAPI JSON

{
  "required": true,
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "minLength": 1,
            "maxLength": 50
          },
          "color": {
            "anyOf": [
              {
                "anyOf": [
                  {
                    "type": "string",
                    "enum": [
                      "darkBlue"
                    ]
                  },
                  {
                    "type": "string",
                    "enum": [
                      "blue"
                    ]
                  },
                  {
                    "type": "string",
                    "enum": [
                      "purple"
                    ]
                  },
                  {
                    "type": "string",
                    "enum": [
                      "red"
                    ]
                  },
                  {
                    "type": "string",
                    "enum": [
                      "yellow"
                    ]
                  },
                  {
                    "type": "string",
                    "enum": [
                      "orange"
                    ]
                  },
                  {
                    "type": "string",
                    "enum": [
                      "green"
                    ]
                  },
                  {
                    "type": "string",
                    "enum": [
                      "lightGreen"
                    ]
                  }
                ]
              },
              {
                "type": "null"
              }
            ]
          }
        },
        "additionalProperties": false
      }
    }
  }
}

Antworten#

200 · Standardantwort

OpenAPI JSON

{
  "description": "Default Response",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "required": [
          "id",
          "name",
          "color",
          "profile_count",
          "created_at",
          "updated_at"
        ],
        "properties": {
          "id": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "color": {
            "type": "string"
          },
          "profile_count": {
            "type": "integer"
          },
          "created_at": {
            "type": "integer"
          },
          "updated_at": {
            "type": "integer"
          }
        }
      }
    }
  }
}

default · HTTP-Fehlerhülle. Status und error.code bezeichnen den Fehler.

OpenAPI JSON

{
  "description": "HTTP error envelope. The status and error.code identify the failure.",
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/Error"
      }
    }
  }
}

Allgemeine Authentifizierungs- und Transportfehler können zusätzlich zu den dokumentierten Antworten auftreten.

OpenAPI-Definition#

Vollständige Operationsdefinition

OpenAPI JSON

{
  "summary": "Tag ändern",
  "tags": [
    "Tags"
  ],
  "requestBody": {
    "required": true,
    "content": {
      "application/json": {
        "schema": {
          "type": "object",
          "properties": {
            "name": {
              "type": "string",
              "minLength": 1,
              "maxLength": 50
            },
            "color": {
              "anyOf": [
                {
                  "anyOf": [
                    {
                      "type": "string",
                      "enum": [
                        "darkBlue"
                      ]
                    },
                    {
                      "type": "string",
                      "enum": [
                        "blue"
                      ]
                    },
                    {
                      "type": "string",
                      "enum": [
                        "purple"
                      ]
                    },
                    {
                      "type": "string",
                      "enum": [
                        "red"
                      ]
                    },
                    {
                      "type": "string",
                      "enum": [
                        "yellow"
                      ]
                    },
                    {
                      "type": "string",
                      "enum": [
                        "orange"
                      ]
                    },
                    {
                      "type": "string",
                      "enum": [
                        "green"
                      ]
                    },
                    {
                      "type": "string",
                      "enum": [
                        "lightGreen"
                      ]
                    }
                  ]
                },
                {
                  "type": "null"
                }
              ]
            }
          },
          "additionalProperties": false
        }
      }
    }
  },
  "parameters": [
    {
      "schema": {
        "type": "string",
        "minLength": 1,
        "maxLength": 64
      },
      "in": "path",
      "name": "id",
      "required": true
    }
  ],
  "x-required-scopes": [
    "profiles:write"
  ],
  "responses": {
    "200": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "required": [
              "id",
              "name",
              "color",
              "profile_count",
              "created_at",
              "updated_at"
            ],
            "properties": {
              "id": {
                "type": "string"
              },
              "name": {
                "type": "string"
              },
              "color": {
                "type": "string"
              },
              "profile_count": {
                "type": "integer"
              },
              "created_at": {
                "type": "integer"
              },
              "updated_at": {
                "type": "integer"
              }
            }
          }
        }
      }
    },
    "default": {
      "description": "HTTP error envelope. The status and error.code identify the failure.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Error"
          }
        }
      }
    }
  }
}