Freigeben über


Type - Get By Name

Rufen Sie die Typdefinition nach ihrem Namen (eindeutig) ab.

GET {endpoint}/datamap/api/atlas/v2/types/typedef/name/{name}

URI-Parameter

Name In Erforderlich Typ Beschreibung
endpoint
path True

string

name
path True

string

Der Name des Typs.

Antworten

Name Typ Beschreibung
200 OK

AtlasTypeDef

Die Anforderung war erfolgreich.

Other Status Codes

AtlasErrorResponse

Eine unerwartete Fehlerantwort.

Sicherheit

OAuth2Auth

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name Beschreibung
https://purview.azure.net/.default

Beispiele

Type_GetByName

Beispielanforderung

GET {endpoint}/datamap/api/atlas/v2/types/typedef/name/glossary_term_status_value

Beispiel für eine Antwort

{
  "category": "ENUM",
  "guid": "0ddc2fcf-ad17-4d06-984a-ffb2ffb2a941",
  "createdBy": "ExampleCreator",
  "updatedBy": "ExampleUpdator",
  "createTime": 1604728877305,
  "updateTime": 1604728877305,
  "version": 1,
  "name": "glossary_term_status_value",
  "description": "glossary_term_status_value",
  "typeVersion": "1.0",
  "lastModifiedTS": "1",
  "elementDefs": [
    {
      "value": "Approved",
      "ordinal": 0
    },
    {
      "value": "Alert",
      "ordinal": 1
    },
    {
      "value": "Expired",
      "ordinal": 2
    },
    {
      "value": "Draft",
      "ordinal": 3
    }
  ]
}

Definitionen

Name Beschreibung
AtlasAttributeDef

-Klasse, die Details eines Struktur-Attributs erfasst.

AtlasConstraintDef

-Klasse, die Details einer Einschränkung erfasst.

AtlasEnumElementDef

-Klasse, die Details eines enum-Elements erfasst.

AtlasErrorResponse

Eine Fehlerantwort des Diensts

AtlasRelationshipAttributeDef

RelationshipEndDef stellt ein Ende der Beziehung dar. Das Ende der Beziehung wird durch einen Typ, einen Attributnamen, kardinalität und ob es das Containerende der Beziehung ist definiert.

AtlasRelationshipEndDef

RelationshipEndDef stellt ein Ende der Beziehung dar. Das Ende der Beziehung wird durch einen Typ, einen Attributnamen, kardinalität und ob es das Containerende der Beziehung ist definiert.

AtlasTypeDef

Die Definitionen des Typs.

CardinalityValue

Kardinalität

DateFormat

Das Datumsformat,

NumberFormat

Das Zahlenformat.

RelationshipCategory

Beziehungskategorie

RoundingMode

Rundungsmodus

TimeZone

Die Zeitzoneninformationen.

TypeCategory

Typkategorie

AtlasAttributeDef

-Klasse, die Details eines Struktur-Attributs erfasst.

Name Typ Beschreibung
cardinality

CardinalityValue

Einwertiges Attribut oder mehrwertiges Attribut.

constraints

AtlasConstraintDef[]

Ein Array von Einschränkungen.

defaultValue

string

Der Standardwert des Attributs.

description

string

Die Beschreibung des Attributs.

includeInNotification

boolean

Bestimmt, ob es in der Benachrichtigung enthalten ist.

isIndexable

boolean

Bestimmt, ob es indiziert werden kann.

isOptional

boolean

Bestimmt, ob dies optional ist.

isUnique

boolean

Bestimmt, ob es eindeutig ist.

name

string

Der Name des Attributs.

options

object

Die Optionen für das Attribut.

typeName

string

Der Name des Typs.

valuesMaxCount

integer

Die maximale Anzahl der Werte.

valuesMinCount

integer

Die Mindestanzahl der Werte.

AtlasConstraintDef

-Klasse, die Details einer Einschränkung erfasst.

Name Typ Beschreibung
params

Die Parameter der Einschränkungsdefinition.

type

string

Der Typ der Einschränkung.

AtlasEnumElementDef

-Klasse, die Details eines enum-Elements erfasst.

Name Typ Beschreibung
description

string

Die Beschreibung der Enumerationselementdefinition.

ordinal

integer

Die Ordnungszahl der Enumerationselementdefinition.

value

string

Der Wert der Enumerationselementdefinition.

AtlasErrorResponse

Eine Fehlerantwort des Diensts

Name Typ Beschreibung
errorCode

string

Der Fehlercode.

errorMessage

string

Die Fehlermeldung.

requestId

string

Die Anforderungs-ID.

AtlasRelationshipAttributeDef

RelationshipEndDef stellt ein Ende der Beziehung dar. Das Ende der Beziehung wird durch einen Typ, einen Attributnamen, kardinalität und ob es das Containerende der Beziehung ist definiert.

Name Typ Beschreibung
cardinality

CardinalityValue

Einwertiges Attribut oder mehrwertiges Attribut.

constraints

AtlasConstraintDef[]

Ein Array von Einschränkungen.

defaultValue

string

Der Standardwert des Attributs.

description

string

Die Beschreibung des Attributs.

includeInNotification

boolean

Bestimmt, ob es in der Benachrichtigung enthalten ist.

isIndexable

boolean

Bestimmt, ob es indiziert werden kann.

isLegacyAttribute

boolean

Bestimmt, ob es sich um ein Legacy-Attribut handelt.

isOptional

boolean

Bestimmt, ob dies optional ist.

isUnique

boolean

Bestimmt, ob es eindeutig ist.

name

string

Der Name des Attributs.

options

object

Die Optionen für das Attribut.

relationshipTypeName

string

Der Name des Beziehungstyps.

typeName

string

Der Name des Typs.

valuesMaxCount

integer

Die maximale Anzahl der Werte.

valuesMinCount

integer

Die Mindestanzahl der Werte.

AtlasRelationshipEndDef

RelationshipEndDef stellt ein Ende der Beziehung dar. Das Ende der Beziehung wird durch einen Typ, einen Attributnamen, kardinalität und ob es das Containerende der Beziehung ist definiert.

Name Typ Beschreibung
cardinality

CardinalityValue

Einwertiges Attribut oder mehrwertiges Attribut.

description

string

Die Beschreibung der Definition des Beziehungsendes.

isContainer

boolean

Bestimmt, ob es sich um einen Container handelt.

isLegacyAttribute

boolean

Bestimmt, ob es sich um ein Legacy-Attribut handelt.

name

string

Der Name der Definition des Beziehungsendes.

type

string

Der Typ des Beziehungsendes.

AtlasTypeDef

Die Definitionen des Typs.

Name Typ Beschreibung
attributeDefs

AtlasAttributeDef[]

Ein Array von Attributdefinitionen.

category

TypeCategory

Die Enumeration der Typkategorie.

createTime

integer

Die Erstellungszeit des Datensatzes.

createdBy

string

Der Benutzer, der den Datensatz erstellt hat.

dateFormatter

DateFormat

Das Datumsformat,

defaultValue

string

Der Standardwert.

description

string

Die Beschreibung der Typdefinition.

elementDefs

AtlasEnumElementDef[]

Ein Array von Enumerationselementdefinitionen.

endDef1

AtlasRelationshipEndDef

RelationshipEndDef stellt ein Ende der Beziehung dar. Das Ende der Beziehung wird durch einen Typ, einen Attributnamen, kardinalität und ob es das Containerende der Beziehung ist definiert.

endDef2

AtlasRelationshipEndDef

RelationshipEndDef stellt ein Ende der Beziehung dar. Das Ende der Beziehung wird durch einen Typ, einen Attributnamen, kardinalität und ob es das Containerende der Beziehung ist definiert.

entityTypes

string[]

Durch das Angeben einer Liste von entityType-Namen im classificationDef wird sichergestellt, dass Klassifizierungen nur auf diese EntityTypes angewendet werden können.

Alle Untertypen der Entitätstypen erben die Einschränkung.

Alle classificationDef-Untertypen erben die entityTypes-Einschränkungen für übergeordnete Elemente.

Alle classificationDef-Untertypen können die Übergeordneten entityTypes-Einschränkungen weiter einschränken, indem eine Teilmenge der entityTypes angegeben wird.

Eine leere entityTypes-Liste, wenn keine übergeordneten Einschränkungen vorhanden sind, bedeutet, dass keine Einschränkungen vorliegen.

Eine leere entityTypes-Liste, wenn übergeordnete Einschränkungen vorhanden sind, bedeutet, dass der Untertyp die übergeordneten Einschränkungen übernimmt.

Wenn eine Liste von entityTypes angegeben wird, bei der eine von einem anderen erbt, wird dies abgelehnt. Dies sollte zu saubereren KlassifizierungenDefs beitragen.

guid

string

Die GUID der Typdefinition.

lastModifiedTS

string

ETag für die Parallelitätssteuerung.

name

string

Der Name der Typdefinition.

options

object

Die Optionen für die Typdefinition.

relationshipAttributeDefs

AtlasRelationshipAttributeDef[]

Ein Array von Beziehungsattributen.

relationshipCategory

RelationshipCategory

Die Beziehungskategorie bestimmt den Beziehungsstil um Eindämmung und Lebenszyklus. Für die Werte wird die UML-Terminologie verwendet.

ASSOCIATION ist eine Beziehung ohne Eindämmung. COMPOSITION und AGGREGATION sind Einschlussbeziehungen.

Der Unterschied besteht in den Lebenszyklen des Containers und seiner untergeordneten Elemente. Im COMPOSITION-Fall können die untergeordneten Elemente nicht ohne den Container vorhanden sein. Bei AGGREGATION sind die Lebenszyklen des Containers und der untergeordneten Elemente völlig unabhängig.

relationshipLabel

string

Die Bezeichnung der Beziehung.

serviceType

string

Der Diensttyp.

subTypes

string[]

Ein Array von Untertypen.

superTypes

string[]

Ein Array von Supertypen.

typeVersion

string

Die Version des Typs.

updateTime

integer

Die Aktualisierungszeit des Datensatzes.

updatedBy

string

Der Benutzer, der den Datensatz aktualisiert hat.

version

integer

Die Version des Datensatzes.

CardinalityValue

Kardinalität

Name Typ Beschreibung
LIST

string

list

SET

string

set

SINGLE

string

single

DateFormat

Das Datumsformat,

Name Typ Beschreibung
availableLocales

string[]

Ein Array verfügbarer Gebietsschemas.

calendar

number

Kalender

dateInstance

DateFormat

Das Datumsformat,

dateTimeInstance

DateFormat

Das Datumsformat,

instance

DateFormat

Das Datumsformat,

lenient

boolean

Bestimmt die Milde des Datumsformats.

numberFormat

NumberFormat

Das Zahlenformat.

timeInstance

DateFormat

Das Datumsformat,

timeZone

TimeZone

Die Zeitzoneninformationen.

NumberFormat

Das Zahlenformat.

Name Typ Beschreibung
availableLocales

string[]

Das Zahlenformat.

currency

string

Die Währung.

currencyInstance

NumberFormat

Das Zahlenformat.

groupingUsed

boolean

Bestimmt, ob eine Gruppierung verwendet wird.

instance

NumberFormat

Das Zahlenformat.

integerInstance

NumberFormat

Das Zahlenformat.

maximumFractionDigits

integer

Die maximale Anzahl von Bruchstellen.

maximumIntegerDigits

integer

Die maximale Anzahl ganzzahliger Ziffern.

minimumFractionDigits

integer

Die minimale Anzahl von Bruchstellen.

minimumIntegerDigits

integer

Die minimale Anzahl ganzzahliger Ziffern.

numberInstance

NumberFormat

Das Zahlenformat.

parseIntegerOnly

boolean

Bestimmt, ob nur ganze Zahlen analysiert werden.

percentInstance

NumberFormat

Das Zahlenformat.

roundingMode

RoundingMode

Die Enumeration des Rundungsmodus.

RelationshipCategory

Beziehungskategorie

Name Typ Beschreibung
AGGREGATION

string

aggregation

ASSOCIATION

string

Korrelation

COMPOSITION

string

Komposition

RoundingMode

Rundungsmodus

Name Typ Beschreibung
CEILING

string

ceiling

DOWN

string

fahren

FLOOR

string

floor

HALF_DOWN

string

halb unten

HALF_EVEN

string

halb gerade

HALF_UP

string

halb aufwärts

UNNECESSARY

string

unnecessary (nicht erforderlich)

UP

string

up

TimeZone

Die Zeitzoneninformationen.

Name Typ Beschreibung
availableIds

string[]

Ein Array verfügbarer IDs.

default

TimeZone

Die Zeitzoneninformationen.

displayName

string

Der Anzeigename der Zeitzone.

dstSavings

integer

Der Wert der Sommerzeit.

id

string

Die ID der Zeitzone.

rawOffset

integer

Der unformatierte Offset der Zeitzone.

TypeCategory

Typkategorie

Name Typ Beschreibung
ARRAY

string

array

CLASSIFICATION

string

Klassifizierung

ENTITY

string

Entität

ENUM

string

enum

MAP

string

Karte

OBJECT_ID_TYPE

string

Objekt-ID-Typ

PRIMITIVE

string

primitiv

RELATIONSHIP

string

Beziehung (relationship)

STRUCT

string

struct

TERM_TEMPLATE

string

Ausdrucksvorlage