Publish all elements matching a query.
Publish all elements matching a query. Publishes all architecture elements matching the query in the body. BusinessProcess elements are excluded automatically. listMode “blacklist” (the default) excludes the provided element IDs, “whitelist” publishes only those IDs. The ids in elementIds are logical ElementIds (the elementId an element keeps across all its versions), not the instance id of one version. The query’s publicationStatus has no effect - publishing always works on drafts.
Security: Manager or Designer of the process space.
POST
/v1/warehouses/{warehouseId}/architectureElements/publishFilteredAuthorization
AuthorizationBearer token (JWT) · headerrequiredBpmLicenseAPI key · headerrequiredPath parameters
warehouseIdstringrequiredWarehouse-Id
Request body
requiredapplication/jsonThe query deciding the set, the element list narrowing it, and how that list acts
elementIdsstring[]listModeListModeAllowed:
BlacklistWhitelistqueryArchitectureElementQueryShow propertiesHide properties
conceptualClassModeListModeAllowed:
BlacklistWhitelistconceptualClassesArchitectureElementType[]createdAfterstring<date-time>createdBeforestring<date-time>elementIdsToIgnorestring[]filterstringfilterByArchitectureFilterAllowed:
createdelementIdidlayermodifiednameidsToIgnorestring[]includeDeactivatedbooleanincludeInvalidbooleanlayerModeListModeAllowed:
BlacklistWhitelistlayersArchitectureElementLayer[]manifestModeListModeAllowed:
BlacklistWhitelistonlyOwnedbooleanorderArchitectureSortingOrder[]publicationStatusPublicationStatusAllowed:
DraftPublishedsortByArchitectureSorting[]Responses
200
successfulElements and failedElements with error message
failedElementsArchitecturePublishFail[]requiredShow propertiesHide properties
Array of
ArchitecturePublishFailelementArchitectureElementrequiredShow propertiesHide properties
conceptualClassArchitectureElementTyperequiredAllowed:
ApplicationCollaborationApplicationComponentApplicationEventApplicationFunctionApplicationInteractionApplicationInterfaceApplicationProcessApplicationServiceArchitectureElementArtifactAssessmentBusinessActorBusinessCollaborationBusinessEventBusinessFunctionBusinessInteractionBusinessInterfaceBusinessObjectBusinessProcessBusinessRoleBusinessServiceCapabilityCommunicationNetworkCommunicationPathConstraintContractCourseOfActionDataObjectDeliverableDeviceDistributionNetworkDriverEquipmentFacilityGapGoalGroupingImplementationEventLocationMaterialMeaningNodeOutcomePlateauPrincipleProductRepresentationRequirementResourceStakeholderSystemSoftwareTechnologyCollaborationTechnologyEventTechnologyFunctionTechnologyInteractionTechnologyInterfaceTechnologyProcessTechnologyServiceValueValueStreamWorkPackagecreatedHistoryrequiredelementIdstringrequiredgroupsArchitectureGroup[]requiredhasPredecessorbooleanrequiredidstringrequiredlastValidationHistorylayerArchitectureElementLayerrequiredAllowed:
ApplicationLayerBusinessLayerGenericLayerImplementationAndMigrationLayerMotivationElementsStrategyLayerTechnologyLayermodifiedHistoryownersEntityId[]requiredprincipalIsOwnerbooleanrequiredpropertiesArchitectureProperty[]requiredpublishedHistoryreferencesArchitectureReference[]requiredrepresentationRefIdspecializationstringvalidityStateArchitectureValidityStaterequiredAllowed:
DraftInvalidNextUpcomingValidvisibilityVisibilityrequiredmessagestringrequiredsuccessfulElementsArchitectureElement[]requiredShow propertiesHide properties
Array of
ArchitectureElementconceptualClassArchitectureElementTyperequiredAllowed:
ApplicationCollaborationApplicationComponentApplicationEventApplicationFunctionApplicationInteractionApplicationInterfaceApplicationProcessApplicationServiceArchitectureElementArtifactAssessmentBusinessActorBusinessCollaborationBusinessEventBusinessFunctionBusinessInteractionBusinessInterfaceBusinessObjectBusinessProcessBusinessRoleBusinessServiceCapabilityCommunicationNetworkCommunicationPathConstraintContractCourseOfActionDataObjectDeliverableDeviceDistributionNetworkDriverEquipmentFacilityGapGoalGroupingImplementationEventLocationMaterialMeaningNodeOutcomePlateauPrincipleProductRepresentationRequirementResourceStakeholderSystemSoftwareTechnologyCollaborationTechnologyEventTechnologyFunctionTechnologyInteractionTechnologyInterfaceTechnologyProcessTechnologyServiceValueValueStreamWorkPackagecreatedHistoryrequiredShow propertiesHide properties
atstringrequiredbystringrequiredelementIdstringrequiredgroupsArchitectureGroup[]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
ArchitecturePropertymetaArchitectureMetaPropertyrequiredShow propertiesHide properties
corebooleanrequireddescriptionTranslatedStringgroupstringkeystringrequiredlabelTranslatedStringtypeArchitecturePropertyTyperequiredAllowed:
BBCodeBooleanDateDateTimeDecimalEnumIntegerStringTimevalidationArchitecturePropertyValidationShow propertiesHide properties
literalsTranslatedString[]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
lastChangeHistoryrequiredvisiblebooleanrequired403
Forbidden: insufficient permissions
string404
Warehouse not found
string