Restriction exception error on query or navigation - HxGN SDx - Update 63 - Administration & Configuration - Hexagon

HxGN SDx API Services Configuration

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

Problem

When you query or navigate to certain data types in the database, the server responds with the following exception message:

Queries on objects of type [restricted type] are restricted via API services

Solution

What you can query for or how you can navigate to certain data types in the database is controlled by in-built restrictions related to various user and role types, and their relationships.

You can control these restrictions by adding or removing values from settings in the application server web.config file. Each setting contains a list of values in a comma separated list that detail the restricted data type UIDs:

  • APIQueryRestrictedClassDefUIDs

  • APIEditRestrictedClassDefUIDs

  • APIEditRestrictedRelDefUIDs

For example:

<add key="APIEditRestrictedClassDefUIDs" value="SPFLoginUser,SPFPaperUser,SPFRole,SPFRoleAssignment,SPFAccessGroup,ClassDef,InterfaceDef,RelDef"/>

If you remove a value from a list, users with a valid OAuth token can then query or edit that data type.