DEdefra
State

Create or update application state

Changed on
post/state

Request

  • Base URL
    http://localhost:3001
  • URL
    http://localhost:3001/state
  • Auth
    HTTP bearer and API key in header x-application-lock-owner

Request body

sbistring required
grantCodestring required
stateStateObject required

Arbitrary state object stored by the service

Response

State updated

successboolean required
createdboolean

Present and true when a new state record was created

updatedboolean

Present and true when an existing state record was updated

Example response

{
  "success": true
}

Changes

  • 047f9b2e19c3Revision changes
    • info

      the endpoint scheme security bearerAuth AND lockToken was added to the API

  • 7623fe906e93Revision changes
    • info

      the request property default value 1 was added

    • info

      request property list-of-types was widened by adding types integer to media type application/json