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

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 Source and Target; only the Association and the generic relationship (ArchitectureReference) also list 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
Autorisierung
AuthorizationBearer-Token (JWT) · headererforderlich
BpmLicenseAPI-Schlüssel · headererforderlich
Pfadparameter
warehouseIdstringerforderlich

Warehouse-Id

Request-Body
erforderlichapplication/json

Object containing the two architecture elements and optional linkedElement refId

currentArchitectureIdstringerforderlich
linkedElementIdRefId
Eigenschaften anzeigen
typestringerforderlich
otherArchitectureIdstringerforderlich
Antworten
200

List of valid reference types with possible directions

Array von ValidReferenceTypeWithDirections
directionsReferenceDirection[]erforderlich
refTypeReferenceKinderforderlich
Erlaubt:AccessAggregationArchitectureReferenceAssignmentAssociationCompositionFlowInfluenceRealizationServingSpecializationTriggering
404

Warehouse not found

string
Ausprobieren
Server
Autorisierung
Parameter
Bodyapplication/json
Anfrage
curl -X POST 'https://goto.bpanda.com/api/v1/warehouses/string/architectureRelationships/types' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'BpmLicense: YOUR_API_KEY' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "currentArchitectureId": "string",
  "linkedElementId": {
    "type": "string"
  },
  "otherArchitectureId": "string"
}'
Antwort
[
  {
    "directions": [
      "Bidirectional"
    ],
    "refType": "Access"
  }
]