Work | Task Verification

Service to manage entities of type 'WorkOrderTaskVerification'.

Overview

URL	api/{tenantKey}/{orgKey}/maintenance/workOrderTaskVerifications
Methods Supported	GET, POST, PUT, DELETE

All Operations

This service includes the following operations:

• GET:
  • GET WorkOrderTaskVerifications (odata)
  • GET WorkOrderTaskVerification by identifier
  • GET WorkOrderTaskVerification by key
• POST:
  • POST WorkOrderTaskVerifications
  • POST Update Work Order Task Verification Info
• PUT:
  • PUT Set Custom Attribute WorkOrderTaskVerification
  • PUT Set IsActive WorkOrderTaskVerification
  • PUT Set WorkOrderTaskVerificationKey WorkOrderTaskVerification
  • PUT Set Company WorkOrderTaskVerification
  • PUT Set AssetType WorkOrderTaskVerification
  • PUT Set Location WorkOrderTaskVerification
  • PUT Set Equipment WorkOrderTaskVerification
  • PUT Set Tool WorkOrderTaskVerification
  • PUT Set MaintenanceRoute WorkOrderTaskVerification
  • PUT Set ReportDate WorkOrderTaskVerification
  • PUT Set VerificationDate WorkOrderTaskVerification
  • PUT Set Employee WorkOrderTaskVerification
  • PUT Set Remarks WorkOrderTaskVerification
  • PUT Set RemarksRequired WorkOrderTaskVerification
  • PUT Set VerificationType WorkOrderTaskVerification
  • PUT Set IsLocked WorkOrderTaskVerification
  • PUT Set WorkOrderMaintenancePlan WorkOrderTaskVerification
  • PUT Set WOMaintenancePlanId WorkOrderTaskVerification
  • PUT Set WOMaintenancePlanTaskId WorkOrderTaskVerification
  • PUT Set WOTaskId WorkOrderTaskVerification
  • PUT Set Task WorkOrderTaskVerification
• DELETE:
  • DELETE WorkOrderTaskVerification by identifier
  • DELETE WorkOrderTaskVerification by key

All Resources

This service uses the following resources:

• ApiWorkOrderTaskVerificationResource
• WorkOrderTaskVerificationInfoResource
• WorkOrderTaskVerificationResource
• ExtensibilityCustomAttributeValueResource

All Enumerations

This service uses the following enumerations:

• ReportAssetType

GET Operations

GET WorkOrderTaskVerifications (odata)

Returns a page of the list of all the entity records available.

The following elements are optional:

opts	(ODataQueryOptions) OData query option.

Response:

When successful, the response body contains the list of records available. See WorkOrderTaskVerificationResource.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

GET WorkOrderTaskVerification by identifier

Returns the entity record that matches the specified identifier.

The following elements are required:

id	(string) The record identifier.

Response:

When successful, the response body contains the entity record. See WorkOrderTaskVerificationResource.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.
404	NotFound. The specified record does not exist.

Resource URL:

GET WorkOrderTaskVerification by key

Returns the entity record that matches the specified key.

The following elements are required:

companyKey	(string) The company key.
workOrderTaskVerificationKey	(string) Task Verification.

Response:

When successful, the response body contains the entity record. See WorkOrderTaskVerificationResource.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.
404	NotFound. The specified record does not exist.

Resource URL:

POST Operations

POST WorkOrderTaskVerifications

Creates a new entity record.

The following elements are required:

workOrderTaskVerificationResource

(ApiWorkOrderTaskVerificationResource) The request body should contain the entity record that should be created. See ApiWorkOrderTaskVerificationResource.

The following elements are optional:

customAttributes

(JSON Document) A key-value pair in JSON format that represents the extensibility custom attributes for this entity. The key should be the custom attribute name prefixed with "custom_", e.g. "custom_attributeName". While the "customAttributes" element is optional, please notice that specific custom attributes might be marked as required.

Response:

When successful, the response body contains the new entity record identifier. The resource header location property contains the URL for the new entity record. See ApiWorkOrderTaskVerificationResource.

Response status codes:

201	Created. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

POST Update Work Order Task Verification Info

Custom operation 'UpdateWorkOrderTaskVerificationInfo'.

The following elements are required:

companyKey	(string) CompanyKey.
workOrderTaskVerificationKey	(string) WorkOrderTaskVerificationKey.
workOrderTaskVerificationInfo	(WorkOrderTaskVerificationInfoResource) WorkOrderTaskVerificationInfo.

The following elements are optional:

customAttributes

(JSON Document) A key-value pair in JSON format that represents the extensibility custom attributes for this entity. The key should be the custom attribute name prefixed with "custom_", e.g. "custom_attributeName". While the "customAttributes" element is optional, please notice that specific custom attributes might be marked as required.

Response:

When successful, the response body contains a resource of type 'WorkOrderTaskVerificationInfoResource'. See WorkOrderTaskVerificationInfoResource.

Resource URL:

PUT Operations

PUT Set AssetType WorkOrderTaskVerification

Updates the value of attribute 'AssetType' in the specified entity record.

The following elements are required:

workOrderTaskVerificationKey	(string) Task Verification.
companyKey	(string) The company key.
value	(enum ReportAssetType) The request body should contain the new value for the attribute. See ReportAssetType.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

PUT Set Company WorkOrderTaskVerification

Updates the value of attribute 'Company' in the specified entity record.

The following elements are required:

workOrderTaskVerificationKey	(string) Task Verification.
companyKey	(string) The company key.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

PUT Set Employee WorkOrderTaskVerification

Updates the value of attribute 'Employee' in the specified entity record.

The following elements are required:

workOrderTaskVerificationKey	(string) Task Verification.
companyKey	(string) The company key.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

PUT Set Equipment WorkOrderTaskVerification

Updates the value of attribute 'Equipment' in the specified entity record.

The following elements are required:

workOrderTaskVerificationKey	(string) Task Verification.
companyKey	(string) The company key.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

PUT Set IsActive WorkOrderTaskVerification

Updates the value of attribute 'IsActive' in the specified entity record.

The following elements are required:

workOrderTaskVerificationKey	(string) Task Verification.
companyKey	(string) The company key.
value	(bool) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.
404	NotFound. The specified record does not exist.

Resource URL:

PUT Set IsLocked WorkOrderTaskVerification

Updates the value of attribute 'IsLocked' in the specified entity record.

The following elements are required:

workOrderTaskVerificationKey	(string) Task Verification.
companyKey	(string) The company key.
value	(bool) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

PUT Set Location WorkOrderTaskVerification

Updates the value of attribute 'Location' in the specified entity record.

The following elements are required:

workOrderTaskVerificationKey	(string) Task Verification.
companyKey	(string) The company key.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

PUT Set MaintenanceRoute WorkOrderTaskVerification

Updates the value of attribute 'MaintenanceRoute' in the specified entity record.

The following elements are required:

workOrderTaskVerificationKey	(string) Task Verification.
companyKey	(string) The company key.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

PUT Set Remarks WorkOrderTaskVerification

Updates the value of attribute 'Remarks' in the specified entity record.

The following elements are required:

workOrderTaskVerificationKey	(string) Task Verification.
companyKey	(string) The company key.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

PUT Set RemarksRequired WorkOrderTaskVerification

Updates the value of attribute 'RemarksRequired' in the specified entity record.

The following elements are required:

workOrderTaskVerificationKey	(string) Task Verification.
companyKey	(string) The company key.
value	(bool) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

PUT Set ReportDate WorkOrderTaskVerification

Updates the value of attribute 'ReportDate' in the specified entity record.

The following elements are required:

workOrderTaskVerificationKey	(string) Task Verification.
companyKey	(string) The company key.
value	(DateTimeOffset) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

PUT Set Task WorkOrderTaskVerification

Updates the value of attribute 'Task' in the specified entity record.

The following elements are required:

workOrderTaskVerificationKey	(string) Task Verification.
companyKey	(string) The company key.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

PUT Set Tool WorkOrderTaskVerification

Updates the value of attribute 'Tool' in the specified entity record.

The following elements are required:

workOrderTaskVerificationKey	(string) Task Verification.
companyKey	(string) The company key.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

PUT Set VerificationDate WorkOrderTaskVerification

Updates the value of attribute 'VerificationDate' in the specified entity record.

The following elements are required:

workOrderTaskVerificationKey	(string) Task Verification.
companyKey	(string) The company key.
value	(DateTimeOffset) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

PUT Set VerificationType WorkOrderTaskVerification

Updates the value of attribute 'VerificationType' in the specified entity record.

The following elements are required:

workOrderTaskVerificationKey	(string) Task Verification.
companyKey	(string) The company key.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

PUT Set WOMaintenancePlanId WorkOrderTaskVerification

Updates the value of attribute 'WOMaintenancePlanId' in the specified entity record.

The following elements are required:

workOrderTaskVerificationKey	(string) Task Verification.
companyKey	(string) The company key.
value	(Guid) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

PUT Set WOMaintenancePlanTaskId WorkOrderTaskVerification

Updates the value of attribute 'WOMaintenancePlanTaskId' in the specified entity record.

The following elements are required:

workOrderTaskVerificationKey	(string) Task Verification.
companyKey	(string) The company key.
value	(Guid) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

PUT Set WorkOrderMaintenancePlan WorkOrderTaskVerification

Updates the value of attribute 'WorkOrderMaintenancePlan' in the specified entity record.

The following elements are required:

workOrderTaskVerificationKey	(string) Task Verification.
companyKey	(string) The company key.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

PUT Set WorkOrderTaskVerificationKey WorkOrderTaskVerification

Updates the value of attribute 'WorkOrderTaskVerificationKey' in the specified entity record.

The following elements are required:

workOrderTaskVerificationKey	(string) Task Verification.
companyKey	(string) The company key.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

PUT Set WOTaskId WorkOrderTaskVerification

Updates the value of attribute 'WOTaskId' in the specified entity record.

The following elements are required:

workOrderTaskVerificationKey	(string) Task Verification.
companyKey	(string) The company key.
value	(Guid) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

PUT Set Custom Attribute WorkOrderTaskVerification

Updates the value of 'CustomAttribute' in the specified entity record.

The following elements are required:

companyKey	(string) The company key.
workOrderTaskVerificationKey	(string) Task Verification
customAttributeName	(string) The custom attribute name.
value	(ExtensibilityCustomAttributeValueResource) The request body should contain the new value for the custom attribute. See ExtensibilityCustomAttributeValueResource.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.
404	NotFound. The specified record does not exist.

Resource URL:

DELETE Operations

DELETE WorkOrderTaskVerification by identifier

Deletes the entity record that matches the specified identifier.

The following elements are required:

id	(string) The record identifier.

Response:

When successful, the response body is empty.

Response status codes:

204	Deleted. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.
404	NotFound. The specified record does not exist.

Resource URL:

DELETE WorkOrderTaskVerification by key

Deletes the entity record that matches the specified key.

The following elements are required:

companyKey	(string) The company key.
workOrderTaskVerificationKey	(string) Task Verification.

Response:

When successful, the response body is empty.

Response status codes:

204	Deleted. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.
404	NotFound. The specified record does not exist.

Resource URL:

Resources

ApiWorkOrderTaskVerificationResource

The following elements are required:

workOrderTaskVerificationKey	(string) Task Verification.
workOrder	(string) Work Order.
company	(string) Company.
assetType	(enum ReportAssetType) Type. See ReportAssetType.
reportDate	(DateTimeOffset) Report Date.
verificationDate	(DateTimeOffset) Verification Date.
employee	(string) Employee.
remarksRequired	(bool) Remarks Required.
verificationType	(string) Verification Type.
isLocked	(bool) Is Locked.

The following elements are optional:

location	(string) Location.
equipment	(string) Equipment.
tool	(string) Tool.
maintenanceRoute	(string) Route.
remarks	(string) Remarks.
workOrderMaintenancePlan	(string) Maintenance Plan.
wOMaintenancePlanId	(Guid) WO Maintenance Plan Id.
wOMaintenancePlanTaskId	(Guid) WO Maintenance Plan Task Id.
wOTaskId	(Guid) WO Task Id.
task	(string) Task.

WorkOrderTaskVerificationInfoResource

The following elements are required:

employee	(string) Employee.
verificationDate	(DateTimeOffset) Verification Date.
verificationType	(string) Verification Type.

The following elements are optional:

remarks	(string) Remarks.
workOrderMaintenancePlan	(string) Maintenance Plan.
wOMaintenancePlanId	(Guid) WO Maintenance Plan Id.
wOMaintenancePlanTaskId	(Guid) WO Maintenance Plan Task Id.
wOTaskId	(Guid) WO Task Id.

WorkOrderTaskVerificationResource

The following elements are required:

workOrderTaskVerificationKey	(string) Task Verification.
workOrder	(string) Work Order. (fk) Allowed value: the natural key of a record of type WorkOrder. These records are accessibly through the WorkOrders service.
company	(string) Company. (fk) Allowed value: the natural key of a record of type Company. These records are accessibly through the Companies service.
assetType	(enum ReportAssetType) Type. See ReportAssetType.
reportDate	(DateTimeOffset) Report Date.
verificationDate	(DateTimeOffset) Verification Date.
employee	(string) Employee. (fk) Allowed value: the natural key of a record of type Employee. These records are accessibly through the Employees service.
remarksRequired	(bool) Remarks Required.
verificationType	(string) Verification Type. (fk) Allowed value: the natural key of a record of type VerificationType. These records are accessibly through the VerificationTypes service.
isLocked	(bool) Is Locked.

The following elements are optional:

location	(string) Location. (fk) Allowed value: the natural key of a record of type Location. These records are accessibly through the Locations service.
equipment	(string) Equipment. (fk) Allowed value: the natural key of a record of type EquipmentItem. These records are accessibly through the EquipmentItems service.
tool	(string) Tool. (fk) Allowed value: the natural key of a record of type EquipmentItem. These records are accessibly through the EquipmentItems service.
maintenanceRoute	(string) Route. (fk) Allowed value: the natural key of a record of type Route. These records are accessibly through the Routes service.
remarks	(string) Remarks.
workOrderMaintenancePlan	(string) Maintenance Plan. (fk) Allowed value: the natural key of a record of type MaintenancePlan. These records are accessibly through the MaintenancePlans service.
wOMaintenancePlanId	(Guid) WO Maintenance Plan Id.
wOMaintenancePlanTaskId	(Guid) WO Maintenance Plan Task Id.
wOTaskId	(Guid) WO Task Id.
task	(string) Task. (fk) Allowed value: the natural key of a record of type Activity. These records are accessibly through the Activities service.

ExtensibilityCustomAttributeValueResource

The following elements are required:

value

(object) The custom attribute value.

Enumerations

ReportAssetType

1	Location
2	Equipment
3	Tool