Business Core | Part

Service to manage entities of type 'Part'.

Overview

api/{tenantKey}/{orgKey}/businessCore/parts

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

All Operations

This service includes the following operations:

GET:
POST:
PUT:
DELETE:
- DELETE Part by identifier
- DELETE Part by key

All Resources

This service uses the following resources:

ApiPartResource
PartResource
ExtensibilityCustomAttributeValueResource

All Enumerations

This service uses the following enumerations:

PartType

GET Operations

GET Parts (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 PartResource.

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/businessCore/parts/odata

GET /businessCore/parts/odata

GET Part 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 PartResource.

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

GET /businessCore/parts/{id}

GET Part by key

Returns the entity record that matches the specified key.

The following elements are required:

partKey

(string) The key for the part. Uniquely identifies the part within the organization.

Response:

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

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/parts/{partKey}

GET /businessCore/parts/{partKey}

GET Part Image.

Returns the value of attribute 'Image' of the specified entity record.

The following elements are required:

id	(string) The record identifier.
fileName	(string) The file name.

Response:

When successful, the response is a stream with the image 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/parts/{id}/image

GET /businessCore/parts/{id}/image

POST Operations

POST Parts

Creates a new entity record.

The following elements are required:

partResource

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

The following elements are optional:

customAttributes

(JSON Document) A key-value pair in JSON format that represents the extensibility custom attributes for this entity.
The key should be the custom attribute name prefixed with "custom_", e.g. "custom_attributeName".
While the "customAttributes" element is optional, please notice that specific custom attributes might be marked as required.

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

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/businessCore/parts

POST /businessCore/parts

POST Build Part

Custom operation 'BuildPart'.

The following elements are optional:

customAttributes

(JSON Document) A key-value pair in JSON format that represents the extensibility custom attributes for this entity.
The key should be the custom attribute name prefixed with "custom_", e.g. "custom_attributeName".
While the "customAttributes" element is optional, please notice that specific custom attributes might be marked as required.

Response:

When successful, the response body contains a resource of type 'PartResource'. See PartResource.

Resource URL:

api/{tenantKey}/{orgKey}/businessCore/parts/buildPart

POST /businessCore/parts/buildPart

POST AddDependent

Custom operation 'AddDependent'.

The following elements are required:

partId

(Guid) PartId.

The following elements are optional:

customAttributes

(JSON Document) A key-value pair in JSON format that represents the extensibility custom attributes for this entity.
The key should be the custom attribute name prefixed with "custom_", e.g. "custom_attributeName".
While the "customAttributes" element is optional, please notice that specific custom attributes might be marked as required.

Response:

When successful, the response body contains an item of type 'boolean'.

Resource URL:

api/{tenantKey}/{orgKey}/businessCore/parts/addDependent

POST /businessCore/parts/addDependent

PUT Operations

PUT Set Attribute Part

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

The following elements are required:

partKey	(string) The key for the part. Uniquely identifies the part within the organization.
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/parts/{partKey}/attribute

PUT /businessCore/parts/{partKey}/attribute

PUT Set Barcode Part

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

The following elements are required:

partKey	(string) The key for the part. Uniquely identifies the part within the organization.
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/parts/{partKey}/barcode

PUT /businessCore/parts/{partKey}/barcode

PUT Set BaseUnit Part

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

The following elements are required:

partKey	(string) The key for the part. Uniquely identifies the part within the organization.
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/parts/{partKey}/baseUnit

PUT /businessCore/parts/{partKey}/baseUnit

PUT Set Brand Part

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

The following elements are required:

partKey	(string) The key for the part. Uniquely identifies the part within the organization.
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/parts/{partKey}/brand

PUT /businessCore/parts/{partKey}/brand

PUT Set BrandModel Part

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

The following elements are required:

partKey	(string) The key for the part. Uniquely identifies the part within the organization.
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/parts/{partKey}/brandModel

PUT /businessCore/parts/{partKey}/brandModel

PUT Set ComplementaryDescription Part

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

The following elements are required:

partKey	(string) The key for the part. Uniquely identifies the part within the organization.
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/parts/{partKey}/complementaryDescription

PUT /businessCore/parts/{partKey}/complementaryDescription

PUT Set Description Part

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

The following elements are required:

partKey	(string) The key for the part. Uniquely identifies the part within the organization.
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/parts/{partKey}/description

PUT /businessCore/parts/{partKey}/description

PUT Set Family Part

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

The following elements are required:

partKey	(string) The key for the part. Uniquely identifies the part within the organization.
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/parts/{partKey}/family

PUT /businessCore/parts/{partKey}/family

PUT Set HaveDependents Part

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

The following elements are required:

partKey	(string) The key for the part. Uniquely identifies the part within the organization.
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.

Resource URL:

api/{tenantKey}/{orgKey}/businessCore/parts/{partKey}/haveDependents

PUT /businessCore/parts/{partKey}/haveDependents

PUT Set Image Part

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

The following elements are required:

partKey	(string) The key for the part. Uniquely identifies the part within the organization.
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/parts/{partKey}/image

PUT /businessCore/parts/{partKey}/image

PUT Set IsActive Part

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

The following elements are required:

partKey	(string) The key for the part. Uniquely identifies the part within the organization.
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/parts/{partKey}/isActive

PUT /businessCore/parts/{partKey}/isActive

PUT Set Keyword Part

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

The following elements are required:

partKey	(string) The key for the part. Uniquely identifies the part within the organization.
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/parts/{partKey}/keyword

PUT /businessCore/parts/{partKey}/keyword

PUT Set PartKey Part

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

The following elements are required:

partKey	(string) The key for the part. Uniquely identifies the part within the organization.
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/parts/{partKey}/partKey

PUT /businessCore/parts/{partKey}/partKey

PUT Set PartType Part

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

The following elements are required:

partKey	(string) The key for the part. Uniquely identifies the part within the organization.
value	(enum PartType) The request body should contain the new value for the attribute. See PartType.

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/parts/{partKey}/partType

PUT /businessCore/parts/{partKey}/partType

PUT Set Remarks Part

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

The following elements are required:

partKey	(string) The key for the part. Uniquely identifies the part within the organization.
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/parts/{partKey}/remarks

PUT /businessCore/parts/{partKey}/remarks

PUT Set Supplier Part

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

The following elements are required:

partKey	(string) The key for the part. Uniquely identifies the part within the organization.
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/parts/{partKey}/supplier

PUT /businessCore/parts/{partKey}/supplier

PUT Set Custom Attribute Part

Updates the value of 'CustomAttribute' in the specified entity record.

The following elements are required:

partKey	(string) The key for the part. Uniquely identifies the part within the organization.
customAttributeName	(string) The custom attribute name.
value	(ExtensibilityCustomAttributeValueResource) The request body should contain the new value for the custom attribute. See ExtensibilityCustomAttributeValueResource.

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/parts/{partKey}/{customAttributeName}

PUT /businessCore/parts/{partKey}/{customAttributeName}

DELETE Operations

DELETE Part 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/parts/{id}

DELETE /businessCore/parts/{id}

DELETE Part by key

Deletes the entity record that matches the specified key.

The following elements are required:

partKey

(string) The key for the part. Uniquely identifies the part within the organization.

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/parts/{partKey}

DELETE /businessCore/parts/{partKey}

Resources

ApiPartResource

The following elements are required:

partKey	(string) The key for the part. Uniquely identifies the part within the organization.
description	(string) The description for the part.
isExternallyManaged	(bool) A flag indicating if the part is externally managed.
baseUnit	(string) The base unit for the part.
partType	(enum PartType) The part type for the part. See PartType.
haveDependents	(bool) Have Dependents.

The following elements are optional:

complementaryDescription	(string) The extended description for the part.
keyword	(string) Keyword.
family	(string) The assortment for the part.
barcode	(string) The barcode for the part.
brand	(string) The brand for the part.
image	(string) The picture for the part.
remarks	(string) The remarks for the part.
externalId	(string) The external identifier for the part.
externalVersion	(string) The external version for the part.
brandModel	(string) The brand model for the part.
supplier	(string) Supplier.
attribute	(string) Attribute.

PartResource

The following elements are required:

partKey	(string) The key for the part. Uniquely identifies the part within the organization.
description	(string) The description for the part.
isExternallyManaged	(bool) A flag indicating if the part is externally managed.
baseUnit	(string) The base unit for the part.
partType	(enum PartType) The part type for the part. See PartType.
haveDependents	(bool) Have Dependents.

The following elements are optional:

complementaryDescription	(string) The extended description for the part.
keyword	(string) Keyword.
family	(string) The assortment for the part.
barcode	(string) The barcode for the part.
brand	(string) The brand for the part.
image	(string) The picture for the part.
remarks	(string) The remarks for the part.
externalId	(string) The external identifier for the part.
externalVersion	(string) The external version for the part.
brandModel	(string) The brand model for the part.
supplier	(string) Supplier.
attribute	(string) Attribute.

ExtensibilityCustomAttributeValueResource

The following elements are required:

value

(object) The custom attribute value.

Enumerations

PartType

1	Part
2	Service