Materials Management | Classify Item
The ClassifyItem endpoint is used to classify items with a subtype.
Overview
| URL | api/{tenantKey}/{orgKey}/materialsCore/classifyItems |
| Methods Supported | POST, GET |
All Operations
This service includes the following operations:
All Resources
This service uses the following resources:
GET Classify Item
Returns the list of entity records that can be processed by the 'ItemSubtypes' service.
The following elements are required:
| pageIndex | (int) The index of the page of the list that should be returned. |
| pageSize | (int) The number of page elements that should be returned (max. is 1000). |
| toApplyItemSubtype | (string) The itrm subtype to apply to the item. |
| showOnlyUnclassifiedItems | (bool) Flag to show only unclassified items. |
Response:
| When successful, the response body contains the list of entity records available for processing. See ClassifyItemLine. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
POST Post Classify Item
The service to post the classify item.
The following elements are required:
| classifyItem | (ClassifyItem) ClassifyItem. |
Response:
| When successful, the response body contains a string. |
Resource URL:
POST Classify Item
Instructs the 'ItemSubtypes' service to process the specified entity records.
The following elements are required:
| list | (ClassifyItemLine) List of the entity records that should be processed. See ClassifyItemLine. |
| companyKey | (string) The company key. |
Response:
| When successful, the response body is empty. The URL of the processed items is returned in the response location header. |
Response status codes:
| 201 | Created. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
Resources
ClassifyItem
The following elements are required:
| selectedCount | (int) The number of the selected item. |
| toApplyItemSubtype | (string) The itrm subtype to apply to the item. |
| showOnlyUnclassifiedItems | (bool) Flag to show only unclassified items. |
ClassifyItemLine
The following elements are required:
| selected | (bool) Selected. |
| item | (string) Item. |
| unit | (string) Unit. |
| materialItemId | (Guid) Material Item Id. |
The following elements are optional:
| description | (string) Description. |
| itemSubtype | (string) Item Subtype. |