Valuekeep Developers - Web API Reference

Parts and Inventory | Part Subtype

Service to manage entities of type 'PartSubType'.

Overview


URL api/{tenantKey}/{orgKey}/inventoryCore/partSubTypes
Methods Supported GET, POST, PUT, DELETE

All Operations

This service includes the following operations:

All Resources

This service uses the following resources:

GET Operations

GET PartSubTypes (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 PartSubTypeResource.

Response status codes:

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

Resource URL:

GET /inventoryCore/partSubTypes/odata

GET PartSubType 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 PartSubTypeResource.

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

GET PartSubType by key

Returns the entity record that matches the specified key.

The following elements are required:

partSubTypeKey (string) The key for the Part Subtype.

Response:

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

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 /inventoryCore/partSubTypes/{partSubTypeKey}

POST Operations

POST PartSubTypes

Creates a new entity record.

The following elements are required:

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

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

Response status codes:

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

Resource URL:

POST /inventoryCore/partSubTypes

PUT Operations

PUT Set Description PartSubType

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

The following elements are required:

partSubTypeKey (string) The key for the Part 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 /inventoryCore/partSubTypes/{partSubTypeKey}/description

PUT Set IsActive PartSubType

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

The following elements are required:

partSubTypeKey (string) The key for the Part 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 /inventoryCore/partSubTypes/{partSubTypeKey}/isActive

PUT Set PartSubTypeKey PartSubType

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

The following elements are required:

partSubTypeKey (string) The key for the Part 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 /inventoryCore/partSubTypes/{partSubTypeKey}/partSubTypeKey

PUT Set Custom Attribute PartSubType

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

The following elements are required:

partSubTypeKey (string) The key for the Part Subtype.
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:

PUT /inventoryCore/partSubTypes/{partSubTypeKey}/{customAttributeName}

DELETE Operations

DELETE PartSubType 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 /inventoryCore/partSubTypes/{id}

DELETE PartSubType by key

Deletes the entity record that matches the specified key.

The following elements are required:

partSubTypeKey (string) The key for the Part 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:

DELETE /inventoryCore/partSubTypes/{partSubTypeKey}

Resources


ApiPartSubTypeResource

The following elements are required:

partSubTypeKey (string) The key for the Part Subtype.

The following elements are optional:

description (string) The description for the Part Subtype.


PartSubTypeResource

The following elements are required:

partSubTypeKey (string) The key for the Part Subtype.

The following elements are optional:

description (string) The description for the Part Subtype.


ExtensibilityCustomAttributeValueResource

The following elements are required:

value (object) The custom attribute value.