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

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
Autorisierung
AuthorizationBearer-Token (JWT) · headererforderlich
BpmLicenseAPI-Schlüssel · headererforderlich
Pfadparameter
warehouseIdstringerforderlich

Warehouse-Id

Request-Body
erforderlichapplication/json

Id of the architecture element or process version and optional filters

filtersstring[]
refIdRefIderforderlich
Eigenschaften anzeigen
typestringerforderlich
Antworten
200

Found external uses as ArchitectureRelations

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
404

Warehouse not found

string
Ausprobieren
Server
Autorisierung
Parameter
Bodyapplication/json
Anfrage
curl -X POST 'https://goto.bpanda.com/api/v1/warehouses/string/architectureRelationships/external/uses' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'BpmLicense: YOUR_API_KEY' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "filters": [
    "string"
  ],
  "refId": {
    "type": "string"
  }
}'
Antwort
[
  {
    "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"
  }
]