List all valid relationship types and directions between two elements.

List all valid relationship types and directions between two elements. Find valid reference types (conceptual classes of relationships) between two architecture elements and possible directions for each reference type. The rules are defined by ArchimateStandard. Already existing relationships between the two architecture elements are filtered out. For BusinessProcesses the existence of a relationship is determined via the currentLinkedElement if defined. Each direction names the role of the other element: Target means the relationship runs from currentArchitectureId to otherArchitectureId, Source means it runs from otherArchitectureId to currentArchitectureId. A type that is valid both ways lists all of Source, Target, Bidirectional and None. Creating a relationship knows no Source or Target: send direction Directional, starting at the element that is the source; Bidirectional and None are sent as they are.

Security: Any user holding a Bpanda licence for the process space.

POST/v1/warehouses/{warehouseId}/architectureRelationships/types

Authorization

AuthorizationBearer token (JWT) · headerrequired

BpmLicenseAPI key · headerrequired

Path parameters

warehouseIdstringrequired

Warehouse-Id

Request body

requiredapplication/json

Object containing the two architecture elements and optional linkedElement refId

currentArchitectureIdstringrequired

linkedElementIdRefId

Show properties

typestringrequired

otherArchitectureIdstringrequired

Responses

200

List of valid reference types with possible directions

Array of ValidReferenceTypeWithDirections

directionsReferenceDirection[]required

refTypeReferenceKindrequired

Allowed:AccessAggregationArchitectureReferenceAssignmentAssociationCompositionFlowInfluenceRealizationServingSpecializationTriggering

404

Warehouse not found

string

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

Bearer token (JWT)API keyRemember on this deviceInclude my values in samples

Parameters

warehouseIdpath*Warehouse-Id

Bodyapplication/json

Request body

Request

curl -X POST 'https://publicapi.goto.bpanda.com/bpm/api/v1/warehouses/string/architectureRelationships/types' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'BpmLicense: YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "currentArchitectureId": "string",
  "linkedElementId": {
    "type": "string"
  },
  "otherArchitectureId": "string"
}'

const response = await fetch("https://publicapi.goto.bpanda.com/bpm/api/v1/warehouses/string/architectureRelationships/types", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "BpmLicense": "YOUR_API_KEY",
    "Content-Type": "application/json"
  },
  body: "{\n  \"currentArchitectureId\": \"string\",\n  \"linkedElementId\": {\n    \"type\": \"string\"\n  },\n  \"otherArchitectureId\": \"string\"\n}"
});

Response

[
  {
    "directions": [
      "Bidirectional"
    ],
    "refType": "Access"
  }
]

"string"