Work | Planner NG
Service to manage entities of type 'Planner NG'.
Overview
| URL | api/{tenantKey}/{orgKey}/maintenance/plannerNGs |
| 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 PlannerNGs (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 PlannerNGResource. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
GET PlannerNG 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 PlannerNGResource. |
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 PlannerNG 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 PlannerNGResource. |
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 Planner Items NG
Custom operation 'GetPlannerItemsNG'.
The following elements are required:
| start | (DateTimeOffset) Start. |
| end | (DateTimeOffset) End. |
| workShopKey | (string) WorkShopKey. |
| technicianKey | (string) TechnicianKey. |
| stateKey | (string) StateKey. |
| customerKey | (string) CustomerKey. |
| supplierKey | (string) SupplierKey. |
| responsibleKey | (string) ResponsibleKey. |
| woTypeKey | (string) WoTypeKey. |
| assetKey | (string) AssetKey. |
| showNotAssigned | (bool) ShowNotAssigned. |
| maxRecords | (int) MaxRecords. |
Response:
| When successful, the response body contains a resource of type 'PlannerItemsResourceNG'. See PlannerItemsResourceNG. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
GET Get Filters NG
Custom operation 'GetFiltersNG'.
Response:
| When successful, the response body contains a resource of type 'PlannerFilterNGResource'. See PlannerFilterNGResource. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
POST PlannerNGs
Creates a new entity record.
The following elements are required:
| plannerNGResource | (ApiPlannerNGResource) The request body should contain the entity record that should be created. See ApiPlannerNGResource. |
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 ApiPlannerNGResource. |
Response status codes:
| 201 | Created. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set IsActive PlannerNG
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 PlannerNG
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 PlannerNG 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 PlannerNG 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
ApiPlannerNGResource
The following elements are required:
| plannerKey | (string) Planner. |
PlannerFilterNGResource
The following elements are optional:
| date | (DateTimeOffset) Date. |
PlannerItemsResourceNG
The following elements are optional:
| date | (DateTimeOffset) Date. |
PlannerNGResource
The following elements are required:
| plannerKey | (string) Planner. |