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

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. A relationship with a BusinessProcess carries a BPMN reference for each BusinessProcess it connects (its process, or an element or lane of it): a missing one is added from the BusinessProcess’s representation. A relationship without a BusinessProcess carries no linked elements. 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. Relationships between the same two elements are created one at a time; if another one is still being created after a short wait, the request is answered with 409. A Composition replaces the other Compositions of its part, since a part belongs to at most one whole. If the part has a draft, only that draft changes until it is published; otherwise the change takes effect at once. A Composition that would close a cycle is rejected. Compositions of one process space are written one at a time; if another one is still being written after a short wait, the request is answered with 409 and can be repeated. Writing a relationship requires the edition of this process space to cover every element the relationship connects: for each of them, the type of every stored version counts, not only the current one.

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

POST/v1/warehouses/{warehouseId}/architectureElements/{elementId}/relations
Autorisierung
AuthorizationBearer-Token (JWT) · headererforderlich
BpmLicenseAPI-Schlüssel · headererforderlich
Pfadparameter
warehouseIdstringerforderlich

Warehouse-Id

elementIdstringerforderlich

Logical ElementId of the source element

Request-Body
erforderlichapplication/json

Relationship to create

directionRelationshipDirectionerforderlich
Erlaubt:BidirectionalDirectionalNone
elementIdstringerforderlich
linkedElementsRefId[]
Eigenschaften anzeigen
Array von RefId
typestringerforderlich
propertiesCreateArchitectureProperty[]
Eigenschaften anzeigen
Array von CreateArchitectureProperty
keystringerforderlich
valueArchitecturePropertyValue
Eigenschaften anzeigen
typestringerforderlich
referenceKindReferenceKinderforderlich
Erlaubt:AccessAggregationArchitectureReferenceAssignmentAssociationCompositionFlowInfluenceRealizationServingSpecializationTriggering
Antworten
200

Created or merged ArchitectureRelationship

architectureElementRefsArchitectureElementRef[]erforderlich
Eigenschaften anzeigen
Array von ArchitectureElementRef
conceptualClassArchitectureElementTypeerforderlich
Erlaubt:ApplicationCollaborationApplicationComponentApplicationEventApplicationFunctionApplicationInteractionApplicationInterfaceApplicationProcessApplicationServiceArchitectureElementArtifactAssessmentBusinessActorBusinessCollaborationBusinessEventBusinessFunctionBusinessInteractionBusinessInterfaceBusinessObjectBusinessProcessBusinessRoleBusinessServiceCapabilityCommunicationNetworkCommunicationPathConstraintContractCourseOfActionDataObjectDeliverableDeviceDistributionNetworkDriverEquipmentFacilityGapGoalGroupingImplementationEventLocationMaterialMeaningNodeOutcomePlateauPrincipleProductRepresentationRequirementResourceStakeholderSystemSoftwareTechnologyCollaborationTechnologyEventTechnologyFunctionTechnologyInteractionTechnologyInterfaceTechnologyProcessTechnologyServiceValueValueStreamWorkPackage
elementIdstringerforderlich
referenceDirectionReferenceDirectionerforderlich
Erlaubt:BidirectionalNoneSourceTarget
referenceKindReferenceKinderforderlich
Erlaubt:AccessAggregationArchitectureReferenceAssignmentAssociationCompositionFlowInfluenceRealizationServingSpecializationTriggering
specializationstring
conceptualClassArchitectureRelationshipType
Erlaubt:AccessAggregationArchitectureReferenceAssignmentAssociationCompositionFlowInfluenceRealizationServingSpecializationTriggering
idstringerforderlich
linkedElementsRefId[]erforderlich
Eigenschaften anzeigen
Array von RefId
typestringerforderlich
propertiesArchitectureProperty[]erforderlich
Eigenschaften anzeigen
Array von ArchitectureProperty
enumKeystring
metaArchitectureMetaPropertyerforderlich
Eigenschaften anzeigen
corebooleanerforderlich
descriptionTranslatedString
groupstring
keystringerforderlich
labelTranslatedString
typeArchitecturePropertyTypeerforderlich
Erlaubt:BBCodeBooleanDateDateTimeDecimalEnumIntegerStringTime
validationArchitecturePropertyValidation
Eigenschaften anzeigen
enumLiteralsArchitectureEnumLiteral[]
Eigenschaften anzeigen
Array von ArchitectureEnumLiteral
deprecatedbooleanerforderlich
keystringerforderlich
labelTranslatedStringerforderlich
literalsTranslatedString[]
lowerBoundstring
mandatorybooleanerforderlich
upperBoundstring
valueTranslatedString
Eigenschaften anzeigen
defaultLanguagestringerforderlich
translationsTranslation[]erforderlich
Eigenschaften anzeigen
Array von Translation
languagestringerforderlich
valuestringerforderlich
relationshipDirectionRelationshipDirectionerforderlich
Erlaubt:BidirectionalDirectionalNone
specializationArchitectureRelationshipSpecializationType
Erlaubt:NotSpecialized
400

Invalid reference kind, direction or property (every kind but Association and ArchitectureReference must be Directional), a Composition cycle, or linkedElements against the BusinessProcess rule (any on a relationship without BusinessProcess, one belonging to no BusinessProcess of it, a BusinessProcess without a process)

string
403

Forbidden: insufficient permissions, or the edition of this process space does not cover an element the relationship connects

string
404

Warehouse or ArchitectureElement not found

string
409

Another Composition of the process space, or another relationship between the two elements, is being written, or a draft of one of them is being published; repeat the request

string
Ausprobieren
Server
Autorisierung
Parameter
Bodyapplication/json
Anfrage
curl -X POST 'https://goto.bpanda.com/api/v1/warehouses/string/architectureElements/string/relations' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'BpmLicense: YOUR_API_KEY' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "direction": "Bidirectional",
  "elementId": "string",
  "linkedElements": [
    {
      "type": "string"
    }
  ],
  "properties": [
    {
      "key": "string",
      "value": {
        "type": "string"
      }
    }
  ],
  "referenceKind": "Access"
}'
Antwort
{
  "architectureElementRefs": [
    {
      "conceptualClass": "ApplicationCollaboration",
      "elementId": "string",
      "referenceDirection": "Bidirectional",
      "referenceKind": "Access",
      "specialization": "string"
    }
  ],
  "conceptualClass": "Access",
  "id": "string",
  "linkedElements": [
    {
      "type": "string"
    }
  ],
  "properties": [
    {
      "enumKey": "string",
      "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": {
          "enumLiterals": [
            {
              "deprecated": true,
              "key": "string",
              "label": {
                "defaultLanguage": "string",
                "translations": [
                  {
                    "language": "string",
                    "value": "string"
                  }
                ]
              }
            }
          ],
          "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"
}