POST

/api/v1/profiles/package/preview

Inhalt eines .adbprofile-Pakets oder .adbbackup-Vollbackups anzeigen und bereits vorhandene Profile erkennen (ohne etwas einzuspielen)

Anfrage#

POSIX-Shell · curl

curl --fail-with-body --request POST \
  "$ADBR_API_URL/api/v1/profiles/package/preview" \
  -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:read

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

Parameter#

Keine Pfad- oder Query-Parameter deklariert.

Anfragekörper#

Erforderlich.

Feld	Typ	Pflicht	Beschreibung
`path`	`string`	Ja
`password`	`string`	Ja

Vollständiges Körperschema

OpenAPI JSON

{
  "required": true,
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "required": [
          "path",
          "password"
        ],
        "properties": {
          "path": {
            "type": "string",
            "minLength": 4,
            "maxLength": 1024
          },
          "password": {
            "type": "string",
            "minLength": 1,
            "maxLength": 1024
          }
        },
        "additionalProperties": false
      }
    }
  }
}

Antworten#

200 · Standardantwort

OpenAPI JSON

{
  "description": "Default Response",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "required": [
          "kind",
          "created_at",
          "workflows",
          "profiles"
        ],
        "properties": {
          "kind": {
            "type": "string"
          },
          "created_at": {
            "type": "string"
          },
          "workflows": {
            "type": "integer"
          },
          "profiles": {
            "type": "array",
            "items": {
              "type": "object",
              "required": [
                "id",
                "no",
                "name",
                "existing"
              ],
              "properties": {
                "id": {
                  "type": "string"
                },
                "no": {
                  "type": "integer"
                },
                "name": {
                  "type": "string"
                },
                "existing": {
                  "anyOf": [
                    {
                      "type": "object",
                      "required": [
                        "id",
                        "no",
                        "name"
                      ],
                      "properties": {
                        "id": {
                          "type": "string"
                        },
                        "no": {
                          "type": "integer"
                        },
                        "name": {
                          "type": "string"
                        }
                      }
                    },
                    {
                      "type": "null"
                    }
                  ]
                }
              }
            }
          }
        }
      }
    }
  }
}

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": "Inhalt eines .adbprofile-Pakets oder .adbbackup-Vollbackups anzeigen und bereits vorhandene Profile erkennen (ohne etwas einzuspielen)",
  "tags": [
    "Import/Export"
  ],
  "requestBody": {
    "required": true,
    "content": {
      "application/json": {
        "schema": {
          "type": "object",
          "required": [
            "path",
            "password"
          ],
          "properties": {
            "path": {
              "type": "string",
              "minLength": 4,
              "maxLength": 1024
            },
            "password": {
              "type": "string",
              "minLength": 1,
              "maxLength": 1024
            }
          },
          "additionalProperties": false
        }
      }
    }
  },
  "x-required-scopes": [
    "profiles:read"
  ],
  "responses": {
    "200": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "required": [
              "kind",
              "created_at",
              "workflows",
              "profiles"
            ],
            "properties": {
              "kind": {
                "type": "string"
              },
              "created_at": {
                "type": "string"
              },
              "workflows": {
                "type": "integer"
              },
              "profiles": {
                "type": "array",
                "items": {
                  "type": "object",
                  "required": [
                    "id",
                    "no",
                    "name",
                    "existing"
                  ],
                  "properties": {
                    "id": {
                      "type": "string"
                    },
                    "no": {
                      "type": "integer"
                    },
                    "name": {
                      "type": "string"
                    },
                    "existing": {
                      "anyOf": [
                        {
                          "type": "object",
                          "required": [
                            "id",
                            "no",
                            "name"
                          ],
                          "properties": {
                            "id": {
                              "type": "string"
                            },
                            "no": {
                              "type": "integer"
                            },
                            "name": {
                              "type": "string"
                            }
                          }
                        },
                        {
                          "type": "null"
                        }
                      ]
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "default": {
      "description": "HTTP error envelope. The status and error.code identify the failure.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Error"
          }
        }
      }
    }
  }
}