Dokumentation / Editor / Endpunkt
PUT

/api/v1/editor-drafts/{kind}/{id}

Eigenen Entwurf mit Versionsprüfung sichern

Anfrage#

POSIX-Shell · curl
curl --fail-with-body --request PUT \
  "$ADBR_API_URL/api/v1/editor-drafts/{kind}/{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: secrets:read

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

Parameter#

ParameterOrtPflichtBeschreibung
kindpathJa
idpathJa
Vollständige Parameterschemas
OpenAPI JSON
[
  {
    "schema": {
      "type": "string",
      "enum": [
        "profile",
        "group",
        "proxy-import",
        "workflow",
        "recording"
      ]
    },
    "in": "path",
    "name": "kind",
    "required": true
  },
  {
    "schema": {
      "type": "string",
      "pattern": "^[a-zA-Z0-9:._-]{1,120}$"
    },
    "in": "path",
    "name": "id",
    "required": true
  }
]

Anfragekörper#

Erforderlich.

FeldTypPflichtBeschreibung
scopestringJa
revisionintegerJa
valueobjectJa
Vollständiges Körperschema
OpenAPI JSON
{
  "required": true,
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "required": [
          "scope",
          "revision",
          "value"
        ],
        "properties": {
          "scope": {
            "type": "string",
            "pattern": "^[a-f0-9]{64}$"
          },
          "revision": {
            "type": "integer",
            "minimum": 0
          },
          "value": {
            "type": "object",
            "additionalProperties": {}
          }
        }
      }
    }
  }
}

Antworten#

200 · Standardantwort
OpenAPI JSON
{
  "description": "Default Response",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "required": [
          "revision",
          "updated_at",
          "value"
        ],
        "properties": {
          "revision": {
            "type": "integer"
          },
          "updated_at": {
            "type": "number"
          },
          "value": {
            "type": "object",
            "additionalProperties": {}
          }
        }
      }
    }
  }
}
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": "Eigenen Entwurf mit Versionsprüfung sichern",
  "tags": [
    "Editor"
  ],
  "requestBody": {
    "required": true,
    "content": {
      "application/json": {
        "schema": {
          "type": "object",
          "required": [
            "scope",
            "revision",
            "value"
          ],
          "properties": {
            "scope": {
              "type": "string",
              "pattern": "^[a-f0-9]{64}$"
            },
            "revision": {
              "type": "integer",
              "minimum": 0
            },
            "value": {
              "type": "object",
              "additionalProperties": {}
            }
          }
        }
      }
    }
  },
  "parameters": [
    {
      "schema": {
        "type": "string",
        "enum": [
          "profile",
          "group",
          "proxy-import",
          "workflow",
          "recording"
        ]
      },
      "in": "path",
      "name": "kind",
      "required": true
    },
    {
      "schema": {
        "type": "string",
        "pattern": "^[a-zA-Z0-9:._-]{1,120}$"
      },
      "in": "path",
      "name": "id",
      "required": true
    }
  ],
  "x-required-scopes": [
    "secrets:read"
  ],
  "responses": {
    "200": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "required": [
              "revision",
              "updated_at",
              "value"
            ],
            "properties": {
              "revision": {
                "type": "integer"
              },
              "updated_at": {
                "type": "number"
              },
              "value": {
                "type": "object",
                "additionalProperties": {}
              }
            }
          }
        }
      }
    },
    "default": {
      "description": "HTTP error envelope. The status and error.code identify the failure.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Error"
          }
        }
      }
    }
  }
}

Suche nach Headless, MCP, Cookies oder einem API-Endpunkt.

↑ ↓ NavigierenEnter ÖffnenEsc Schließen