Zum Inhalt springen
Bpanda
Deutsch
DeutschEnglishNicht übersetzt
Esc
↑↓navigieren↵öffnen⌘Jvorschau

List all relationships with the given IDs.

List all relationships with the given IDs. Get list of architecture relationships by ids

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

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

Warehouse-Id

Query parameters
onlyLatestboolean

if true only return relationships connecting the latest element versions

Request body
requiredapplication/json

ArchitectureRelationship-Ids.

Array of string
string
Responses
200

Found ArchitectureRelations as BulkResult

errorsArchitectureRelationshipBulkError[]required
Show properties
Array of ArchitectureRelationshipBulkError
errorstringrequired
idstringrequired
statusinteger<int32>required
itemsArchitectureRelationship[]required
Show properties
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/byIds/bulk' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'BpmLicense: YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '[
  "string"
]'
Response
{
  "errors": [
    {
      "error": "string",
      "id": "string",
      "status": 0
    }
  ],
  "items": [
    {
      "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"
    }
  ]
}