WebAPI

WebAPI – Task verification records

11 views 28 April, 2017 8 February, 2018 Valuekeep 0

This service allows you to retrieve and handle task verification records in Valuekeep.

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

Get Task Verification Records

GET /api/mytenant/myorganization/maintenancemanagementcore/workordertaskverifications/GetWorkOrderTaskVerificationsByFilter

This method allows you to retrieve a list of task verification reports applying several filters. You can retrieve this list using the following filters:

  • StateKey: List of states (see the numeric part of the natural key of values in the States section, on Create a Work Order)
  • AssignedTo: Username of the employee that verified the task
  • WorkOrderKey: Work Order code
  • MaxRecords: Maximum number of records (you can request 200 records at a time)
  • Version: Version

All filters are optional. The list of task verification records returned is sorted by version ascendingly.

Examples:

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

Retrieves a maximum of 50 task verification records of work orders in the “Pending” and “Waiting for Approval” states, verified by the employee with the “myuser” username and using version “AAAAAAAAAAA=” later.

GET /api/mytenant/myorganization/maintenancemanagementcore/workordertaskverifications/GetWorkOrderTaskVerificationsByFilter?workorderkey=WO001

Retrieves task verification records for WO “WO001”.

Create Task Verification Records

POST /api/mytenant/myorganization/maintenancemanagementcore/workordertaskverifications

This method allows you to create a Task Verification Record for a specific Work Order. The “body” of the message must follow the structure of the WorkOrderTaskVerificationResource.

Example:

{
“WorkOrderTaskVerificationKey”: “c51293b6-7a69-4e7c-9bd8-faf41c48b00f”,
“Remarks”: “”,
“WorkOrder”: “OT0017”,
“MaintenancePlan”: “PMV-000007.1”,
“Task”: “T-000009”,
“Location”: null,
“Asset”: “CALD001”,
“Employee”: “0002”,
“ValidationType”: “V1”,
“ValidationTypeDetail”: “V1.BBB”,
“Id”: “c51293b6-7a69-4e7c-9bd8-faf41c48b00f”,
“IsActive”: true,
“IsDeleted”: false,
“Version”: “AAAAAAAAlPs=”
}

Change Task Verification Record

PUT /api/mytenant/myorganization/maintenancemanagementcore/workordertaskverifications?workOrderTaskVerificationKey=<workOrderTaskVerificationKey>

This method allows you to change task verification records in the work order. The value of <workOrderTaskVerificationKey> must be the task verification record key and the “body” of the message must follow the structure for the WorkOrderTaskVerification resource.

Example:

PUT /api/mytenant/myorganization/maintenancemanagementcore/workordertaskverifications?workOrderTaskVerificationKey=c51293b6-7a69-4e7c-9bd8-faf41c48b00f

This request can be used to update the consumption report with key “c51293b6-7a69-4e7c-9bd8-faf41c48b00f”.
After the request, the “Version” field will be updated in the returned resource.

Tags:

Foi útil?