Lesen von Datenmodellen mithilfe der API - Cloud

Nutzungshandbuch für Talend Cloud Data Stewardship

Version
Cloud
Language
Deutsch
Product
Talend Cloud
Module
Talend Data Stewardship
Content
Administration und Überwachung > Verwaltung von Benutzern
Data Governance > Datenmodellverwaltung
Data Governance > Kampagnenverwaltung
Data Governance > Taskzuweisung
Datenqualität und Datenaufbereitung > Handhabung von Tasks
Last publication date
2024-02-05

Sie können ein Datenmodell über seinen Namen abrufen. Die Antwort enthält technische Informationen zu den Datenmodellattributen, sodass Sie das Datenmodell aktualisieren können.

In diesem Beispiel wird Talend API Tester zum Senden von Requests verwendet.

Weitere Informationen zu Talend API Tester finden Sie im Nutzungshandbuch für Talend Cloud API Tester.

Prozedur

  1. Sofern Sie noch nicht über ein persönliches Zugriffstoken verfügen, erzeugen Sie eines. Weitere Informationen finden Sie unter „Generieren persönlicher Zugriffstoken“.
  2. Öffnen Sie Talend API Tester in Ihrem Browser.
  3. Wählen Sie auf der Registerkarte Repository die Methode Get in der Dropdown-Liste Method (Methode) aus.
  4. Geben Sie folgende URL ein: https://tds.{region}.cloud.talend.com/schemaservice/api/v1/schemas/org.talend.schema/{dataModelName}
    Eine Liste der für die verschiedenen Rechenzentren zu verwendenden URLs finden Sie unter Talend Cloud-Regionen und -URLs.

    {dataModelName} entspricht dem technischen Namen des Datenmodells, jedoch nicht dem in der Liste der Datenmodelle in Talend Cloud Data Stewardship angezeigten Namen. Beispiel: my_products_created_via_API (Meine per API erstellten Produkte), verwendet in Erstellen von Datenmodellen mithilfe der API.

  5. Klicken Sie auf die Schaltfläche Add header (Header hinzufügen) und geben Sie Authorization (Autorisierung) in das Feld name (Name) und Bearer, gefolgt von einem Leerzeichen und Ihrem Token in das Feld value (Wert) ein.
  6. Klicken Sie auf die Schaltfläche Add header (Header hinzufügen), geben Sie Cookie in das Feld name (Name) ein und lassen Sie das Feld value (Wert) leer.
  7. Klicken Sie auf Send (Senden).

Ergebnisse

Die API gibt den HTTP-Code 200 zurück, um Sie darüber zu informieren, dass der Request erfolgreich war. Die Antwort enthält eine JSON-Beschreibung der Datenmodellattribute. Beispiel:
{
    "namespace": "org.talend.schema",
    "displayName": "Product (created via API)",
    "name": "my_products_created_via_API",
    "description": "Product catalog available.",
    "version": 1,
    "references": null,
    "creationDate": 1601467434441,
    "lastUpdateDate": 1601467434441,
    "createdBy":{
        "id": "3e2eed7d-c632-40da-822e-9780f2c74842",
        "username": "user@account",
        "firstName": "user",
        "lastName": "name",
        "enabled": true
    },
    "lastUpdatedBy": {
        "id": "3e2eed7d-c632-40da-822e-9780f2c74842",
        "username": "user@account",
        "firstName": "user",
        "lastName": "name",
        "enabled": true
    },
    "fields": [{
        "uuid": "333ca858-5083-4425-bf36-c4fb3c259550",
        "name": "Id",
        "displayName": "Id",
        "path": null,
        "type": "integer",
        "description": "",
        "required": true,
        "constraints": [],
        "allowedValues": null
    }, {
        "uuid": "fef4318c-b859-45ce-a454-06cd3ded3389",
        "name": "Name",
        "displayName": "Name",
        "path": null,
        "type": "text",
        "description": "",
        "required": true,
        "constraints": [],
        "allowedValues": null
    }, {
        "uuid": "7fa67525-bd6d-4b69-ad5b-f515911d32a6",
        "name": "Material",
        "displayName": "Material",
        "path": null,
        "type": "text",
        "description": "",
        "required": true,
        "constraints": [],
        "allowedValues": null
    }, {
        "uuid": "7673756a-73e8-4c4f-b460-86cc27e938e7",
        "name": "Size",
        "displayName": "Size",
        "path": null,
        "type": "text",
        "description": "",
        "required": true,
        "constraints": [],
        "allowedValues": null
    }, {
        "uuid": "1f358991-9c16-412a-88d4-75b99a3d1748",
        "name": "Price",
        "displayName": "Price",
        "path": null,
        "type": "decimal",
        "description": "",
        "required": true,
        "constraints": [{
            "name": "scaleDecimal",
            "value": "2"
        }],
        "allowedValues": null
    }, {
        "uuid": "c933a4d6-3ce5-4548-99fe-102313ef47e4",
        "name": "Quantity",
        "displayName": "Quantity",
        "path": null,
        "type": "integer",
        "description": "",
        "required": true,
        "constraints": [],
        "allowedValues": null
    }, {
        "uuid": "dcd1b06f-2545-45f5-a94f-4f8ddbfc35b7",
        "name": "Family",
        "displayName": "Family",
        "path": null,
        "type": "text",
        "description": "",
        "required": true,
        "constraints": [],
        "allowedValues": null
    }, {
        "uuid": "9bf5f4b2-7454-423d-a2e7-3a41de740927",
        "name": "Packaging",
        "displayName": "Packaging",
        "path": null,
        "type": "text",
        "description": "",
        "required": true,
        "constraints": [],
        "allowedValues": null
    }, {
        "uuid": "48678877-8401-47d8-93d9-2097fe0df3c0",
        "name": "ProductURL",
        "displayName": "Product URL",
        "path": null,
        "type": "URL",
        "description": "",
        "required": true,
        "constraints": [],
        "allowedValues": null
    }, {
        "uuid": "737ea048-de9c-414b-9052-904ad8ed316a",
        "name": "productType",
        "displayName": "Type",
        "path": null,
        "type": "text",
        "description": "",
        "required": false,
        "constraints": [],
        "allowedValues": null
    }],
    "referenced": true
}
Anmerkung: Wenn Sie versuchen, ein Datenmodell mit einem nicht vorhandenen Namen abzurufen, gibt die API den Fehler 404 Not Found (404 Nicht gefunden) zurück. Die Antwort enthält in etwa folgende Nachricht:
"code":"SCHEMA_ALL_SCHEMA_NOT_FOUND","message":"SCHEMA_NOT_FOUND","context":{"namespace":"org.talend.schema","name":"demo_produc"}}