proposals.get-submission

GET

/v1/proposals/{proposal_id}/submissions/{submission_version}

const url = 'https://example.com/v1/proposals/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/submissions/1?accessProfile=facility-correction-applier';
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/submissions/1?accessProfile=facility-correction-applier'

Parameters

Path Parameters

proposal_id

required

string format: uuid

submission_version

required

integer

>= 1 <= 4294967295

Query Parameters

accessProfile

required

string

Allowed values: facility-correction-applier facility-correction-author

Responses

200

Authorized Proposal operation

application/json

object

actionId

required

string

application

required

Any of:

object

applicationId

required

string format: uuid

appliedAt

Application time, present with appliedBy only when the selected profile holds get-application-actor.

string format: date-time

appliedBy

Keyed actor pseudonym, present with appliedAt only when the selected profile holds get-application-actor.

string

/^hmac-sha256:[0-9a-f]{64}$/

state

required

Allowed value: applied

current

required

boolean

decision

object

decidedAt

required

string format: date-time

publicReason

string

>= 1 characters /^[^\u0000-\u001F\u007F-\u009F]*[^\u0000-\u0020\u007F-\u00A0\u1680\u2000-\u200A\u2028\u2029\u202F\u205F\u3000][^\u0000-\u001F\u007F-\u009F]*$/

status

required

Allowed values: approved rejected changes-requested answered

effectDigest

required

string

/^sha256:[0-9a-f]{64}$/

required

string format: uuid

review

required

Any of:

object
null

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

submissionVersion

required

integer

>= 1 <= 4294967295

Example

{
  "application": {
    "state": "applied"
  },
  "decision": {
    "status": "approved"
  },
  "review": {
    "state": "pending"
  }
}

404

Resource unavailable to this caller

410

The submission’s review result and application receipt are no longer retained

412

Observed authority or lifecycle condition changed