List all elements with the given external IDs.

List all elements with the given external IDs. Get list of architecture elements by their externalId, the identifier used in ArchiMate exchange. Every version carrying one of the externalIds is returned unless onlyLatest is set; only what the caller may read is returned.

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

POST/v1/warehouses/{warehouseId}/architectureElements/byExternalIds/bulk

Autorisierung

AuthorizationBearer-Token (JWT) · headererforderlich

BpmLicenseAPI-Schlüssel · headererforderlich

Pfadparameter

warehouseIdstringerforderlich

Warehouse-Id

Query-Parameter

includeDeactivatedboolean

If true also return deactivated elements

includeInvalidboolean

If true also return invalid elements

onlyLatestboolean

If true only return the latest version of each element

conceptualClassstring

If given only include elements of this conceptual class

Request-Body

erforderlichapplication/json

ArchitectureElement-ExternalIds.

Array von string

string

Antworten

200

Found ArchitectureElements, a 404 error per externalId without one

errorsArchitectureElementBulkError[]erforderlich

Eigenschaften anzeigen

Array von ArchitectureElementBulkError

errorstringerforderlich

idstringerforderlich

statusinteger<int32>erforderlich

itemsArchitectureElement[]erforderlich

Eigenschaften anzeigen

Array von ArchitectureElement

conceptualClassArchitectureElementTypeerforderlich

Erlaubt:ApplicationCollaborationApplicationComponentApplicationEventApplicationFunctionApplicationInteractionApplicationInterfaceApplicationProcessApplicationServiceArchitectureElementArtifactAssessmentBusinessActorBusinessCollaborationBusinessEventBusinessFunctionBusinessInteractionBusinessInterfaceBusinessObjectBusinessProcessBusinessRoleBusinessServiceCapabilityCommunicationNetworkCommunicationPathConstraintContractCourseOfActionDataObjectDeliverableDeviceDistributionNetworkDriverEquipmentFacilityGapGoalGroupingImplementationEventLocationMaterialMeaningNodeOutcomePlateauPrincipleProductRepresentationRequirementResourceStakeholderSystemSoftwareTechnologyCollaborationTechnologyEventTechnologyFunctionTechnologyInteractionTechnologyInterfaceTechnologyProcessTechnologyServiceValueValueStreamWorkPackage

createdHistoryerforderlich

Eigenschaften anzeigen

atstringerforderlich

bystringerforderlich

elementIdstringerforderlich

externalIdstring

groupsArchitectureGroup[]erforderlich

Eigenschaften anzeigen

Array von ArchitectureGroup

corebooleanerforderlich

descriptionTranslatedString

Eigenschaften anzeigen

defaultLanguagestringerforderlich

translationsTranslation[]erforderlich

Eigenschaften anzeigen

Array von Translation

languagestringerforderlich

valuestringerforderlich

keystringerforderlich

labelTranslatedString

hasPredecessorbooleanerforderlich

idstringerforderlich

lastValidationHistory

Eigenschaften anzeigen

atstringerforderlich

bystringerforderlich

layerArchitectureElementLayererforderlich

Erlaubt:ApplicationLayerBusinessLayerGenericLayerImplementationAndMigrationLayerMotivationElementsStrategyLayerTechnologyLayer

modifiedHistory

Eigenschaften anzeigen

atstringerforderlich

bystringerforderlich

ownersEntityId[]erforderlich

Eigenschaften anzeigen

Array von EntityId

typeEntityIdTypeerforderlich

Erlaubt:GroupIdOrgRoleIdOrgUnitIdUserId

valuestringerforderlich

principalIsOwnerbooleanerforderlich

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

publishedHistory

Eigenschaften anzeigen

atstringerforderlich

bystringerforderlich

referencesArchitectureReference[]erforderlich

Eigenschaften anzeigen

Array von ArchitectureReference

metaArchitectureMetaReferenceerforderlich

Eigenschaften anzeigen

corebooleanerforderlich

descriptionTranslatedString

groupstring

keystringerforderlich

labelTranslatedString

multiplicityArchitectureReferenceMultiplicityerforderlich

Erlaubt:ExactlyOneOneOrMoreZeroOrMoreZeroOrOne

targetClassesstring[]erforderlich

targetReference

Eigenschaften anzeigen

assignedArchitectureElementRefsArchitectureElementRef[]erforderlich

Eigenschaften anzeigen

Array von ArchitectureElementRef

conceptualClassArchitectureElementTypeerforderlich

elementIdstringerforderlich

referenceDirectionReferenceDirectionerforderlich

Erlaubt:BidirectionalNoneSourceTarget

referenceKindReferenceKinderforderlich

Erlaubt:AccessAggregationArchitectureReferenceAssignmentAssociationCompositionFlowInfluenceRealizationServingSpecializationTriggering

specializationstring

createdHistoryerforderlich

linkedElementsRefId[]erforderlich

modifiedHistory

propertiesArchitectureProperty[]erforderlich

relationshipIdstringerforderlich

representationRefId

Eigenschaften anzeigen

typestringerforderlich

specializationstring

validityStateArchitectureValidityStateerforderlich

Erlaubt:DraftInvalidNextUpcomingValid

visibilityVisibilityerforderlich

Eigenschaften anzeigen

lastChangeHistoryerforderlich

visiblebooleanerforderlich

404

Warehouse 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-IdincludeDeactivatedqueryIf true also return deactivated elementsincludeInvalidqueryIf true also return invalid elementsonlyLatestqueryIf true only return the latest version of each elementconceptualClassqueryIf given only include elements of this conceptual class

Bodyapplication/json

Request-Body

Anfrage

curl -X POST 'https://goto.bpanda.com/api/v1/warehouses/string/architectureElements/byExternalIds/bulk' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'BpmLicense: YOUR_API_KEY' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '[
  "string"
]'

const response = await fetch("https://goto.bpanda.com/api/v1/warehouses/string/architectureElements/byExternalIds/bulk", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "BpmLicense": "YOUR_API_KEY",
    "Accept": "application/json",
    "Content-Type": "application/json"
  },
  body: "[\n  \"string\"\n]"
});

Antwort

{
  "errors": [
    {
      "error": "string",
      "id": "string",
      "status": 0
    }
  ],
  "items": [
    {
      "conceptualClass": "ApplicationCollaboration",
      "created": {
        "at": "string",
        "by": "string"
      },
      "elementId": "string",
      "externalId": "string",
      "groups": [
        {
          "core": true,
          "description": {
            "defaultLanguage": "string",
            "translations": [
              {
                "language": "string",
                "value": "string"
              }
            ]
          },
          "key": "string",
          "label": {
            "defaultLanguage": "string",
            "translations": [
              {
                "language": "string",
                "value": "string"
              }
            ]
          }
        }
      ],
      "hasPredecessor": true,
      "id": "string",
      "lastValidation": {
        "at": "string",
        "by": "string"
      },
      "layer": "ApplicationLayer",
      "modified": {
        "at": "string",
        "by": "string"
      },
      "owners": [
        {
          "type": "GroupId",
          "value": "string"
        }
      ],
      "principalIsOwner": true,
      "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"
              }
            ]
          }
        }
      ],
      "published": {
        "at": "string",
        "by": "string"
      },
      "references": [
        {
          "meta": {
            "core": true,
            "description": {
              "defaultLanguage": "string",
              "translations": [
                {
                  "language": "string",
                  "value": "string"
                }
              ]
            },
            "group": "string",
            "key": "string",
            "label": {
              "defaultLanguage": "string",
              "translations": [
                {
                  "language": "string",
                  "value": "string"
                }
              ]
            },
            "multiplicity": "ExactlyOne",
            "targetClasses": [
              "string"
            ]
          },
          "target": {
            "assignedArchitectureElementRefs": [
              {
                "conceptualClass": "ApplicationCollaboration",
                "elementId": "string",
                "referenceDirection": "Bidirectional",
                "referenceKind": "Access",
                "specialization": "string"
              }
            ],
            "created": {
              "at": "string",
              "by": "string"
            },
            "linkedElements": [
              {
                "type": "string"
              }
            ],
            "modified": {
              "at": "string",
              "by": "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": [
                            {}
                          ]
                        }
                      }
                    ],
                    "literals": [
                      {
                        "defaultLanguage": "string",
                        "translations": [
                          {
                            "language": "string",
                            "value": "string"
                          }
                        ]
                      }
                    ],
                    "lowerBound": "string",
                    "mandatory": true,
                    "upperBound": "string"
                  }
                },
                "value": {
                  "defaultLanguage": "string",
                  "translations": [
                    {
                      "language": "string",
                      "value": "string"
                    }
                  ]
                }
              }
            ],
            "relationshipId": "string"
          }
        }
      ],
      "representation": {
        "type": "string"
      },
      "specialization": "string",
      "validityState": "Draft",
      "visibility": {
        "lastChange": {
          "at": "string",
          "by": "string"
        },
        "visible": true
      }
    }
  ]
}

"string"