List a single element by external ID.
List a single element by external ID. Get the architecture element an externalId means, among what the caller may read: the draft of its lineage, or else its newest published version. Where several lineages carry the externalId, a working draft wins over a published one, then the newest. Does the edition of the process space not include the type of that version, the newest version of the same lineage whose type it does include is answered instead - the one byElementIds hands out. Covers the edition no version of that lineage, the element is refused with 403; another lineage carrying the same externalId is not offered in its place, so byExternalIds can still answer where this route refuses.
Security: Any user holding a Bpanda licence for the process space.
GET
/v1/warehouses/{warehouseId}/architectureElements/byExternalId/{externalId}Authorization
AuthorizationBearer token (JWT) · headerrequiredBpmLicenseAPI key · headerrequiredPath parameters
warehouseIdstringrequiredWarehouse-Id
externalIdstringrequiredArchitectureElement-ExternalId
Responses
200
Found ArchitectureElement
conceptualClassArchitectureElementTyperequiredAllowed:
ApplicationCollaborationApplicationComponentApplicationEventApplicationFunctionApplicationInteractionApplicationInterfaceApplicationProcessApplicationServiceArchitectureElementArtifactAssessmentBusinessActorBusinessCollaborationBusinessEventBusinessFunctionBusinessInteractionBusinessInterfaceBusinessObjectBusinessProcessBusinessRoleBusinessServiceCapabilityCommunicationNetworkCommunicationPathConstraintContractCourseOfActionDataObjectDeliverableDeviceDistributionNetworkDriverEquipmentFacilityGapGoalGroupingImplementationEventLocationMaterialMeaningNodeOutcomePlateauPrincipleProductRepresentationRequirementResourceStakeholderSystemSoftwareTechnologyCollaborationTechnologyEventTechnologyFunctionTechnologyInteractionTechnologyInterfaceTechnologyProcessTechnologyServiceValueValueStreamWorkPackagecreatedHistoryrequiredShow propertiesHide properties
atstringrequiredbystringrequiredelementIdstringrequiredexternalIdstringgroupsArchitectureGroup[]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
ArchitecturePropertyenumKeystringmetaArchitectureMetaPropertyrequiredShow propertiesHide properties
corebooleanrequireddescriptionTranslatedStringgroupstringkeystringrequiredlabelTranslatedStringtypeArchitecturePropertyTyperequiredAllowed:
BBCodeBooleanDateDateTimeDecimalEnumIntegerStringTimevalidationArchitecturePropertyValidationShow propertiesHide properties
enumLiteralsArchitectureEnumLiteral[]Show propertiesHide properties
Array of
ArchitectureEnumLiteraldeprecatedbooleanrequiredkeystringrequiredlabelTranslatedStringrequiredliteralsTranslatedString[]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
atstringrequiredbystringrequiredvisiblebooleanrequired403
The edition of this process space includes no version of this element's lineage
string404
Warehouse not found or no readable element with this externalId
string