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

Edit a single relationship.

Edit a single relationship. Edits an existing ArchitectureRelationship The linkedElements follow the same rule as on creation: a BusinessProcess left without a BPMN reference gets its process, a relationship without a BusinessProcess takes none. While an end of the relationship has a draft, the edit changes the drafts only and reaches the published state of the other end with the draft’s publication. A business process in draft does not count. Writing a relationship requires the edition of this process space to cover every element the relationship connects. For an element that carries the relationship, covered means the type of every stored version carrying it is included; for an end that only the other side names, that a read bounded by the edition still hands the element out.

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

PUT/v1/warehouses/{warehouseId}/architectureRelationships/{relationshipId}
Autorisierung
AuthorizationBearer-Token (JWT) · headererforderlich
BpmLicenseAPI-Schlüssel · headererforderlich
Pfadparameter
warehouseIdstringerforderlich

Warehouse-Id

relationshipIdstringerforderlich

ArchitectureRelationship-Id

Request-Body
erforderlichapplication/json

UpdateArchitectureReference

linkedElementsRefId[]
Eigenschaften anzeigen
Array von RefId
typestringerforderlich
propertiesCreateArchitectureProperty[]
Eigenschaften anzeigen
Array von CreateArchitectureProperty
keystringerforderlich
valueArchitecturePropertyValue
Eigenschaften anzeigen
typestringerforderlich
Antworten
200

Updated 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 linkedElements against the BusinessProcess rule: any on a relationship without BusinessProcess, one belonging to no BusinessProcess of it, or 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 ArchitectureRelationship not found

string
409

The draft the edit was for is being published, or was published or discarded meanwhile; edit again. A 409 saying the relationship exists on only one of its elements is not helped by retrying; it clears once the reference maintenance has dealt with it - it either writes the missing counterpart back, after which the edit works, or removes the relationship itself, after which this route answers 404. Daily where that maintenance is enabled, not at all where it is switched off or the counterpart element is gone entirely; such a relationship can then only be removed, not edited

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

War diese Seite hilfreich?