List an element and its parts in the Composition hierarchy down to a given depth.

List an element and its parts in the Composition hierarchy down to a given depth. The element itself comes at depth 0. Every element appears once, also when legacy data contains cycles or parts with several wholes. Without maxDepth the server limit of 100 levels applies.

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

GET/v1/warehouses/{warehouseId}/architectureElements/{elementId}/hierarchy/subtree

Authorization

AuthorizationBearer token (JWT) · headerrequired

BpmLicenseAPI key · headerrequired

Path parameters

warehouseIdstringrequired

Warehouse-Id

elementIdstringrequired

Logical id of the element

Query parameters

maxDepthinteger<int32>

Levels below the element to include (>= 0, capped at 100)

Responses

200

The element and its parts

nodesArchitectureHierarchyNode[]required

Show properties

Array of ArchitectureHierarchyNode

depthinteger<int32>required

elementBasicArchitectureElementrequired

Show properties

conceptualClassArchitectureElementTyperequired

Allowed:ApplicationCollaborationApplicationComponentApplicationEventApplicationFunctionApplicationInteractionApplicationInterfaceApplicationProcessApplicationServiceArchitectureElementArtifactAssessmentBusinessActorBusinessCollaborationBusinessEventBusinessFunctionBusinessInteractionBusinessInterfaceBusinessObjectBusinessProcessBusinessRoleBusinessServiceCapabilityCommunicationNetworkCommunicationPathConstraintContractCourseOfActionDataObjectDeliverableDeviceDistributionNetworkDriverEquipmentFacilityGapGoalGroupingImplementationEventLocationMaterialMeaningNodeOutcomePlateauPrincipleProductRepresentationRequirementResourceStakeholderSystemSoftwareTechnologyCollaborationTechnologyEventTechnologyFunctionTechnologyInteractionTechnologyInterfaceTechnologyProcessTechnologyServiceValueValueStreamWorkPackage

createdHistoryrequired

Show properties

atstringrequired

bystringrequired

elementIdstringrequired

hasPredecessorbooleanrequired

idstringrequired

layerArchitectureElementLayerrequired

Allowed:ApplicationLayerBusinessLayerGenericLayerImplementationAndMigrationLayerMotivationElementsStrategyLayerTechnologyLayer

modifiedHistory

ownersEntityId[]required

Show properties

Array of EntityId

typeEntityIdTyperequired

Allowed:GroupIdOrgRoleIdOrgUnitIdUserId

valuestringrequired

principalIsOwnerbooleanrequired

propertiesBasicArchitectureProperty[]required

Show properties

Array of BasicArchitectureProperty

metaBasicArchitectureMetaPropertyrequired

Show properties

keystringrequired

labelstring

valuestring

publishedHistory

representationRefId

Show properties

typestringrequired

specializationstring

validityStateArchitectureValidityStaterequired

Allowed:DraftInvalidNextUpcomingValid

visibilityVisibilityrequired

Show properties

lastChangeHistoryrequired

visiblebooleanrequired

hasChildrenbooleanrequired

parentElementIdstring

400

Negative maxDepth

string

403

The edition of this process space does not include the element's type

string

404

Element not found

string

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

Bearer token (JWT)API keyRemember on this deviceInclude my values in samples

Parameters

warehouseIdpath*Warehouse-IdelementIdpath*Logical id of the elementmaxDepthqueryLevels below the element to include (>= 0, capped at 100)

Request

curl -X GET 'https://goto.bpanda.com/api/v1/warehouses/string/architectureElements/string/hierarchy/subtree' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'BpmLicense: YOUR_API_KEY' \
  -H 'Accept: application/json'

const response = await fetch("https://goto.bpanda.com/api/v1/warehouses/string/architectureElements/string/hierarchy/subtree", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "BpmLicense": "YOUR_API_KEY",
    "Accept": "application/json"
  }
});

Response

{
  "nodes": [
    {
      "depth": 0,
      "element": {
        "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
        }
      },
      "hasChildren": true,
      "parentElementId": "string"
    }
  ]
}

"string"

"string"

"string"