Skip to content
Bpanda
English
DeutschEnglishNot translated
Esc
↑↓navigate↵open⌘Jpreview

List all external uses of an element or a process version.

List all external uses of an element or a process version. Find external uses of either an architecture element or a process version as a list of architecture relationships e.g. all relationships of a Business Process which represents a given process version e.g. all relationships of a given Application Component with Business Processes representing process versions or process version elements

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

POST/v1/warehouses/{warehouseId}/architectureRelationships/external/uses
Authorization
AuthorizationBearer token (JWT) · headerrequired
BpmLicenseAPI key · headerrequired
Path parameters
warehouseIdstringrequired

Warehouse-Id

Request body
requiredapplication/json

Id of the architecture element or process version and optional filters

filtersstring[]
refIdRefIdrequired
Show properties
typestringrequired
Responses
200

Found external uses as ArchitectureRelations

Array of ArchitectureRelationship
architectureElementRefsArchitectureElementRef[]required
Show properties
Array of ArchitectureElementRef
conceptualClassArchitectureElementTyperequired
Allowed:ApplicationCollaborationApplicationComponentApplicationEventApplicationFunctionApplicationInteractionApplicationInterfaceApplicationProcessApplicationServiceArchitectureElementArtifactAssessmentBusinessActorBusinessCollaborationBusinessEventBusinessFunctionBusinessInteractionBusinessInterfaceBusinessObjectBusinessProcessBusinessRoleBusinessServiceCapabilityCommunicationNetworkCommunicationPathConstraintContractCourseOfActionDataObjectDeliverableDeviceDistributionNetworkDriverEquipmentFacilityGapGoalGroupingImplementationEventLocationMaterialMeaningNodeOutcomePlateauPrincipleProductRepresentationRequirementResourceStakeholderSystemSoftwareTechnologyCollaborationTechnologyEventTechnologyFunctionTechnologyInteractionTechnologyInterfaceTechnologyProcessTechnologyServiceValueValueStreamWorkPackage
elementIdstringrequired
referenceDirectionReferenceDirectionrequired
Allowed:BidirectionalNoneSourceTarget
referenceKindReferenceKindrequired
Allowed:AccessAggregationArchitectureReferenceAssignmentAssociationCompositionFlowInfluenceRealizationServingSpecializationTriggering
specializationstring
conceptualClassArchitectureRelationshipType
Allowed:AccessAggregationArchitectureReferenceAssignmentAssociationCompositionFlowInfluenceRealizationServingSpecializationTriggering
idstringrequired
linkedElementsRefId[]required
Show properties
Array of RefId
typestringrequired
propertiesArchitectureProperty[]required
Show properties
Array of ArchitectureProperty
metaArchitectureMetaPropertyrequired
Show properties
corebooleanrequired
descriptionTranslatedString
groupstring
keystringrequired
labelTranslatedString
typeArchitecturePropertyTyperequired
Allowed:BBCodeBooleanDateDateTimeDecimalEnumIntegerStringTime
validationArchitecturePropertyValidation
Show properties
literalsTranslatedString[]
lowerBoundstring
mandatorybooleanrequired
upperBoundstring
valueTranslatedString
Show properties
defaultLanguagestringrequired
translationsTranslation[]required
Show properties
Array of Translation
languagestringrequired
valuestringrequired
relationshipDirectionRelationshipDirectionrequired
Allowed:BidirectionalDirectionalNone
specializationArchitectureRelationshipSpecializationType
Allowed:NotSpecialized
404

Warehouse not found

string
Try it
Server
Authorization
Parameters
Bodyapplication/json
Request
curl -X POST 'https://publicapi.goto.bpanda.com/bpm/api/v1/warehouses/string/architectureRelationships/external/uses' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'BpmLicense: YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "filters": [
    "string"
  ],
  "refId": {
    "type": "string"
  }
}'
Response
[
  {
    "architectureElementRefs": [
      {
        "conceptualClass": "ApplicationCollaboration",
        "elementId": "string",
        "referenceDirection": "Bidirectional",
        "referenceKind": "Access",
        "specialization": "string"
      }
    ],
    "conceptualClass": "Access",
    "id": "string",
    "linkedElements": [
      {
        "type": "string"
      }
    ],
    "properties": [
      {
        "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": {
            "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"
  }
]