Skip to content
Registry StackDocsDevelopment (unreleased)

proposals.get-review-status

GET
/v1/proposals/{proposal_id}/review-status
curl --request GET \
  --url 'https://example.com/v1/proposals/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/review-status?accessProfile=casework-review-status'

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
proposal_id
required
string format: uuid

Query Parameters

Section titled “Query Parameters”
accessProfile
required
string
Allowed values: casework-review-status facility-correction-author

Responses

Section titled “Responses”

200

Section titled “200”

Authorized Proposal operation

Media typeapplication/json
object
actionId
required
string
actionRevision
required
string
authority
string
context
required
object
contract
object
id
required
string
<= 2048 characters /^urn:registry:breg:review-context:/
revision
required
string
/^sha256:[0-9a-f]{64}$/
schemaDigest
required
string
/^sha256:[0-9a-f]{64}$/
reference
required
string
effectDigest
required
string
id
required
string format: uuid
policy
object
digest
required
string
id
required
string
version
required
string
requestId
string format: uuid
result
object
availableUntil
string format: date-time
completedAt
string format: date-time
resultId
string format: uuid
state
required
Allowed values: pending approved rejected changes-requested answered cancelled superseded expired
reviewable
required
boolean
revision
required
integer
>= 1
subject
required
object
digest
required
string
id
required
string format: uuid
source
required
string
subjectType
required
Allowed value: proposal
version
required
string
submissionVersion
required
integer
>= 1

Example 

{
  "result": {
    "state": "pending"
  },
  "subject": {
    "subjectType": "proposal"
  }
}

404

Section titled “404”

Resource unavailable to this caller

412

Section titled “412”

Observed authority or lifecycle condition changed