Description
Provides a facility to create or overwrite a layout for screen panels in the Complex module, by uploading a DXF file.
The API can be called with just the mandatory parameters to create a layout with default settings. The optional fields can be used to specify the default screen panel settings, meaning all panels in the layout will have the same attributes (thickness, dimensions, part number, etc). The attributes for the individual panels can then be edited in the software at a later stage.
The Area that the DXF is being imported to will have to be already created in the software before the import is attempted. To update an existing layout, use the DXF File for Screen Panel API to retrieve the current layout DXF file.
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
POST
Headers
Content-Type = Multipart/Form-data
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
|
Object: screenpanel |
|
|
partNumber - string(50) |
|
|
screenPanelTypeName string(50) |
|
|
screenPanelFixingTypeName - string(50) |
|
|
screenPanelMaterialTypeName* string(50) |
|
|
screenPanelManufacturerName string(50) |
|
|
length – int |
|
|
width – int |
|
|
thickness – int |
|
|
openArea - string(50) |
|
|
apertureLength - decimal(18,2) |
|
|
apertureWidth - decimal(18,2) |
|
|
apertureStyle - string(50) |
|
|
wireProfile - string(50) |
|
|
surfaceTreatment - string(50) |
|
|
orientation - string(50) |
|
|
feature - string(50) Any other features of the screen panel not described in other fields. Free text. |
|
|
deflector - string(50) The type of deflector built into the screen panel. Free text. |
|
|
InstallationDate - dateTime The time the panel was installed. If not populated, this will default to the date and time the record was sent to PDS. |
|
|
InsatllationWorkOrder - string(50) |
|
|
leadTime – int |
|
|
replacementInterval – int |
|
|
comments - string(500) Free text limited to 500 characters. Any comments can be added as required. |
|
|
OverwriteLayout - Boolean Determines whether the existing layout gets replaced or updated by the new layout. When there is an existing layout: TRUE - all existing records for that area be will deleted and a new layout created. FALSE - the existing layout will be edited. Existing records will remain unless the entity is removed from the layout. |
|
|
Object: dxf_file: |
|
|
This is the file containing the layout to be imported. File should be a dxf format and Entities (liners/ screenpanels) should be created as Polyline or LWPolyline. Text can be added as a non clickable entity. Polyline and LWPolyline entities can be added as non-clickable (so they can be used for flow direction, arrow pointers, etc) by adding a custom property "non-clickable". When downloading the DXF from PDS (previously uploaded), the DXF file will contain a PDS number for each entity. The value should be unique when editing it or adding new entities. A duplicate number will cause the upload to fail. |
Response
Body
|
Object: ResponseEntity<string>[] |
|
|
businessName: string(50) The name of the business as recorded in the hierarchy. Can be obtained from the hierarchy or the Area Details API. |
|
|
businessFunctionalLocation: string(50) Unique code used to identify the business. Can be obtained from the business edit dialog in the software, or the Area Details API. |
Response Status Code
See HTTP Response Codes and Errors
Examples
URL:
https://apiprod.pdsglobal.com/V2/api/common/equipmentscreenpanel/dxf/V1?api_key=ABC123
Request Body:
Form-Data Request Body:
screenpanel:
{
"Thickness" :45,
"Width":100,
"Length":200,
"Comments":"Extra information can be added",
"WireProfile":"Test",
"PartNumber":"EG1234",
"ScreenPanelManufacturer":"MFG",
"ScreenPanelMaterialType":"MAT",
"ScreenPanelType":"SideLiner",
"ScreenPanelFixingType":"Snap fit",
"MPN":"12234",
"ApertureLength":34,
"ApertureWidth":55,
"ApertureStyle":"cut edge",
"Orientation":"Portrait",
"ApertureSize":44,
"SurfaceTreatment":"treatment",
"Deflector":"test deflector",
"Feature":"test feature",
"backColour":"#FBE870",
"fontColour":"#8359A3",
"OverwriteLayout" : false,
"Description":"Upload test",
"OpenArea":23.2
}
dxf_file: [dxf file]