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

Add an element.

Add an element. Creates a new ArchitectureElement. The elementId and the externalId can be given, e.g. to keep the ID an element had in another system. Both are free strings (not empty, at most 128 characters, no whitespace or control characters); the externalId must also be an XML NCName, since the ArchiMate export writes it as identifier. Without them the elementId is generated and the externalId is “id-” followed by the elementId.

Security: Manager or Designer of the process space.

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

Warehouse-Id

Request-Body
erforderlichapplication/json

CreateArchitectureElement

conceptualClassArchitectureElementTypeerforderlich
Erlaubt:ApplicationCollaborationApplicationComponentApplicationEventApplicationFunctionApplicationInteractionApplicationInterfaceApplicationProcessApplicationServiceArchitectureElementArtifactAssessmentBusinessActorBusinessCollaborationBusinessEventBusinessFunctionBusinessInteractionBusinessInterfaceBusinessObjectBusinessProcessBusinessRoleBusinessServiceCapabilityCommunicationNetworkCommunicationPathConstraintContractCourseOfActionDataObjectDeliverableDeviceDistributionNetworkDriverEquipmentFacilityGapGoalGroupingImplementationEventLocationMaterialMeaningNodeOutcomePlateauPrincipleProductRepresentationRequirementResourceStakeholderSystemSoftwareTechnologyCollaborationTechnologyEventTechnologyFunctionTechnologyInteractionTechnologyInterfaceTechnologyProcessTechnologyServiceValueValueStreamWorkPackage
elementIdstring
externalIdstring
ownersEntityId[]
Eigenschaften anzeigen
Array von EntityId
typeEntityIdTypeerforderlich
Erlaubt:GroupIdOrgRoleIdOrgUnitIdUserId
valuestringerforderlich
propertiesCreateArchitectureProperty[]erforderlich
Eigenschaften anzeigen
Array von CreateArchitectureProperty
keystringerforderlich
valueArchitecturePropertyValue
Eigenschaften anzeigen
typestringerforderlich
specializationstring
Antworten
200

Created 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

Name missing or blank, or given elementId or externalId malformed (empty, over 128 characters, whitespace or control characters, externalId no NCName)

string
403

Forbidden: insufficient permissions

string
404

Warehouse not found

string
409

Given elementId or externalId already carried by a version of another element

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

War diese Seite hilfreich?