Requisitions | Requisition State

Service to manage entities of type 'RequisitionState'.

This service extends VKSchemaEntityStates.

Overview

api/{tenantKey}/{orgKey}/requisitionsCore/requisitionStates

URL	api/{tenantKey}/{orgKey}/requisitionsCore/requisitionStates
Methods Supported	GET, POST, PUT, DELETE

All Operations

This service includes the following operations:

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

All Resources

This service uses the following resources:

ApiBaseRequisitionStateResource
ApiRequisitionStateResource
BaseRequisitionStateResource
RequisitionStateResource
ExtensibilityCustomAttributeValueResource

GET Operations

GET RequisitionStates (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 RequisitionStateResource.

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/requisitionsCore/requisitionStates/extension/odata

GET /requisitionsCore/requisitionStates/extension/odata

GET RequisitionState 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 RequisitionStateResource.

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}/requisitionsCore/requisitionStates/{id}/extension

GET /requisitionsCore/requisitionStates/{id}/extension

GET RequisitionState by key

Returns the entity record that matches the specified key.

The following elements are required:

stateKey

(string) State.

Response:

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

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}/requisitionsCore/requisitionStates/{stateKey}/extension

GET /requisitionsCore/requisitionStates/{stateKey}/extension

GET RequisitionStates (with VKSchemaEntityState)

Returns the list of all the entity records available. Each record contains both data from the entity and the base entity.

Response:

When successful, the response body contains the list of records available. See BaseRequisitionStateResource.

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/requisitionsCore/requisitionStates

GET /requisitionsCore/requisitionStates

GET RequisitionStates (with VKSchemaEntityState) (paged)

Returns a page of the list of all the entity records available. Each record contains both data from the entity and the base entity.

The following elements are optional:

page	(int) The index of the page of the list that should be returned. This is a query string parameter.
pageSize	(int) The number of page elements that should be returned (max. is 1000). This is a query string parameter.

Response:

When successful, the response body contains the list of records available. See BaseRequisitionStateResource.

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/requisitionsCore/requisitionStates?page={page}&pageSize={pageSize}

GET /requisitionsCore/requisitionStates?page={page}&pageSize={pageSize}

GET RequisitionState (with VKSchemaEntityState) by identifier

Returns the entity record that matches the specified identifier. The record contains both data from the entity and the base entity.

The following elements are required:

id	(string) The record identifier.

Response:

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

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

GET /requisitionsCore/requisitionStates/{id}

GET RequisitionState (with VKSchemaEntityState) by key

Returns the entity record that matches the specified key. The record contains both data from the entity and the base entity.

The following elements are required:

stateKey

(string) State.

Response:

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

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}/requisitionsCore/requisitionStates/{stateKey}

GET /requisitionsCore/requisitionStates/{stateKey}

POST Operations

POST RequisitionStates

Creates a new entity record.

The following elements are required:

requisitionStateResource

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

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

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/requisitionsCore/requisitionStates/extension

POST /requisitionsCore/requisitionStates/extension

POST RequisitionStates (with ApiBaseRequisitionState)

Creates a new entity record. The record shoud contain both data from the entity and the base entity.

The following elements are required:

requisitionStateResource

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

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

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/requisitionsCore/requisitionStates

POST /requisitionsCore/requisitionStates

POST Get State Configuration

Gets the state configuration.

The following elements are required:

stateId

(Guid) The state id.

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

Resource URL:

api/{tenantKey}/{orgKey}/requisitionsCore/requisitionStates/getStateConfiguration/{stateId}

POST /requisitionsCore/requisitionStates/getStateConfiguration/{stateId}

POST Get All Requisition States

Custom operation 'GetAllRequisitionStates'.

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 list of resources of type 'RequisitionStateResource'. See RequisitionStateResource.

Resource URL:

api/{tenantKey}/{orgKey}/requisitionsCore/requisitionStates/getAllRequisitionStates

POST /requisitionsCore/requisitionStates/getAllRequisitionStates

PUT Operations

PUT Set AllowCostReport RequisitionState

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

The following elements are required:

stateKey	(string) State.
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}/requisitionsCore/requisitionStates/{stateKey}/allowCostReport

PUT /requisitionsCore/requisitionStates/{stateKey}/allowCostReport

PUT Set AllowCreateStockEntry RequisitionState

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

The following elements are required:

stateKey	(string) State.
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}/requisitionsCore/requisitionStates/{stateKey}/allowCreateStockEntry

PUT /requisitionsCore/requisitionStates/{stateKey}/allowCreateStockEntry

PUT Set IsActive RequisitionState

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

The following elements are required:

stateKey	(string) State.
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}/requisitionsCore/requisitionStates/{stateKey}/isActive

PUT /requisitionsCore/requisitionStates/{stateKey}/isActive

PUT Set Custom Attribute RequisitionState

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

The following elements are required:

stateKey	(string) State
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}/requisitionsCore/requisitionStates/{stateKey}/{customAttributeName}

PUT /requisitionsCore/requisitionStates/{stateKey}/{customAttributeName}

DELETE Operations

DELETE RequisitionState 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}/requisitionsCore/requisitionStates/{id}

DELETE /requisitionsCore/requisitionStates/{id}

DELETE RequisitionState by key

Deletes the entity record that matches the specified key.

The following elements are required:

stateKey

(string) State.

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}/requisitionsCore/requisitionStates/{stateKey}

DELETE /requisitionsCore/requisitionStates/{stateKey}

Resources

ApiBaseRequisitionStateResource

The following elements are required:

stateKey	(string) State.
description	(string) Description.
isInitialState	(bool) Is Initial State.
isFinalState	(bool) Is Final State.
schemaEntity	(string) Entity.

The following elements are optional:

allowCostReport	(bool) Allow Cost Report.
allowCreateStockEntry	(bool) Allow Create Stock Entry.
isLockedForChanges	(bool) Is Locked For Changes.
localizedDescription	(string) Localized Description.
notificationId	(Guid) Initial Notification.

ApiRequisitionStateResource

The following elements are required:

stateKey

(string) State.

The following elements are optional:

allowCostReport	(bool) Allow Cost Report.
allowCreateStockEntry	(bool) Allow Create Stock Entry.

BaseRequisitionStateResource

The following elements are required:

stateKey	(string) State.
description	(string) Description.
isInitialState	(bool) Is Initial State.
isFinalState	(bool) Is Final State.
schemaEntity	(string) Entity.

The following elements are optional:

allowCostReport	(bool) Allow Cost Report.
allowCreateStockEntry	(bool) Allow Create Stock Entry.
isLockedForChanges	(bool) Is Locked For Changes.
localizedDescription	(string) Localized Description.
notificationId	(Guid) Initial Notification.

RequisitionStateResource

The following elements are required:

stateKey

(string) State.

The following elements are optional:

allowCostReport	(bool) Allow Cost Report.
allowCreateStockEntry	(bool) Allow Create Stock Entry.

ExtensibilityCustomAttributeValueResource

The following elements are required:

value

(object) The custom attribute value.