Work | Priority Level
Service to manage entities of type 'PriorityLevel'.
Overview
| URL | api/{tenantKey}/{orgKey}/maintenanceCore/priorityLevels |
| Methods Supported | GET, POST, PUT, DELETE |
All Operations
This service includes the following operations:
- GET:
- POST:
-
PUT:
- PUT Set Custom Attribute PriorityLevel
- PUT Set Custom Attribute PriorityLevelLine
- PUT Set IsActive PriorityLevel
- PUT Set PriorityLevelKey PriorityLevel
- PUT Set Description PriorityLevel
- PUT Set Remarks PriorityLevel
- PUT Set WeekDayMask PriorityLevelLine
- PUT Set ResponseTime PriorityLevelLine
- PUT Set TimeUnit PriorityLevelLine
- DELETE:
All Resources
This service uses the following resources:
- ApiPriorityLevelPriorityLevelLinesResource
- ApiPriorityLevelResource
- PriorityLevelResource
- ExtensibilityCustomAttributeValueResource
All Enumerations
This service uses the following enumerations:
GET PriorityLevels (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 PriorityLevelResource. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
GET PriorityLevel 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 PriorityLevelResource. |
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 PriorityLevel by key
Returns the entity record that matches the specified key.
The following elements are required:
| priorityLevelKey | (string) Priority Level. |
Response:
| When successful, the response body contains the entity record. See PriorityLevelResource. |
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 PriorityLevels
Creates a new entity record.
The following elements are required:
| priorityLevelResource | (ApiPriorityLevelResource) The request body should contain the entity record that should be created. See ApiPriorityLevelResource. |
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 ApiPriorityLevelResource. |
Response status codes:
| 201 | Created. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
POST Priority Level Line
Inserts a new 'Priority Level Line' in the 'Priority Level'.
The following elements are required:
| priorityLevelKey | (string) Priority Level. |
| value | (ApiPriorityLevelPriorityLevelLinesResource) The ApiPriorityLevelPriorityLevelLinesResource instance. See ApiPriorityLevelPriorityLevelLinesResource. |
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:
| 204 | NoContent. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set Description PriorityLevel
Updates the value of attribute 'Description' in the specified entity record.
The following elements are required:
| priorityLevelKey | (string) Priority Level. |
| 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 PriorityLevel
Updates the value of attribute 'IsActive' in the specified entity record.
The following elements are required:
| priorityLevelKey | (string) Priority Level. |
| 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 PriorityLevelKey PriorityLevel
Updates the value of attribute 'PriorityLevelKey' in the specified entity record.
The following elements are required:
| priorityLevelKey | (string) Priority Level. |
| 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 PriorityLevel
Updates the value of attribute 'Remarks' in the specified entity record.
The following elements are required:
| priorityLevelKey | (string) Priority Level. |
| 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 ResponseTime PriorityLevelLine
Updates the value of attribute 'ResponseTime' in the specified entity record.
The following elements are required:
| priorityLevelKey | (string) Priority Level. |
| lineId | (string) The detail identifier. |
| 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 TimeUnit PriorityLevelLine
Updates the value of attribute 'TimeUnit' in the specified entity record.
The following elements are required:
| priorityLevelKey | (string) Priority Level. |
| lineId | (string) The detail identifier. |
| value | (enum TimeUnit) The request body should contain the new value for the attribute. See TimeUnit. |
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 WeekDayMask PriorityLevelLine
Updates the value of attribute 'WeekDayMask' in the specified entity record.
The following elements are required:
| priorityLevelKey | (string) Priority Level. |
| lineId | (string) The detail identifier. |
| value | (enum WeekDayMask) The request body should contain the new value for the attribute. See WeekDayMask. |
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 PriorityLevel
Updates the value of 'CustomAttribute' in the specified entity record.
The following elements are required:
| priorityLevelKey | (string) Priority Level |
| 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 Set Custom Attribute PriorityLevelLine
Updates the value of 'CustomAttribute' in the specified entity record.
The following elements are required:
| priorityLevelKey | (string) Priority Level |
| lineId | (string) The detail identifier. |
| 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 Priority Level Line by identifier
Deletes the entity record that matches the specified identifier.
The following elements are required:
| priorityLevelKey | (string) Priority Level. |
| lineId | (string) The line identifier. |
Response:
| When successful, the response body is empty. |
Response status codes:
| 204 | NoContent. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
| 404 | NotFound. The specified record does not exist. |
Resource URL:
DELETE PriorityLevel 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 PriorityLevel by key
Deletes the entity record that matches the specified key.
The following elements are required:
| priorityLevelKey | (string) Priority Level. |
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
ApiPriorityLevelPriorityLevelLinesResource
The following elements are required:
| weekDayMask | (enum WeekDayMask) Week Day Mask.
See WeekDayMask. |
| responseTime | (int) Response Time. |
| timeUnit | (enum TimeUnit) Time Unit.
See TimeUnit. |
ApiPriorityLevelResource
The following elements are required:
| priorityLevelKey | (string) Priority Level. |
| description | (string) Description. |
The following elements are optional:
| remarks | (string) Remarks. |
| priorityLevelLines | (List of ApiPriorityLevelPriorityLevelLinesResource) Priority Level Lines.
See ApiPriorityLevelPriorityLevelLinesResource. |
PriorityLevelResource
The following elements are required:
| priorityLevelKey | (string) Priority Level. |
| description | (string) Description. |
The following elements are optional:
| remarks | (string) Remarks. |
| priorityLevelLines | (List of PriorityLevelLineResource) Priority Level Lines.
See PriorityLevelLineResource. |
ExtensibilityCustomAttributeValueResource
The following elements are required:
| value | (object) The custom attribute value. |