Skip to content
Bpanda
English
DeutschEnglishNot translated
Esc
↑↓navigate↵open⌘Jpreview

Edit a single relationship.

Edit a single relationship. Edits an existing ArchitectureRelationship

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

PUT/v1/warehouses/{warehouseId}/architectureRelationships/{relationshipId}
Authorization
AuthorizationBearer token (JWT) · headerrequired
BpmLicenseAPI key · headerrequired
Path parameters
warehouseIdstringrequired

Warehouse-Id

relationshipIdstringrequired

ArchitectureRelationship-Id

Request body
requiredapplication/json

UpdateArchitectureReference

linkedElementsRefId[]
Show properties
Array of RefId
typestringrequired
propertiesCreateArchitectureProperty[]
Show properties
Array of CreateArchitectureProperty
keystringrequired
valueArchitecturePropertyValue
Show properties
typestringrequired
Responses
200

Updated 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
403

Forbidden: insufficient permissions

string
404

Warehouse or ArchitectureRelationship not found

string
Try it
Server
Authorization
Parameters
Bodyapplication/json
Request
curl -X PUT 'https://publicapi.goto.bpanda.com/bpm/api/v1/warehouses/string/architectureRelationships/string' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'BpmLicense: YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "linkedElements": [
    {
      "type": "string"
    }
  ],
  "properties": [
    {
      "key": "string",
      "value": {
        "type": "string"
      }
    }
  ]
}'
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"
}