WebAPI

WebAPI – Monitorings and Monitoring Values

98 views 28 April, 2017 21 January, 2020 Valuekeep 0

This service allows you to retrieve and handle Monitorings and Monitoring Values in Valuekeep.

Below you can find an analysis of the methods available through the service.

Monitorings List

GET /api/mytenant/myorganization/maintenancemanagemententcore/monitorings/GetMonitoringsByVersionAndRecords?version=AAA&maxRecords=2000

This method provides the list of condition checks. You can get the list filtered by:

  • Version
  • MaxRecords: Optional. Maximum number of records to be returned (if not defined, by default returns 2000 records)

Example:

GET /api/mytenant/myorganization/maintenancemanagemententcore/monitorings/GetMonitoringsByVersionAndRecords?version=AAAAAAAA=&maxRecords=200

You get a maximum of 200 condition checks with a version higher than “AAAAAAAA=”.

Get Monitoring Values

 GET /api/mytenant/myorganization/maintenancemanagementcore/monitoringvalues/GetMonitoringValuesByFilter

This method allows you to retrieve the list of monitorings values applying several filters. You can retrieve this list using the following filters:

  • Version: Minimum version from which the list will be returned
  • MaxRecords: Maximum number of records (you can request 200 records at a time)
  • StateKey: List of states (see the numeric part of the natural key of values in the States section, on Create a Work Order)
  • AssignedTo: The employee’s username. The system returns monitoring values associated with WOs where tasks are assigned to this employee.
  • WorkOrderKey: Work Order code. The system returns monitoring values associated with this WO.
  • AssetKey: Asset code. The system returns monitoring values associated with this asset.
  • LocationKey: Location code. The system returns monitoring values associated with this location.
  • MonitoringKey: Monitoring value code. The system returns the values for this monitoring.

All filters are optional. The list of values returned is sorted by version ascendingly.

Examples:

GET /api/mytenant/myorganization/maintenancemanagementcore/monitoringvalues/GetMonitoringValuesByFilter?stateKey=001&stateKey=002&maxRecords=50&assignedTo=myuser&version=AAAAAAAAAAA=

Retrieves a maximum of 50 monitoring values in the “Pending” and “Waiting for Approval” states, assigned to the employee with the “myuser” username and using version “AAAAAAAAAAA=” or later.

GET /api/mytenant/myorganization/maintenancemanagementcore/monitoringvalues/GetMonitoringValuesByFilter?workorderkey=WO001

Retrieves monitoring values for WO “WO001”.

Create Monitoring Values

POST /api/mytenant/myorganization/maintenancemanagementcore/monitoringvalues

This method allows you to create condition control values for a given condition control. The “body” of the message must be filled with the structure of the resource:  MonitoringValueResource.

Example: The “body” of the message must be filled with the structure of the resource: MonitoringValueResource:

{
“Date”: “2017-04-05Q09:54:12.8997517+01:00”,
“Value”: 100,
“MovingAverage”: null,
“Notes”: “”
“MonitoringAssetKey”: “”
“MonitoringLocationKey”: “”,
“Monitoring”: “AC-0001”,
“Issue”: null,
“Notification”: null,
“WorkOrder”: “OT0018.”
“UserFields.” []
}

 

 

Change Monitoring Values

PUT /api/mytenant/myorganization/maintenancemanagementcore/monitoringvalues/{id}

This method allows you to change condition control value records. The value of <id> must be the identifier of the condition control values record and the “body” of the message must be filled with the structure of the resource: MonitoringValueResource.

Example:

PUT /api/mytenant/myorganization/maintenancemanagementcore/monitoringvalues/8badd58e-ae1a-e711-9d09-c01885a63e51

{
“ReadingNumber”: 2,
“Date”: “2017-04-06T09:54:12.8997517+01:00”,
“Value: 120,
“MovingAverage”: null,
“Notes”: “”
“MonitoringAssetKey”: “”
“MonitoringLocationKey”: “”,
“Monitoring”: “MN-0003”,
“Notification”: null,
“UserFields.” [],
“Id”: “8badd58e-ae1a-e711-9d09-c01885a63e51”
}

 

This request serves to update the condition check value record with the identifier “8badd58e-ae1a-e711-9d09-c01885a63e51”.

After the request, the returned resource has the value of the “Version” field updated.

Tags:

Foi útil?