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

List a page of elements matching the given criteria.

List a page of elements matching the given criteria. Gets a paginated list of architecture elements. The criteria are passed in the body - idsToIgnore and elementIdsToIgnore outgrow a URL as soon as they cover a whole space. Only the page to read stays in the query, so that paging through one and the same query does not mean resending its criteria. Without sortBy the elements come by name, then by id, so paging returns every element exactly once.

Security: Any user holding a Bpanda licence for the process space.

POST/v1/warehouses/{warehouseId}/architectureElements/list
Autorisierung
AuthorizationBearer-Token (JWT) · headererforderlich
BpmLicenseAPI-Schlüssel · headererforderlich
Pfadparameter
warehouseIdstringerforderlich

Warehouse-Id

Query-Parameter
pageinteger<int32>

Page number (starts with 1)

pageSizeinteger<int32>

Page size

Request-Body
erforderlichapplication/json

Criteria the returned elements have to match

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

Found and paginated ArchitectureElements

itemsBasicArchitectureElement[]erforderlich
Eigenschaften anzeigen
Array von BasicArchitectureElement
conceptualClassArchitectureElementTypeerforderlich
Erlaubt:ApplicationCollaborationApplicationComponentApplicationEventApplicationFunctionApplicationInteractionApplicationInterfaceApplicationProcessApplicationServiceArchitectureElementArtifactAssessmentBusinessActorBusinessCollaborationBusinessEventBusinessFunctionBusinessInteractionBusinessInterfaceBusinessObjectBusinessProcessBusinessRoleBusinessServiceCapabilityCommunicationNetworkCommunicationPathConstraintContractCourseOfActionDataObjectDeliverableDeviceDistributionNetworkDriverEquipmentFacilityGapGoalGroupingImplementationEventLocationMaterialMeaningNodeOutcomePlateauPrincipleProductRepresentationRequirementResourceStakeholderSystemSoftwareTechnologyCollaborationTechnologyEventTechnologyFunctionTechnologyInteractionTechnologyInterfaceTechnologyProcessTechnologyServiceValueValueStreamWorkPackage
createdHistoryerforderlich
Eigenschaften anzeigen
atstringerforderlich
bystringerforderlich
elementIdstringerforderlich
hasPredecessorbooleanerforderlich
idstringerforderlich
layerArchitectureElementLayererforderlich
Erlaubt:ApplicationLayerBusinessLayerGenericLayerImplementationAndMigrationLayerMotivationElementsStrategyLayerTechnologyLayer
modifiedHistory
Eigenschaften anzeigen
atstringerforderlich
bystringerforderlich
ownersEntityId[]erforderlich
Eigenschaften anzeigen
Array von EntityId
typeEntityIdTypeerforderlich
Erlaubt:GroupIdOrgRoleIdOrgUnitIdUserId
valuestringerforderlich
principalIsOwnerbooleanerforderlich
propertiesBasicArchitectureProperty[]erforderlich
Eigenschaften anzeigen
Array von BasicArchitectureProperty
metaBasicArchitectureMetaPropertyerforderlich
Eigenschaften anzeigen
keystringerforderlich
labelstring
valuestring
publishedHistory
Eigenschaften anzeigen
atstringerforderlich
bystringerforderlich
representationRefId
Eigenschaften anzeigen
typestringerforderlich
specializationstring
validityStateArchitectureValidityStateerforderlich
Erlaubt:DraftInvalidNextUpcomingValid
visibilityVisibilityerforderlich
Eigenschaften anzeigen
lastChangeHistoryerforderlich
visiblebooleanerforderlich
metadataArchitecturePaginationMetadataerforderlich
Eigenschaften anzeigen
totalItemsinteger<int32>erforderlich
relationshipsArchitectureRelationship[]
Eigenschaften anzeigen
Array von ArchitectureRelationship
architectureElementRefsArchitectureElementRef[]erforderlich
Eigenschaften anzeigen
Array von ArchitectureElementRef
conceptualClassArchitectureElementTypeerforderlich
Erlaubt:ApplicationCollaborationApplicationComponentApplicationEventApplicationFunctionApplicationInteractionApplicationInterfaceApplicationProcessApplicationServiceArchitectureElementArtifactAssessmentBusinessActorBusinessCollaborationBusinessEventBusinessFunctionBusinessInteractionBusinessInterfaceBusinessObjectBusinessProcessBusinessRoleBusinessServiceCapabilityCommunicationNetworkCommunicationPathConstraintContractCourseOfActionDataObjectDeliverableDeviceDistributionNetworkDriverEquipmentFacilityGapGoalGroupingImplementationEventLocationMaterialMeaningNodeOutcomePlateauPrincipleProductRepresentationRequirementResourceStakeholderSystemSoftwareTechnologyCollaborationTechnologyEventTechnologyFunctionTechnologyInteractionTechnologyInterfaceTechnologyProcessTechnologyServiceValueValueStreamWorkPackage
elementIdstringerforderlich
referenceDirectionReferenceDirectionerforderlich
Erlaubt:BidirectionalNoneSourceTarget
referenceKindReferenceKinderforderlich
Erlaubt:AccessAggregationArchitectureReferenceAssignmentAssociationCompositionFlowInfluenceRealizationServingSpecializationTriggering
specializationstring
conceptualClassArchitectureRelationshipType
Erlaubt:AccessAggregationArchitectureReferenceAssignmentAssociationCompositionFlowInfluenceRealizationServingSpecializationTriggering
idstringerforderlich
linkedElementsRefId[]erforderlich
Eigenschaften anzeigen
Array von RefId
typestringerforderlich
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
Eigenschaften anzeigen
defaultLanguagestringerforderlich
translationsTranslation[]erforderlich
Eigenschaften anzeigen
Array von Translation
languagestringerforderlich
valuestringerforderlich
relationshipDirectionRelationshipDirectionerforderlich
Erlaubt:BidirectionalDirectionalNone
specializationArchitectureRelationshipSpecializationType
Erlaubt:NotSpecialized
400

Invalid criteria, e.g. sortBy and order of different length or a field twice in sortBy

string
403

Forbidden: insufficient permissions

string
404

Warehouse not found

string
500

Server-side failure

string
Ausprobieren
Server
Autorisierung
Parameter
Bodyapplication/json
Anfrage
curl -X POST 'https://goto.bpanda.com/api/v1/warehouses/string/architectureElements/list' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'BpmLicense: YOUR_API_KEY' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "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
{
  "items": [
    {
      "conceptualClass": "ApplicationCollaboration",
      "created": {
        "at": "string",
        "by": "string"
      },
      "elementId": "string",
      "hasPredecessor": true,
      "id": "string",
      "layer": "ApplicationLayer",
      "modified": {
        "at": "string",
        "by": "string"
      },
      "owners": [
        {
          "type": "GroupId",
          "value": "string"
        }
      ],
      "principalIsOwner": true,
      "properties": [
        {
          "meta": {
            "key": "string",
            "label": "string"
          },
          "value": "string"
        }
      ],
      "published": {
        "at": "string",
        "by": "string"
      },
      "representation": {
        "type": "string"
      },
      "specialization": "string",
      "validityState": "Draft",
      "visibility": {
        "lastChange": {
          "at": "string",
          "by": "string"
        },
        "visible": true
      }
    }
  ],
  "metadata": {
    "totalItems": 0
  },
  "relationships": [
    {
      "architectureElementRefs": [
        {
          "conceptualClass": "ApplicationCollaboration",
          "elementId": "string",
          "referenceDirection": "Bidirectional",
          "referenceKind": "Access",
          "specialization": "string"
        }
      ],
      "conceptualClass": "Access",
      "id": "string",
      "linkedElements": [
        {
          "type": "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": [
                      {
                        "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"
              }
            ]
          }
        }
      ],
      "relationshipDirection": "Bidirectional",
      "specialization": "NotSpecialized"
    }
  ]
}

War diese Seite hilfreich?