Description
This API Endpoint will allow a customer to download a specific layout for an Equipment Screen Panel as a DXF file. The file contains custom generated properties that maps each entity to PDS which can be used to update the layout in PDS.
URL
https://apiprod.pdsglobal.com/V2/api/common/equipmentscreenpanel/dxf/V1
There are two non-production environments that can be used for testing.
Request
Mandatory Fields are denoted by *
Type
GET
Headers
Content-Type = Application/Json
Parameters
Api_key*
This is required for authentication. If you do not have your API key please contact PDS Support (support@pdsglobal.com).
Body
|
Object: ScreenType: |
|
|
businessName* - string(50) |
|
| groupName* - string(50) Obtained from the hierarchy as shown in the PDS software. |
|
| departmentName* - string(50) Obtained from the hierarchy as shown in the PDS software. |
|
| areaName* - string(50) Obtained from the hierarchy as shown in the PDS software. |
|
| equipmentTypeName* - string(50) Defines the equipment type being used in the DXF. Values can be obtained from the Equipment Type dialog. |
GET Area Details can be used to get the hierarchy details above.
Response
After sending through your data, the API call will return a response entity with a body and a status. The response entity will let you know if the data you sent through was successful or unsuccessful.
Status
200 - HTTP Response OK
400 - HTTP Response Bad Request
- Missing API Key
- businessName/groupName/departmentName/areaName/equipmentTypeName is not provided
403 - HTTP Response Forbidden
- Invalid/Incorrect API Key
- Non “API User” role.
500 - HTTP Response Internal Server Error
Body
Object: ResponseEntity
The ResponseEntity object will contain a string or object value. This will have an error or success message – examples below:
- Downloaded Complex Equipment Screen Panel Layout
- Missing API Key
- businessName/groupName/departmentName/areaName/equipmentTypeName is not provided
- Invalid/Incorrect API Key
- Non “API User” role.