Use the GET method to view registration details of an application that was registered with SmartPlant Foundation or SDx.
The input is as follows:
-
Service Root URI: https://<Server Name>/<IIS Application Name>/sem/v4
-
Resource path: /Sites('<Site Name>')/Plants('<Plant Name>')/Application('<Application Abbreviation>')/Registrations[('<Tool Name>')]
-
You must send a separate request for each plant and application for which you want to view registration details.
-
Resource path strings are case-sensitive.
-
The parameters for the service root URI below are provided as an example. The server and domain name you provide depend on your specific environment.
Sample URI for viewing all registrations of a plant application
This request supports the following applications:
-
Smart P&ID : Sppid
-
Smart Electrical : Spel
GET
https://WebApiServer1.APIServerDomain.com/sem-webapi/sem/v4/Sites('WebAPISite01')/Plants('WebAPIPlant01')/Applications('Sppid')/Registrations
Sample JSON response
A typical response to the request is:
{
"@odata.context": "https://localhost/sem-webapi/sem/v4/$metadata#Sites('WebAPISite01')/Plants('WebAPIPlant01')/Applications('Sppid')/Registrations",
"value": [
{
"Id": "7f848023-228a-45fd-8c3a-d484cc88ea57",
"ConcurrencyToken": null,
"Type": "SDX",
"Url": "https://COMPSERVER.COMPDOMAIN.COM/AdminSDxServer/",
"ToolSignature": "AAAH",
"PlantId": "PL_DemoPlant1",
"PlantName": "DemoPlant1",
"SchemaVersion": "02.02.02.0005"
}
]
}
Sample URI for viewing registration of a plant application in a specific integration tool
This request supports the following integration tools:
-
SmartPlant Foundation: SPF
-
SDx
GET
https://WebApiServer1.APIServerDomain.com/sem-webapi/sem/v4/Sites('WebAPISite01')/Plants('WebAPIPlant02')/Applications('Spel')/Registrations('SPF')
Sample JSON response
A typical response to the request is:
{
"@odata.context": "https://localhost/sem-webapi/sem/v4/$metadata#Sites('WebAPISite01')/Plants('WebAPIPlant02')/Applications('Spel')/Registrations/$entity",
"Id": "a12c86bf-80cd-44b7-be21-b43d93ca44dc",
"ConcurrencyToken": null,
"Type": "SPF",
"Url": "https://COMPSERVER.COMPDOMAIN.COM/AdminSDxServer/",
"ToolSignature": "AAAH",
"PlantId": "PL_DemoPlant2",
"PlantName": "DemoPlant2",
"SchemaVersion": "02.02.02.0005"
}