List the wholes above an element in the Composition hierarchy.

List the wholes above an element in the Composition hierarchy. Serves a breadcrumb: ordered from the topmost whole down to the direct whole of the given element; depth counts the levels above it. Ends at a cycle in legacy data instead of looping.

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

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

Autorisierung

AuthorizationBearer-Token (JWT) · headererforderlich

BpmLicenseAPI-Schlüssel · headererforderlich

Pfadparameter

warehouseIdstringerforderlich

Warehouse-Id

elementIdstringerforderlich

Logical id of the element

Antworten

200

The ancestor chain, empty for a topmost element

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

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 element

Anfrage

curl -X GET 'https://goto.bpanda.com/api/v1/warehouses/string/architectureElements/string/hierarchy/ancestors' \
  -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/ancestors", {
  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"