Zum Inhalt springen
Bpanda
Esc
↑↓navigieren↵öffnen⌘Jvorschau

Import elements and relationships from an ArchiMate XML file.

Import elements and relationships from an ArchiMate XML file. Imports the elements and relationships of an ArchiMate exchange format XML file. Elements whose type is not enabled in the architecture settings of the space, or that have no type, are not imported and are listed in failed; properties the settings do not declare for the element’s type are left out and listed in droppedProperties. A file that is no well-formed XML is turned down with 400.

Security: Manager or Designer of the process space.

POST/v1/warehouses/{warehouseId}/archimate/import
Autorisierung
AuthorizationBearer-Token (JWT) · headererforderlich
BpmLicenseAPI-Schlüssel · headererforderlich
Pfadparameter
warehouseIdstringerforderlich

ID of warehouse

Request-Body
erforderlichmultipart/form-data
filestring<binary>erforderlich
Antworten
200

Imported elements and relationships, and what was left out - also an element whose draft another change is working on, or whose draft was published or discarded meanwhile; import it again

droppedPropertiesArchimateImportDroppedProperty[]erforderlich
Eigenschaften anzeigen
Array von ArchimateImportDroppedProperty
conceptualClassstringerforderlich
externalIdstring
propertyKeystringerforderlich
reasonstringerforderlich
failedFail[]erforderlich
Eigenschaften anzeigen
Array von Fail
reasonstringerforderlich
successfulArchitectureElementsArchimateImportElementResult[]erforderlich
Eigenschaften anzeigen
Array von ArchimateImportElementResult
architectureElementIdstringerforderlich
architectureIdstringerforderlich
externalIdstringerforderlich
successfullRelationshipsArchimateImportRelationshipResult[]erforderlich
Eigenschaften anzeigen
Array von ArchimateImportRelationshipResult
externalIdstringerforderlich
relationshipIdstringerforderlich
400

The file is no well-formed XML

string
403

Forbidden: insufficient permissions

string
404

Warehouse not found

string
Ausprobieren
Server
Autorisierung
Parameter
Bodymultipart/form-data
Anfrage
curl -X POST 'https://goto.bpanda.com/api/v1/warehouses/string/archimate/import' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'BpmLicense: YOUR_API_KEY' \
  -H 'Accept: application/json' \
  --form-string 'file=string'
Antwort
{
  "droppedProperties": [
    {
      "conceptualClass": "string",
      "externalId": "string",
      "propertyKey": "string",
      "reason": "string"
    }
  ],
  "failed": [
    {
      "reason": "string"
    }
  ],
  "successfulArchitectureElements": [
    {
      "architectureElementId": "string",
      "architectureId": "string",
      "externalId": "string"
    }
  ],
  "successfullRelationships": [
    {
      "externalId": "string",
      "relationshipId": "string"
    }
  ]
}