List a single element by external ID.

List a single element by external ID. Get the architecture element an externalId means, among what the caller may read: the draft of its lineage, or else its newest published version. Where several lineages carry the externalId, a working draft wins over a published one, then the newest. Does the edition of the process space not include the type of that version, the newest version of the same lineage whose type it does include is answered instead - the one byElementIds hands out. Covers the edition no version of that lineage, the element is refused with 403; another lineage carrying the same externalId is not offered in its place, so byExternalIds can still answer where this route refuses.

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

GET/v1/warehouses/{warehouseId}/architectureElements/byExternalId/{externalId}

Autorisierung

AuthorizationBearer-Token (JWT) · headererforderlich

BpmLicenseAPI-Schlüssel · headererforderlich

Pfadparameter

warehouseIdstringerforderlich

Warehouse-Id

externalIdstringerforderlich

ArchitectureElement-ExternalId

Antworten

200

Found 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

Eigenschaften anzeigen

defaultLanguagestringerforderlich

translationsTranslation[]erforderlich

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

Eigenschaften anzeigen

defaultLanguagestringerforderlich

translationsTranslation[]erforderlich

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

Eigenschaften anzeigen

atstringerforderlich

bystringerforderlich

visiblebooleanerforderlich

403

The edition of this process space includes no version of this element's lineage

string

404

Warehouse not found or no readable element with this externalId

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-IdexternalIdpath*ArchitectureElement-ExternalId

Anfrage

curl -X GET 'https://goto.bpanda.com/api/v1/warehouses/string/architectureElements/byExternalId/string' \
  -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/byExternalId/string", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "BpmLicense": "YOUR_API_KEY",
    "Accept": "application/json"
  }
});

Antwort

{
  "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": [
                        {
                          "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"
                }
              ]
            }
          }
        ],
        "relationshipId": "string"
      }
    }
  ],
  "representation": {
    "type": "string"
  },
  "specialization": "string",
  "validityState": "Draft",
  "visibility": {
    "lastChange": {
      "at": "string",
      "by": "string"
    },
    "visible": true
  }
}

"string"

"string"