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.
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.