Contracts | Contract State
Service to manage entities of type 'ContractState'.
This service extends VKSchemaEntityStates.
Overview
| URL | api/{tenantKey}/{orgKey}/contractsCore/contractStates |
| Methods Supported | GET, POST, PUT, DELETE |
All Operations
This service includes the following operations:
- GET:
- POST:
- PUT:
- DELETE:
All Resources
This service uses the following resources:
GET ContractStates (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 ContractStateResource. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
GET ContractState 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 ContractStateResource. |
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 ContractState 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 ContractStateResource. |
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 ContractStates (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 BaseContractStateResource. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
GET ContractStates (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 BaseContractStateResource. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
GET ContractState (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 BaseContractStateResource. |
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 ContractState (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 BaseContractStateResource. |
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:
POST ContractStates
Creates a new entity record.
The following elements are required:
| contractStateResource | (ApiContractStateResource) The request body should contain the entity record that should be created. See ApiContractStateResource. |
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 ApiContractStateResource. |
Response status codes:
| 201 | Created. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
POST ContractStates (with ApiBaseContractState)
Creates a new entity record. The record shoud contain both data from the entity and the base entity.
The following elements are required:
| contractStateResource | (ApiContractStateResource) The request body should contain the entity record that should be created. See ApiContractStateResource. |
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 ApiBaseContractStateResource. |
Response status codes:
| 201 | Created. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
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 'ContractStateResource'. See ContractStateResource. |
Resource URL:
POST Get All Contract States
Custom operation 'GetAllContractStates'.
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 'ContractStateResource'. See ContractStateResource. |
Resource URL:
PUT Set IsActive ContractState
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:
PUT Set IsCanceledState ContractState
Updates the value of attribute 'IsCanceledState' 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:
PUT Set Custom Attribute ContractState
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:
DELETE ContractState 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 ContractState 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:
Resources
ApiBaseContractStateResource
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:
| isCanceledState | (bool) Canceled. |
| isLockedForChanges | (bool) Is Locked For Changes. |
| localizedDescription | (string) Localized Description. |
| notificationId | (Guid) Initial Notification. |
ApiContractStateResource
The following elements are required:
| stateKey | (string) State. |
The following elements are optional:
| isCanceledState | (bool) Canceled. |
BaseContractStateResource
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:
| isCanceledState | (bool) Canceled. |
| isLockedForChanges | (bool) Is Locked For Changes. |
| localizedDescription | (string) Localized Description. |
| notificationId | (Guid) Initial Notification. |
ContractStateResource
The following elements are required:
| stateKey | (string) State. |
The following elements are optional:
| isCanceledState | (bool) Canceled. |
ExtensibilityCustomAttributeValueResource
The following elements are required:
| value | (object) The custom attribute value. |