proposals.get-review-context

GET

/v1/proposals/{proposal_id}/review-context

const url = 'https://example.com/v1/proposals/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/review-context?accessProfile=proposal-reviewer';
const options = {method: 'GET'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'https://example.com/v1/proposals/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/review-context?accessProfile=proposal-reviewer'

Parameters

Path Parameters

proposal_id

required

string format: uuid

Query Parameters

accessProfile

required

string

Allowed values: proposal-reviewer

Responses

200

Authorized Proposal operation

application/json

object

actionId

required

string

actionRevision

required

string

authority

string

context

required

object

contract

required

object

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}$/

fields

required

object

reference

required

string

effectDigest

required

string

required

string format: uuid

policy

object

digest

required

string

required

string

version

required

string

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

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

Resource unavailable to this caller

412

Observed authority or lifecycle condition changed