State

Patch application status on the state for an SBI, grant code and grant version

Changed on
patch/state/{sbi}/{grantCode}/{grantVersion}

Request

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

Path parameters

sbistring required
grantCodestring required
string required
OR
integer required

Request body

applicationRefstring

Selects which application to patch when the grant allows several per SBI. Omitted, the single application for the SBI, grant code and version is patched.

Response

The updated state record

successboolean required
patchedboolean

Present and true when a state record was patched

Example response

{
  "success": true
}

Changes