proposal.getquerysince 0.1
One proposal, with its content and its reviews.
Request
umwelt call story.umw proposal.get '{
"proposalId": "01a1cbd8-63fc-7ec1-aac1-c0b733797443"
}'Request
const result = await client.proposalGet({ proposalId: '01a1cbd8-63fc-7ec1-aac1-c0b733797443' });Request
var result = engine.ProposalGet(new ProposalId { ProposalIdValue = "01a1cbd8-63fc-7ec1-aac1-c0b733797443" });Response
{
"id": "01a1cbd8-63fc-7ec1-aac1-c0b733797443",
"status": "pending",
"input": {
"projectId": "ball",
"event": {
"id": "confession",
"title": "The confession",
"position": { "tick": 10 },
"evidence": [],
"participants": ["bob", "duchess"],
"provenance": { "origin": { "kind": "human" } },
"type": "scene"
},
"records": [
{
"kind": "holding",
"id": "duchess-knows",
"holder": "duchess",
"claim": {
"subject": "bob",
"predicate": "stole",
"object": { "kind": "entity", "id": "necklace" },
"polarity": true,
"qualifiers": {}
},
"attitude": "knows",
"confidence": 1.0,
"accessibility": "available",
"acquisition": {
"kind": "told-by",
"intent": "honest",
"sourceHolderId": "bob",
"sourceRecordId": "bob-did"
},
"position": { "tick": 10 },
"provenance": { "origin": { "kind": "human" } }
}
],
"transitions": [
{
"status": "superseded",
"position": { "tick": 10 },
"provenance": { "origin": { "kind": "human" } },
"supersededBy": "duchess-knows",
"targetRecordId": "duchess-told"
}
]
},
"reviews": []
}Payload
| Field | Type | Description |
|---|---|---|
proposalIdrequired | string | The proposal, by the id propose returned. |
Result
| Field | Type | Description |
|---|---|---|
idalways | string | The proposal’s id. |
inputalways | ProposeInput | The commit it holds: the event, records and transitions, as proposed. |
statusalways | "pending" | "applied" | "partially-applied" | "rejected" | pending until it is applied (applied, or partially-applied when some operations were rejected) or rejected. |
reviews | ProposalReview[] | Every review so far, oldest first. The latest one for an operation decides it. |
rejectionRationale | string | Why it was rejected, when it was. |
Errors
VALIDATION_FAILEDThe payload is malformed.NOT_FOUNDThe proposal does not exist.HANDSHAKE_REQUIREDOver the protocol, hello was not sent first.Every code is listed in Errors.
See also
Was this page helpful?