Valuekeep Developers - Web API Reference

Parts and Inventory | Document Type

Service to manage entities of type 'DocumentType'.

Overview


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

All Operations

This service includes the following operations:

All Resources

This service uses the following resources:

All Enumerations

This service uses the following enumerations:

GET Operations

GET DocumentTypes (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 DocumentTypeResource.

Response status codes:

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

Resource URL:

GET /inventoryCore/documentTypes/odata

GET DocumentType 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 DocumentTypeResource.

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

GET DocumentType by key

Returns the entity record that matches the specified key.

The following elements are required:

companyKey (string) The company key.
documentTypeKey (string) Document Type.

Response:

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

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/documentTypes/{companyKey}/{documentTypeKey}

POST Operations

POST DocumentTypes

Creates a new entity record.

The following elements are required:

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

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

Response status codes:

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

Resource URL:

POST /inventoryCore/documentTypes

PUT Operations

PUT Set Company DocumentType

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

The following elements are required:

documentTypeKey (string) Document Type.
companyKey (string) The company key.
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/documentTypes/{companyKey}/{documentTypeKey}/company

PUT Set Description DocumentType

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

The following elements are required:

documentTypeKey (string) Document Type.
companyKey (string) The company key.
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/documentTypes/{companyKey}/{documentTypeKey}/description

PUT Set DocumentTypeKey DocumentType

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

The following elements are required:

documentTypeKey (string) Document Type.
companyKey (string) The company key.
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/documentTypes/{companyKey}/{documentTypeKey}/documentTypeKey

PUT Set IsActive DocumentType

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

The following elements are required:

documentTypeKey (string) Document Type.
companyKey (string) The company key.
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/documentTypes/{companyKey}/{documentTypeKey}/isActive

PUT Set IsDefault DocumentType

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

The following elements are required:

documentTypeKey (string) Document Type.
companyKey (string) The company key.
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:

PUT /inventoryCore/documentTypes/{companyKey}/{documentTypeKey}/isDefault

PUT Set Remarks DocumentType

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

The following elements are required:

documentTypeKey (string) Document Type.
companyKey (string) The company key.
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/documentTypes/{companyKey}/{documentTypeKey}/remarks

PUT Set Type DocumentType

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

The following elements are required:

documentTypeKey (string) Document Type.
companyKey (string) The company key.
value (enum PartDocumentType) The request body should contain the new value for the attribute.
See PartDocumentType.

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/documentTypes/{companyKey}/{documentTypeKey}/type

PUT Set Custom Attribute DocumentType

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

The following elements are required:

companyKey (string) The company key.
documentTypeKey (string) Document Type
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/documentTypes/{companyKey}/{documentTypeKey}/{customAttributeName}

DELETE Operations

DELETE DocumentType 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/documentTypes/{id}

DELETE DocumentType by key

Deletes the entity record that matches the specified key.

The following elements are required:

companyKey (string) The company key.
documentTypeKey (string) Document Type.

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/documentTypes/{companyKey}/{documentTypeKey}

Resources


ApiDocumentTypeResource

The following elements are required:

documentTypeKey (string) Document Type.
description (string) Description.
isDefault (bool) Is Default.
company (string) Company.

The following elements are optional:

type (enum PartDocumentType) Type.
See PartDocumentType.
remarks (string) Remarks.


DocumentTypeResource

The following elements are required:

documentTypeKey (string) Document Type.
description (string) Description.
isDefault (bool) Is Default.
company (string) Company.
(fk) Allowed value: the natural key of a record of type Company. These records are accessibly through the Companies service.

The following elements are optional:

type (enum PartDocumentType) Type.
See PartDocumentType.
remarks (string) Remarks.


ExtensibilityCustomAttributeValueResource

The following elements are required:

value (object) The custom attribute value.

Enumerations


PartDocumentType

1 Entrie
2 Issue