DEdefra
State

Retrieve application state for an SBI, grant code and version

Changed on
get/state

Request

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

Query parameters

sbistring required
grantCodestring required
string required
OR
integer required
applicationRefstring

Selects one application when the grant allows several per SBI. Omitted, the single application for the SBI, grant code and version is used.

Response

The stored state document

_idstring

MongoDB document identifier

sbistring required
grantCodestring required
grantVersionstring required
pinnedMajorinteger
majorinteger
minorinteger
patchinteger
stateStateObject required

Arbitrary state object stored by the service

createdAtstring date-time
updatedAtstring date-time

Changes