(GET) DXF file for Screen Panel API

URL  

https://apiprod.pdsglobal.com/V2/api/common/equipmentscreenpanel/dxf/V1  

Description  

The purpose of this endpoint is to let a specific layout for Equipment Screen Panel to be downloaded as DXF file. The file contains custom generated properties that maps each entity to PDS which can be used to update the layout in PDS. 

To update the layout, edit the downloaded file and re-uploaded it back using  /api/common/equipmentscreenpanel/dxf/V1 (POST) 

Type  

GET 

URL Parameters  

(key)      api_key  

(value)   Provided separately to this document  

(key)      businessName  

(value)    Should already be known as per the PDS hierarchy 

(key)      groupName 

(value)    Should already be known as per the PDS hierarchy 

(key)      departmentName 

(value)    Should already be known as per the PDS hierarchy 

(key)      areaName 

(value)    Should already be known as per the PDS hierarchy 

(key)      equipmentTypeName 

(value)    Should already be known as per the PDS Equipment Type lookup table 

GET Area Details can be used to get hierarchy details above.

Response Data  

HTTP Response OK (200)  

HTTP Response Bad Request (400) 
-          Missing API Key 
-          Missing required parameters
-          Invalid hierarchy
-          Invalid Equipment Type Name 

HTTP Response Forbidden (403)
-          Invalid/Incorrect API Key
-          Non “API User” role.