POST

/api/v1/profiles/{id}/external-links

Weblink in einer bestehenden Profilsitzung öffnen

Anfrage#

POSIX-Shell · curl

curl --fail-with-body --request POST \
  "$ADBR_API_URL/api/v1/profiles/{id}/external-links" \
  -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: runtime:control

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
`session_id`	`string`	Ja
`url`	`string`	Ja

Vollständiges Körperschema

OpenAPI JSON

{
  "required": true,
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "required": [
          "session_id",
          "url"
        ],
        "properties": {
          "session_id": {
            "type": "string",
            "maxLength": 128
          },
          "url": {
            "type": "string",
            "maxLength": 8192
          }
        },
        "additionalProperties": false
      }
    }
  }
}

Antworten#

200 · Standardantwort

OpenAPI JSON

{
  "description": "Default Response"
}

Für diese Antwort enthält der Export kein Inhaltsschema.

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": "Weblink in einer bestehenden Profilsitzung öffnen",
  "tags": [
    "Laufzeit"
  ],
  "requestBody": {
    "required": true,
    "content": {
      "application/json": {
        "schema": {
          "type": "object",
          "required": [
            "session_id",
            "url"
          ],
          "properties": {
            "session_id": {
              "type": "string",
              "maxLength": 128
            },
            "url": {
              "type": "string",
              "maxLength": 8192
            }
          },
          "additionalProperties": false
        }
      }
    }
  },
  "parameters": [
    {
      "schema": {
        "type": "string",
        "minLength": 1,
        "maxLength": 64
      },
      "in": "path",
      "name": "id",
      "required": true
    }
  ],
  "x-required-scopes": [
    "runtime:control"
  ],
  "responses": {
    "200": {
      "description": "Default Response"
    },
    "default": {
      "description": "HTTP error envelope. The status and error.code identify the failure.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Error"
          }
        }
      }
    }
  }
}