Passer au contenu principal

Gestion des propriétés de recherche

Mis à jour il y a plus d'un mois

Cette section détaille les endpoints permettant de lister et mettre à jour les propriétés de recherche d'une arborescence.

Remarque : Si vous n'êtes pas familiers avec ces fonctionnalités, consultez notre article sur la gestion des propriétés de recherche.

Récupérer la liste des propriétés recherchables dans une arborescence

Description

Cette requête renvoie une liste avec l'ensemble des propriétés recherchables présentes dans l'arborescence.

Get /v2/data-structures/{data_structure_id}/searchable-properties

Scope

Pour effectuer cette requête, vous devez posséder le scope metadata:read.

Paramètres

Ce paramètre doit être ajouté à l'URL pour construire la chaîne de requête :

/v2/data-structures/{data_structure_id}/searchable-properties

Exemple de requête

# Commande pour lister les propriétés recherchables d'une arborescence 
 curl -X 'GET' \ 
   'https://xxx.indaba.api.indasuite.io-base.com/v2/data-structures/67337415-6bcb-4c21-b0f5-8253d68b6e80/searchable-properties' \ 
 
   # ----- En-têtes ----- 
   -H 'accept: application/json' \ 
   -H 'Authorization: Bearer VOTRE_JETON_JWT'

Réponses

exemple de réponse valide (200 OK) : 

{ 
   "data": [ 
     { 
       "typeId": "0b3f2349-9b17-45d9-b7c4-0b47d0f39960", 
       "property": { 
         "name": "Name", 
         "format": "Text" 
       }, 
       "displayName": "Name", 
       "isTypeMetric": true, 
       "searchableType": "Custom" 
     }, 
     { 
       "typeId": "0b3f2349-9b17-45d9-b7c4-0b47d0f39960", 
       "property": { 
         "name": "Datasource", 
         "format": "Text" 
       }, 
       "displayName": "Datasource", 
       "isTypeMetric": true, 
       "searchableType": "Custom" 
     }, 
     { 
       "typeId": "0b3f2349-9b17-45d9-b7c4-0b47d0f39960", 
       "property": { 
         "name": "Description", 
         "format": "Text" 
       }, 
       "displayName": "Description", 
       "isTypeMetric": true, 
       "searchableType": "Custom" 
     }, 
     { 
       "typeId": "0b3f2349-9b17-45d9-b7c4-0b47d0f39960", 
       "property": { 
         "name": "Unit", 
         "format": "Text" 
       }, 
       "displayName": "Unit", 
       "isTypeMetric": true, 
       "searchableType": "Custom" 
     } 
   ], 
   "resultCode": 2010, 
   "message": "OK" 
 }

Erreurs courantes

Veuillez vous référer à la liste des erreurs courantes.

Mettre à jour des propriétés recherchables

Description

Cette requête vous permet de modifier des propriétés de recherche associées aux types de vos arborescences.

Put /v2/data-structures/{data_structure_id}/searchable-properties

Scope

Pour effectuer cette requête, vous devez posséder le scope suivant : metadata:admin.

Paramètres

Ce paramètre doit être ajouté à l'URL pour construire la chaîne de requête :

/v2/data-structures/{data_structure_id}/searchable-properties

Corps de la requête

Les paramètres suivants doivent être inclus dans le corps de la requête :

  • type_id (string, obligatoire) : ID attribué au type d'élément.

    Vous pouvez trouver l'ID d'un type dans le corps de réponse de la requête Get v2/data-structures/{data_structure_id}/types ou lors de la création d'un nouveau type.

  • displayName : nom d'affichage de la propriété

  • searchableType : propriété de recherche associée au type

    Par exemple :

    [

    {

    "typeId": "e9910c2b-83e9-4954-a1dd-abca2d833999",

    "displayName": "Documentation - id",

    "searchableType": "Id"

    }

    ]

Exemple de requête

Voici une requête avec plusieurs propriétés de recherche : 

# Commande pour mettre à jour les propriétés recherchables 
 curl -X 'PUT' \ 
   'https://xxx.indaba.api.indasuite.io-base.com/v2/data-structures/67337415-6bcb-4c21-b0f5-8253d68b6e80/searchable-properties' \ 
 
   # ----- En-têtes ----- 
   -H 'accept: application/json' \ 
   -H 'Authorization: Bearer VOTRE_JETON_JWT' \ 
   -H 'Content-Type: application/json' \ 
 
   # ----- Corps de la requête ----- 
   -d ' 
   [ 
     { 
       "typeId": "e9910c2b-83e9-4954-a1dd-abca2d833999", 
       "displayName": "Documentation - Id", 
       "searchableType": "Id" 
     }, 
     { 
       "typeId": "e9910c2b-83e9-4954-a1dd-abca2d833999", 
       "displayName": "exemple2 - Label", 
       "searchableType": "Label" 
     } 
   ] 
   '

Réponses

exemple de réponses valide (200 OK) : 

{ 
   "data": [ 
     { 
       "typeId": "e9910c2b-83e9-4954-a1dd-abca2d833999", 
       "displayName": "Documentation - Id", 
       "isTypeMetric": false, 
       "searchableType": "Id" 
     }, 
     { 
       "typeId": "e9910c2b-83e9-4954-a1dd-abca2d833999", 
       "displayName": "exemple2 - Label", 
       "isTypeMetric": false, 
       "searchableType": "Label" 
     } 
   ], 
   "resultCode": 2010, 
   "message": "OK" 
 }

Erreurs courantes

Veuillez vous référer à la liste des erreurs courantes.

Erreurs courantes

Vous rencontrerez principalement les codes d'erreur HTTP suivants :

  • 400 Bad Request : Votre requête est malformée. Cela peut être dû à un paramètre manquant, un type de donnée incorrect ou un JSON invalide. Le corps de la réponse contiendra un tableau errors détaillant le problème.
    ​

    { 
    "errors": [ 
    { 
    "error": "Type_De_L_Erreur", 
    "message": "Description détaillée de l'erreur spécifique." 
    } 
    ], 
    "statusCode": 1050, 
    "message": "Invalid request" 
    }

  • 401 Unauthorized : Votre jeton d'authentification (JWT) est manquant, invalide ou expiré. Vous devez obtenir un nouveau jeton valide.

  • 403 Forbidden : Votre jeton d'authentification est valide, mais vous n'avez pas les droits nécessaires pour cette action.

    Votre jeton n'a pas les droits (scope) nécessaires (par exemple, vous tentez de créer une arborescence sans avoir le scope metadata:admin).

  • 404 Not Found : La ressource que vous essayez d'atteindre n'existe pas. Cela se produit typiquement si vous utilisez un ID incorrect ou si vous demandez une métrique qui n'existe pas.

Article suivant

Avez-vous trouvé la réponse à votre question ?