--- seo: description: >- For API access over HTTPS please make sure that your SSL client includes the Comodo SHA-2 root certificate in its key chain (e.g. use Java at least in version… sidebar: label: Overview title: Bpanda REST API (experimental) --- For API access over HTTPS please make sure that your SSL client includes the Comodo SHA-2 root certificate in its key chain (e.g. use Java at least in version 8u51). This Version is experimental and may change in the future. Version 0.0.1-experimental+2026-04 Base URL: `https://publicapi.goto.bpanda.com/bpm/api` ## Architecture - [`POST /v1/warehouses/{warehouseId}/architectureElements/list`](/api-reference/architecture/architecture-get-paginated-architecture-elements) — List a page of elements matching the given criteria. - [`POST /v1/warehouses/{warehouseId}/architectureElements/{elementId}/relations`](/api-reference/architecture/architecture-add-architecture-element-relation) — Add a relationship starting at an element. - [`DELETE /v1/warehouses/{warehouseId}/architectureRelationships`](/api-reference/architecture/architecture-remove-architecture-relationships) — Remove relationships by ID. - [`PUT /v1/warehouses/{warehouseId}/architectureElements/visibility`](/api-reference/architecture/architecture-set-architecture-element-visibility) — Show or hide every version of the given elements. - [`PUT /v1/warehouses/{warehouseId}/architectureRelationships/{relationshipId}`](/api-reference/architecture/architecture-edit-architecture-relationship) — Edit a single relationship. - [`POST /v1/warehouses/{warehouseId}/architectureReports/evaluate/details`](/api-reference/architecture/architecture-evaluate-report-details) — Evaluate the detail table of a report for the given elements. - [`POST /v1/warehouses/{warehouseId}/architectureRelationships/types`](/api-reference/architecture/architecture-find-valid-reference-types-with-directions) — List all valid relationship types and directions between two elements. - [`POST /v1/warehouses/{warehouseId}/archimate/import`](/api-reference/architecture/architecture-import-archimate-xml) — Import elements and relationships from an ArchiMate XML file. - [`POST /v1/warehouses/{warehouseId}/architectureElements`](/api-reference/architecture/architecture-create-architecture-element) — Add an element. - [`DELETE /v1/warehouses/{warehouseId}/architectureElements`](/api-reference/architecture/architecture-remove-architecture-elements) — Remove element drafts by ID. - [`POST /v1/warehouses/{warehouseId}/architectureElements/publish`](/api-reference/architecture/architecture-publish-architecture-elements) — Publish the elements with the given IDs. - [`POST /v1/warehouses/{warehouseId}/architectureRelationships/byIds/bulk`](/api-reference/architecture/architecture-get-architecture-relationships-by-ids) — List all relationships with the given IDs. - [`GET /v1/warehouses/{warehouseId}/architectureReports/types`](/api-reference/architecture/architecture-get-valid-architecture-report-types) — List all valid report types. - [`POST /v1/warehouses/{warehouseId}/architectureElements/byIds/bulk`](/api-reference/architecture/architecture-get-architecture-elements-by-ids) — List all elements with the given instance IDs. - [`GET /v1/warehouses/{warehouseId}/architectureElements/types`](/api-reference/architecture/architecture-get-valid-architecture-element-types) — List all valid element types. - [`GET /v1/warehouses/{warehouseId}/architectureReports/evaluate`](/api-reference/architecture/architecture-evaluate-report) — Evaluate a report by its type. - [`POST /v1/warehouses/{warehouseId}/archimate/export`](/api-reference/architecture/architecture-export-archimate-xml) — Export the given elements as an ArchiMate XML file. - [`PUT /v1/warehouses/{warehouseId}/architectureElements/{instanceId}`](/api-reference/architecture/architecture-edit-architecture-element) — Edit a single element. - [`GET /v1/warehouses/{warehouseId}/architectureElements/drafts/count`](/api-reference/architecture/architecture-get-draft-count) — Count the element drafts visible to the caller. - [`POST /v1/warehouses/{warehouseId}/architectureElements/byRepresentation`](/api-reference/architecture/architecture-get-architecture-elements-by-representation) — List all elements by their representation. - [`GET /v1/warehouses/{warehouseId}/archimate/export/reports`](/api-reference/architecture/architecture-archimate-export-reports) — List all remembered ArchiMate export reports. - [`GET /v1/warehouses/{warehouseId}/archimate/export/{exportId}/report`](/api-reference/architecture/architecture-archimate-export-report) — List a single ArchiMate export report by ID. - [`POST /v1/warehouses/{warehouseId}/archimate/exportFiltered`](/api-reference/architecture/architecture-export-filtered-archimate-xml) — Export all elements matching the given filters as an ArchiMate XML file. - [`GET /v1/warehouses/{warehouseId}/preferences/architecture/reports`](/api-reference/architecture/architecture-load-architecture-report-settings) — List all reports of the report settings. - [`PUT /v1/warehouses/{warehouseId}/preferences/architecture/reports`](/api-reference/architecture/architecture-add-architecture-report-settings) — Add reports to the report settings. - [`DELETE /v1/warehouses/{warehouseId}/preferences/architecture/reports`](/api-reference/architecture/architecture-remove-architecture-report-settings) — Remove reports from the report settings. - [`POST /v1/warehouses/{warehouseId}/architectureElements/byElementIds/bulk`](/api-reference/architecture/architecture-get-architecture-elements-by-element-ids) — List all elements with the given element IDs. - [`GET /v1/warehouses/{warehouseId}/preferences/architecture/elements`](/api-reference/architecture/architecture-load-architecture-element-settings) — List all elements of the element settings. - [`PUT /v1/warehouses/{warehouseId}/preferences/architecture/elements`](/api-reference/architecture/architecture-add-architecture-element-settings) — Add elements to the element settings. - [`DELETE /v1/warehouses/{warehouseId}/preferences/architecture/elements`](/api-reference/architecture/architecture-remove-architecture-element-settings) — Remove elements from the element settings. - [`POST /v1/warehouses/{warehouseId}/architectureRelationships/external/uses`](/api-reference/architecture/architecture-find-external-uses) — List all external uses of an element or a process version. - [`POST /v1/warehouses/{warehouseId}/architectureElements/publishFiltered`](/api-reference/architecture/architecture-publish-filtered-architecture-elements) — Publish all elements matching a query. ## Users - [`GET /v1/warehouses/{warehouseId}/users/email/{email}`](/api-reference/users/users-get-by-e-mail) — List a single user by email address. - [`GET /v1/warehouses/{warehouseId}/users`](/api-reference/users/users-get-all-users) — List all users. - [`GET /v1/warehouses/{warehouseId}/users/{userId}`](/api-reference/users/users-get) — List a single user by ID. - [`POST /v1/warehouses/{warehouseId}/users/byids`](/api-reference/users/users-get-by-ids) — List several users by IDs. ## API Authorization - [`POST /v1/apiUserInfo`](/api-reference/api-authorization/api-user-info-get-api-user-info) — Obtain a token, license and user info for a client of an account. ## OrgStructure - [`GET /v1/warehouses/{warehouseId}/orgstructure`](/api-reference/orgstructure/org-structure-get-org-structure) — List the complete structure of the space. - [`POST /v1/warehouses/{warehouseId}/orgstructure/roles/byuserids`](/api-reference/orgstructure/org-structure-get-org-roles-by-user-ids) — List all roles containing one of the given users. - [`POST /v1/warehouses/{warehouseId}/orgstructure/units/byids`](/api-reference/orgstructure/org-structure-get-org-units) — List all units with the given IDs. - [`GET /v1/warehouses/{warehouseId}/orgstructure/roles/{roleId}/userids`](/api-reference/orgstructure/org-structure-get-org-role-user-ids) — List all users of a role, optionally limited to a unit. - [`GET /v1/warehouses/{warehouseId}/orgstructure/roles`](/api-reference/orgstructure/org-structure-get-org-roles) — List all roles. - [`GET /v1/warehouses/{warehouseId}/orgstructure/roles/{roleId}`](/api-reference/orgstructure/org-structure-get-org-role) — List a single role by ID. - [`GET /v1/warehouses/{warehouseId}/orgstructure/units/{unitId}`](/api-reference/orgstructure/org-structure-get-org-unit) — List a single unit by ID. - [`GET /v1/warehouses/{warehouseId}/orgstructure/users/{userId}`](/api-reference/orgstructure/org-structure-get-org-units-by-user) — List all units a user is part of. - [`GET /v1/warehouses/{warehouseId}/orgstructure/roles/{roleId}/unitids`](/api-reference/orgstructure/org-structure-get-org-role-unit-ids) — List all units using a role. - [`GET /v1/warehouses/{warehouseId}/orgstructure/units/{unitId}/roleids`](/api-reference/orgstructure/org-structure-get-org-unit-role-ids) — List all roles used in a unit. ## Processes - [`GET /v1/warehouses/{warehouseId}/processes/{processId}`](/api-reference/processes/processes-get-process) — List the full model of a single version by ID. - [`POST /v1/warehouses/{warehouseId}/processes/{processId}/elementinfos`](/api-reference/processes/processes-get-process-elements-info) — List the meta information of the given elements of a version. - [`GET /v1/warehouses/{warehouseId}/processes/{processId}/versions`](/api-reference/processes/processes-get-versions) — List all versions visible to the caller. - [`GET /v1/warehouses/{warehouseId}/processes/{processId}/info`](/api-reference/processes/processes-get-process-info) — List the meta information of a single version. - [`GET /v1/warehouses/{warehouseId}/processes/{processId}/svg`](/api-reference/processes/processes-get-svg) — Export the diagram of a version as SVG. ## Groups - [`POST /v1/warehouses/{warehouseId}/groups/byids`](/api-reference/groups/users-get-groups) — List several groups by IDs. - [`GET /v1/warehouses/{warehouseId}/groups`](/api-reference/groups/users-get-all-groups) — List all groups. - [`GET /v1/warehouses/{warehouseId}/groups/{groupId}`](/api-reference/groups/users-get-group) — List a single group by ID.