Show Menu
SUJETS×

Modèles de Requête

Exemples d’appels d’API

Maintenant que vous savez quels en-têtes utiliser, vous êtes prêt à commencer à lancer des appels à l’API Requête Service. Les sections suivantes décrivent les différents appels d’API que vous pouvez effectuer à l’aide de l’API Requête Service. Chaque appel comprend le format général de l’API, un exemple de requête indiquant les en-têtes requis et un exemple de réponse.

Récupération d’une liste de modèles de requête

Vous pouvez récupérer une liste de tous les modèles de requête pour votre organisation IMS en adressant une demande GET au point de /query-templates terminaison.
Format d’API
GET /query-templates
GET /query-templates?{QUERY_PARAMETERS}

Propriété
Description
{QUERY_PARAMETERS}
( Facultatif ) Paramètres ajoutés au chemin de requête qui configurent les résultats renvoyés dans la réponse. Plusieurs paramètres peuvent être inclus, séparés par des esperluettes ( & ). Les paramètres disponibles sont répertoriés ci-dessous.
Paramètres de Requête
Voici une liste des paramètres de requête disponibles pour répertorier les modèles de requête. Tous ces paramètres sont facultatifs. L'appel à ce point de terminaison sans paramètre récupère tous les modèles de requête disponibles pour votre entreprise.
Paramètre
Description
orderby
Indique le champ selon lequel les résultats doivent être commandés. Les champs pris en charge sont created et updated . Par exemple, orderby=created triera les résultats par ordre croissant. L'ajout d'un élément - avant création ( orderby=-created ) triera les éléments par création dans l'ordre décroissant.
limit
Indique la limite de taille de page pour contrôler le nombre de résultats inclus dans une page. ( Default value: 20 )
start
Décale la liste de réponse à l’aide d’une numérotation à base zéro. Par exemple, start=2 renvoie une liste commençant à partir de la troisième requête répertoriée. ( Default value: 0 )
property
Filtrez les résultats en fonction des champs. Les filtres doivent être une séquence d’échappement HTML. Les virgules sont utilisées pour combiner plusieurs ensembles de filtres. Les champs pris en charge sont name et userId . Le seul opérateur pris en charge est == (égal à). Par exemple, name==my_template renvoie tous les modèles de requête portant le nom my_template .
Requête
La requête suivante récupère le dernier modèle de requête créé pour votre organisation IMS.
curl -X GET https://platform.adobe.io/data/foundation/query/query-templates?limit=1
 -H 'Authorization: Bearer {ACCESS_TOKEN}' \
 -H 'x-gw-ims-org-id: {IMS_ORG}' \
 -H 'x-api-key: {API_KEY}' \
 -H 'x-sandbox-name: {SANDBOX_NAME}'

Réponse
Une réponse réussie renvoie l'état HTTP 200 avec une liste de modèles de requête pour l'organisation IMS spécifiée. La réponse suivante renvoie le dernier modèle de requête créé pour votre organisation IMS.
{
    "templates": [
        {
            "sql": "SELECT *\nFROM\n  accounts\nLIMIT 10\n",
            "name": "Test",
            "id": "f7cb5155-29da-4b95-8131-8c5deadfbe7f",
            "updated": "2019-11-21T21:50:01.469Z",
            "userId": "{USER_ID}",
            "created": "2019-11-21T21:50:01.469Z",
            "_links": {
                "self": {
                    "href": "https://platform.adobe.io/data/foundation/query/query-templates/f7cb5155-29da-4b95-8131-8c5deadfbe7f",
                    "method": "GET"
                },
                "delete": {
                    "href": "https://platform.adobe.io/data/foundation/query/query-templates/f7cb5155-29da-4b95-8131-8c5deadfbe7f",
                    "method": "DELETE"
                },
                "update": {
                    "href": "https://platform.adobe.io/data/foundation/query/query-templates/f7cb5155-29da-4b95-8131-8c5deadfbe7f",
                    "method": "PUT",
                    "body": "{\"sql\" : \"new sql \", \"name\" : \"new name\"}"
                }
            }
        }
    ],
    "_page": {
        "orderby": "-created",
        "start": "2019-11-21T21:50:01.469Z",
        "next": "2019-11-21T21:50:01.469Z",
        "count": 1
    },
    "_links": {
        "next": {
            "href": "https://platform.adobe.io/data/foundation/query/query-templates?orderby=-created&start=2019-11-21T21:50:01.469Z"
        },
        "prev": {
            "href": "https://platform.adobe.io/data/foundation/query/query-templates?orderby=-created&start=2019-11-21T21:50:01.469Z&isPrevLink=true"
        }
    },
    "version": 1
}

Vous pouvez utiliser la valeur de _links.delete pour supprimer votre modèle de requête.

Création d’un modèle de requête

Vous pouvez créer un modèle de requête en envoyant une requête POST au point de /query-templates terminaison.
Format d’API
POST /query-templates

Requête
curl -X POST https://platform.adobe.io/data/foundation/query/query-templates
 -H 'Authorization: Bearer {ACCESS_TOKEN}' \
 -H 'x-gw-ims-org-id: {IMS_ORG}' \
 -H 'x-api-key: {API_KEY}' \
 -H 'x-sandbox-name: {SANDBOX_NAME}'
 -d '{
        "sql": "SELECT * FROM accounts;",
        "name": "Sample query template"
    }'

Propriété
Description
sql
requête SQL que vous souhaitez créer.
name
Nom du modèle de requête.
Réponse
Une réponse réussie renvoie l’état HTTP 202 (Accepté) avec les détails de votre nouveau modèle de requête.
{
    "sql": "SELECT * FROM accounts;",
    "name": "Sample query template",
    "id": "0094d000-9062-4e6a-8fdb-05606805f08f",
    "updated": "2020-01-09T00:20:09.670Z",
    "userId": "{USER_ID}",
    "created": "2020-01-09T00:20:09.670Z",
    "_links": {
        "self": {
            "href": "https://platform.adobe.io/data/foundation/query/query-templates/0094d000-9062-4e6a-8fdb-05606805f08f",
            "method": "GET"
        },
        "delete": {
            "href": "https://platform.adobe.io/data/foundation/query/query-templates/0094d000-9062-4e6a-8fdb-05606805f08f",
            "method": "DELETE"
        },
        "update": {
            "href": "https://platform.adobe.io/data/foundation/query/query-templates/0094d000-9062-4e6a-8fdb-05606805f08f",
            "method": "PUT",
            "body": "{\"sql\" : \"new sql \", \"name\" : \"new name\"}"
        }
    }
}

Vous pouvez utiliser la valeur de _links.delete pour supprimer votre modèle de requête.

Récupération d’un modèle de requête spécifié

Vous pouvez récupérer un modèle de requête spécifique en envoyant une requête GET au point de /query-templates/{TEMPLATE_ID} terminaison et en indiquant l’identifiant du modèle de requête dans le chemin d’accès de la requête.
Format d’API
GET /query-templates/{TEMPLATE_ID}

Propriété
Description
{TEMPLATE_ID}
Valeur id du modèle de requête que vous souhaitez récupérer.
Requête
curl -X GET https://platform.adobe.io/data/foundation/query/query-templates/0094d000-9062-4e6a-8fdb-05606805f08f
 -H 'Authorization: Bearer {ACCESS_TOKEN}' \
 -H 'x-gw-ims-org-id: {IMS_ORG}' \
 -H 'x-api-key: {API_KEY}' \
 -H 'x-sandbox-name: {SANDBOX_NAME}'

Réponse
Une réponse réussie renvoie l’état HTTP 200 avec les détails du modèle de requête spécifié.
{
    "sql": "SELECT * FROM accounts;",
    "name": "Sample query template",
    "id": "0094d000-9062-4e6a-8fdb-05606805f08f",
    "updated": "2020-01-09T00:20:09.670Z",
    "userId": "A5A562D15E1645480A495CE1@techacct.adobe.com",
    "created": "2020-01-09T00:20:09.670Z",
    "_links": {
        "self": {
            "href": "https://platform.adobe.io/data/foundation/query/query-templates/0094d000-9062-4e6a-8fdb-05606805f08f",
            "method": "GET"
        },
        "delete": {
            "href": "https://platform.adobe.io/data/foundation/query/query-templates/0094d000-9062-4e6a-8fdb-05606805f08f",
            "method": "DELETE"
        },
        "update": {
            "href": "https://platform.adobe.io/data/foundation/query/query-templates/0094d000-9062-4e6a-8fdb-05606805f08f",
            "method": "PUT",
            "body": "{\"sql\" : \"new sql \", \"name\" : \"new name\"}"
        }
    }
}

Vous pouvez utiliser la valeur de _links.delete pour supprimer votre modèle de requête.

Mettre à jour un modèle de requête spécifié

Vous pouvez mettre à jour un modèle de requête spécifique en exécutant une requête PUT sur le point de /query-templates/{TEMPLATE_ID} terminaison et en indiquant l’identifiant du modèle de requête dans le chemin de la requête.
Format d’API
PUT /query-templates/{TEMPLATE_ID}

Propriété
Description
{TEMPLATE_ID}
Valeur id du modèle de requête que vous souhaitez récupérer.
Requête
La requête PUT nécessite que le champ sql et le champ name soient remplis et remplace ​le contenu actuel de ce modèle de requête.
curl -X PUT https://platform.adobe.io/data/foundation/query/query-templates/0094d000-9062-4e6a-8fdb-05606805f08f
 -H 'Authorization: Bearer {ACCESS_TOKEN}' \
 -H 'x-gw-ims-org-id: {IMS_ORG}' \
 -H 'x-api-key: {API_KEY}' \
 -H 'x-sandbox-name: {SANDBOX_NAME}'
 -d '{
    "sql": "SELECT * FROM accounts LIMIT 20;",
    "name": "Sample query template"
 }'

Propriété
Description
sql
requête SQL à mettre à jour.
name
Nom de la requête planifiée.
Réponse
Une réponse réussie renvoie l’état HTTP 202 (Accepté) avec les informations mises à jour pour votre modèle de requête spécifié.
{
    "sql": "SELECT * FROM accounts LIMIT 20;",
    "name": "Sample query template",
    "id": "0094d000-9062-4e6a-8fdb-05606805f08f",
    "updated": "2020-01-09T00:29:20.028Z",
    "lastUpdatedBy": "{USER_ID}",
    "userId": "{USER_ID}",
    "created": "2020-01-09T00:20:09.670Z",
    "_links": {
        "self": {
            "href": "https://platform.adobe.io/data/foundation/query/query_templates/0094d000-9062-4e6a-8fdb-05606805f08f",
            "method": "GET"
        },
        "delete": {
            "href": "https://platform.adobe.io/data/foundation/query/query_templates/0094d000-9062-4e6a-8fdb-05606805f08f",
            "method": "DELETE"
        },
        "update": {
            "href": "https://platform.adobe.io/data/foundation/query/query_templates/0094d000-9062-4e6a-8fdb-05606805f08f",
            "method": "PUT",
            "body": "{\"sql\" : \"new sql \", \"name\" : \"new name\"}"
        }
    }
}

Vous pouvez utiliser la valeur de _links.delete pour supprimer votre modèle de requête.

Suppression d’un modèle de requête spécifié

Vous pouvez supprimer un modèle de requête spécifique en adressant une requête DELETE au modèle de requête /query-templates/{TEMPLATE_ID} et en indiquant l’identifiant dans le chemin d’accès à la requête.
Format d’API
DELETE /query-templates/{TEMPLATE_ID}

Propriété
Description
{TEMPLATE_ID}
Valeur id du modèle de requête que vous souhaitez récupérer.
Requête
curl -X DELETE https://platform.adobe.io/data/foundation/query/query-templates/0094d000-9062-4e6a-8fdb-05606805f08f
 -H 'Authorization: Bearer {ACCESS_TOKEN}' \
 -H 'x-gw-ims-org-id: {IMS_ORG}' \
 -H 'x-api-key: {API_KEY}' \
 -H 'x-sandbox-name: {SANDBOX_NAME}'

Réponse
Une réponse réussie renvoie l’état HTTP 202 (Accepté) avec le message suivant.
{
    "message": "Deleted",
    "statusCode": 202
}