Description
Provides the visual equipment layout for Screen Panel areas in DXF file format. This can be used to make edits to the visual layout of the area.
The file contains custom generated properties which include information used to link each Screen Panel to an equipment record in the system.
URL
https://apiprod.pdsglobal.com/V2/api/common/equipmentscreenpanel/dxf/V1
Note: There are two non-production environments that can be used for testing.
Request
Type
GET
Headers
Content-Type = Application/Json
Parameters
Mandatory parameters are denoted by *
*
api_key: string(50) This is required for authentication. It is used to identify the user and determine access to the system. If you do not have your API key please contact PDS Support (support@pdsglobal.com).
businessName: string(50) The name of the business as recorded in the hierarchy. Can be obtained from the hierarchy or the Area Details API.
groupName: string(50) The name of the group as recorded in the hierarchy. Can be obtained from the hierarchy or the Area Details API.
departmentName: string(50) The name of the department as recorded in the hierarchy. Can be obtained from the hierarchy or the Area Details API.
areaName: string(50) The name of the area as recorded in the hierarchy. Can be obtained from the hierarchy or the Area Details API.
equipmentTypeName: string(50) The type of equipment as specified in the Equipment Type dialog.
Body
No body is required for this API Endpoint.
Response
Body
The response from this API is a DXF file.
Response Status Code
See HTTP Response Codes and Errors
Examples
URL:
https://apiprod.pdsglobal.com/V2/api/common/equipmentscreenpanel/dxf/V1?api_key=ABC123
Response Body:
The response from this API is a DXF file.