Description
Supplies fault information from inspections.
URL
https://apiprod.pdsglobal.com/V2/api/inspections/faults/V1
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).
businessName: string(50)
The name of the business as recorded in the hierarchy. Can be obtained from the hierarchy or the Area Details API.
taskStatus: string
Filter records based on status. Valid options are 'Open' or 'Closed'.
taskGroupName: string
Return records which are within a specific task group.
includeUnplanned: bool
Controls whether unplanned inspection records are returned in the dataset.
lastSynced: DateTime Used to retrieve only the records which have wear tests 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.
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.
0 is the starting page. For example if there was a total of 3517 records for the last 6 months, then page 0 will show 1 - 2000 records, and page 1 will show the remaining 1517 records.
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.
|
|
inspectionID: integer
This is the unique identifier (primary key) for the inspection.
|
|
businessName: string(50)
The name of the business as recorded in the hierarchy.
|
|
planned: boolean
Indicates if the fault is related to a planned inspection (as opposed to an unplanned inspection).
|
|
taskGroupName: string(50)
The name of the task group to which the inspection is related. For unplanned inspections this will be 'Unplanned'.
|
|
plannedStartDate: DateTime
The date on which the inspection is expected to commence.
|
|
WorkOrderNo: string(50)
Work order number created for the fault when generated in the customer’s system (e.g. SAP), and entered in the Inspection task screen.
|
|
InspectionNotificationNo: string(50)
Notification number provided by the customer’s system (e.g.SAP) for the inspection, and entered into the notification number field on the create inspection checklist screen.
|
|
WorkOrderNumber: string(50)
Work order number provided by the customer’s system (e.g. SAP) for the inspection, and entered into the work order number field on the create inspection checklist screen.
|
|
NotificationNo: string(50)
Notification number created for the fault when generated in the customer’s system (e.g. SAP), and entered in the Inspection task screen.
|
|
workorderName: string(50)
Details entered in the name field on the create inspection checklist screen.
|
|
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.
|
|
areaType: string(50)
Determines the type of area, which is generally based on the equipment within the area (e.g. Conveyor, Transfer Chute, etc).
|
|
areaName: string(50)
The name of the area as recorded in the hierarchy. Can be obtained from the hierarchy or the Area Details API.
|
|
equipmentType: string(50)
The type of equipment as specified in the Equipment Type dialog.
|
|
equipment: string(50)
The description of the equipment as entered against the equipment record in the Asset module.
|
|
equipmentID: integer
This is the unique identifier (primary key) for the equipment.
|
|
grouping: string(50)
The grouping as specified in the Task Assignment for the inspection task.
|
|
taskName: string(50)
The name of the task as specified against the task in the task library.
|
|
taskDescription: string(50)
The description of the task as specified against the task in the task library.
|
|
taskType: string(50)
The type of task as specified against the task in the task library.
|
|
units: string(50)
The symbol for the relevant unit of measurement. E.g. "mm".
|
|
lowerLimit: decimal
The lower limit for measurement as specified against the task in the task library.
|
|
upperLimit: decimal
The upper limit for measurement as specified against the task in the task library.
|
|
mandatoryTask: boolean
Indicates that the task must be carried out as part of the inspection. I.e. it is not optional.
|
|
complianceClause: string(50)
Text detailing compliance requirements.
|
|
equipmentIsInstalled: boolean
Indicates whether the equipment is currently installed.
|
|
equipmentStatus: string(50)
Indicates whether the equipment is currently installed. Options are Installed, Removed, or null (which indicates no install status, which effectively means it is not installed).
|
|
condition: string(50)
The condition code as selected in the inspection detail.
|
|
topCoverCondition: string(50)
The condition code for the top cover as selected in the inspection detail.
|
|
bottomCoverCondition: string(50)
The condition code for the bottom cover as selected in the inspection detail.
|
|
result: string(50)
The result of the inspection detail, the value of which is determined by the inspection type.
|
|
fault1: string(50)
Fault 1 as recorded in the inspection detail.
|
|
fault2: string(50)
Fault 2 as recorded in the inspection detail.
|
|
comments: string(50)
Comments as entered in the inspection detail.
|
|
topCoverComments: string(50)
Where a top cover exists, comments related to the cover.
|
|
bottomCoverComments: string(50)
Where a bottom cover exists, comments related to the cover.
|
|
action: string(50)
Notes on actions to be carried out.
|
|
notes: string(50)
General notes for the task.
|
|
taskStatus: string(50)
Indicates if the task is still open. Options are Open or Closed.
|
|
isClosedOut: boolean
Indicates the task has been closed out (i.e. rectified).
|
|
inspectedBy: string(50)
Identifies who carried out the inspection (email address).
|
|
date: DateTime
The date on which the inspection task was carried out.
|
|
closedBy: string(50)
Identifies who closed/resolved the inspection task (email address).
|
|
lubrication: string(150)
Details the name, part number, quantity of lubrication required for the task.
|
|
attachments: string(50)
File names of attached files.
|
|
attachmentsNoof: integer
Number of files attached to the task.
|
|
|
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/inspections/plannedinspectionfaults/V1?api_key=ABC123&businessName=Mine Operations&taskStatus=Open&includeUnplanned=false
Response Body:
"inspectionID": 1697,
"businessName": "Mine Operations",
"planned": true,
"taskGroupName": "a",
"plannedStartDate": null,
"workorderName": "Inspection 2",
"groupName": "Raw Coal",
"departmentName": "Conveyors",
"areaType": "Conveyors",
"areaName": "CV101",
"equipmentType": "Pulleys",
"equipment": "Head",
"equipmentID": 7174,
"grouping": null,
"taskName": "Task 1",
"taskDescription": null,
"taskType": "Visual",
"units": null,
"lowerLimit": null,
"upperLimit": null,
"mandatoryTask": false,
"complianceClause": null,
"equipmentIsInstalled": "0",
"equipmentStatus": "Removed",
"condition": "Out of Spec",
"topCoverCondition": null,
"bottomCoverCondition": null,
"result": null,
"fault1": "Build up on Pulley face",
"fault2": "Lagging Wear Severe",
"comments": null,
"topCoverComments": null,
"bottomCoverComments": null,
"action": null,
"notes": null,
"notification": null,
"taskStatus": "Open",
"isClosedOut": null,
"inspectedBy": "TestProd2@pdsglobal.com",
"date": "2019-04-04T09:04:00.000+11:00",
"closedBy": null,
"lubrication": null,
"attachments": null,
"notifications": null,
"attachmentsNoof": 0
