Skip to content
Bpanda
English
DeutschEnglishNot translated
Esc
↑↓navigate↵open⌘Jpreview

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
Authorization
AuthorizationBearer token (JWT) · headerrequired
BpmLicenseAPI key · headerrequired
Path parameters
warehouseIdstringrequired

ID of warehouse

Request body
requiredmultipart/form-data
filestring<binary>required
Responses
200

Imported elements and relationships, and what was left out

droppedPropertiesArchimateImportDroppedProperty[]required
Show properties
Array of ArchimateImportDroppedProperty
conceptualClassstringrequired
externalIdstring
propertyKeystringrequired
reasonstringrequired
failedFail[]required
Show properties
Array of Fail
reasonstringrequired
successfulArchitectureElementsArchimateImportElementResult[]required
Show properties
Array of ArchimateImportElementResult
architectureElementIdstringrequired
architectureIdstringrequired
externalIdstringrequired
successfullRelationshipsArchimateImportRelationshipResult[]required
Show properties
Array of ArchimateImportRelationshipResult
externalIdstringrequired
relationshipIdstringrequired
400

The file is no well-formed XML

string
403

Forbidden: insufficient permissions

string
404

Warehouse not found

string
Try it
Server
Authorization
Parameters
Bodymultipart/form-data
Request
curl -X POST 'https://publicapi.goto.bpanda.com/bpm/api/v1/warehouses/string/archimate/import' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'BpmLicense: YOUR_API_KEY' \
  --form-string 'file=string'
Response
{
  "droppedProperties": [
    {
      "conceptualClass": "string",
      "externalId": "string",
      "propertyKey": "string",
      "reason": "string"
    }
  ],
  "failed": [
    {
      "reason": "string"
    }
  ],
  "successfulArchitectureElements": [
    {
      "architectureElementId": "string",
      "architectureId": "string",
      "externalId": "string"
    }
  ],
  "successfullRelationships": [
    {
      "externalId": "string",
      "relationshipId": "string"
    }
  ]
}