Valuekeep Developers - Web API Reference

Requisitions | Requisition

Service to manage entities of type 'Requisition'.

Overview


URL api/{tenantKey}/{orgKey}/requisitions/requisitions
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 Requisitions (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 RequisitionResource.

Response status codes:

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

Resource URL:

GET /requisitions/requisitions/odata

GET Requisition 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 RequisitionResource.

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

GET Requisition by key

Returns the entity record that matches the specified key.

The following elements are required:

companyKey (string) The company key.
requisitionKey (string) Requisition.

Response:

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

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 /requisitions/requisitions/{companyKey}/{requisitionKey}

POST Operations

POST Requisitions

Creates a new entity record.

The following elements are required:

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

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

Response status codes:

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

Resource URL:

POST /requisitions/requisitions

POST Add WorkOrders by keys

Adds the specified 'WorkOrders' to the 'Requisition' (by specifying its keys).

The following elements are required:

requisitionKey (string) Requisition.
value (Array of string) A list of record keys to be added.

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 is empty.

Response status codes:

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

Resource URL:

POST /requisitions/requisitions/{requisitionKey}/workorders/add

POST Add WorkOrders by identifiers

Adds the specified 'WorkOrders' to the 'Requisition' (by specifying its identifiers).

The following elements are required:

requisitionKey (string) Requisition.
value (Array of string) A list of record identifiers to be added.

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 is empty.

Response status codes:

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

Resource URL:

POST /requisitions/requisitions/{requisitionKey}/workorders/addById

POST Remove WorkOrders by keys

Removes the specified 'WorkOrders' to the 'Requisition' (by specifying its keys).

The following elements are required:

requisitionKey (string) Requisition.
value (Array of string) A list of record keys to be removed.

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 is empty.

Response status codes:

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

Resource URL:

POST /requisitions/requisitions/{requisitionKey}/workorders/remove

POST Remove WorkOrders by identifiers

Removes the specified 'WorkOrders' to the 'Requisition' (by specifying its identifiers).

The following elements are required:

requisitionKey (string) Requisition.
value (Array of string) A list of record identifiers to be removed.

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 is empty.

Response status codes:

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

Resource URL:

POST /requisitions/requisitions/{requisitionKey}/workorders/removeById

POST Requisition Part

Inserts a new 'Requisition Part' in the 'Requisition'.

The following elements are required:

requisitionKey (string) Requisition.
companyKey (string) The company key.
value (ApiRequisitionRequisitionPartsResource) The ApiRequisitionRequisitionPartsResource instance.
See ApiRequisitionRequisitionPartsResource.

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 is empty.

Response status codes:

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

Resource URL:

POST /requisitions/requisitions/{companyKey}/{requisitionKey}/requisitionParts

POST Change Schema Entity State

Custom operation 'ChangeSchemaEntityState'.

The following elements are required:

companyKey (string) CompanyKey.
requisitionKey (string) RequisitionKey.
schemaEntityStateKey (string) SchemaEntityStateKey.
schemaEntityStateTransition (ChangeSchemaEntityStateParamsResource) SchemaEntityStateTransition.
isManager (bool) IsManager.

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 'RequisitionResource'. See RequisitionResource.

Resource URL:

POST /requisitions/requisitions/changeSchemaEntityState/{companyKey}/{requisitionKey}/{schemaEntityStateKey}

PUT Operations

PUT Set AllowCreateStockEntry Requisition

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

The following elements are required:

requisitionKey (string) Requisition.
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 /requisitions/requisitions/{companyKey}/{requisitionKey}/allowCreateStockEntry

PUT Set Company Requisition

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

The following elements are required:

requisitionKey (string) Requisition.
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 /requisitions/requisitions/{companyKey}/{requisitionKey}/company

PUT Set Date Requisition

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

The following elements are required:

requisitionKey (string) Requisition.
companyKey (string) The company key.
value (DateTimeOffset) 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 /requisitions/requisitions/{companyKey}/{requisitionKey}/date

PUT Set Description Requisition

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

The following elements are required:

requisitionKey (string) Requisition.
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 /requisitions/requisitions/{companyKey}/{requisitionKey}/description

PUT Set IsActive Requisition

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

The following elements are required:

requisitionKey (string) Requisition.
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 /requisitions/requisitions/{companyKey}/{requisitionKey}/isActive

PUT Set IsLocked Requisition

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

The following elements are required:

requisitionKey (string) Requisition.
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 /requisitions/requisitions/{companyKey}/{requisitionKey}/isLocked

PUT Set IsTechnician Requisition

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

The following elements are required:

requisitionKey (string) Requisition.
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 /requisitions/requisitions/{companyKey}/{requisitionKey}/isTechnician

PUT Set IsWorkManager Requisition

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

The following elements are required:

requisitionKey (string) Requisition.
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 /requisitions/requisitions/{companyKey}/{requisitionKey}/isWorkManager

PUT Set NewStateId Requisition

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

The following elements are required:

requisitionKey (string) Requisition.
companyKey (string) The company key.
value (Guid) 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 /requisitions/requisitions/{companyKey}/{requisitionKey}/newStateId

PUT Set Part RequisitionPart

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

The following elements are required:

requisitionKey (string) Requisition.
lineId (string) The detail identifier.
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 /requisitions/requisitions/{companyKey}/{requisitionKey}/requisitionParts/{lineId}/part

PUT Set PreviousStateId Requisition

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

The following elements are required:

requisitionKey (string) Requisition.
companyKey (string) The company key.
value (Guid) 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 /requisitions/requisitions/{companyKey}/{requisitionKey}/previousStateId

PUT Set Quantity RequisitionPart

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

The following elements are required:

requisitionKey (string) Requisition.
lineId (string) The detail identifier.
companyKey (string) The company key.
value (decimal) 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 /requisitions/requisitions/{companyKey}/{requisitionKey}/requisitionParts/{lineId}/quantity

PUT Set Remarks Requisition

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

The following elements are required:

requisitionKey (string) Requisition.
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 /requisitions/requisitions/{companyKey}/{requisitionKey}/remarks

PUT Set Remarks RequisitionPart

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

The following elements are required:

requisitionKey (string) Requisition.
lineId (string) The detail identifier.
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 /requisitions/requisitions/{companyKey}/{requisitionKey}/requisitionParts/{lineId}/remarks

PUT Set RequestedBy Requisition

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

The following elements are required:

requisitionKey (string) Requisition.
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 /requisitions/requisitions/{companyKey}/{requisitionKey}/requestedBy

PUT Set RequisitionKey Requisition

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

The following elements are required:

requisitionKey (string) Requisition.
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 /requisitions/requisitions/{companyKey}/{requisitionKey}/requisitionKey

PUT Set RequisitionType Requisition

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

The following elements are required:

requisitionKey (string) Requisition.
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 /requisitions/requisitions/{companyKey}/{requisitionKey}/requisitionType

PUT Set SchemaEntityState Requisition

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

The following elements are required:

requisitionKey (string) Requisition.
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 /requisitions/requisitions/{companyKey}/{requisitionKey}/schemaEntityState

PUT Set TemplateParameters Requisition

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

The following elements are required:

requisitionKey (string) Requisition.
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 /requisitions/requisitions/{companyKey}/{requisitionKey}/templateParameters

PUT Set TriggerStateId Requisition

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

The following elements are required:

requisitionKey (string) Requisition.
companyKey (string) The company key.
value (Guid) 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 /requisitions/requisitions/{companyKey}/{requisitionKey}/triggerStateId

PUT Set Unit RequisitionPart

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

The following elements are required:

requisitionKey (string) Requisition.
lineId (string) The detail identifier.
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 /requisitions/requisitions/{companyKey}/{requisitionKey}/requisitionParts/{lineId}/unit

PUT Set Warehouse RequisitionPart

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

The following elements are required:

requisitionKey (string) Requisition.
lineId (string) The detail identifier.
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 /requisitions/requisitions/{companyKey}/{requisitionKey}/requisitionParts/{lineId}/warehouse

PUT Set WorkOrders Requisition

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

The following elements are required:

requisitionKey (string) Requisition.
companyKey (string) The company key.
value (WorkOrder) 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 /requisitions/requisitions/{companyKey}/{requisitionKey}/workOrders

PUT Set Custom Attribute Requisition

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

The following elements are required:

companyKey (string) The company key.
requisitionKey (string) Requisition
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 /requisitions/requisitions/{companyKey}/{requisitionKey}/{customAttributeName}

PUT Set Custom Attribute RequisitionPart

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

The following elements are required:

companyKey (string) The company key.
requisitionKey (string) Requisition
lineId (string) The detail identifier.
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 /requisitions/requisitions/{companyKey}/{requisitionKey}/requisitionParts/{lineId}/{customAttributeName}

DELETE Operations

DELETE Requisition Part by identifier

Deletes the entity record that matches the specified identifier.

The following elements are required:

requisitionKey (string) Requisition.
companyKey (string) The company key.
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:

DELETE /requisitions/requisitions/{companyKey}/{requisitionKey}/requisitionParts/{lineId}

DELETE Requisition 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 /requisitions/requisitions/{id}

DELETE Requisition by key

Deletes the entity record that matches the specified key.

The following elements are required:

companyKey (string) The company key.
requisitionKey (string) Requisition.

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 /requisitions/requisitions/{companyKey}/{requisitionKey}

Resources


ApiRequisitionRequisitionPartsResource

The following elements are required:

part (string) Part.
unit (string) Unit.

The following elements are optional:

quantity (decimal) Quantity.
warehouse (string) Warehouse.
remarks (string) Remarks.


ApiRequisitionResource

The following elements are required:

requisitionKey (string) Requisition.
requisitionType (string) Requisition Type.
date (DateTimeOffset) Date.
requestedBy (string) Requested By.
schemaEntityState (string) State.
company (string) Company.
isLocked (bool) Is Locked.
newStateId (Guid) New State Id.

The following elements are optional:

description (string) Description.
remarks (string) Remarks.
workOrders (WorkOrder) Work Orders.
requisitionParts (List of ApiRequisitionRequisitionPartsResource) Requisition Parts.
See ApiRequisitionRequisitionPartsResource.
isTechnician (bool) Is Technician.
templateParameters (string) Template Parameters.
previousStateId (Guid) Previous State Id.
triggerStateId (Guid) Trigger State Id.
isWorkManager (bool) Is Work Manager.
allowCreateStockEntry (bool) Allow Create Stock Entry.


RequisitionPartResource

The following elements are required:

part (string) Part.
unit (string) Unit.

The following elements are optional:

quantity (decimal) Quantity.
warehouse (string) Warehouse.
remarks (string) Remarks.


RequisitionResource

The following elements are required:

requisitionKey (string) Requisition.
requisitionType (string) Requisition Type.
date (DateTimeOffset) Date.
requestedBy (string) Requested By.
schemaEntityState (string) State.
company (string) Company.
isLocked (bool) Is Locked.
newStateId (Guid) New State Id.

The following elements are optional:

description (string) Description.
remarks (string) Remarks.
workOrders (WorkOrder) Work Orders.
requisitionParts (List of RequisitionPartResource) Requisition Parts.
See RequisitionPartResource.
isTechnician (bool) Is Technician.
templateParameters (string) Template Parameters.
previousStateId (Guid) Previous State Id.
triggerStateId (Guid) Trigger State Id.
isWorkManager (bool) Is Work Manager.
allowCreateStockEntry (bool) Allow Create Stock Entry.


ExtensibilityCustomAttributeValueResource

The following elements are required:

value (object) The custom attribute value.