(GET) Wear Management Results API

Description

Supplies the wear measurements which have been recorded against equipment. Includes the X and Y coordinates of the reading.

Each measurement is grouped under a 'Wear Measurement' record (via the TestId) which can be retrieved from the Wear Management Tests API. 

 

URL

https://apiprod.pdsglobal.com/V2/api/wear/wearmanagementresults/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.

resultId: string(50)
This is the unique identifier (primary key) for the result.

testId: string(50)

This is the unique identifier (primary key) for the related wear test.

x: integer

The x coordinate indicating where the measurement was taken. This is the point along the width of the equipment.

y: string(50)

The y coordinate indicating where the measurement was taken. This is the point along the length of the equipment.

ref: string(50)

Displays the Ref coordinate for the corresponding wear test result.

result: integer

The measured result in the relevant Unit of Measurement.

resultIsInvalid: string(50)

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.

resultDifference: string(50)

Returns a calculated value being the difference between the previous result recorded at the same X & Y or Ref and the current result at the same coordinates (Result Current - Result Previous)

averageResultDifference: integer

Returns a calculated value being the average of all the result difference values for the entire wear test.

lastSavedBy: string(50)

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

lastSavedDateTime: DateTime

Indicates the last time the record was updated.

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/wearmanagementresults/V4?api_key=ABC123

 

Response Body: 

{
    "changedRecords": [
        {
            "resultId"24420,
            "testId"20886,
            "x"1,
            "y"1,
            "ref"null,
            "result"1.00,
            "resultIsInvalid"false,
            "resultDifference"0.00,
            "averageResultDifference"0.00,
            "lastSavedBy""Test2@pdsglobal.com",
            "lastSavedDateTime""2021-11-01T18:12:52.377Z"
        }
    ],
    "lastPage"0
}

 

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

Articles in this section

prev next

Related sections