WebAPI

WebAPI – Report Down Time

62 views 28 June, 2018 31 October, 2018 Valuekeep 0

This service allows you to retrieve a list of down time records from Valuekeep locations and assets.

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

Get Down Time Records with filters

GET /api/mytenant/myorganization/maintenancemanagementcore/downanduptimehistories/GetDownAndUptimeHistoryByFilter

This method allows you to retrieve the down time records for assets and locations applying several filters. You can retrieve this list of records using the following filters:

  • MaxRecords: Maximum number of records (you can request 200 records at a time)
  • ShowActive: Whether to return records with no end date yet.
  • Version: Version
  • Year: Year

All filters are optional except for Version. The data in the list returned is sorted by version ascendingly.

Example:

GET /api/mytenant/myorganization/maintenancemanagementcore/downanduptimehistories/GetDownAndUptimeHistoryByFilter?showActive=true&version=AAAA&maxRecords=200&year=2018

Get Down Time Records by asset/location

GET /api/mytenant/myorganization/maintenancemanagementcore/downanduptimehistories/GetObjectDownAndUptimeHistory

This method allows you to retrieve the down time records for specific assets/location applying several filters. You can retrieve this list of records using the following filters:

  • AssignedTo: User to search for
  • AssetKey: Asset to search for
  • LocationKey: Location to search for
  • Months: Number of past months to search for
  • Version: Version

All filters are optional except for Version. If you do not specify the month, the system returns the current month, and if you do not enter an asset/location, the system returns all objects without filter, for the selected categories. If you add “assignedTo“, the system returns the down times associated with the Work Orders assigned to the specified user. The data in the list returned is sorted by version ascendingly.

Example:

GET /api/mytenant/myorganization/maintenancemanagementcore/downanduptimehistories/GetObjectDownAndUptimeHistory?assignedTo=user&locationKey=L-0001 &months=6&version=AAAA

Foi útil?