-
You are expected to have a good level of knowledge and experience using OData, managing Web APIs, the schema model, API groups, and your systems metadata to construct the OData syntax.
-
The service calls shown in this document are EXAMPLES of the OData syntax that can be used to create a service call or POST. Each example can be used as a template to construct service calls using the metadata from your SDx system, and use a short annotation of the full host URL address.
The following OData syntax examples use Web API v1 or v2 to create POST or GET requests. The examples can easily be configured to match your own system metadata.
All examples use the short notation prefix, <Access_URL>, to represent the full host and site name URL. Therefore, https://<HostName>/<SiteName>, is combined to display as <Access_URL> in each example.
When you create a URL using OData syntax, the URL is made up of segments to cover each parameter for the address 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 SDx is made up of the following segments:
POST https://<HostName>/<SiteName>/api/v3/<APIGroupName>/<ExposedName>
The following descriptions apply to each parameter segment of the address.
|
Parameter |
Description |
|
<HostName> |
The name of the host name for the system software.This is combined with the site name. For example, https://<HostName>/<SiteName>. This combination is shortened to display as <Access_URL> in the examples. |
|
<SiteName> |
The name of the site/tenant where the software is running.This is combined with the host name. For example, https://<HostName>/<SiteName>. This combination is shortened to display as <Access_URL> in the examples. |
|
<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 named 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 use the short notation prefix, <Access_URL>, to represent the full host and site name URL. Therefore, the example https://<HostName>/<SiteName> is combined to display as <Access_URL> in each example.
Hexagon recommends using the secure internet protocol so your URL is prefixed by
https denoting a system configured to use SSL.