Master Data Business Entities | Item Set

An Item Set represents a set of items related to one or more companies.

Overview

api/{tenantKey}/{orgKey}/businessCore/itemSets

URL	api/{tenantKey}/{orgKey}/businessCore/itemSets
Methods Supported	GET, POST, PUT, DELETE

All Operations

This service includes the following operations:

GET:
POST:
- POST ItemSets
- POST Item Set
PUT:
DELETE:

All Resources

This service uses the following resources:

ApiItemSetItemSetCompaniesResource
ApiItemSetResource
ItemSetCompanyResource
ItemSetResource

GET Operations

GET ItemSets

Returns the list of all the entity records available.

Response:

When successful, the response body contains the list of records available. See ItemSetResource.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/businessCore/itemSets

GET /businessCore/itemSets

GET ItemSets (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 ItemSetResource.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/businessCore/itemSets?page={page}&pageSize={pageSize}

GET /businessCore/itemSets?page={page}&pageSize={pageSize}

GET ItemSet 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 ItemSetResource.

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}/businessCore/itemSets/{id}

GET /businessCore/itemSets/{id}

GET ItemSet by key

Returns the entity record that matches the specified key.

The following elements are required:

itemSetKey

(string) The key for the Item Set.

Response:

When successful, the response body contains the entity record. See ItemSetResource.

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}/businessCore/itemSets/{itemSetKey}

GET /businessCore/itemSets/{itemSetKey}

GET Print ItemSet 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}/businessCore/itemSets/{id}/print?template={template}

GET /businessCore/itemSets/{id}/print?template={template}

GET Print ItemSet by key

Prints the specified entity record.

The following elements are required:

itemSetKey

(string) The key for the Item Set.

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}/businessCore/itemSets/{itemSetKey}/print

GET /businessCore/itemSets/{itemSetKey}/print

GET Original Print ItemSetOriginal 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}/businessCore/itemSets/{id}/printOriginal?template={template}

GET /businessCore/itemSets/{id}/printOriginal?template={template}

GET Original Print ItemSet by key

Prints the specified entity record.

The following elements are required:

itemSetKey

(string) The key for the Item Set.

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}/businessCore/itemSets/{itemSetKey}/printOriginal

GET /businessCore/itemSets/{itemSetKey}/printOriginal

POST Operations

POST ItemSets

Creates a new entity record.

The following elements are required:

itemSetResource

(ApiItemSetResource) The request body should contain the entity record that should be created.
See ApiItemSetResource.

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 ApiItemSetResource.

Response status codes:

201	Created. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/businessCore/itemSets

POST /businessCore/itemSets

POST Item Set

Inserts a new 'Item Set Company' in the 'Item Set'.

The following elements are required:

itemSetKey	(string) The key for the Item Set.
value	(ApiItemSetItemSetCompaniesResource) The ApiItemSetItemSetCompaniesResource instance. See ApiItemSetItemSetCompaniesResource.

Response:

When successful, the response body is empty.

Response status codes:

204	NoContent. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/businessCore/itemSets/{itemSetKey}/itemSetCompanies

POST /businessCore/itemSets/{itemSetKey}/itemSetCompanies

PUT Operations

PUT Set Company ItemSetCompany

Updates the value of attribute 'Company' in the specified entity record.

The following elements are required:

itemSetKey	(string) The key for the Item Set.
lineId	(string) The detail identifier.
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}/businessCore/itemSets/{itemSetKey}/itemSetCompanies/{lineId}/company

PUT /businessCore/itemSets/{itemSetKey}/itemSetCompanies/{lineId}/company

PUT Set Description ItemSet

Updates the value of attribute 'Description' in the specified entity record.

The following elements are required:

itemSetKey	(string) The key for the Item Set.
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}/businessCore/itemSets/{itemSetKey}/description

PUT /businessCore/itemSets/{itemSetKey}/description

PUT Set IsActive ItemSet

Updates the value of attribute 'IsActive' in the specified entity record.

The following elements are required:

itemSetKey	(string) The key for the Item Set.
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}/businessCore/itemSets/{itemSetKey}/isActive

PUT /businessCore/itemSets/{itemSetKey}/isActive

PUT Set ItemSetKey ItemSet

Updates the value of attribute 'ItemSetKey' in the specified entity record.

The following elements are required:

itemSetKey	(string) The key for the Item Set.
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}/businessCore/itemSets/{itemSetKey}/itemSetKey

PUT /businessCore/itemSets/{itemSetKey}/itemSetKey

DELETE Operations

DELETE Item Set Company by identifier

Deletes the entity record that matches the specified identifier.

The following elements are required:

itemSetKey	(string) The key for the Item Set.
lineId	(string) The line identifier.

Response:

When successful, the response body is empty.

Response status codes:

204	NoContent. 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}/businessCore/itemSets/{itemSetKey}/itemSetCompanies/{lineId}

DELETE /businessCore/itemSets/{itemSetKey}/itemSetCompanies/{lineId}

DELETE ItemSet 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}/businessCore/itemSets/{id}

DELETE /businessCore/itemSets/{id}

DELETE ItemSet by key

Deletes the entity record that matches the specified key.

The following elements are required:

itemSetKey

(string) The key for the Item Set.

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}/businessCore/itemSets/{itemSetKey}

DELETE /businessCore/itemSets/{itemSetKey}

Resources

ApiItemSetItemSetCompaniesResource

The following elements are required:

company

(string) The company that is associated with the item set.

ApiItemSetResource

The following elements are required:

itemSetKey

(string) The key for the Item Set.

The following elements are optional:

description	(string) The description for the Item Set.
itemSetCompanies	(List of ApiItemSetItemSetCompaniesResource) Set of companies that use the item set. See ApiItemSetItemSetCompaniesResource.

ItemSetCompanyResource

The following elements are required:

company

(string) The company that is associated with the item set.

ItemSetResource

The following elements are required:

itemSetKey

(string) The key for the Item Set.

The following elements are optional:

description	(string) The description for the Item Set.
itemSetCompanies	(List of ItemSetCompanyResource) Set of companies that use the item set. See ItemSetCompanyResource.