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

Edit a single element.

Edit a single element. Edits an existing ArchitectureElement. The path names it by its instance id (the id of one version of the element), not by its logical ElementId. The edit lands in the element’s draft, derived from the published version if it has none yet, and that version is what it is read against: the properties taken are the ones its conceptual class declares, and a change of the conceptual class is measured against the one it carries - not against the version the path names.

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

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

Warehouse-Id

instanceIdstringerforderlich

Instance id of the ArchitectureElement (its id, not its elementId)

Request-Body
erforderlichapplication/json

UpdateArchitectureElement

conceptualClassArchitectureElementType
Erlaubt:ApplicationCollaborationApplicationComponentApplicationEventApplicationFunctionApplicationInteractionApplicationInterfaceApplicationProcessApplicationServiceArchitectureElementArtifactAssessmentBusinessActorBusinessCollaborationBusinessEventBusinessFunctionBusinessInteractionBusinessInterfaceBusinessObjectBusinessProcessBusinessRoleBusinessServiceCapabilityCommunicationNetworkCommunicationPathConstraintContractCourseOfActionDataObjectDeliverableDeviceDistributionNetworkDriverEquipmentFacilityGapGoalGroupingImplementationEventLocationMaterialMeaningNodeOutcomePlateauPrincipleProductRepresentationRequirementResourceStakeholderSystemSoftwareTechnologyCollaborationTechnologyEventTechnologyFunctionTechnologyInteractionTechnologyInterfaceTechnologyProcessTechnologyServiceValueValueStreamWorkPackage
ownersEntityId[]
Eigenschaften anzeigen
Array von EntityId
typeEntityIdTypeerforderlich
Erlaubt:GroupIdOrgRoleIdOrgUnitIdUserId
valuestringerforderlich
propertiesCreateArchitectureProperty[]
Eigenschaften anzeigen
Array von CreateArchitectureProperty
keystringerforderlich
valueArchitecturePropertyValue
Eigenschaften anzeigen
typestringerforderlich
propertyUpdateModePropertyUpdateMode
Erlaubt:MergeOverwrite
representationRefId
Eigenschaften anzeigen
typestringerforderlich
specializationstring
Antworten
200

Updated ArchitectureElement

conceptualClassArchitectureElementTypeerforderlich
Erlaubt:ApplicationCollaborationApplicationComponentApplicationEventApplicationFunctionApplicationInteractionApplicationInterfaceApplicationProcessApplicationServiceArchitectureElementArtifactAssessmentBusinessActorBusinessCollaborationBusinessEventBusinessFunctionBusinessInteractionBusinessInterfaceBusinessObjectBusinessProcessBusinessRoleBusinessServiceCapabilityCommunicationNetworkCommunicationPathConstraintContractCourseOfActionDataObjectDeliverableDeviceDistributionNetworkDriverEquipmentFacilityGapGoalGroupingImplementationEventLocationMaterialMeaningNodeOutcomePlateauPrincipleProductRepresentationRequirementResourceStakeholderSystemSoftwareTechnologyCollaborationTechnologyEventTechnologyFunctionTechnologyInteractionTechnologyInterfaceTechnologyProcessTechnologyServiceValueValueStreamWorkPackage
createdHistoryerforderlich
Eigenschaften anzeigen
atstringerforderlich
bystringerforderlich
elementIdstringerforderlich
externalIdstring
groupsArchitectureGroup[]erforderlich
Eigenschaften anzeigen
Array von ArchitectureGroup
corebooleanerforderlich
descriptionTranslatedString
Eigenschaften anzeigen
defaultLanguagestringerforderlich
translationsTranslation[]erforderlich
Eigenschaften anzeigen
Array von Translation
languagestringerforderlich
valuestringerforderlich
keystringerforderlich
labelTranslatedString
Eigenschaften anzeigen
defaultLanguagestringerforderlich
translationsTranslation[]erforderlich
hasPredecessorbooleanerforderlich
idstringerforderlich
lastValidationHistory
Eigenschaften anzeigen
atstringerforderlich
bystringerforderlich
layerArchitectureElementLayererforderlich
Erlaubt:ApplicationLayerBusinessLayerGenericLayerImplementationAndMigrationLayerMotivationElementsStrategyLayerTechnologyLayer
modifiedHistory
Eigenschaften anzeigen
atstringerforderlich
bystringerforderlich
ownersEntityId[]erforderlich
Eigenschaften anzeigen
Array von EntityId
typeEntityIdTypeerforderlich
Erlaubt:GroupIdOrgRoleIdOrgUnitIdUserId
valuestringerforderlich
principalIsOwnerbooleanerforderlich
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
publishedHistory
Eigenschaften anzeigen
atstringerforderlich
bystringerforderlich
referencesArchitectureReference[]erforderlich
Eigenschaften anzeigen
Array von ArchitectureReference
metaArchitectureMetaReferenceerforderlich
Eigenschaften anzeigen
corebooleanerforderlich
descriptionTranslatedString
groupstring
keystringerforderlich
labelTranslatedString
multiplicityArchitectureReferenceMultiplicityerforderlich
Erlaubt:ExactlyOneOneOrMoreZeroOrMoreZeroOrOne
targetClassesstring[]erforderlich
targetReference
Eigenschaften anzeigen
assignedArchitectureElementRefsArchitectureElementRef[]erforderlich
Eigenschaften anzeigen
Array von ArchitectureElementRef
conceptualClassArchitectureElementTypeerforderlich
Erlaubt:ApplicationCollaborationApplicationComponentApplicationEventApplicationFunctionApplicationInteractionApplicationInterfaceApplicationProcessApplicationServiceArchitectureElementArtifactAssessmentBusinessActorBusinessCollaborationBusinessEventBusinessFunctionBusinessInteractionBusinessInterfaceBusinessObjectBusinessProcessBusinessRoleBusinessServiceCapabilityCommunicationNetworkCommunicationPathConstraintContractCourseOfActionDataObjectDeliverableDeviceDistributionNetworkDriverEquipmentFacilityGapGoalGroupingImplementationEventLocationMaterialMeaningNodeOutcomePlateauPrincipleProductRepresentationRequirementResourceStakeholderSystemSoftwareTechnologyCollaborationTechnologyEventTechnologyFunctionTechnologyInteractionTechnologyInterfaceTechnologyProcessTechnologyServiceValueValueStreamWorkPackage
elementIdstringerforderlich
referenceDirectionReferenceDirectionerforderlich
Erlaubt:BidirectionalNoneSourceTarget
referenceKindReferenceKinderforderlich
Erlaubt:AccessAggregationArchitectureReferenceAssignmentAssociationCompositionFlowInfluenceRealizationServingSpecializationTriggering
specializationstring
createdHistoryerforderlich
linkedElementsRefId[]erforderlich
modifiedHistory
propertiesArchitectureProperty[]erforderlich
relationshipIdstringerforderlich
representationRefId
Eigenschaften anzeigen
typestringerforderlich
specializationstring
validityStateArchitectureValidityStateerforderlich
Erlaubt:DraftInvalidNextUpcomingValid
visibilityVisibilityerforderlich
Eigenschaften anzeigen
lastChangeHistoryerforderlich
Eigenschaften anzeigen
atstringerforderlich
bystringerforderlich
visiblebooleanerforderlich
400

The element would be left without a name, a property value is invalid or its key is not declared by the conceptual class the edit is read against, or the representation belongs to another element

string
403

Forbidden: insufficient permissions

string
404

Warehouse or ArchitectureElement not found

string
409

Another change is still working on the draft of the element or on the representation given, the draft was published or discarded meanwhile, or the version this edit was prepared for is no longer the one it would be written to; repeat the request. Or the element documents a version of a process with an open BPMN draft; change the process in that draft instead

string
Ausprobieren
Server
Autorisierung
Parameter
Bodyapplication/json
Anfrage
curl -X PUT 'https://goto.bpanda.com/api/v1/warehouses/string/architectureElements/string' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'BpmLicense: YOUR_API_KEY' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "conceptualClass": "ApplicationCollaboration",
  "owners": [
    {
      "type": "GroupId",
      "value": "string"
    }
  ],
  "properties": [
    {
      "key": "string",
      "value": {
        "type": "string"
      }
    }
  ],
  "propertyUpdateMode": "Merge",
  "representation": {
    "type": "string"
  },
  "specialization": "string"
}'
Antwort
{
  "conceptualClass": "ApplicationCollaboration",
  "created": {
    "at": "string",
    "by": "string"
  },
  "elementId": "string",
  "externalId": "string",
  "groups": [
    {
      "core": true,
      "description": {
        "defaultLanguage": "string",
        "translations": [
          {
            "language": "string",
            "value": "string"
          }
        ]
      },
      "key": "string",
      "label": {
        "defaultLanguage": "string",
        "translations": [
          {
            "language": "string",
            "value": "string"
          }
        ]
      }
    }
  ],
  "hasPredecessor": true,
  "id": "string",
  "lastValidation": {
    "at": "string",
    "by": "string"
  },
  "layer": "ApplicationLayer",
  "modified": {
    "at": "string",
    "by": "string"
  },
  "owners": [
    {
      "type": "GroupId",
      "value": "string"
    }
  ],
  "principalIsOwner": true,
  "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"
          }
        ]
      }
    }
  ],
  "published": {
    "at": "string",
    "by": "string"
  },
  "references": [
    {
      "meta": {
        "core": true,
        "description": {
          "defaultLanguage": "string",
          "translations": [
            {
              "language": "string",
              "value": "string"
            }
          ]
        },
        "group": "string",
        "key": "string",
        "label": {
          "defaultLanguage": "string",
          "translations": [
            {
              "language": "string",
              "value": "string"
            }
          ]
        },
        "multiplicity": "ExactlyOne",
        "targetClasses": [
          "string"
        ]
      },
      "target": {
        "assignedArchitectureElementRefs": [
          {
            "conceptualClass": "ApplicationCollaboration",
            "elementId": "string",
            "referenceDirection": "Bidirectional",
            "referenceKind": "Access",
            "specialization": "string"
          }
        ],
        "created": {
          "at": "string",
          "by": "string"
        },
        "linkedElements": [
          {
            "type": "string"
          }
        ],
        "modified": {
          "at": "string",
          "by": "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"
                }
              ]
            }
          }
        ],
        "relationshipId": "string"
      }
    }
  ],
  "representation": {
    "type": "string"
  },
  "specialization": "string",
  "validityState": "Draft",
  "visibility": {
    "lastChange": {
      "at": "string",
      "by": "string"
    },
    "visible": true
  }
}