Valuekeep Developers - Web API Reference

Work | Preventive Maint FiIe Import

Service to manage entities of type 'PreventiveMaintFileImport'.

Overview


URL api/{tenantKey}/{orgKey}/maintenance/preventiveMaintFileImports
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 PreventiveMaintFileImports (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 PreventiveMaintFileImportResource.

Response status codes:

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

Resource URL:

GET /maintenance/preventiveMaintFileImports/odata

GET PreventiveMaintFileImport 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 PreventiveMaintFileImportResource.

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 /maintenance/preventiveMaintFileImports/{id}

GET PreventiveMaintFileImport by key

Returns the entity record that matches the specified key.

The following elements are required:

import (string) Import.

Response:

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

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 /maintenance/preventiveMaintFileImports/{import}

POST Operations

POST PreventiveMaintFileImports

Creates a new entity record.

The following elements are required:

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

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

Response status codes:

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

Resource URL:

POST /maintenance/preventiveMaintFileImports

PUT Operations

PUT Set BlobFilename PreventiveMaintFileImport

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

The following elements are required:

import (string) Import.
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 /maintenance/preventiveMaintFileImports/{import}/blobFilename

PUT Set Description PreventiveMaintFileImport

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

The following elements are required:

import (string) Import.
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 /maintenance/preventiveMaintFileImports/{import}/description

PUT Set EndDate PreventiveMaintFileImport

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

The following elements are required:

import (string) Import.
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 /maintenance/preventiveMaintFileImports/{import}/endDate

PUT Set File PreventiveMaintFileImport

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

The following elements are required:

import (string) Import.
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 /maintenance/preventiveMaintFileImports/{import}/file

PUT Set Import PreventiveMaintFileImport

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

The following elements are required:

import (string) Import.
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 /maintenance/preventiveMaintFileImports/{import}/import

PUT Set IsActive PreventiveMaintFileImport

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

The following elements are required:

import (string) Import.
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 /maintenance/preventiveMaintFileImports/{import}/isActive

PUT Set Log PreventiveMaintFileImport

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

The following elements are required:

import (string) Import.
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 /maintenance/preventiveMaintFileImports/{import}/log

PUT Set StartDate PreventiveMaintFileImport

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

The following elements are required:

import (string) Import.
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 /maintenance/preventiveMaintFileImports/{import}/startDate

PUT Set Status PreventiveMaintFileImport

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

The following elements are required:

import (string) Import.
value (int) 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 /maintenance/preventiveMaintFileImports/{import}/status

DELETE Operations

DELETE PreventiveMaintFileImport 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 /maintenance/preventiveMaintFileImports/{id}

DELETE PreventiveMaintFileImport by key

Deletes the entity record that matches the specified key.

The following elements are required:

import (string) Import.

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 /maintenance/preventiveMaintFileImports/{import}

Resources


ApiPreventiveMaintFileImportResource

The following elements are required:

import (string) Import.
status (int) Status.

The following elements are optional:

description (string) Description.
file (string) File.
log (string) Log.
blobFilename (string) Blob Filename.
startDate (DateTimeOffset) Start Date.
endDate (DateTimeOffset) End Date.


PreventiveMaintFileImportResource

The following elements are required:

import (string) Import.
status (int) Status.

The following elements are optional:

description (string) Description.
loaded (bool) Loaded.
file (string) File.
log (string) Log.
blobFilename (string) Blob Filename.
startDate (DateTimeOffset) Start Date.
endDate (DateTimeOffset) End Date.