Work | Planner
Service to manage entities of type 'Planner'.
Overview
| URL | api/{tenantKey}/{orgKey}/maintenance/planners |
| Methods Supported | GET, POST, PUT, DELETE |
All Operations
This service includes the following operations:
- GET:
- POST:
- PUT:
- DELETE:
All Resources
This service uses the following resources:
GET Planners (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 PlannerResource. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
GET Planner 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 PlannerResource. |
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 Planner by key
Returns the entity record that matches the specified key.
The following elements are required:
| plannerKey | (string) Planner. |
Response:
| When successful, the response body contains the entity record. See PlannerResource. |
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 Filters
Custom operation 'GetFilters'.
Response:
| When successful, the response body contains a resource of type 'PlannerFilterResource'. See PlannerFilterResource. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
GET Get Planner Items
Custom operation 'GetPlannerItems'.
The following elements are required:
| start | (DateTimeOffset) Start. |
| end | (DateTimeOffset) End. |
| workShopKey | (string) WorkShopKey. |
| technicianKey | (string) TechnicianKey. |
| stateKey | (string) StateKey. |
| maxRecords | (int) MaxRecords. |
Response:
| When successful, the response body contains a resource of type 'PlannerItemsResource'. See PlannerItemsResource. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
POST Planners
Creates a new entity record.
The following elements are required:
| plannerResource | (ApiPlannerResource) The request body should contain the entity record that should be created. See ApiPlannerResource. |
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 ApiPlannerResource. |
Response status codes:
| 201 | Created. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set IsActive Planner
Updates the value of attribute 'IsActive' in the specified entity record.
The following elements are required:
| plannerKey | (string) Planner. |
| 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 PlannerKey Planner
Updates the value of attribute 'PlannerKey' in the specified entity record.
The following elements are required:
| plannerKey | (string) Planner. |
| 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:
DELETE Planner 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 Planner by key
Deletes the entity record that matches the specified key.
The following elements are required:
| plannerKey | (string) Planner. |
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
ApiPlannerResource
The following elements are required:
| plannerKey | (string) Planner. |
PlannerFilterResource
The following elements are optional:
| date | (DateTimeOffset) Date. |
PlannerItemsResource
The following elements are optional:
| date | (DateTimeOffset) Date. |
PlannerResource
The following elements are required:
| plannerKey | (string) Planner. |