URL components - HxGN SDx - Update 70 - Administration & Configuration - Hexagon

HxGN SDx API Services Configuration

ft:locale
en-US
Product
HxGN SDx
Search by Category
Administration & Configuration

For an explanation of the <Access_URL> placeholder, see The <Access_URL> placeholder in documentation.

Requests to the API must include these components in this order:

HostName/ServerSiteName/api/APIVersion/APIGroupName/ExposedName

Component

Description

HostName

The name of the host system where the software is running.

ServerSiteName

The name of the SDx site you are connecting to.

api

A hard-coded part of the path, where all the resources, actions, and functions are found for all versions of the API.

APIVersion

The version of the API you are using. Valid values for SDx are v1, v2, or v3.

APIGroupName

The name of the API Group that the API belongs to, if applicable.

By default, most API resources, actions, and functions are part of the SIO product group. However, the API Group Name you need to use might be different. The API might be part of a custom API Group or no API group.

SHARED Tip Use the $metadata endpoint to figure out whether you need to include a group name in the URL.

ExposedName

The name of the object type you want to work with, as defined by the exposed named value for the object type: ClassDefIsExposed, InterfaceDefIsExposed, RelDefIsExposed, or EdgeDefIsExposed.

For help figuring out parts of the URL path, talk to your SDx administrator.

Some examples

acme.mycloud.com/coyote-canyon-facility/SDxSite1/api/v3/sio/SPFFolders

acme.mycloud.com/coyote-canyon-facility/SDxSite1/api/v3/UploadFile

acme.mycloud.com/coyote-canyon-facility/SDxSite1/api/v2/FileMgmt/UploadFile

acme.mycloud.com/coyote-canyon-facility/SDxSite1/api/v2/TagModelAsset/Tags