Business Core | Entity State Transition History

Service to manage entities of type 'VKEntittyStateTransitionHistory'.

Overview

URL	api/{tenantKey}/{orgKey}/businessCore/vKEntittyStateTransitionHistories
Methods Supported	GET, POST, PUT, DELETE

All Operations

This service includes the following operations:

• GET:
  • GET VKEntittyStateTransitionHistories (odata)
  • GET VKEntittyStateTransitionHistory by identifier
  • GET VKEntittyStateTransitionHistory by key
  • GET Get State Transitions
• POST:
  • POST VKEntittyStateTransitionHistories
  • POST Register State Transition
• PUT:
  • PUT Set Custom Attribute VKEntittyStateTransitionHistory
  • PUT Set IsActive VKEntittyStateTransitionHistory
  • PUT Set Key VKEntittyStateTransitionHistory
  • PUT Set EntityNaturalKey VKEntittyStateTransitionHistory
  • PUT Set DateTransition VKEntittyStateTransitionHistory
  • PUT Set NewState VKEntittyStateTransitionHistory
  • PUT Set Justification VKEntittyStateTransitionHistory
  • PUT Set PreviousState VKEntittyStateTransitionHistory
  • PUT Set SchemaEntity VKEntittyStateTransitionHistory
  • PUT Set StateJustification VKEntittyStateTransitionHistory
  • PUT Set StateJustificationType VKEntittyStateTransitionHistory
• DELETE:
  • DELETE VKEntittyStateTransitionHistory by identifier
  • DELETE VKEntittyStateTransitionHistory by key

All Resources

This service uses the following resources:

• ApiVKEntittyStateTransitionHistoryResource
• StateTransitionResource
• VKEntittyStateTransitionHistoryResource
• ExtensibilityCustomAttributeValueResource

GET Operations

GET VKEntittyStateTransitionHistories (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 VKEntittyStateTransitionHistoryResource.

Response status codes:

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

Resource URL:

GET VKEntittyStateTransitionHistory 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 VKEntittyStateTransitionHistoryResource.

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 VKEntittyStateTransitionHistory by key

Returns the entity record that matches the specified key.

The following elements are required:

key	(string) Key.
entityNaturalKey	(string) Entity Natural.
dateTransition	(DateTimeOffset) Date Transition.

Response:

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

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 Get State Transitions

Custom operation 'GetStateTransitions'.

The following elements are required:

schemaEntityKey	(string) SchemaEntityKey.
entityNaturalKey	(string) EntityNaturalKey.

Response:

When successful, the response body contains a list of resources of type 'StateTransitionResource'. See StateTransitionResource.

Response status codes:

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

Resource URL:

POST Operations

POST VKEntittyStateTransitionHistories

Creates a new entity record.

The following elements are required:

vKEntittyStateTransitionHistoryResource

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

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

Response status codes:

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

Resource URL:

POST Register State Transition

Registers the state transition history record.

The following elements are required:

schemaEntityId	(Guid) SchemaEntityId.
entityNaturalKey	(string) EntityNaturalKey.
previousStateId	(Guid) PreviousStateId.
newStateId	(Guid) NewStateId.
dateTransition	(DateTimeOffset) DateTransition.
justification	(string) Justification.
stateJustificationKey	(string) StateJustificationKey.
stateJustificationTypeKey	(string) StateJustificationTypeKey.

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:

PUT Operations

PUT Set DateTransition VKEntittyStateTransitionHistory

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

The following elements are required:

key	(string) Key.
entityNaturalKey	(string) Entity Natural.
dateTransition	(DateTimeOffset) Date Transition.
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 Set EntityNaturalKey VKEntittyStateTransitionHistory

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

The following elements are required:

key	(string) Key.
entityNaturalKey	(string) Entity Natural.
dateTransition	(DateTimeOffset) Date Transition.
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 Set IsActive VKEntittyStateTransitionHistory

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

The following elements are required:

key	(string) Key.
entityNaturalKey	(string) Entity Natural.
dateTransition	(DateTimeOffset) Date Transition.
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 Justification VKEntittyStateTransitionHistory

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

The following elements are required:

key	(string) Key.
entityNaturalKey	(string) Entity Natural.
dateTransition	(DateTimeOffset) Date Transition.
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 Set Key VKEntittyStateTransitionHistory

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

The following elements are required:

key	(string) Key.
entityNaturalKey	(string) Entity Natural.
dateTransition	(DateTimeOffset) Date Transition.
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 Set NewState VKEntittyStateTransitionHistory

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

The following elements are required:

key	(string) Key.
entityNaturalKey	(string) Entity Natural.
dateTransition	(DateTimeOffset) Date Transition.
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 Set PreviousState VKEntittyStateTransitionHistory

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

The following elements are required:

key	(string) Key.
entityNaturalKey	(string) Entity Natural.
dateTransition	(DateTimeOffset) Date Transition.
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 Set SchemaEntity VKEntittyStateTransitionHistory

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

The following elements are required:

key	(string) Key.
entityNaturalKey	(string) Entity Natural.
dateTransition	(DateTimeOffset) Date Transition.
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 Set StateJustification VKEntittyStateTransitionHistory

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

The following elements are required:

key	(string) Key.
entityNaturalKey	(string) Entity Natural.
dateTransition	(DateTimeOffset) Date Transition.
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 Set StateJustificationType VKEntittyStateTransitionHistory

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

The following elements are required:

key	(string) Key.
entityNaturalKey	(string) Entity Natural.
dateTransition	(DateTimeOffset) Date Transition.
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 Set Custom Attribute VKEntittyStateTransitionHistory

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

The following elements are required:

key	(string) Key
entityNaturalKey	(string) Entity Natural
dateTransition	(DateTimeOffset) Date Transition
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 Operations

DELETE VKEntittyStateTransitionHistory 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 VKEntittyStateTransitionHistory by key

Deletes the entity record that matches the specified key.

The following elements are required:

key	(string) Key.
entityNaturalKey	(string) Entity Natural.
dateTransition	(DateTimeOffset) Date Transition.

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

ApiVKEntittyStateTransitionHistoryResource

The following elements are required:

key	(string) Key.
entityNaturalKey	(string) Entity Natural.
dateTransition	(DateTimeOffset) Date Transition.
newState	(string) New State.
previousState	(string) Previous State.
schemaEntity	(string) Entity.

The following elements are optional:

justification	(string) Justification.
stateJustification	(string) State Justification.
stateJustificationType	(string) State Justification Type.
employeeDescription	(string) Employee Description.

StateTransitionResource

The following elements are required:

dateTransition	(DateTimeOffset) Date Transition.
entityNaturalKey	(string) Entity Natural.
key	(string) Key.
newState	(string) New State.
previousState	(string) Previous State.
schemaEntity	(string) Entity.

The following elements are optional:

justification	(string) Justification.
stateJustification	(string) State Justification.
stateJustificationType	(string) State Justification Type.
employeeDescription	(string) Employee Description.

VKEntittyStateTransitionHistoryResource

The following elements are required:

key	(string) Key.
entityNaturalKey	(string) Entity Natural.
dateTransition	(DateTimeOffset) Date Transition.
newState	(string) New State.
previousState	(string) Previous State.
schemaEntity	(string) Entity.

The following elements are optional:

justification	(string) Justification.
stateJustification	(string) State Justification.
stateJustificationType	(string) State Justification Type.
employeeDescription	(string) Employee Description.

ExtensibilityCustomAttributeValueResource

The following elements are required:

value

(object) The custom attribute value.