Valuekeep Developers - Web API Reference

Parts and Inventory | Part Issue Historic

Service to manage entities of type 'PartIssueHistoric'.

Overview


URL api/{tenantKey}/{orgKey}/inventoryManagement/partIssueHistorics
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 PartIssueHistorics (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 PartIssueHistoricResource.

Response status codes:

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

Resource URL:

GET /inventoryManagement/partIssueHistorics/odata

GET PartIssueHistoric 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 PartIssueHistoricResource.

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

GET PartIssueHistoric by key

Returns the entity record that matches the specified key.

The following elements are required:

companyKey (string) The company key.
partIssue (string) Part Issue.

Response:

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

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 /inventoryManagement/partIssueHistorics/{companyKey}/{partIssue}

POST Operations

POST PartIssueHistorics

Creates a new entity record.

The following elements are required:

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

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

Response status codes:

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

Resource URL:

POST /inventoryManagement/partIssueHistorics

PUT Operations

PUT Set Company PartIssueHistoric

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

The following elements are required:

partIssue (string) Part Issue.
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 /inventoryManagement/partIssueHistorics/{companyKey}/{partIssue}/company

PUT Set IsActive PartIssueHistoric

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

The following elements are required:

partIssue (string) Part Issue.
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 /inventoryManagement/partIssueHistorics/{companyKey}/{partIssue}/isActive

PUT Set PartEntrie PartIssueHistoric

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

The following elements are required:

partIssue (string) Part Issue.
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 /inventoryManagement/partIssueHistorics/{companyKey}/{partIssue}/partEntrie

PUT Set PartIssue PartIssueHistoric

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

The following elements are required:

partIssue (string) Part Issue.
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 /inventoryManagement/partIssueHistorics/{companyKey}/{partIssue}/partIssue

PUT Set WorkOrderReportConsumption PartIssueHistoric

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

The following elements are required:

partIssue (string) Part Issue.
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 /inventoryManagement/partIssueHistorics/{companyKey}/{partIssue}/workOrderReportConsumption

PUT Set Custom Attribute PartIssueHistoric

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

The following elements are required:

companyKey (string) The company key.
partIssue (string) Part Issue
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 /inventoryManagement/partIssueHistorics/{companyKey}/{partIssue}/{customAttributeName}

DELETE Operations

DELETE PartIssueHistoric 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 /inventoryManagement/partIssueHistorics/{id}

DELETE PartIssueHistoric by key

Deletes the entity record that matches the specified key.

The following elements are required:

companyKey (string) The company key.
partIssue (string) Part Issue.

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 /inventoryManagement/partIssueHistorics/{companyKey}/{partIssue}

Resources


ApiPartIssueHistoricResource

The following elements are required:

partIssue (string) Part Issue.
company (string) Company.

The following elements are optional:

workOrderReportConsumption (string) Work Order Report Consumption.
partEntrie (string) Part Entrie.


PartIssueHistoricResource

The following elements are required:

partIssue (string) Part Issue.
(fk) Allowed value: the natural key of a record of type PartIssue. These records are accessibly through the PartIssues service.
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:

workOrderReportConsumption (string) Work Order Report Consumption.
(fk) Allowed value: the natural key of a record of type WorkOrderReportConsumption. These records are accessibly through the WorkOrderReportConsumptions service.
partEntrie (string) Part Entrie.
(fk) Allowed value: the natural key of a record of type PartEntrie. These records are accessibly through the PartEntries service.


ExtensibilityCustomAttributeValueResource

The following elements are required:

value (object) The custom attribute value.