Description
Provides a facility to record wear data into the software.
A 'Wear Measurement' is the act of attending a piece of equipment to take measurements. Each Wear Measurement can contain multiple results at various X and Y coordinates. This API will allow the recording of a Wear Measurement along with it's associated results.
URL
https://apiprod.pdsglobal.com/V2/api/integration/wear/V1
Note: There are two non-production environments that can be used for testing.
Request
Type
POST
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).
Body
|
Object: CreateWearRequest: |
|||||
|
equipmentIdentifier* An object containing the primary key identifying the equipment being measured. The primary key can be specified by use of one of the properties of the object: equipmentID, equipmentFunctionalLocation or externalEquipmentID. Examples: The values passed must relate to existing equipment in the PDS system. EquipmentID can be found on the Equipment Dashboard in Asset by scrolling to the right. Equipment Functional Location and External Equipment ID can be found on the Asset’s edit page. |
|||||
|
wearSurfaceType* - string(50) The type of wear surface being measured. Values can be obtained from the Wear Surface Types dialog. |
|||||
|
wearMeasurementType* - string(50) The type of wear measurement being performed. Values can be obtained from the Wear Measurement Types dialog. |
|||||
|
inspectedBy - string(50) Free text limited to 50 characters. InspectedBy should be who or what inspected the wear measurement. Generally this will be the username or email address of the user. |
|||||
|
instrumentType - string(50) Free text limited to 50 characters. Instrument type should be the name of the instrument used to take the wear measurement. |
|||||
|
instrumentVelocity - decimal (18,1) Decimal value limited to 1 decimal place. The velocity setting as shown on the thickness testing unit (as recorded in instrumentType). |
|||||
|
callibrationThickness - decimal (18,1) Decimal value limited to 1 decimal Place. Calibration thickness used on the thickness testing unit in millimetres. |
|||||
|
surfaceTemperature - decimal (18,1) Decimal value limited to 1 decimal place. The temperature of the surface being measured. |
|||||
|
testPosition - string (50) Free text limited to 50 characters. The position on the equipment where the wear measurement is taking place. |
|||||
|
comments - string (500) Free text limited to 500 characters. Any comments can be added as required. |
|||||
|
hardness - int Whole number. A hardness measurement can be recorded for the belt section. |
|||||
|
wearMeasurementResults* - List<WearMeasurementResult>
|
Response
Body
|
Object: ResponseEntity<string> |
|
|
errorMessage: string(50) Contains error details |
|
|
successMessage: string(50) Message containing success details |
Response Status Code
See HTTP Response Codes and Errors
Examples
URL:
https://apiprod.pdsglobal.com/V2/api/integration/wear/V1?api_key=ABC123
Request Body:
Response Body: