Valuekeep Developers - Web API Reference

Work | VK Transition Change

Service to manage entities of type 'VKTransitionChange'.

Overview


URL api/{tenantKey}/{orgKey}/maintenance/vKTransitionChanges
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 VKTransitionChanges (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 VKTransitionChangeResource.

Response status codes:

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

Resource URL:

GET /maintenance/vKTransitionChanges/odata

GET VKTransitionChange 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 VKTransitionChangeResource.

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

GET VKTransitionChange by key

Returns the entity record that matches the specified key.

The following elements are required:

transitionChangeKey (string) Transition Change.

Response:

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

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 /maintenance/vKTransitionChanges/{transitionChangeKey}

POST Operations

POST VKTransitionChanges

Creates a new entity record.

The following elements are required:

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

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

Response status codes:

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

Resource URL:

POST /maintenance/vKTransitionChanges

POST State Transition Change Item

Inserts a new 'State Transition Change Item' in the 'State Transition Change'.

The following elements are required:

transitionChangeKey (string) Transition Change.
value (ApiVKTransitionChangeVKTransitionChangeItemsResource) The ApiVKTransitionChangeVKTransitionChangeItemsResource instance.
See ApiVKTransitionChangeVKTransitionChangeItemsResource.

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 /maintenance/vKTransitionChanges/{transitionChangeKey}/vKTransitionChangeItems

PUT Operations

PUT Set DateTransition VKTransitionChangeItem

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

The following elements are required:

transitionChangeKey (string) Transition Change.
lineId (string) The detail identifier.
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 /maintenance/vKTransitionChanges/{transitionChangeKey}/vKTransitionChangeItems/{lineId}/dateTransition

PUT Set Description VKTransitionChange

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

The following elements are required:

transitionChangeKey (string) Transition Change.
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 /maintenance/vKTransitionChanges/{transitionChangeKey}/description

PUT Set EntityId VKTransitionChange

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

The following elements are required:

transitionChangeKey (string) Transition Change.
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 /maintenance/vKTransitionChanges/{transitionChangeKey}/entityId

PUT Set EntityName VKTransitionChange

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

The following elements are required:

transitionChangeKey (string) Transition Change.
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 /maintenance/vKTransitionChanges/{transitionChangeKey}/entityName

PUT Set IsActive VKTransitionChange

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

The following elements are required:

transitionChangeKey (string) Transition Change.
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 /maintenance/vKTransitionChanges/{transitionChangeKey}/isActive

PUT Set Justification VKTransitionChangeItem

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

The following elements are required:

transitionChangeKey (string) Transition Change.
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:

PUT /maintenance/vKTransitionChanges/{transitionChangeKey}/vKTransitionChangeItems/{lineId}/justification

PUT Set SchemaEntity VKTransitionChange

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

The following elements are required:

transitionChangeKey (string) Transition Change.
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 /maintenance/vKTransitionChanges/{transitionChangeKey}/schemaEntity

PUT Set TransitionChangeKey VKTransitionChange

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

The following elements are required:

transitionChangeKey (string) Transition Change.
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 /maintenance/vKTransitionChanges/{transitionChangeKey}/transitionChangeKey

PUT Set Custom Attribute VKTransitionChange

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

The following elements are required:

transitionChangeKey (string) Transition Change
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 /maintenance/vKTransitionChanges/{transitionChangeKey}/{customAttributeName}

PUT Set Custom Attribute VKTransitionChangeItem

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

The following elements are required:

transitionChangeKey (string) Transition Change
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 /maintenance/vKTransitionChanges/{transitionChangeKey}/vKTransitionChangeItems/{lineId}/{customAttributeName}

DELETE Operations

DELETE State Transition Change Item by identifier

Deletes the entity record that matches the specified identifier.

The following elements are required:

transitionChangeKey (string) Transition Change.
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 /maintenance/vKTransitionChanges/{transitionChangeKey}/vKTransitionChangeItems/{lineId}

DELETE VKTransitionChange 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 /maintenance/vKTransitionChanges/{id}

DELETE VKTransitionChange by key

Deletes the entity record that matches the specified key.

The following elements are required:

transitionChangeKey (string) Transition Change.

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 /maintenance/vKTransitionChanges/{transitionChangeKey}

Resources


ApiVKTransitionChangeResource

The following elements are required:

transitionChangeKey (string) Transition Change.

The following elements are optional:

description (string) Description.
vKTransitionChangeItems (List of ApiVKTransitionChangeVKTransitionChangeItemsResource) VK Transition Change Items.
See ApiVKTransitionChangeVKTransitionChangeItemsResource.
entityId (Guid) Entity Id.
entityName (string) Entity Name.
schemaEntity (string) Schema Entity.


ApiVKTransitionChangeVKTransitionChangeItemsResource

The following elements are required:

dateTransition (DateTimeOffset) Date Transition.

The following elements are optional:

justification (string) Justification.


VKTransitionChangeResource

The following elements are required:

transitionChangeKey (string) Transition Change.

The following elements are optional:

description (string) Description.
vKTransitionChangeItems (List of VKTransitionChangeItemResource) VK Transition Change Items.
See VKTransitionChangeItemResource.
entityId (Guid) Entity Id.
entityName (string) Entity Name.
schemaEntity (string) Schema Entity.
(fk) Allowed value: the natural key of a record of type SchemaEntity. These records are accessibly through the SchemaEntities service.


ExtensibilityCustomAttributeValueResource

The following elements are required:

value (object) The custom attribute value.