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

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. The 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/publishFiltered
Autorisierung
AuthorizationBearer-Token (JWT) · headererforderlich
BpmLicenseAPI-Schlüssel · headererforderlich
Pfadparameter
warehouseIdstringerforderlich

Warehouse-Id

Request-Body
erforderlichapplication/json

The query deciding the set, the element list narrowing it, and how that list acts

elementIdsstring[]
listModeListMode
Erlaubt:BlacklistWhitelist
queryArchitectureElementQuery
Eigenschaften anzeigen
conceptualClassModeListMode
Erlaubt:BlacklistWhitelist
conceptualClassesArchitectureElementType[]
createdAfterstring<date-time>
createdBeforestring<date-time>
elementIdsToIgnorestring[]
filterstring
filterByArchitectureFilter
Erlaubt:createdelementIdidlayermodifiedname
idsToIgnorestring[]
includeDeactivatedboolean
includeInvalidboolean
includeRelationshipsboolean
layerModeListMode
Erlaubt:BlacklistWhitelist
layersArchitectureElementLayer[]
manifestModeListMode
Erlaubt:BlacklistWhitelist
onlyOwnedboolean
orderArchitectureSortingOrder[]
publicationStatusPublicationStatus
Erlaubt:DraftPublished
relationshipTypesArchitectureRelationshipType[]
sortByArchitectureSorting[]
Antworten
200

The successfulElements and failedElements with error message

failedElementsArchitecturePublishFail[]erforderlich
Eigenschaften anzeigen
Array von ArchitecturePublishFail
elementArchitectureElementerforderlich
Eigenschaften anzeigen
conceptualClassArchitectureElementTypeerforderlich
Erlaubt:ApplicationCollaborationApplicationComponentApplicationEventApplicationFunctionApplicationInteractionApplicationInterfaceApplicationProcessApplicationServiceArchitectureElementArtifactAssessmentBusinessActorBusinessCollaborationBusinessEventBusinessFunctionBusinessInteractionBusinessInterfaceBusinessObjectBusinessProcessBusinessRoleBusinessServiceCapabilityCommunicationNetworkCommunicationPathConstraintContractCourseOfActionDataObjectDeliverableDeviceDistributionNetworkDriverEquipmentFacilityGapGoalGroupingImplementationEventLocationMaterialMeaningNodeOutcomePlateauPrincipleProductRepresentationRequirementResourceStakeholderSystemSoftwareTechnologyCollaborationTechnologyEventTechnologyFunctionTechnologyInteractionTechnologyInterfaceTechnologyProcessTechnologyServiceValueValueStreamWorkPackage
createdHistoryerforderlich
elementIdstringerforderlich
externalIdstring
groupsArchitectureGroup[]erforderlich
hasPredecessorbooleanerforderlich
idstringerforderlich
lastValidationHistory
layerArchitectureElementLayererforderlich
Erlaubt:ApplicationLayerBusinessLayerGenericLayerImplementationAndMigrationLayerMotivationElementsStrategyLayerTechnologyLayer
modifiedHistory
ownersEntityId[]erforderlich
principalIsOwnerbooleanerforderlich
propertiesArchitectureProperty[]erforderlich
publishedHistory
referencesArchitectureReference[]erforderlich
representationRefId
specializationstring
validityStateArchitectureValidityStateerforderlich
Erlaubt:DraftInvalidNextUpcomingValid
visibilityVisibilityerforderlich
messagestringerforderlich
successfulElementsArchitectureElement[]erforderlich
Eigenschaften anzeigen
Array von 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
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
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
visiblebooleanerforderlich
403

Forbidden: insufficient permissions

string
404

Warehouse not found

string
409

A draft is still being written by another change; the elements published before stay published, repeat the request for the rest

string
Ausprobieren
Server
Autorisierung
Parameter
Bodyapplication/json
Anfrage
curl -X POST 'https://goto.bpanda.com/api/v1/warehouses/string/architectureElements/publishFiltered' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'BpmLicense: YOUR_API_KEY' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "elementIds": [
    "string"
  ],
  "listMode": "Blacklist",
  "query": {
    "conceptualClassMode": "Blacklist",
    "conceptualClasses": [
      "ApplicationCollaboration"
    ],
    "createdAfter": "2019-08-24T14:15:22Z",
    "createdBefore": "2019-08-24T14:15:22Z",
    "elementIdsToIgnore": [
      "string"
    ],
    "filter": "string",
    "filterBy": "created",
    "idsToIgnore": [
      "string"
    ],
    "includeDeactivated": true,
    "includeInvalid": true,
    "includeRelationships": true,
    "layerMode": "Blacklist",
    "layers": [
      "ApplicationLayer"
    ],
    "manifestMode": "Blacklist",
    "onlyOwned": true,
    "order": [
      "ascending"
    ],
    "publicationStatus": "Draft",
    "relationshipTypes": [
      "Access"
    ],
    "sortBy": [
      "conceptualClass"
    ]
  }
}'
Antwort
{
  "failedElements": [
    {
      "element": {
        "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": [
                              null
                            ]
                          }
                        }
                      ],
                      "literals": [
                        {
                          "defaultLanguage": "string",
                          "translations": [
                            {}
                          ]
                        }
                      ],
                      "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
        }
      },
      "message": "string"
    }
  ],
  "successfulElements": [
    {
      "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": [
                            {}
                          ]
                        }
                      }
                    ],
                    "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
      }
    }
  ]
}