Skip to main content Skip to complementary content

Get a list of all views

Availability-noteDeprecated

Gets a list of all Web Filter views that correspond to the deployed data models, including the name, description, and data model ID (name) for each view, and also the roles authorized to access each view.

Information noteNote: Only the Super Admin type users with the administration role have access to this API. For more information about MDM user types, see MDM user types and system roles.
Request
GET /services/rest/system/views
Parameters
  • lang (optional): This is a String value of the language code which specifies the language in which the description of the view will be returned, for example, en for English. If this parameter is not specified or the description in the specified language does not exist, all defined description will be returned.
Headers
  • Accept: application/json
  • Authorization: Basic Authentication scheme
Response A JSON array that contains a list of all Web Filter views that correspond to the deployed data models.
Status
  • 200 OK: The operation is executed successfully.
  • 403 FORBIDDEN: Missing required permission.
  • 500 INTERNAL SERVER ERROR: Other errors.

Sample response

[
  {
    "name": "Browse_items_Product",
    "description": "[EN:Product][FR:Produit][ZH:产品]",
    "dataModelId": "Product",
    "roles": [
      "Demo_Manager",
      "Demo_User"
    ]
  },
  {
    "name": "Browse_items_Product#Stores",
    "description": "[FR:Produit avec Magasins][EN:Product with Stores]",
    "dataModelId": "Product",
    "roles": [
      "Demo_Manager",
      "Demo_User"
    ]
  },
  {
    "name": "Browse_items_ProductFamily",
    "description": "[FR:Famille Produit][EN:Product Family]",
    "dataModelId": "Product",
    "roles": [
      "Demo_Manager",
      "Demo_User"
    ]
  },
  {
    "name": "Browse_items_Product#Unavailable",
    "description": "[EN:Unavailable Products][FR:Produits non disponible]",
    "dataModelId": "Product",
    "roles": [
      "Demo_Manager",
      "Demo_User"
    ]
  },
  {
    "name": "Browse_items_Store",
    "description": "[EN:Store][FR:Magasin]",
    "dataModelId": "Product",
    "roles": [
      "Demo_Manager",
      "Demo_User"
    ]
  },
  {
    "name": "Browse_items_Product#AndFamily",
    "description": "[EN:Product with Family][FR:Produit avec famille]",
    "dataModelId": "Product",
    "roles": [
      "Demo_Manager",
      "Demo_User"
    ]
  }
]

Did this page help you?

If you find any issues with this page or its content – a typo, a missing step, or a technical error – please let us know!