Materials Management | Item Subtype
Service to manage entities of type 'ItemSubType'.
Overview
| URL | api/{tenantKey}/{orgKey}/materialsCore/itemSubtypes |
| 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 ItemSubtypes (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 ItemSubtypeResource. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
GET ItemSubtype 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 ItemSubtypeResource. |
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 ItemSubtype by key
Returns the entity record that matches the specified key.
The following elements are required:
| itemSubtypeKey | (string) The key for the Item Subtype. |
Response:
| When successful, the response body contains the entity record. See ItemSubtypeResource. |
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 ItemSubtypes
Creates a new entity record.
The following elements are required:
| itemSubtypeResource | (ApiItemSubtypeResource) The request body should contain the entity record that should be created. See ApiItemSubtypeResource. |
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 ApiItemSubtypeResource. |
Response status codes:
| 201 | Created. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set Description ItemSubtype
Updates the value of attribute 'Description' in the specified entity record.
The following elements are required:
| itemSubtypeKey | (string) The key for the Item Subtype. |
| 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 FiscalClassification ItemSubtype
Updates the value of attribute 'FiscalClassification' in the specified entity record.
The following elements are required:
| itemSubtypeKey | (string) The key for the Item Subtype. |
| 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 ItemSubtype
Updates the value of attribute 'IsActive' in the specified entity record.
The following elements are required:
| itemSubtypeKey | (string) The key for the Item Subtype. |
| 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 ItemSubtypeKey ItemSubtype
Updates the value of attribute 'ItemSubtypeKey' in the specified entity record.
The following elements are required:
| itemSubtypeKey | (string) The key for the Item Subtype. |
| 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 ItemSubtype 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 ItemSubtype by key
Deletes the entity record that matches the specified key.
The following elements are required:
| itemSubtypeKey | (string) The key for the Item Subtype. |
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
ApiItemSubtypeResource
The following elements are required:
| itemSubtypeKey | (string) The key for the Item Subtype. |
The following elements are optional:
| description | (string) The description for the Item Subtype. |
| fiscalClassification | (string) The Fiscal Classification for the Item Subtype. |
ItemSubtypeResource
The following elements are required:
| itemSubtypeKey | (string) The key for the Item Subtype. |
The following elements are optional:
| description | (string) The description for the Item Subtype. |
| fiscalClassification | (string) The Fiscal Classification for the Item Subtype.
(fk) Allowed value: the natural key of a record of type FiscalClassification. These records are accessibly through the FiscalClassifications service. |