Business Core | State

Service to manage entities of type 'VKSchemaEntityState'.

Overview

api/{tenantKey}/{orgKey}/businessCore/vKSchemaEntityStates

URL	api/{tenantKey}/{orgKey}/businessCore/vKSchemaEntityStates
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:

ApiVKSchemaEntityStateResource
ApiVKSchemaEntityStateVKSchemaEntityStateTransitionsResource
ApiVKSchemaEntityStateVKSchemaEntityStateTransitionsStateTransitionRolesResource
StateTransitionRoleResource
VKSchemaEntityStateResource
VKSchemaEntityStateResourceResource
VKSchemaEntityStateResourceVKSchemaEntityStateTransitionsResource
VKSchemaEntityStateTransitionResource
ExtensibilityCustomAttributeValueResource

GET Operations

GET VKSchemaEntityStates (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 VKSchemaEntityStateResource.

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/businessCore/vKSchemaEntityStates/odata

GET /businessCore/vKSchemaEntityStates/odata

GET VKSchemaEntityState 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 VKSchemaEntityStateResource.

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

GET /businessCore/vKSchemaEntityStates/{id}

GET VKSchemaEntityState 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 VKSchemaEntityStateResource.

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}/businessCore/vKSchemaEntityStates/{stateKey}

GET /businessCore/vKSchemaEntityStates/{stateKey}

GET Get States Localized Descriptions

Gets the states' localized descriptions.

Response:

When successful, the response body contains a string.

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/businessCore/vKSchemaEntityStates/getStatesLocalizedDescriptions

GET /businessCore/vKSchemaEntityStates/getStatesLocalizedDescriptions

POST Operations

POST VKSchemaEntityStates

Creates a new entity record.

The following elements are required:

vKSchemaEntityStateResource

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

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

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/businessCore/vKSchemaEntityStates

POST /businessCore/vKSchemaEntityStates

POST VK Schema Entity State Transition

Inserts a new 'VK Schema Entity State Transition' in the 'State'.

The following elements are required:

stateKey	(string) State.
value	(ApiVKSchemaEntityStateVKSchemaEntityStateTransitionsResource) The ApiVKSchemaEntityStateVKSchemaEntityStateTransitionsResource instance. See ApiVKSchemaEntityStateVKSchemaEntityStateTransitionsResource.

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:

api/{tenantKey}/{orgKey}/businessCore/vKSchemaEntityStates/{stateKey}/vKSchemaEntityStateTransitions

POST /businessCore/vKSchemaEntityStates/{stateKey}/vKSchemaEntityStateTransitions

POST Get Initial State Id

Gets the initial state id for the specified entity.

The following elements are required:

entityId

(Guid) The entity 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 unique identifier.

Resource URL:

api/{tenantKey}/{orgKey}/businessCore/vKSchemaEntityStates/getInitialStateId/{entityId}

POST /businessCore/vKSchemaEntityStates/getInitialStateId/{entityId}

POST Validate Initial State

Validates if the state is initial.

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 an item of type 'boolean'.

Resource URL:

api/{tenantKey}/{orgKey}/businessCore/vKSchemaEntityStates/validateInitialState/{stateId}

POST /businessCore/vKSchemaEntityStates/validateInitialState/{stateId}

POST Validate State Transition

Checks whether the state transition is defined.

The following elements are required:

originalStateId	(Guid) The original state id.
newStateId	(Guid) The new state id.
entityNaturalKey	(string) Entity natural key.

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 an item of type 'boolean'.

Resource URL:

api/{tenantKey}/{orgKey}/businessCore/vKSchemaEntityStates/validateStateTransition/{originalStateId}/{newStateId}

POST /businessCore/vKSchemaEntityStates/validateStateTransition/{originalStateId}/{newStateId}

POST Get All Schema Entity States

Custom operation 'GetAllSchemaEntityStates'.

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

Resource URL:

api/{tenantKey}/{orgKey}/businessCore/vKSchemaEntityStates/getAllSchemaEntityStates

POST /businessCore/vKSchemaEntityStates/getAllSchemaEntityStates

PUT Operations

PUT Set Description VKSchemaEntityState

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

The following elements are required:

stateKey	(string) State.
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:

api/{tenantKey}/{orgKey}/businessCore/vKSchemaEntityStates/{stateKey}/description

PUT /businessCore/vKSchemaEntityStates/{stateKey}/description

PUT Set IsActive VKSchemaEntityState

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}/businessCore/vKSchemaEntityStates/{stateKey}/isActive

PUT /businessCore/vKSchemaEntityStates/{stateKey}/isActive

PUT Set IsFinalState VKSchemaEntityState

Updates the value of attribute 'IsFinalState' 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}/businessCore/vKSchemaEntityStates/{stateKey}/isFinalState

PUT /businessCore/vKSchemaEntityStates/{stateKey}/isFinalState

PUT Set IsInitialState VKSchemaEntityState

Updates the value of attribute 'IsInitialState' 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}/businessCore/vKSchemaEntityStates/{stateKey}/isInitialState

PUT /businessCore/vKSchemaEntityStates/{stateKey}/isInitialState

PUT Set IsInternal VKSchemaEntityStateTransition

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

The following elements are required:

stateKey	(string) State.
lineId	(string) The detail identifier.
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}/businessCore/vKSchemaEntityStates/{stateKey}/vKSchemaEntityStateTransitions/{lineId}/isInternal

PUT /businessCore/vKSchemaEntityStates/{stateKey}/vKSchemaEntityStateTransitions/{lineId}/isInternal

PUT Set IsLockedForChanges VKSchemaEntityState

Updates the value of attribute 'IsLockedForChanges' 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}/businessCore/vKSchemaEntityStates/{stateKey}/isLockedForChanges

PUT /businessCore/vKSchemaEntityStates/{stateKey}/isLockedForChanges

PUT Set LocalizedDescription VKSchemaEntityState

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

The following elements are required:

stateKey	(string) State.
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:

api/{tenantKey}/{orgKey}/businessCore/vKSchemaEntityStates/{stateKey}/localizedDescription

PUT /businessCore/vKSchemaEntityStates/{stateKey}/localizedDescription

PUT Set NeedJustification VKSchemaEntityStateTransition

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

The following elements are required:

stateKey	(string) State.
lineId	(string) The detail identifier.
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}/businessCore/vKSchemaEntityStates/{stateKey}/vKSchemaEntityStateTransitions/{lineId}/needJustification

PUT /businessCore/vKSchemaEntityStates/{stateKey}/vKSchemaEntityStateTransitions/{lineId}/needJustification

PUT Set NotificationId VKSchemaEntityState

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

The following elements are required:

stateKey	(string) State.
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:

api/{tenantKey}/{orgKey}/businessCore/vKSchemaEntityStates/{stateKey}/notificationId

PUT /businessCore/vKSchemaEntityStates/{stateKey}/notificationId

PUT Set NotificationId VKSchemaEntityStateTransition

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

The following elements are required:

stateKey	(string) State.
lineId	(string) The detail identifier.
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:

api/{tenantKey}/{orgKey}/businessCore/vKSchemaEntityStates/{stateKey}/vKSchemaEntityStateTransitions/{lineId}/notificationId

PUT /businessCore/vKSchemaEntityStates/{stateKey}/vKSchemaEntityStateTransitions/{lineId}/notificationId

PUT Set SchemaEntity VKSchemaEntityState

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

The following elements are required:

stateKey	(string) State.
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:

api/{tenantKey}/{orgKey}/businessCore/vKSchemaEntityStates/{stateKey}/schemaEntity

PUT /businessCore/vKSchemaEntityStates/{stateKey}/schemaEntity

PUT Set StateKey VKSchemaEntityState

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

The following elements are required:

stateKey	(string) State.
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:

api/{tenantKey}/{orgKey}/businessCore/vKSchemaEntityStates/{stateKey}/stateKey

PUT /businessCore/vKSchemaEntityStates/{stateKey}/stateKey

PUT Set TargetEntityState VKSchemaEntityStateTransition

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

The following elements are required:

stateKey	(string) State.
lineId	(string) The detail identifier.
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:

api/{tenantKey}/{orgKey}/businessCore/vKSchemaEntityStates/{stateKey}/vKSchemaEntityStateTransitions/{lineId}/targetEntityState

PUT /businessCore/vKSchemaEntityStates/{stateKey}/vKSchemaEntityStateTransitions/{lineId}/targetEntityState

PUT Set Custom Attribute VKSchemaEntityState

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}/businessCore/vKSchemaEntityStates/{stateKey}/{customAttributeName}

PUT /businessCore/vKSchemaEntityStates/{stateKey}/{customAttributeName}

PUT Set Custom Attribute VKSchemaEntityStateTransition

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

The following elements are required:

stateKey	(string) State
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:

api/{tenantKey}/{orgKey}/businessCore/vKSchemaEntityStates/{stateKey}/vKSchemaEntityStateTransitions/{lineId}/{customAttributeName}

PUT /businessCore/vKSchemaEntityStates/{stateKey}/vKSchemaEntityStateTransitions/{lineId}/{customAttributeName}

DELETE Operations

DELETE VK Schema Entity State Transition by identifier

Deletes the entity record that matches the specified identifier.

The following elements are required:

stateKey	(string) State.
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:

api/{tenantKey}/{orgKey}/businessCore/vKSchemaEntityStates/{stateKey}/vKSchemaEntityStateTransitions/{lineId}

DELETE /businessCore/vKSchemaEntityStates/{stateKey}/vKSchemaEntityStateTransitions/{lineId}

DELETE VKSchemaEntityState 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}/businessCore/vKSchemaEntityStates/{id}

DELETE /businessCore/vKSchemaEntityStates/{id}

DELETE VKSchemaEntityState 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}/businessCore/vKSchemaEntityStates/{stateKey}

DELETE /businessCore/vKSchemaEntityStates/{stateKey}

Resources

ApiVKSchemaEntityStateResource

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:

vKSchemaEntityStateTransitions	(List of ApiVKSchemaEntityStateVKSchemaEntityStateTransitionsResource) VK Schema Entity State Transitions. See ApiVKSchemaEntityStateVKSchemaEntityStateTransitionsResource.
isLockedForChanges	(bool) Is Locked For Changes.
localizedDescription	(string) Localized Description.
notificationId	(Guid) Initial Notification.

ApiVKSchemaEntityStateVKSchemaEntityStateTransitionsResource

The following elements are required:

targetEntityState	(string) Target Entity State.
needJustification	(bool) Need Justification.

The following elements are optional:

isInternal	(bool) Is Internal.
notificationId	(Guid) Notification Id.
stateTransitionRoles	(List of ApiVKSchemaEntityStateVKSchemaEntityStateTransitionsStateTransitionRolesResource) State Transition Roles. See ApiVKSchemaEntityStateVKSchemaEntityStateTransitionsStateTransitionRolesResource.

ApiVKSchemaEntityStateVKSchemaEntityStateTransitionsStateTransitionRolesResource

The following elements are required:

role	(string) Role.

StateTransitionRoleResource

The following elements are required:

role	(string) Role.

VKSchemaEntityStateResource

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:

vKSchemaEntityStateTransitions	(List of VKSchemaEntityStateTransitionResource) VK Schema Entity State Transitions. See VKSchemaEntityStateTransitionResource.
isLockedForChanges	(bool) Is Locked For Changes.
localizedDescription	(string) Localized Description.
notificationId	(Guid) Initial Notification.

VKSchemaEntityStateResourceResource

The following elements are required:

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

The following elements are optional:

isLockedForChanges	(bool) Is Locked For Changes.
localizedDescription	(string) Localized Description.
notificationId	(Guid) Initial Notification.
vKSchemaEntityStateTransitions	(List of VKSchemaEntityStateResourceVKSchemaEntityStateTransitionsResource) VK Schema Entity State Transitions. See VKSchemaEntityStateResourceVKSchemaEntityStateTransitionsResource.

VKSchemaEntityStateResourceVKSchemaEntityStateTransitionsResource

The following elements are required:

needJustification	(bool) Need Justification.
targetEntityState	(string) Target Entity State.

The following elements are optional:

isInternal	(bool) Is Internal.
notificationId	(Guid) Notification Id.

VKSchemaEntityStateTransitionResource

The following elements are required:

targetEntityState	(string) Target Entity State.
needJustification	(bool) Need Justification.

The following elements are optional:

isInternal	(bool) Is Internal.
notificationId	(Guid) Notification Id.
stateTransitionRoles	(List of StateTransitionRoleResource) State Transition Roles. See StateTransitionRoleResource.

ExtensibilityCustomAttributeValueResource

The following elements are required:

value

(object) The custom attribute value.