Accéder au contenu principal Passer au contenu complémentaire

Obtenir les paramètres d'une vue par son nom

Availability-noteDéprécié·e

Obtient les paramètres d'une vue par son nom spécifié, dont la description, l'ID du modèle de données (nom), les éléments métier visibles, les éléments métier recherchables, etc.

Note InformationsRemarque : Seuls les utilisateurs et utilisatrices de type Super Admin ayant le rôle administrateur ont accès à cette API. Pour plus d'informations concernant les types d'utilisateur·trices MDM, consultez Types d'utilisateurs et rôles système MDM.
Requête
GET /services/rest/system/views/{viewName}
Paramètres
  • viewName : valeur String qui spécifie le nom de la vue.
  • lang (optionnel) : valeur String du code de langue qui spécifie la langue dans laquelle la description de la vue sera retournée, par exemple en pour l'anglais. Si ce paramètre n'est pas spécifié ou que la description n'existe pas dans la langue spécifiée, toutes les descriptions définies seront retournées.
En-têtes
  • Accept : application/json
  • Authorization : schéma d'authentification basique
Réponse Paramètres de la vue au format JSON.
Statut
  • 200 OK : l'opération a bien été exécutée.
  • 400 BAD REQUEST : la requête contient un paramètre invalide.
  • 403 FORBIDDEN : l'autorisation requise est manquante.
  • 404 NOT FOUND : la ressource n'existe pas, par exemple l'ID de la vue est invalide.
  • 500 INTERNAL SERVER ERROR : autres erreurs.

Exemple de réponse

{
  "name": "Browse_items_Product#Stores",
  "description": "[FR:Produit avec Magasins][EN:Product with Stores]",
  "dataModelId": "Product",
  "sortField": "",
  "isAsc": false,
  "isTransformerActive": false,
  "customForm": "",
  "viewableBusinessElements": [
    "Product/Id",
    "Product/Name",
    "Product/Description",
    "Product/Availability",
    "Product/Price",
    "Product/Family",
    "Store/Address"
  ],
  "searchableBusinessElements": [
    "Product",
    "Product/Id",
    "Product/Name",
    "Product/Description",
    "Product/Price",
    "Product/Family",
    "Store/Address"
  ],
  "whereConditions": [
    {
      "leftPath": "Product/Stores/Store",
      "operator": "JOINS",
      "rightValueOrPath": "Store/Id",
      "spellCheck": "false",
      "stringPredicate": "NONE"
    }
  ]
}

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 – faites-le-nous savoir.