Skip to content
DatAscend

Logical States

Logical states are stored in the state system entity and are used to store possible actions that can be executed on an entity with that state. For example: An entity in state Inactive can only be read, no other action (like deleting) can be done to it.

API

  • GET /api/v1/states/exists: Validate if the table state exists in dasec schema
  • GET /api/v1/states/: Return all the states inside state table
  • GET /api/v1/states/{id}: Return the state by given id
  • POST /api/v1/states/: Creates a state inside state table. Example:
{
  "state": "State name",
  "actions": ["create", "read", "update", "delete"],
  "is_default": true,
}
  • PUT /api/v1/states/{id}: Updates a state by given id
  • DELETE /api/v1/states/{id}: Deletes a state by given id

Middlewares

There are two middlewares applied on Logical States module, they do not apply for external entities.

State middleware

It is responsible to validate that the records that have assigned a logical state counts with the action that the user is going to do. For example, if a record on Animal entity has assigned a logical state called Active and it does not have with the action UPDATE, then the middleware will catch the request, validates if it is a PUT (update) request and if it is, then the user won’t be allowed to complete the request and the system will display an Error 405 Method not allowed error message.

Delete state middleware

In order to delete a state, the state shouldn’t be applied on any other records, meaning the user is responsible to remove the relationship with the state before the deletion. This middleware checks if the state is being applied on any entity records and blocks the request if it is. The user will receive a Error 409 Method not allowed for this record error message.