Valuekeep Developers - Web API Reference

Work | Verification Type

Service to manage entities of type 'VerificationType'.

Overview


URL api/{tenantKey}/{orgKey}/maintenanceCore/verificationTypes
Methods Supported GET, POST, PUT, DELETE

All Operations

This service includes the following operations:

All Resources

This service uses the following resources:

GET Operations

GET VerificationTypes (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 VerificationTypeResource.

Response status codes:

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

Resource URL:

GET /maintenanceCore/verificationTypes/odata

GET VerificationType 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 VerificationTypeResource.

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 /maintenanceCore/verificationTypes/{id}

GET VerificationType by key

Returns the entity record that matches the specified key.

The following elements are required:

verificationTypeKey (string) Verification Type.

Response:

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

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 /maintenanceCore/verificationTypes/{verificationTypeKey}

POST Operations

POST VerificationTypes

Creates a new entity record.

The following elements are required:

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

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 ApiVerificationTypeResource.

Response status codes:

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

Resource URL:

POST /maintenanceCore/verificationTypes

PUT Operations

PUT Set Description VerificationType

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

The following elements are required:

verificationTypeKey (string) Verification Type.
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 /maintenanceCore/verificationTypes/{verificationTypeKey}/description

PUT Set IsActive VerificationType

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

The following elements are required:

verificationTypeKey (string) Verification Type.
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 /maintenanceCore/verificationTypes/{verificationTypeKey}/isActive

PUT Set IsDefault VerificationType

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

The following elements are required:

verificationTypeKey (string) Verification Type.
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 /maintenanceCore/verificationTypes/{verificationTypeKey}/isDefault

PUT Set NotesRequired VerificationType

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

The following elements are required:

verificationTypeKey (string) Verification Type.
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 /maintenanceCore/verificationTypes/{verificationTypeKey}/notesRequired

PUT Set Remarks VerificationType

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

The following elements are required:

verificationTypeKey (string) Verification Type.
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 /maintenanceCore/verificationTypes/{verificationTypeKey}/remarks

PUT Set Verification VerificationType

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

The following elements are required:

verificationTypeKey (string) Verification Type.
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 /maintenanceCore/verificationTypes/{verificationTypeKey}/verification

PUT Set VerificationTypeKey VerificationType

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

The following elements are required:

verificationTypeKey (string) Verification Type.
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 /maintenanceCore/verificationTypes/{verificationTypeKey}/verificationTypeKey

PUT Set Custom Attribute VerificationType

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

The following elements are required:

verificationTypeKey (string) Verification Type
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:

PUT /maintenanceCore/verificationTypes/{verificationTypeKey}/{customAttributeName}

DELETE Operations

DELETE VerificationType 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 /maintenanceCore/verificationTypes/{id}

DELETE VerificationType by key

Deletes the entity record that matches the specified key.

The following elements are required:

verificationTypeKey (string) Verification Type.

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 /maintenanceCore/verificationTypes/{verificationTypeKey}

Resources


ApiVerificationTypeResource

The following elements are required:

verificationTypeKey (string) Verification Type.
description (string) Description.
verification (string) Verification.
isDefault (bool) Is Default.

The following elements are optional:

notesRequired (bool) Notes Required.
remarks (string) Remarks.


VerificationTypeResource

The following elements are required:

verificationTypeKey (string) Verification Type.
description (string) Description.
verification (string) Verification.
(fk) Allowed value: the natural key of a record of type Verification. These records are accessibly through the Verifications service.
isDefault (bool) Is Default.

The following elements are optional:

notesRequired (bool) Notes Required.
remarks (string) Remarks.


ExtensibilityCustomAttributeValueResource

The following elements are required:

value (object) The custom attribute value.