Supported URL parameters - HxGN SDx - Update 63 - Administration & Configuration

Administration and Configuration of HxGN SDx

Language
English
Product
HxGN SDx
Search by Category
Administration & Configuration
SmartPlant Foundation / SDx Version
10

Dashboards use the Open Data Protocol (OData) and Web API v1 and v2 to access data from other systems.

Only GET requests used with filter, select, count, top, skip, orderby, and groupby parameters are supported when defining the URL to return the data. Any supported keyword can be used when using a variable to build the URL.

  • For dashboards, top is used to limit the number of items displayed in a page, rather than limiting the total number of items returned.

  • The groupby parameter can be used with chart widgets only.

For example:

  • When the current object is a tag, the following returns the name and description of the tag:

    Tags({{CURRENT_OBJECT_ID}})?$select=Name,Description

  • The following returns the name and description of all tags where the name starts with 230-AF:

    Tags?$select=Name,Description&$filter=startswith(Name,'230-AF')

  • For a chart widget, the following returns all tags grouped by status, and a count of the number of tags in each group:

    Tags?$apply=groupby((Tag_Status),aggregate(Id with countdistinct as Count))

For more information on OData, see Using OData in Web API v1 or v2.