List all elements by their representation.
List all elements by their representation. Get list of architecture elements by its representation
Security: Any user holding a Bpanda licence for the process space.
POST
/v1/warehouses/{warehouseId}/architectureElements/byRepresentationAuthorization
AuthorizationBearer token (JWT) · headerrequiredBpmLicenseAPI key · headerrequiredPath parameters
warehouseIdstringrequiredWarehouse-Id
Query parameters
includeDeactivatedbooleanif true also return deactivated elements
includeInvalidbooleanif true also return invalid elements
onlyLatestbooleanif true only return the latest version of each element
conceptualClassstringif given only include elements of this conceptual class
Request body
requiredapplication/jsonRepresentaion reference of the architecture elements
typestringrequiredResponses
200
Found ArchitectureElements with given representation
Array of
ArchitectureElementconceptualClassArchitectureElementTyperequiredAllowed:
ApplicationCollaborationApplicationComponentApplicationEventApplicationFunctionApplicationInteractionApplicationInterfaceApplicationProcessApplicationServiceArchitectureElementArtifactAssessmentBusinessActorBusinessCollaborationBusinessEventBusinessFunctionBusinessInteractionBusinessInterfaceBusinessObjectBusinessProcessBusinessRoleBusinessServiceCapabilityCommunicationNetworkCommunicationPathConstraintContractCourseOfActionDataObjectDeliverableDeviceDistributionNetworkDriverEquipmentFacilityGapGoalGroupingImplementationEventLocationMaterialMeaningNodeOutcomePlateauPrincipleProductRepresentationRequirementResourceStakeholderSystemSoftwareTechnologyCollaborationTechnologyEventTechnologyFunctionTechnologyInteractionTechnologyInterfaceTechnologyProcessTechnologyServiceValueValueStreamWorkPackagecreatedHistoryrequiredShow propertiesHide properties
atstringrequiredbystringrequiredelementIdstringrequiredgroupsArchitectureGroup[]requiredShow propertiesHide properties
Array of
ArchitectureGroupcorebooleanrequireddescriptionTranslatedStringShow propertiesHide properties
defaultLanguagestringrequiredtranslationsTranslation[]requiredShow propertiesHide properties
Array of
TranslationlanguagestringrequiredvaluestringrequiredkeystringrequiredlabelTranslatedStringShow propertiesHide properties
defaultLanguagestringrequiredtranslationsTranslation[]requiredhasPredecessorbooleanrequiredidstringrequiredlastValidationHistoryShow propertiesHide properties
atstringrequiredbystringrequiredlayerArchitectureElementLayerrequiredAllowed:
ApplicationLayerBusinessLayerGenericLayerImplementationAndMigrationLayerMotivationElementsStrategyLayerTechnologyLayermodifiedHistoryShow propertiesHide properties
atstringrequiredbystringrequiredownersEntityId[]requiredShow propertiesHide properties
Array of
EntityIdtypeEntityIdTyperequiredAllowed:
GroupIdOrgRoleIdOrgUnitIdUserIdvaluestringrequiredprincipalIsOwnerbooleanrequiredpropertiesArchitectureProperty[]requiredShow propertiesHide properties
Array of
ArchitecturePropertymetaArchitectureMetaPropertyrequiredShow propertiesHide properties
corebooleanrequireddescriptionTranslatedStringgroupstringkeystringrequiredlabelTranslatedStringtypeArchitecturePropertyTyperequiredAllowed:
BBCodeBooleanDateDateTimeDecimalEnumIntegerStringTimevalidationArchitecturePropertyValidationShow propertiesHide properties
literalsTranslatedString[]lowerBoundstringmandatorybooleanrequiredupperBoundstringvalueTranslatedStringShow propertiesHide properties
defaultLanguagestringrequiredtranslationsTranslation[]requiredpublishedHistoryShow propertiesHide properties
atstringrequiredbystringrequiredreferencesArchitectureReference[]requiredShow propertiesHide properties
Array of
ArchitectureReferencemetaArchitectureMetaReferencerequiredShow propertiesHide properties
corebooleanrequireddescriptionTranslatedStringgroupstringkeystringrequiredlabelTranslatedStringmultiplicityArchitectureReferenceMultiplicityrequiredAllowed:
ExactlyOneOneOrMoreZeroOrMoreZeroOrOnetargetClassesstring[]requiredtargetReferenceShow propertiesHide properties
assignedArchitectureElementRefsArchitectureElementRef[]requiredShow propertiesHide properties
Array of
ArchitectureElementRefconceptualClassArchitectureElementTyperequiredAllowed:
ApplicationCollaborationApplicationComponentApplicationEventApplicationFunctionApplicationInteractionApplicationInterfaceApplicationProcessApplicationServiceArchitectureElementArtifactAssessmentBusinessActorBusinessCollaborationBusinessEventBusinessFunctionBusinessInteractionBusinessInterfaceBusinessObjectBusinessProcessBusinessRoleBusinessServiceCapabilityCommunicationNetworkCommunicationPathConstraintContractCourseOfActionDataObjectDeliverableDeviceDistributionNetworkDriverEquipmentFacilityGapGoalGroupingImplementationEventLocationMaterialMeaningNodeOutcomePlateauPrincipleProductRepresentationRequirementResourceStakeholderSystemSoftwareTechnologyCollaborationTechnologyEventTechnologyFunctionTechnologyInteractionTechnologyInterfaceTechnologyProcessTechnologyServiceValueValueStreamWorkPackageelementIdstringrequiredreferenceDirectionReferenceDirectionrequiredAllowed:
BidirectionalNoneSourceTargetreferenceKindReferenceKindrequiredAllowed:
AccessAggregationArchitectureReferenceAssignmentAssociationCompositionFlowInfluenceRealizationServingSpecializationTriggeringspecializationstringcreatedHistoryrequiredlinkedElementsRefId[]requiredmodifiedHistorypropertiesArchitectureProperty[]requiredrelationshipIdstringrequiredrepresentationRefIdShow propertiesHide properties
typestringrequiredspecializationstringvalidityStateArchitectureValidityStaterequiredAllowed:
DraftInvalidNextUpcomingValidvisibilityVisibilityrequiredShow propertiesHide properties
lastChangeHistoryrequiredShow propertiesHide properties
atstringrequiredbystringrequiredvisiblebooleanrequired404
Warehouse not found
string