(GET) Wear Management Tests API

Description

Supplies the instances of wear tests which have been performed. A Wear Test is the act of going to a piece of equipment on a certain day and taking wear measurements.

A single test can contain numerous test readings (results). These results can be retrieved from the Wear Management Results API and linked to the test via the TestId. 

URL

https://apiprod.pdsglobal.com/V2/api/wear/wearmanagementtests/V4

Note: There are two non-production environments that can be used for testing.

 


Request

Type

GET

Headers

No header is required for this API Endpoint.

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).

lastSynced: DateTime Used to retrieve only the records which have changed since the last call to the endpoint. On first call of the endpoint leave blank - this will return all records. Store the timestamp after every call and pass it in the lastSynced parameter to retrieve only records which have changed since that time.

The format is yyyy-MM-dd HH:mm:ss.sss (e.g. 2021-01-01 01:23:00.000).

Note that if both rowVersion and lastSynced are populated, rowVersion will take precedence. For some endpoints the lastSynced value is limited to 6 months.

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.

groupName: string(50) The name of the group as recorded in the hierarchy. Can be obtained from the hierarchy or the Area Details API.

groupFunctionalLocation: string(50) Unique code used to identify the group. Can be obtained from the group edit dialog in the software, 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.

departmentFunctionalLocation: string(50) Unique code used to identify the department. Can be obtained from the department edit dialog in the software, 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.

areaFunctionalLocation: string(50) Unique code used to identify the area. Can be obtained from the area edit dialog, or the Area Details API.

page: integer Large datasets are broken down into pages with 2000 records per page. Use the page parameter to specify which page of the paged dataset to retrieve. Note that this number cannot be greater than the lastPage value returned by the first call to the endpoint.

lastPage: integer When a paged endpoint is called, it calculates the number of records it will return, then calculates the number of pages required.

This is an intensive operation which affects the performance of the endpoint. After calling the endpoint the first time the lastPage value is returned in the result. By passing that value in to the lastPage parameter on subsequent calls the service will know not to recalculate the number of pages.

Body

No body is required for this API Endpoint.


Response

Body

 

Object: ResponseEntity<string>

 

changedRecords[]

List of records returned by the call.

testId: integer
This is the unique identifier (primary key) for the wear measurement record. This is the record which groups together all the results.

equipmentId: int

This is the unique identifier (primary key) for the equipment.

testDate: DateTime
Indicates the time the test was performed.

testedBy: string(50)

Identifies the user who performed the test (email address).

workOrderNo: string(50)

The Work Order number for the repair. Free text. 

testComments: string(500)

Free text for comments on the wear measurement.

surfaceTemperature: decimal

The surface temperature recorded when the readings were taken.

hardness: integer

The hardness reading.

instrumentVelocity: decimal

The velocity of the measuring equipment.

calibrationThickness: decimal

The calibration thickness of the measuring device.

testIsValid: bit

Indicates whether the test result is still valid. In some cases results can be marked as invalid. This prevents the result from skewing the calculations.

testPosition: string(50)

Notes to indicate where the test was performed. Free text.

instrumentType: string(50)

The name of the instrument being used. Free text.

gpsLatitude: decimal

GPS latitude coordinate of the Idler.

gpsLongitude: decimal

GPS longitude coordinate of the Idler.

createdBy: string(50)

Identifies the user who created the record (email address).

createdDate: DateTime

Indicates the date and time the record was created.

lastSavedBy: string(50)

Identifies the user who last updated the record (email address).

lastSavedDateTime: DateTime

Indicates the last time the record was updated. The format is yyyy-MM-dd HH:mm:ss.sss (e.g. 2021-01-01 01:23:00.000).

 

wearSurfaceType[]

wearSurfaceTypeID: integer

This is the unique identifier (primary key) for the wear surface type.

name: string(50)

The type of wear surface as specified in the Wear Surface Type dialog. E.g. Top/Bottom.

description: string(250)

A detailed description of the wear surface type. E.g. "Top surface".

sortOrder: integer
All items of equipment have a sort order number assigned to them. It identifies them as an individual item within an area, and for some equipment it determines the sequence of the item.

isActive: boolean

Indicates whether the Wear Surface Type is currently active/enabled. 

lastSavedBy: string(50)

Identifies the user who last updated the record (email address).

lastSavedDateTime: DateTime

Indicates the last time the record was updated. The format is yyyy-MM-dd HH:mm:ss.sss (e.g. 2021-01-01 01:23:00.000).

createdBy: string(50)

Identifies the user who created the record (email address).

createdDate: DateTime

Indicates the date and time the record was created.

wearSurfaceTypeSetId: integer

This is the unique identifier (primary key) for the wear surface type set.

 

wearSurfaceTypeSet[]

Provide a grouping for the Wear Surface Type.

wearSurfaceTypeSetId: integer

This is the unique identifier (primary key) for the wear surface type set.

name: string(50)
The type of wear surface as specified in the Wear Surface Type Sets dialog. E.g. "Outside/Inside".

sortOrder: integer
All items of equipment have a sort order number assigned to them. It identifies them as an individual item within an area, and for some equipment it determines the sequence of the item.

isActive: boolean

Indicates whether the Wear Surface Type Set is currently active/enabled.

lastSavedBy: string(50)

Identifies the user who last updated the record (email address).

lastSavedDateTime: DateTime

Indicates the last time the record was updated. The format is yyyy-MM-dd HH:mm:ss.sss (e.g. 2021-01-01 01:23:00.000).

createdBy: string(50)

Identifies the user who created the record (email address).

createdDate: DateTime

Indicates the date and time the record was created.

wearMeasurementType[]

Indicates the type of measurement being performed. E.g. Thickness, Hardness, etc.

wearMeasurementTypeId: integer

This is the unique identifier (primary key) for the wear measurement type.

name: string(50)

The name of wear measurement type as specified in the Wear Measurement Type dialog. E.g. Thickness, Hardness, etc.

description: string(250)

A detailed description of the unit of measurement for this measurement type. E.g. "Length - Large".

units: string(50)

The symbol for the relevant unit of measurement. E.g. "mm".

unitOfMeasurementTypeId: integer

This is the unique identifier (primary key) for the unit of measurement for this wear measurement type.

sortOrder: integer
All items of equipment have a sort order number assigned to them. It identifies them as an individual item within an area, and for some equipment it determines the sequence of the item.

isActive: boolean

Indicates whether the Wear Measurement Type is currently active/enabled.

lastSavedBy: string(50)

Identifies the user who last updated the record (email address).

lastSavedDateTime: DateTime

Indicates the last time the record was updated. The format is yyyy-MM-dd HH:mm:ss.sss (e.g. 2021-01-01 01:23:00.000).

createdBy: string(50)

Identifies the user who created the record (email address).

createdDate: DateTime

Indicates the date and time the record was created.

lastPage: integer

Indicates the page number of the last page when a paged endpoint is called. 

Response Status Code

See HTTP Response Codes and Errors

 


Examples

URL:

https://apiprod.pdsglobal.com/V2/api/wear/wearmanagementtests/V4?api_key=ABC123

 

 

Response Body: 

{
    "changedRecords": [
        {
            "testId"20886,
            "equipmentId"40373,
            "testDate""2021-11-01T18:12:43.893Z",
            "wearSurfaceType": [
                {
                    "wearSurfaceTypeID"1,
                    "name""Top",
                    "wearSurfaceTypeSetId"1,
                    "wearSurfaceTypeSet": [
                        {
                            "wearSurfaceTypeSetId"1,
                            "name""Top/Bottom",
                            "sortOrder"3,
                            "isActive"true,
                            "lastSavedBy""support@pdsonline.com.au",
                            "lastSavedDateTime""2017-01-21T08:01:11.800Z",
                            "createdBy""support@pdsonline.com.au",
                            "createdDateTime""2017-01-21T08:01:11.800Z"
                        }
                    ],
                    "description""Top surface",
                    "sortOrder"1,
                    "isActive"true,
                    "lastSavedBy""ricks@pdsonline.com.au",
                    "lastSavedDateTime""2018-04-18T03:55:40.387Z",
                    "createdBy""support@pdsonline.com.au",
                    "createdDateTime""2017-01-21T08:01:11.000Z"
                }
            ],
            "wearMeasurementType": [
                {
                    "wearMeasurementTypeId"1,
                    "name""Thickness",
                    "description"null,
                    "units""mm",
                    "unitOfMeasurementTypeId"null,
                    "sortOrder"1,
                    "isActive"true,
                    "lastSavedBy"null,
                    "lastSavedDateTime"null,
                    "createdBy"null,
                    "createdDateTime"null
                }
            ],
            "testedBy""Test2@pdsglobal.com",
            "testIsValid"true,
            "testPosition""",
            "instrumentType""",
            "instrumentVelocity"null,
            "calibrationThickness"null,
            "surfaceTemperature"null,
            "hardness"null,
            "workOrderNo""",
            "testComments""",
            "gpsLatitude"null,
            "gpsLongitude"null,
            "lastSavedBy""Test2@pdsglobal.com",
            "lastSavedDate""2021-11-01T18:13:13.507Z",
            "createdBy""Test2@pdsglobal.com",
            "createdDateTime""2021-11-01T18:13:13.507Z"
        }
    ],
    "lastPage"0
}

 

prev next
Was this article helpful?
0 out of 0 found this helpful

Articles in this section

prev next

Related sections