GET

/api/v1/profiles/import/template

Import-Vorlage mit allen Spalten (XLSX mit Blatt „Zusatzkonten“, CSV oder TXT)

Anfrage#

POSIX-Shell · curl

curl --fail-with-body --request GET \
  "$ADBR_API_URL/api/v1/profiles/import/template" \
  -H "Authorization: Bearer $ADBR_API_TOKEN"

Verwende lokale Adresse und Token aus API & MCP. Ersetze Pfadplatzhalter wie {id} durch tatsächliche IDs.

Authentifizierung und Rechte#

Authentifizierung: Bearer-Token

Scopes: profiles:read

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
`format`	query	Nein

Vollständige Parameterschemas

OpenAPI JSON

[
  {
    "schema": {
      "anyOf": [
        {
          "type": "string",
          "enum": [
            "xlsx"
          ]
        },
        {
          "type": "string",
          "enum": [
            "csv"
          ]
        },
        {
          "type": "string",
          "enum": [
            "txt"
          ]
        }
      ]
    },
    "in": "query",
    "name": "format",
    "required": false
  }
]

Anfragekörper#

Kein Anfragekörper deklariert.

Antworten#

200 · Standardantwort

OpenAPI JSON

{
  "description": "Default Response",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "required": [
          "file_name",
          "mime",
          "content_base64"
        ],
        "properties": {
          "file_name": {
            "type": "string"
          },
          "mime": {
            "type": "string"
          },
          "content_base64": {
            "type": "string"
          }
        }
      }
    }
  }
}

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": "Import-Vorlage mit allen Spalten (XLSX mit Blatt „Zusatzkonten“, CSV oder TXT)",
  "tags": [
    "Import/Export"
  ],
  "parameters": [
    {
      "schema": {
        "anyOf": [
          {
            "type": "string",
            "enum": [
              "xlsx"
            ]
          },
          {
            "type": "string",
            "enum": [
              "csv"
            ]
          },
          {
            "type": "string",
            "enum": [
              "txt"
            ]
          }
        ]
      },
      "in": "query",
      "name": "format",
      "required": false
    }
  ],
  "x-required-scopes": [
    "profiles:read"
  ],
  "responses": {
    "200": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "required": [
              "file_name",
              "mime",
              "content_base64"
            ],
            "properties": {
              "file_name": {
                "type": "string"
              },
              "mime": {
                "type": "string"
              },
              "content_base64": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "default": {
      "description": "HTTP error envelope. The status and error.code identify the failure.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Error"
          }
        }
      }
    }
  }
}