POST

/api/v1/automation/shares/redeem

Freigabecode einmal abrufen und Importvorschau erstellen

Anfrage#

POSIX-Shell · curl

curl --fail-with-body --request POST \
  "$ADBR_API_URL/api/v1/automation/shares/redeem" \
  -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, rpa:write

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
`code`	`string`	Ja

Vollständiges Körperschema

OpenAPI JSON

{
  "required": true,
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "required": [
          "code"
        ],
        "properties": {
          "code": {
            "type": "string",
            "minLength": 8,
            "maxLength": 2010
          }
        },
        "additionalProperties": false
      }
    }
  }
}

Antworten#

200 · Standardantwort

OpenAPI JSON

{
  "description": "Default Response",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "required": [
          "sha256",
          "created_at",
          "items",
          "ticket",
          "expires_at"
        ],
        "properties": {
          "sha256": {
            "type": "string"
          },
          "created_at": {
            "type": "string"
          },
          "items": {
            "type": "array",
            "items": {
              "type": "object",
              "required": [
                "id",
                "name",
                "dependencies",
                "group",
                "description",
                "missing_values",
                "is_template",
                "steps",
                "protected_values"
              ],
              "properties": {
                "id": {
                  "type": "string"
                },
                "name": {
                  "type": "string"
                },
                "dependencies": {
                  "type": "array",
                  "items": {
                    "type": "string"
                  }
                },
                "group": {
                  "type": [
                    "string",
                    "null"
                  ]
                },
                "description": {
                  "type": [
                    "string",
                    "null"
                  ]
                },
                "missing_values": {
                  "type": "integer"
                },
                "is_template": {
                  "type": "boolean"
                },
                "steps": {
                  "type": "integer"
                },
                "protected_values": {
                  "type": "integer"
                }
              }
            }
          },
          "ticket": {
            "type": "string"
          },
          "expires_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": "Freigabecode einmal abrufen und Importvorschau erstellen",
  "tags": [
    "Automation"
  ],
  "requestBody": {
    "required": true,
    "content": {
      "application/json": {
        "schema": {
          "type": "object",
          "required": [
            "code"
          ],
          "properties": {
            "code": {
              "type": "string",
              "minLength": 8,
              "maxLength": 2010
            }
          },
          "additionalProperties": false
        }
      }
    }
  },
  "x-required-scopes": [
    "runtime:control",
    "rpa:write"
  ],
  "responses": {
    "200": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "required": [
              "sha256",
              "created_at",
              "items",
              "ticket",
              "expires_at"
            ],
            "properties": {
              "sha256": {
                "type": "string"
              },
              "created_at": {
                "type": "string"
              },
              "items": {
                "type": "array",
                "items": {
                  "type": "object",
                  "required": [
                    "id",
                    "name",
                    "dependencies",
                    "group",
                    "description",
                    "missing_values",
                    "is_template",
                    "steps",
                    "protected_values"
                  ],
                  "properties": {
                    "id": {
                      "type": "string"
                    },
                    "name": {
                      "type": "string"
                    },
                    "dependencies": {
                      "type": "array",
                      "items": {
                        "type": "string"
                      }
                    },
                    "group": {
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "description": {
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "missing_values": {
                      "type": "integer"
                    },
                    "is_template": {
                      "type": "boolean"
                    },
                    "steps": {
                      "type": "integer"
                    },
                    "protected_values": {
                      "type": "integer"
                    }
                  }
                }
              },
              "ticket": {
                "type": "string"
              },
              "expires_at": {
                "type": "integer"
              }
            }
          }
        }
      }
    },
    "default": {
      "description": "HTTP error envelope. The status and error.code identify the failure.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Error"
          }
        }
      }
    }
  }
}