Assets | Route

Service to manage entities of type 'Route'.

Overview

api/{tenantKey}/{orgKey}/assetManagementCore/routes

URL	api/{tenantKey}/{orgKey}/assetManagementCore/routes
Methods Supported	GET, POST, PUT, DELETE

All Operations

This service includes the following operations:

GET:
POST:
PUT:
DELETE:
- DELETE Route by identifier
- DELETE Route by key

All Resources

This service uses the following resources:

ApiLocationRoutesResource
RouteMaintenanceNotificationTemplateParameter
RouteResource
ExtensibilityCustomAttributeValueResource

GET Operations

GET Routes (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 RouteResource.

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/assetManagementCore/routes/odata

GET /assetManagementCore/routes/odata

GET Route 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 RouteResource.

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:

api/{tenantKey}/{orgKey}/assetManagementCore/routes/{id}

GET /assetManagementCore/routes/{id}

GET Route by key

Returns the entity record that matches the specified key.

The following elements are required:

companyKey	(string) The company key.
routeKey	(string) Route.

Response:

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

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:

api/{tenantKey}/{orgKey}/assetManagementCore/routes/{companyKey}/{routeKey}

GET /assetManagementCore/routes/{companyKey}/{routeKey}

GET Get Maintenance Notification Template Parameters

Custom operation 'GetMaintenanceNotificationTemplateParameters'.

The following elements are required:

companyKey	(string) CompanyKey.
routeKey	(string) RouteKey.
cultureKey	(string) CultureKey.

Response:

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

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/assetManagementCore/routes/getMaintenanceNotificationTemplateParameters/{companyKey}/{routeKey}

GET /assetManagementCore/routes/getMaintenanceNotificationTemplateParameters/{companyKey}/{routeKey}

POST Operations

POST LocationRoutes

Creates a new entity record.

The following elements are required:

routeResource

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

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

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/assetManagementCore/routes

POST /assetManagementCore/routes

POST Add Locations by keys

Adds the specified 'Locations' to the 'Route' (by specifying its keys).

The following elements are required:

routeKey	(string) Route.
value	(Array of string) A list of record keys to be added.

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 is empty.

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/assetManagementCore/routes/{routeKey}/locations/add

POST /assetManagementCore/routes/{routeKey}/locations/add

POST Add Locations by identifiers

Adds the specified 'Locations' to the 'Route' (by specifying its identifiers).

The following elements are required:

routeKey	(string) Route.
value	(Array of string) A list of record identifiers to be added.

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 is empty.

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/assetManagementCore/routes/{routeKey}/locations/addById

POST /assetManagementCore/routes/{routeKey}/locations/addById

POST Remove Locations by keys

Removes the specified 'Locations' to the 'Route' (by specifying its keys).

The following elements are required:

routeKey	(string) Route.
value	(Array of string) A list of record keys to be removed.

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 is empty.

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/assetManagementCore/routes/{routeKey}/locations/remove

POST /assetManagementCore/routes/{routeKey}/locations/remove

POST Remove Locations by identifiers

Removes the specified 'Locations' to the 'Route' (by specifying its identifiers).

The following elements are required:

routeKey	(string) Route.
value	(Array of string) A list of record identifiers to be removed.

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 is empty.

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/assetManagementCore/routes/{routeKey}/locations/removeById

POST /assetManagementCore/routes/{routeKey}/locations/removeById

POST Add EquipmentItems by keys

Adds the specified 'EquipmentItems' to the 'Route' (by specifying its keys).

The following elements are required:

routeKey	(string) Route.
value	(Array of string) A list of record keys to be added.

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 is empty.

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/assetManagementCore/routes/{routeKey}/equipmentitems/add

POST /assetManagementCore/routes/{routeKey}/equipmentitems/add

POST Add EquipmentItems by identifiers

Adds the specified 'EquipmentItems' to the 'Route' (by specifying its identifiers).

The following elements are required:

routeKey	(string) Route.
value	(Array of string) A list of record identifiers to be added.

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 is empty.

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/assetManagementCore/routes/{routeKey}/equipmentitems/addById

POST /assetManagementCore/routes/{routeKey}/equipmentitems/addById

POST Remove EquipmentItems by keys

Removes the specified 'EquipmentItems' to the 'Route' (by specifying its keys).

The following elements are required:

routeKey	(string) Route.
value	(Array of string) A list of record keys to be removed.

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 is empty.

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/assetManagementCore/routes/{routeKey}/equipmentitems/remove

POST /assetManagementCore/routes/{routeKey}/equipmentitems/remove

POST Remove EquipmentItems by identifiers

Removes the specified 'EquipmentItems' to the 'Route' (by specifying its identifiers).

The following elements are required:

routeKey	(string) Route.
value	(Array of string) A list of record identifiers to be removed.

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 is empty.

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/assetManagementCore/routes/{routeKey}/equipmentitems/removeById

POST /assetManagementCore/routes/{routeKey}/equipmentitems/removeById

PUT Operations

PUT Set Brand Route

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

The following elements are required:

routeKey	(string) Route.
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:

api/{tenantKey}/{orgKey}/assetManagementCore/routes/{companyKey}/{routeKey}/brand

PUT /assetManagementCore/routes/{companyKey}/{routeKey}/brand

PUT Set BrandModel Route

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

The following elements are required:

routeKey	(string) Route.
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:

api/{tenantKey}/{orgKey}/assetManagementCore/routes/{companyKey}/{routeKey}/brandModel

PUT /assetManagementCore/routes/{companyKey}/{routeKey}/brandModel

PUT Set Company Route

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

The following elements are required:

routeKey	(string) Route.
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:

api/{tenantKey}/{orgKey}/assetManagementCore/routes/{companyKey}/{routeKey}/company

PUT /assetManagementCore/routes/{companyKey}/{routeKey}/company

PUT Set Description Route

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

The following elements are required:

routeKey	(string) Route.
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:

api/{tenantKey}/{orgKey}/assetManagementCore/routes/{companyKey}/{routeKey}/description

PUT /assetManagementCore/routes/{companyKey}/{routeKey}/description

PUT Set Family Route

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

The following elements are required:

routeKey	(string) Route.
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:

api/{tenantKey}/{orgKey}/assetManagementCore/routes/{companyKey}/{routeKey}/family

PUT /assetManagementCore/routes/{companyKey}/{routeKey}/family

PUT Set IsActive Route

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

The following elements are required:

routeKey	(string) Route.
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:

api/{tenantKey}/{orgKey}/assetManagementCore/routes/{companyKey}/{routeKey}/isActive

PUT /assetManagementCore/routes/{companyKey}/{routeKey}/isActive

PUT Set LocationFunction Route

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

The following elements are required:

routeKey	(string) Route.
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:

api/{tenantKey}/{orgKey}/assetManagementCore/routes/{companyKey}/{routeKey}/locationFunction

PUT /assetManagementCore/routes/{companyKey}/{routeKey}/locationFunction

PUT Set Remarks Route

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

The following elements are required:

routeKey	(string) Route.
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:

api/{tenantKey}/{orgKey}/assetManagementCore/routes/{companyKey}/{routeKey}/remarks

PUT /assetManagementCore/routes/{companyKey}/{routeKey}/remarks

PUT Set Responsible Route

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

The following elements are required:

routeKey	(string) Route.
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:

api/{tenantKey}/{orgKey}/assetManagementCore/routes/{companyKey}/{routeKey}/responsible

PUT /assetManagementCore/routes/{companyKey}/{routeKey}/responsible

PUT Set RouteKey Route

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

The following elements are required:

routeKey	(string) Route.
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:

api/{tenantKey}/{orgKey}/assetManagementCore/routes/{companyKey}/{routeKey}/routeKey

PUT /assetManagementCore/routes/{companyKey}/{routeKey}/routeKey

PUT Set Custom Attribute Route

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

The following elements are required:

companyKey	(string) The company key.
routeKey	(string) Route
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:

api/{tenantKey}/{orgKey}/assetManagementCore/routes/{companyKey}/{routeKey}/{customAttributeName}

PUT /assetManagementCore/routes/{companyKey}/{routeKey}/{customAttributeName}

DELETE Operations

DELETE Route 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:

api/{tenantKey}/{orgKey}/assetManagementCore/routes/{id}

DELETE /assetManagementCore/routes/{id}

DELETE Route by key

Deletes the entity record that matches the specified key.

The following elements are required:

companyKey	(string) The company key.
routeKey	(string) Route.

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:

api/{tenantKey}/{orgKey}/assetManagementCore/routes/{companyKey}/{routeKey}

DELETE /assetManagementCore/routes/{companyKey}/{routeKey}

Resources

ApiLocationRoutesResource

The following elements are required:

routeKey	(string) Route.
description	(string) Description.
company	(string) Company.

The following elements are optional:

locationFunction	(string) Location Function.
family	(string) Family.
brand	(string) Brand.
brandModel	(string) Model.
tools	(string) Tools.
remarks	(string) Remarks.
responsible	(string) Responsible.

RouteMaintenanceNotificationTemplateParameter

The following elements are required:

name	(string) Name.

The following elements are optional:

value

(string) Value.

RouteResource

The following elements are required:

routeKey	(string) Route.
description	(string) Description.
company	(string) Company. (fk) Allowed value: the natural key of a record of type Company. These records are accessibly through the Companies service.

The following elements are optional:

locationFunction	(string) Location Function. (fk) Allowed value: the natural key of a record of type LocationFunction. These records are accessibly through the LocationFunctions service.
family	(string) Family. (fk) Allowed value: the natural key of a record of type Family. These records are accessibly through the Families service.
brand	(string) Brand. (fk) Allowed value: the natural key of a record of type Brand. These records are accessibly through the Brands service.
brandModel	(string) Model. (fk) Allowed value: the natural key of a record of type BrandModel. These records are accessibly through the BrandModels service.
locations	(Location) Locations.
equipmentItems	(EquipmentItem) Equipment Items.
tools	(List of EquipmentToolRouteResource) Tools. See EquipmentToolRouteResource.
remarks	(string) Remarks.
responsible	(string) Responsible. (fk) Allowed value: the natural key of a record of type Employee. These records are accessibly through the Employees service.

ExtensibilityCustomAttributeValueResource

The following elements are required:

value

(object) The custom attribute value.