The general format of a URL request to the web API is:
https://Host/WebApp/s3dadmin/v1/Sites(‘Site Alias’)/Plants(‘Plant Name’)/Remaining Resource Path/Query Options
Where:
-
Host is the name of the web API web server
-
WebApp is the web application name defined for the web server
-
s3dadmin/v1 is the service prefix
-
Site Alias is the alias for the Smart 3D database server and Smart 3D database combination. This value was defined when the Smart 3D Admin Web API "RestoreSite" or "EnableSite" was triggered.
-
Plant Name is the name of the Smart 3D plant, in the previously specified site, which is going to be accessed.
-
Remaining Resource Path defines the specific resource which is to be accessed.
-
Query Options are the standard OData query options.
For example, to return the properties of a Permission group named "PG202" from the MyS3dPlant plant, the following URL is used:
GET
https://MyServer.domain.com/WebApp/s3dadmin/v1/Sites('MyS3DSiteAlias')/Plants('MyS3dPlant')/PermissionGroups?$filter=Name eq 'PG202'
<ServiceRoot> URL Syntax in this Document
To help keep URLs is this document readable, you will see <ServiceRoot> for the first part of the URL.
For example, this:
GET
https://MyServer.domain.com/WebApp/s3dadmin/v1/Sites(‘MyS3DSiteAlias’)/Plants(’MyS3dPlant’)/PermissionGroups?$filter=Name eq ‘PG202’
Will be shown as this:
GET
<ServiceRoot>/Sites(‘MyS3DSiteAlias’)/Plants(’MyS3dPlant’)/PermissionGroups?$filter=Name eq ‘PG202’
Or if you were to return properties of Permission Group belonging to Catalog, it would be shown as this:
GET
<ServiceRoot>/Sites(‘MyS3DSiteAlias’)/Catalogs(’MyCatalog’)/PermissionGroups?$filter=Name eq ‘PG101’