proposals.get-review-context-batch

GET

/v1/proposals/review-context

const url = 'https://example.com/v1/proposals/review-context?accessProfile=proposal-reviewer&ids=2489E9AD-2EE2-8E00-8EC9-32D5F69181C0';
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/review-context?accessProfile=proposal-reviewer&ids=2489E9AD-2EE2-8E00-8EC9-32D5F69181C0'

One bounded transport exchange under each item’s current get-review-context authority. Ordered visible or concealed results; operational failures refuse the whole batch. Maximum response is 8 MiB.

Parameters

Query Parameters

accessProfile

required

string

Allowed values: proposal-reviewer

ids

required

Array<string>

>= 1 items <= 100 items unique items

One to 100 distinct canonical Proposal UUIDs, in response order.

Responses

200

Authorized Proposal operation

application/json

object

items

required

Array

>= 1 items <= 100 items

One of:

object
object

object

context

required

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

required

string format: uuid

status

required

Allowed value: visible

Example

{
  "items": [
    {
      "context": {
        "result": {
          "state": "pending"
        },
        "subject": {
          "subjectType": "proposal"
        }
      },
      "status": "visible"
    }
  ]
}

404

Resource unavailable to this caller

412

Observed authority or lifecycle condition changed