Using OData in Web API v1 or v2 - 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

The service calls shown in this document are only examples of the OData syntax that can be used to create a service call or POST. The object types in your system schema use different metadata for your own service calls or posts. To construct the OData syntax, you must have a good understanding of your own systems metadata and the schema model being used. The examples shown are examples only and show the short annotation version of the full URL. However, they can be modified for use in your instance of HxGN SDx.

OData provides a uniform structure to define the ways to expose the metadata to the Web Client so you can manipulate the data through the create, read, update, and delete operations. The Web API v1 and v2 makes it easy to create an OData endpoint for a data set. You can control exactly which OData operations the endpoint supports.

The following sections detail Web API v1 or v2 examples of the syntax, headers, and service calls that can be used to create an OData POST or GET request. These can easily be configured for your own system. All examples use a short notation of the full URL. For example, . . /api/v1/User/Roles.

How to construct a URL using OData syntax

When you create a URL using OData syntax, the URL is made up of segments to cover each parameter and provides the ability to interact, automate, and simplify complex repetitive tasks using the standard GET, POST, PATCH, PUT, and DELETE request methods.

When you use Web API v1, v2, or v3, the full OData URL for HxGN SDx is made up of the following segments:

Post https://<MachineName>/<SiteName>/api/v2/<APIGroupName>/<ExposedName>

The following descriptions apply to the segment parameters.

Parameter

Description

<MachineName>

The name of the machine where the software is running and being hosted. Displayed as [host] in the examples.

<SiteName>

The name given to the site when it was created on the server.

<APIGroupName>

The name of an existing APIGroup or you can create a group for functionality according to the product or product area.

For example, you can create an APIGroup with a name of TMA and relate the Tag, Model, Asset, class definitions or interface definitions to the TMA group.

<ExposedName>

The name of the object type you want to work with.

For example, the exposed named values for SPFClassDefIsExposedName, SPFInterfaceDefIsExposedName, SPFRelDefIsExposed, or SPFEdgeDefIsExposed.

All examples displayed use a short annotation version of the full URL. For example, . . /api/v2/TMA/DevelopmentTags.

SHARED Tip For API calls that request to amend or get server data, the user must be related to the specific roles and activated. For more information on how to activate roles for a user using OData, see Set user roles.

Web API v3 is not supported in SmartPlant Foundation.