List all elements with the given external IDs.
List all elements with the given external IDs. Get list of architecture elements by their externalId, the identifier used in ArchiMate exchange. Every version carrying one of the externalIds is returned unless onlyLatest is set; only what the caller may read is returned.
Security: Any user holding a Bpanda licence for the process space.
POST
/v1/warehouses/{warehouseId}/architectureElements/byExternalIds/bulkAuthorization
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/jsonArchitectureElement-ExternalIds.
Array of
stringstringResponses
200
Found ArchitectureElements, a 404 error per externalId without one
errorsArchitectureElementBulkError[]requiredShow propertiesHide properties
Array of
ArchitectureElementBulkErrorerrorstringrequiredidstringrequiredstatusinteger<int32>requireditemsArchitectureElement[]requiredShow propertiesHide properties
Array of
ArchitectureElementconceptualClassArchitectureElementTyperequiredAllowed:
ApplicationCollaborationApplicationComponentApplicationEventApplicationFunctionApplicationInteractionApplicationInterfaceApplicationProcessApplicationServiceArchitectureElementArtifactAssessmentBusinessActorBusinessCollaborationBusinessEventBusinessFunctionBusinessInteractionBusinessInterfaceBusinessObjectBusinessProcessBusinessRoleBusinessServiceCapabilityCommunicationNetworkCommunicationPathConstraintContractCourseOfActionDataObjectDeliverableDeviceDistributionNetworkDriverEquipmentFacilityGapGoalGroupingImplementationEventLocationMaterialMeaningNodeOutcomePlateauPrincipleProductRepresentationRequirementResourceStakeholderSystemSoftwareTechnologyCollaborationTechnologyEventTechnologyFunctionTechnologyInteractionTechnologyInterfaceTechnologyProcessTechnologyServiceValueValueStreamWorkPackagecreatedHistoryrequiredShow propertiesHide properties
atstringrequiredbystringrequiredelementIdstringrequiredexternalIdstringgroupsArchitectureGroup[]requiredShow propertiesHide properties
Array of
ArchitectureGroupcorebooleanrequireddescriptionTranslatedStringShow propertiesHide properties
defaultLanguagestringrequiredtranslationsTranslation[]requiredShow propertiesHide properties
Array of
TranslationlanguagestringrequiredvaluestringrequiredkeystringrequiredlabelTranslatedStringhasPredecessorbooleanrequiredidstringrequiredlastValidationHistoryShow 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[]lowerBoundstringmandatorybooleanrequiredupperBoundstringvalueTranslatedStringpublishedHistoryShow 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
lastChangeHistoryrequiredvisiblebooleanrequired404
Warehouse not found
string