Créer un modèle de données à l'aide de l'API

Un modèle de données consiste en une liste d'attributs. Le modèle de données doit être créé avant la création de la campagne.

Dans cet exemple, Talend API Tester est utilisé pour envoyer des requêtes.

Pour plus d'informations concernant Talend API Tester, consultez le Guide d'utilisation de Talend Cloud API Tester.

Procédure

Si vous n'avez pas encore de jeton d'accès personnel, générez-en un. Pour plus d'informations, consultez Générer un jeton d'accès personnel.
Ouvrez Talend API Tester dans votre navigateur.
Dans l'onglet Repository (Référentiel), sélectionnez Post dans la liste déroulante Method (Méthode).
Saisissez l'URL suivante : https://tds.{region}.cloud.talend.com/schemaservice/api/v1/schemas/org.talend.schema

Vous pouvez voir une liste d'URL à utiliser pour chaque centre de données dans URL et régions de Talend Cloud.
Cliquez sur le bouton Add header, saisissez Authorization dans le champ name et Bearer suivi d'un espace, puis de votre jeton, dans le champ value.
Cliquez sur le bouton Add header et saisissez Cookie dans le champ name et laissez le champ value vide.

Dans le champ Body, incluez les détails du modèle de données au format JSON.

Exemple

Pour créer le même modèle de données demo_product que dans la visite guidée, utilisez un nom différent, comme my_products_created_via_API et saisissez :

{
    "name": "my_products_created_via_API",
    "displayName": "Product (created via API)",
    "description": "Product catalog available.",
    "fields": [{
        "name": "Id",
        "displayName": "Id",
        "description": "",
        "type": "integer",
        "required": true
    }, {
        "name": "Name",
        "displayName": "Name",
        "description": "",
        "type": "text",
        "required": true
    }, {
        "name": "Material",
        "displayName": "Material",
        "description": "",
        "type": "text",
        "required": true
    }, {
        "name": "Size",
        "displayName": "Size",
        "description": "",
        "type": "text",
        "required": true
    }, {
        "name": "Price",
        "displayName": "Price",
        "description": "",
        "type": "decimal",
        "required": true,
        "constraints": [{
            "name": "scaleDecimal",
            "value": 2
        }]
    }, {
        "name": "Quantity",
        "displayName": "Quantity",
        "description": "",
        "type": "integer",
        "required": true
    }, {
        "name": "Family",
        "displayName": "Family",
        "description": "",
        "type": "text",
        "required": true
    }, {
        "name": "Packaging",
        "displayName": "Packaging",
        "description": "",
        "type": "text",
        "required": true
    }, {
        "name": "ProductURL",
        "displayName": "Product URL",
        "description": "",
        "type": "URL",
        "required": true
    }, {
        "name": "productType",
        "displayName": "Type",
        "description": "",
        "type": "text",
        "required": false
    }]
}

Cliquez sur Send (Envoyer).

Résultats

L'API retourne un code HTTP 200 pour vous informer que la requête a bien été exécutée. La réponse comprend une description JSON du modèle de données créé, par exemple :

{
    "namespace": "org.talend.schema",
    "displayName": "Product (created via API)",
    "name": "my_products_created_via_API",
    "description": "Product catalog available.",
    "version": 1,
    "references":[],
    "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": null,
    "referenced": false
}

Vous pouvez voir le modèle de données que vous avez créé dans Talend Cloud Data Stewardship.

Remarque : Si vous essayez de créer un modèle de données avec un nom qui existe déjà, l'API retourne une erreur 400 Bad request. La réponse comprend un message similaire à celui-ci :

{"code":"SCHEMA_ALL_SCHEMA_NAME_ALREADY_EXISTS","message":"SCHEMA_NAME_ALREADY_EXISTS","context":{"name":"demo_product"}}

Cette page vous a-t-elle aidé ?

Si vous rencontrez des problèmes sur cette page ou dans son contenu – une faute de frappe, une étape manquante ou une erreur technique – dites-nous comment nous améliorer !

Laissez vos commentaires ici