Get details of a view by its name

Gets details of a view by the specified name, including the view name, description, data model ID (name), viewable business elements, searchable business elements, etc.

Note: Only the Super Admin type users with the administration role have access to this API. For more information about MDM user types, see the related description in Talend Administration Center User Guide.

Request	`GET /services/rest/system/views/{viewName}`
Parameters	viewName: This is a String value which specifies the name of the view. 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	The details of the view in JSON format.
Status	200 OK: The operation is executed successfully. 400 BAD REQUEST: The request contains invalid parameter. 403 FORBIDDEN: Missing required permission. 404 NOT FOUND: The resource does not exist, for example, invalid view ID. 500 INTERNAL SERVER ERROR: Other errors.

Sample response

{
  "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"
    }
  ]
}

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!

Leave your feedback here