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.

Architecture

• POST
  List a page of elements matching the given criteria./v1/warehouses/{warehouseId}/architectureElements/list
• POST
  Add a relationship starting at an element./v1/warehouses/{warehouseId}/architectureElements/{elementId}/relations
• DELETE
  Remove relationships by ID./v1/warehouses/{warehouseId}/architectureRelationships
• PUT
  Show or hide every version of the given elements./v1/warehouses/{warehouseId}/architectureElements/visibility
• PUT
  Edit a single relationship./v1/warehouses/{warehouseId}/architectureRelationships/{relationshipId}
• POST
  Evaluate the detail table of a report for the given elements./v1/warehouses/{warehouseId}/architectureReports/evaluate/details
• POST
  List all valid relationship types and directions between two elements./v1/warehouses/{warehouseId}/architectureRelationships/types
• POST
  Import elements and relationships from an ArchiMate XML file./v1/warehouses/{warehouseId}/archimate/import
• POST
  Add an element./v1/warehouses/{warehouseId}/architectureElements
• DELETE
  Remove element drafts by ID./v1/warehouses/{warehouseId}/architectureElements
• POST
  Publish the elements with the given IDs./v1/warehouses/{warehouseId}/architectureElements/publish
• POST
  List all relationships with the given IDs./v1/warehouses/{warehouseId}/architectureRelationships/byIds/bulk
• GET
  List all valid report types./v1/warehouses/{warehouseId}/architectureReports/types
• POST
  List all elements with the given instance IDs./v1/warehouses/{warehouseId}/architectureElements/byIds/bulk
• GET
  List all valid element types./v1/warehouses/{warehouseId}/architectureElements/types
• GET
  Evaluate a report by its type./v1/warehouses/{warehouseId}/architectureReports/evaluate
• POST
  Export the given elements as an ArchiMate XML file./v1/warehouses/{warehouseId}/archimate/export
• PUT
  Edit a single element./v1/warehouses/{warehouseId}/architectureElements/{instanceId}
• GET
  Count the element drafts visible to the caller./v1/warehouses/{warehouseId}/architectureElements/drafts/count
• POST
  List all elements by their representation./v1/warehouses/{warehouseId}/architectureElements/byRepresentation
• GET
  List all remembered ArchiMate export reports./v1/warehouses/{warehouseId}/archimate/export/reports
• GET
  List a single ArchiMate export report by ID./v1/warehouses/{warehouseId}/archimate/export/{exportId}/report
• POST
  Export all elements matching the given filters as an ArchiMate XML file./v1/warehouses/{warehouseId}/archimate/exportFiltered
• GET
  List all reports of the report settings./v1/warehouses/{warehouseId}/preferences/architecture/reports
• PUT
  Add reports to the report settings./v1/warehouses/{warehouseId}/preferences/architecture/reports
• DELETE
  Remove reports from the report settings./v1/warehouses/{warehouseId}/preferences/architecture/reports
• POST
  List all elements with the given element IDs./v1/warehouses/{warehouseId}/architectureElements/byElementIds/bulk
• GET
  List all elements of the element settings./v1/warehouses/{warehouseId}/preferences/architecture/elements
• PUT
  Add elements to the element settings./v1/warehouses/{warehouseId}/preferences/architecture/elements
• DELETE
  Remove elements from the element settings./v1/warehouses/{warehouseId}/preferences/architecture/elements
• POST
  List all external uses of an element or a process version./v1/warehouses/{warehouseId}/architectureRelationships/external/uses
• POST
  Publish all elements matching a query./v1/warehouses/{warehouseId}/architectureElements/publishFiltered

Users

• GET
  List a single user by email address./v1/warehouses/{warehouseId}/users/email/{email}
• GET
  List all users./v1/warehouses/{warehouseId}/users
• GET
  List a single user by ID./v1/warehouses/{warehouseId}/users/{userId}
• POST
  List several users by IDs./v1/warehouses/{warehouseId}/users/byids

API Authorization

• POST
  Obtain a token, license and user info for a client of an account./v1/apiUserInfo

OrgStructure

• GET
  List the complete structure of the space./v1/warehouses/{warehouseId}/orgstructure
• POST
  List all roles containing one of the given users./v1/warehouses/{warehouseId}/orgstructure/roles/byuserids
• POST
  List all units with the given IDs./v1/warehouses/{warehouseId}/orgstructure/units/byids
• GET
  List all users of a role, optionally limited to a unit./v1/warehouses/{warehouseId}/orgstructure/roles/{roleId}/userids
• GET
  List all roles./v1/warehouses/{warehouseId}/orgstructure/roles
• GET
  List a single role by ID./v1/warehouses/{warehouseId}/orgstructure/roles/{roleId}
• GET
  List a single unit by ID./v1/warehouses/{warehouseId}/orgstructure/units/{unitId}
• GET
  List all units a user is part of./v1/warehouses/{warehouseId}/orgstructure/users/{userId}
• GET
  List all units using a role./v1/warehouses/{warehouseId}/orgstructure/roles/{roleId}/unitids
• GET
  List all roles used in a unit./v1/warehouses/{warehouseId}/orgstructure/units/{unitId}/roleids

Processes

• GET
  List the full model of a single version by ID./v1/warehouses/{warehouseId}/processes/{processId}
• POST
  List the meta information of the given elements of a version./v1/warehouses/{warehouseId}/processes/{processId}/elementinfos
• GET
  List all versions visible to the caller./v1/warehouses/{warehouseId}/processes/{processId}/versions
• GET
  List the meta information of a single version./v1/warehouses/{warehouseId}/processes/{processId}/info
• GET
  Export the diagram of a version as SVG./v1/warehouses/{warehouseId}/processes/{processId}/svg

Groups

• POST
  List several groups by IDs./v1/warehouses/{warehouseId}/groups/byids
• GET
  List all groups./v1/warehouses/{warehouseId}/groups
• GET
  List a single group by ID./v1/warehouses/{warehouseId}/groups/{groupId}