Add a relationship starting at an element.

Add a relationship starting at an element. Creates a relationship starting at the architecture element named in the path. Both the path and the body name the elements by their logical ElementId (the elementId an element keeps across all its versions), not by the instance id of one version. The conceptual class of both elements is resolved from the stored elements, so besides the two element ids only the reference kind and the direction are required; properties and linked elements may be omitted. If a relationship of the same kind and direction already exists between the two elements, that relationship is returned instead of a second one being created, and properties and linked elements sent along are merged into it as long as both elements are active and valid.

Security: Manager or Designer of the process space, or an owner of the affected architecture element(s).

POST/v1/warehouses/{warehouseId}/architectureElements/{elementId}/relations

Authorization

AuthorizationBearer token (JWT) · headerrequired

BpmLicenseAPI key · headerrequired

Path parameters

warehouseIdstringrequired

Warehouse-Id

elementIdstringrequired

logical ElementId of the source element

Request body

requiredapplication/json

Relationship to create

directionRelationshipDirectionrequired

Allowed:BidirectionalDirectionalNone

elementIdstringrequired

linkedElementsRefId[]

Show properties

Array of RefId

typestringrequired

propertiesCreateArchitectureProperty[]

Show properties

Array of CreateArchitectureProperty

keystringrequired

valueArchitecturePropertyValue

Show properties

typestringrequired

referenceKindReferenceKindrequired

Allowed:AccessAggregationArchitectureReferenceAssignmentAssociationCompositionFlowInfluenceRealizationServingSpecializationTriggering

Responses

200

Created or merged ArchitectureRelationship

architectureElementRefsArchitectureElementRef[]required

Show properties

Array of ArchitectureElementRef

conceptualClassArchitectureElementTyperequired

Allowed:ApplicationCollaborationApplicationComponentApplicationEventApplicationFunctionApplicationInteractionApplicationInterfaceApplicationProcessApplicationServiceArchitectureElementArtifactAssessmentBusinessActorBusinessCollaborationBusinessEventBusinessFunctionBusinessInteractionBusinessInterfaceBusinessObjectBusinessProcessBusinessRoleBusinessServiceCapabilityCommunicationNetworkCommunicationPathConstraintContractCourseOfActionDataObjectDeliverableDeviceDistributionNetworkDriverEquipmentFacilityGapGoalGroupingImplementationEventLocationMaterialMeaningNodeOutcomePlateauPrincipleProductRepresentationRequirementResourceStakeholderSystemSoftwareTechnologyCollaborationTechnologyEventTechnologyFunctionTechnologyInteractionTechnologyInterfaceTechnologyProcessTechnologyServiceValueValueStreamWorkPackage

elementIdstringrequired

referenceDirectionReferenceDirectionrequired

Allowed:BidirectionalNoneSourceTarget

referenceKindReferenceKindrequired

Allowed:AccessAggregationArchitectureReferenceAssignmentAssociationCompositionFlowInfluenceRealizationServingSpecializationTriggering

specializationstring

conceptualClassArchitectureRelationshipType

Allowed:AccessAggregationArchitectureReferenceAssignmentAssociationCompositionFlowInfluenceRealizationServingSpecializationTriggering

idstringrequired

linkedElementsRefId[]required

Show properties

Array of RefId

typestringrequired

propertiesArchitectureProperty[]required

Show properties

Array of ArchitectureProperty

metaArchitectureMetaPropertyrequired

Show properties

corebooleanrequired

descriptionTranslatedString

groupstring

keystringrequired

labelTranslatedString

typeArchitecturePropertyTyperequired

Allowed:BBCodeBooleanDateDateTimeDecimalEnumIntegerStringTime

validationArchitecturePropertyValidation

Show properties

literalsTranslatedString[]

lowerBoundstring

mandatorybooleanrequired

upperBoundstring

valueTranslatedString

Show properties

defaultLanguagestringrequired

translationsTranslation[]required

Show properties

Array of Translation

languagestringrequired

valuestringrequired

relationshipDirectionRelationshipDirectionrequired

Allowed:BidirectionalDirectionalNone

specializationArchitectureRelationshipSpecializationType

Allowed:NotSpecialized

400

Invalid reference kind, direction or property

string

403

Forbidden: insufficient permissions

string

404

Warehouse or ArchitectureElement 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-IdelementIdpath*logical ElementId of the source element

Bodyapplication/json

Request body

Request

curl -X POST 'https://publicapi.goto.bpanda.com/bpm/api/v1/warehouses/string/architectureElements/string/relations' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'BpmLicense: YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "direction": "Bidirectional",
  "elementId": "string",
  "linkedElements": [
    {
      "type": "string"
    }
  ],
  "properties": [
    {
      "key": "string",
      "value": {
        "type": "string"
      }
    }
  ],
  "referenceKind": "Access"
}'

const response = await fetch("https://publicapi.goto.bpanda.com/bpm/api/v1/warehouses/string/architectureElements/string/relations", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "BpmLicense": "YOUR_API_KEY",
    "Content-Type": "application/json"
  },
  body: "{\n  \"direction\": \"Bidirectional\",\n  \"elementId\": \"string\",\n  \"linkedElements\": [\n    {\n      \"type\": \"string\"\n    }\n  ],\n  \"properties\": [\n    {\n      \"key\": \"string\",\n      \"value\": {\n        \"type\": \"string\"\n      }\n    }\n  ],\n  \"referenceKind\": \"Access\"\n}"
});

Response

{
  "architectureElementRefs": [
    {
      "conceptualClass": "ApplicationCollaboration",
      "elementId": "string",
      "referenceDirection": "Bidirectional",
      "referenceKind": "Access",
      "specialization": "string"
    }
  ],
  "conceptualClass": "Access",
  "id": "string",
  "linkedElements": [
    {
      "type": "string"
    }
  ],
  "properties": [
    {
      "meta": {
        "core": true,
        "description": {
          "defaultLanguage": "string",
          "translations": [
            {
              "language": "string",
              "value": "string"
            }
          ]
        },
        "group": "string",
        "key": "string",
        "label": {
          "defaultLanguage": "string",
          "translations": [
            {
              "language": "string",
              "value": "string"
            }
          ]
        },
        "type": "BBCode",
        "validation": {
          "literals": [
            {
              "defaultLanguage": "string",
              "translations": [
                {
                  "language": "string",
                  "value": "string"
                }
              ]
            }
          ],
          "lowerBound": "string",
          "mandatory": true,
          "upperBound": "string"
        }
      },
      "value": {
        "defaultLanguage": "string",
        "translations": [
          {
            "language": "string",
            "value": "string"
          }
        ]
      }
    }
  ],
  "relationshipDirection": "Bidirectional",
  "specialization": "NotSpecialized"
}

"string"

"string"

"string"