Materials Management | Item Subtype

Service to manage entities of type 'ItemSubType'.

Overview

api/{tenantKey}/{orgKey}/materialsCore/itemSubtypes

URL	api/{tenantKey}/{orgKey}/materialsCore/itemSubtypes
Methods Supported	GET, POST, PUT, DELETE

All Operations

This service includes the following operations:

GET:
POST:
- POST ItemSubtypes
PUT:
DELETE:
- DELETE ItemSubtype by identifier
- DELETE ItemSubtype by key

All Resources

This service uses the following resources:

ApiItemSubtypeResource
ItemSubtypeResource

GET Operations

GET ItemSubtypes

Returns the list of all the entity records available.

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:

api/{tenantKey}/{orgKey}/materialsCore/itemSubtypes

GET /materialsCore/itemSubtypes

GET ItemSubtypes (paged)

Returns a page of the list of all the entity records available.

The following elements are optional:

page	(int) The index of the page of the list that should be returned. This is a query string parameter.
pageSize	(int) The number of page elements that should be returned (max. is 1000). This is a query string parameter.

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:

api/{tenantKey}/{orgKey}/materialsCore/itemSubtypes?page={page}&pageSize={pageSize}

GET /materialsCore/itemSubtypes?page={page}&pageSize={pageSize}

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:

api/{tenantKey}/{orgKey}/materialsCore/itemSubtypes/{id}

GET /materialsCore/itemSubtypes/{id}

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:

api/{tenantKey}/{orgKey}/materialsCore/itemSubtypes/{itemSubtypeKey}

GET /materialsCore/itemSubtypes/{itemSubtypeKey}

GET Print ItemSubtype by identifier

Prints the specified entity record.

The following elements are required:

id	(string) The record identifier.

The following elements are optional:

template

(string) The report template that should be used. This is a query string parameter.

Response:

When successful, the response body contains a stream with the printed file.

Response status codes:

200	OK. The operation was completed successfully.
404	NotFound. The specified resord does not exist.

Resource URL:

api/{tenantKey}/{orgKey}/materialsCore/itemSubtypes/{id}/print?template={template}

GET /materialsCore/itemSubtypes/{id}/print?template={template}

GET Print ItemSubtype by key

Prints the specified entity record.

The following elements are required:

itemSubtypeKey

(string) The key for the Item Subtype.

The following elements are optional:

template

(string) The report template that should be used. This is a query string parameter.

Response:

When successful, the response body contains a stream with the printed file.

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:

api/{tenantKey}/{orgKey}/materialsCore/itemSubtypes/{itemSubtypeKey}/print

GET /materialsCore/itemSubtypes/{itemSubtypeKey}/print

GET Original Print ItemSubtypeOriginal by identifier

Prints the specified entity record.

The following elements are required:

id	(string) The record identifier.

The following elements are optional:

template

(string) The report template that should be used. This is a query string parameter.

Response:

When successful, the response body contains a stream with the printed file.

Response status codes:

200	OK. The operation was completed successfully.
404	NotFound. The specified resord does not exist.

Resource URL:

api/{tenantKey}/{orgKey}/materialsCore/itemSubtypes/{id}/printOriginal?template={template}

GET /materialsCore/itemSubtypes/{id}/printOriginal?template={template}

GET Original Print ItemSubtype by key

Prints the specified entity record.

The following elements are required:

itemSubtypeKey

(string) The key for the Item Subtype.

The following elements are optional:

template

(string) The report template that should be used. This is a query string parameter.

Response:

When successful, the response body contains a stream with the printed file.

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:

api/{tenantKey}/{orgKey}/materialsCore/itemSubtypes/{itemSubtypeKey}/printOriginal

GET /materialsCore/itemSubtypes/{itemSubtypeKey}/printOriginal

POST Operations

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:

api/{tenantKey}/{orgKey}/materialsCore/itemSubtypes

POST /materialsCore/itemSubtypes

PUT Operations

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:

api/{tenantKey}/{orgKey}/materialsCore/itemSubtypes/{itemSubtypeKey}/description

PUT /materialsCore/itemSubtypes/{itemSubtypeKey}/description

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:

api/{tenantKey}/{orgKey}/materialsCore/itemSubtypes/{itemSubtypeKey}/fiscalClassification

PUT /materialsCore/itemSubtypes/{itemSubtypeKey}/fiscalClassification

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:

api/{tenantKey}/{orgKey}/materialsCore/itemSubtypes/{itemSubtypeKey}/isActive

PUT /materialsCore/itemSubtypes/{itemSubtypeKey}/isActive

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:

api/{tenantKey}/{orgKey}/materialsCore/itemSubtypes/{itemSubtypeKey}/itemSubtypeKey

PUT /materialsCore/itemSubtypes/{itemSubtypeKey}/itemSubtypeKey

DELETE Operations

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:

api/{tenantKey}/{orgKey}/materialsCore/itemSubtypes/{id}

DELETE /materialsCore/itemSubtypes/{id}

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:

api/{tenantKey}/{orgKey}/materialsCore/itemSubtypes/{itemSubtypeKey}

DELETE /materialsCore/itemSubtypes/{itemSubtypeKey}

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.