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

Autorisierung

AuthorizationBearer-Token (JWT) · headererforderlich

BpmLicenseAPI-Schlüssel · headererforderlich

Pfadparameter

warehouseIdstringerforderlich

Warehouse-Id

elementIdstringerforderlich

Logical id of the element

Query-Parameter

maxDepthinteger<int32>

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

Antworten

200

The element and its parts

nodesArchitectureHierarchyNode[]erforderlich

Eigenschaften anzeigen

Array von ArchitectureHierarchyNode

depthinteger<int32>erforderlich

elementBasicArchitectureElementerforderlich

Eigenschaften anzeigen

conceptualClassArchitectureElementTypeerforderlich

Erlaubt:ApplicationCollaborationApplicationComponentApplicationEventApplicationFunctionApplicationInteractionApplicationInterfaceApplicationProcessApplicationServiceArchitectureElementArtifactAssessmentBusinessActorBusinessCollaborationBusinessEventBusinessFunctionBusinessInteractionBusinessInterfaceBusinessObjectBusinessProcessBusinessRoleBusinessServiceCapabilityCommunicationNetworkCommunicationPathConstraintContractCourseOfActionDataObjectDeliverableDeviceDistributionNetworkDriverEquipmentFacilityGapGoalGroupingImplementationEventLocationMaterialMeaningNodeOutcomePlateauPrincipleProductRepresentationRequirementResourceStakeholderSystemSoftwareTechnologyCollaborationTechnologyEventTechnologyFunctionTechnologyInteractionTechnologyInterfaceTechnologyProcessTechnologyServiceValueValueStreamWorkPackage

createdHistoryerforderlich

Eigenschaften anzeigen

atstringerforderlich

bystringerforderlich

elementIdstringerforderlich

hasPredecessorbooleanerforderlich

idstringerforderlich

layerArchitectureElementLayererforderlich

Erlaubt:ApplicationLayerBusinessLayerGenericLayerImplementationAndMigrationLayerMotivationElementsStrategyLayerTechnologyLayer

modifiedHistory

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

representationRefId

Eigenschaften anzeigen

typestringerforderlich

specializationstring

validityStateArchitectureValidityStateerforderlich

Erlaubt:DraftInvalidNextUpcomingValid

visibilityVisibilityerforderlich

Eigenschaften anzeigen

lastChangeHistoryerforderlich

visiblebooleanerforderlich

hasChildrenbooleanerforderlich

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

Ausprobieren

Server

Basis-URLEigene Basis-URLÜberschreibt den ausgewählten Server, wenn gesetzt.

Autorisierung

Bearer-Token (JWT)API-SchlüsselAuf diesem Gerät merkenMeine Werte in die Beispiele übernehmen

Parameter

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

Anfrage

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"
  }
});

Antwort

{
  "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"