Assets | Background Services

Service to manage entities of type 'WorkersConfiguration'.

Overview

URL	api/{tenantKey}/{orgKey}/assetManagement/workersConfigurations
Methods Supported	GET, POST, PUT, DELETE

All Operations

This service includes the following operations:

• GET:
  • GET WorkersConfigurations (odata)
  • GET WorkersConfiguration by identifier
  • GET WorkersConfiguration by key
  • GET Get All Background Services
• POST:
  • POST WorkersConfigurations
• PUT:
  • PUT Set Custom Attribute WorkersConfiguration
  • PUT Set IsActive WorkersConfiguration
  • PUT Set WorkersConfigurationKey WorkersConfiguration
  • PUT Set EnableMTTR WorkersConfiguration
  • PUT Set KPINextExecutionDate WorkersConfiguration
  • PUT Set KPIExecutionLog WorkersConfiguration
  • PUT Set Company WorkersConfiguration
  • PUT Set EnableUpTime WorkersConfiguration
  • PUT Set UpTimeNextExecutionDate WorkersConfiguration
  • PUT Set UpTimeExecutionLog WorkersConfiguration
  • PUT Set EnableEventsReschedule WorkersConfiguration
  • PUT Set EventsNextExecutionDate WorkersConfiguration
  • PUT Set EventsExecutionLog WorkersConfiguration
  • PUT Set KPIExecutionResult WorkersConfiguration
  • PUT Set UpTimeExecutionResult WorkersConfiguration
  • PUT Set EventsExecutionResult WorkersConfiguration
  • PUT Set NextExecutionDate WorkersConfiguration
  • PUT Set EnableClosingRequests WorkersConfiguration
  • PUT Set EnableClosingWorkOrders WorkersConfiguration
  • PUT Set AutomaticClosingExecutionLog WorkersConfiguration
  • PUT Set CloseRequestsAfter WorkersConfiguration
  • PUT Set CloseWorkOrdersAfter WorkersConfiguration
  • PUT Set AutomaticClosingExecutionResult WorkersConfiguration
• DELETE:
  • DELETE WorkersConfiguration by identifier
  • DELETE WorkersConfiguration by key

All Resources

This service uses the following resources:

• ApiWorkersConfigurationResource
• WorkersConfigurationResource
• ExtensibilityCustomAttributeValueResource

All Enumerations

This service uses the following enumerations:

• WorkerConfigurationResult

GET Operations

GET WorkersConfigurations (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 WorkersConfigurationResource.

Response status codes:

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

Resource URL:

GET WorkersConfiguration 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 WorkersConfigurationResource.

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 WorkersConfiguration by key

Returns the entity record that matches the specified key.

The following elements are required:

companyKey	(string) The company key.
workersConfigurationKey	(string) Configuration.

Response:

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

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 Get All Background Services

Custom operation 'GetAllWorkersConfigurations'.

Response:

When successful, the response body contains a list of resources of type 'WorkersConfigurationResource'. See WorkersConfigurationResource.

Response status codes:

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

Resource URL:

POST Operations

POST WorkersConfigurations

Creates a new entity record.

The following elements are required:

workersConfigurationResource

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

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

Response status codes:

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

Resource URL:

PUT Operations

PUT Set AutomaticClosingExecutionLog WorkersConfiguration

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

The following elements are required:

workersConfigurationKey	(string) Configuration.
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 AutomaticClosingExecutionResult WorkersConfiguration

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

The following elements are required:

workersConfigurationKey	(string) Configuration.
companyKey	(string) The company key.
value	(enum WorkerConfigurationResult) The request body should contain the new value for the attribute. See WorkerConfigurationResult.

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 CloseRequestsAfter WorkersConfiguration

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

The following elements are required:

workersConfigurationKey	(string) Configuration.
companyKey	(string) The company key.
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 Set CloseWorkOrdersAfter WorkersConfiguration

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

The following elements are required:

workersConfigurationKey	(string) Configuration.
companyKey	(string) The company key.
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 Set Company WorkersConfiguration

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

The following elements are required:

workersConfigurationKey	(string) Configuration.
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 EnableClosingRequests WorkersConfiguration

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

The following elements are required:

workersConfigurationKey	(string) Configuration.
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 EnableClosingWorkOrders WorkersConfiguration

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

The following elements are required:

workersConfigurationKey	(string) Configuration.
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 EnableEventsReschedule WorkersConfiguration

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

The following elements are required:

workersConfigurationKey	(string) Configuration.
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 EnableMTTR WorkersConfiguration

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

The following elements are required:

workersConfigurationKey	(string) Configuration.
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 EnableUpTime WorkersConfiguration

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

The following elements are required:

workersConfigurationKey	(string) Configuration.
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 EventsExecutionLog WorkersConfiguration

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

The following elements are required:

workersConfigurationKey	(string) Configuration.
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 EventsExecutionResult WorkersConfiguration

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

The following elements are required:

workersConfigurationKey	(string) Configuration.
companyKey	(string) The company key.
value	(enum WorkerConfigurationResult) The request body should contain the new value for the attribute. See WorkerConfigurationResult.

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 EventsNextExecutionDate WorkersConfiguration

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

The following elements are required:

workersConfigurationKey	(string) Configuration.
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 IsActive WorkersConfiguration

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

The following elements are required:

workersConfigurationKey	(string) Configuration.
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 KPIExecutionLog WorkersConfiguration

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

The following elements are required:

workersConfigurationKey	(string) Configuration.
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 KPIExecutionResult WorkersConfiguration

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

The following elements are required:

workersConfigurationKey	(string) Configuration.
companyKey	(string) The company key.
value	(enum WorkerConfigurationResult) The request body should contain the new value for the attribute. See WorkerConfigurationResult.

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 KPINextExecutionDate WorkersConfiguration

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

The following elements are required:

workersConfigurationKey	(string) Configuration.
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 NextExecutionDate WorkersConfiguration

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

The following elements are required:

workersConfigurationKey	(string) Configuration.
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 UpTimeExecutionLog WorkersConfiguration

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

The following elements are required:

workersConfigurationKey	(string) Configuration.
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 UpTimeExecutionResult WorkersConfiguration

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

The following elements are required:

workersConfigurationKey	(string) Configuration.
companyKey	(string) The company key.
value	(enum WorkerConfigurationResult) The request body should contain the new value for the attribute. See WorkerConfigurationResult.

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 UpTimeNextExecutionDate WorkersConfiguration

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

The following elements are required:

workersConfigurationKey	(string) Configuration.
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 WorkersConfigurationKey WorkersConfiguration

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

The following elements are required:

workersConfigurationKey	(string) Configuration.
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 Custom Attribute WorkersConfiguration

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

The following elements are required:

companyKey	(string) The company key.
workersConfigurationKey	(string) Configuration
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 WorkersConfiguration 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 WorkersConfiguration by key

Deletes the entity record that matches the specified key.

The following elements are required:

companyKey	(string) The company key.
workersConfigurationKey	(string) Configuration.

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

ApiWorkersConfigurationResource

The following elements are required:

workersConfigurationKey	(string) Configuration.
enableMTTR	(bool) Enable MTTR.
company	(string) Company.
enableUpTime	(bool) Enable Up Time.
enableEventsReschedule	(bool) Enable Events Rescheduling.
enableClosingRequests	(bool) Enable Closing Requests.
enableClosingWorkOrders	(bool) Enable Closing Work Orders.
closeRequestsAfter	(int) Close Requests After (days).
closeWorkOrdersAfter	(int) Close Work Orders After (days).

The following elements are optional:

kPINextExecutionDate	(DateTimeOffset) Next Execution Date.
kPIExecutionLog	(string) KPI Execution Log.
upTimeNextExecutionDate	(DateTimeOffset) Next Execution Date.
upTimeExecutionLog	(string) Up Time Execution Log.
eventsNextExecutionDate	(DateTimeOffset) Next Execution Date.
eventsExecutionLog	(string) Rescheduling Execution Log.
kPIExecutionResult	(enum WorkerConfigurationResult) KPI Execution Result. See WorkerConfigurationResult.
upTimeExecutionResult	(enum WorkerConfigurationResult) Up Time Execution Result. See WorkerConfigurationResult.
eventsExecutionResult	(enum WorkerConfigurationResult) Rescheduling Execution Result. See WorkerConfigurationResult.
nextExecutionDate	(DateTimeOffset) Next Execution Date.
automaticClosingExecutionLog	(string) Automatic Closing Execution Log.
automaticClosingExecutionResult	(enum WorkerConfigurationResult) Automatic Closing Execution Result. See WorkerConfigurationResult.

WorkersConfigurationResource

The following elements are required:

workersConfigurationKey	(string) Configuration.
enableMTTR	(bool) Enable MTTR.
company	(string) Company.
enableUpTime	(bool) Enable Up Time.
enableEventsReschedule	(bool) Enable Events Rescheduling.
enableClosingRequests	(bool) Enable Closing Requests.
enableClosingWorkOrders	(bool) Enable Closing Work Orders.
closeRequestsAfter	(int) Close Requests After (days).
closeWorkOrdersAfter	(int) Close Work Orders After (days).

The following elements are optional:

kPINextExecutionDate	(DateTimeOffset) Next Execution Date.
kPIExecutionLog	(string) KPI Execution Log.
upTimeNextExecutionDate	(DateTimeOffset) Next Execution Date.
upTimeExecutionLog	(string) Up Time Execution Log.
eventsNextExecutionDate	(DateTimeOffset) Next Execution Date.
eventsExecutionLog	(string) Rescheduling Execution Log.
kPIExecutionResult	(enum WorkerConfigurationResult) KPI Execution Result. See WorkerConfigurationResult.
upTimeExecutionResult	(enum WorkerConfigurationResult) Up Time Execution Result. See WorkerConfigurationResult.
eventsExecutionResult	(enum WorkerConfigurationResult) Rescheduling Execution Result. See WorkerConfigurationResult.
nextExecutionDate	(DateTimeOffset) Next Execution Date.
automaticClosingExecutionLog	(string) Automatic Closing Execution Log.
automaticClosingExecutionResult	(enum WorkerConfigurationResult) Automatic Closing Execution Result. See WorkerConfigurationResult.

ExtensibilityCustomAttributeValueResource

The following elements are required:

value

(object) The custom attribute value.

Enumerations

WorkerConfigurationResult

1	Success
2	Error