Skip to content
Registry StackDocsv0.46.0
Search

proposals.edit

POST
/v1/proposals/{proposal_id}/edit
curl --request POST \
  --url 'https://example.com/v1/proposals/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/edit?accessProfile=facility-correction-author' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: example' \
  --header 'If-Match: example' \
  --data '{ "input": { "addressLine": "example", "city": "example", "facilityId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "postalCode": "example" } }'

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: facility-correction-author

Header Parameters

Section titled “Header Parameters”
If-Match
required
string
Idempotency-Key
required
string

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
Any of:
object
input
required
object
addressLine
string
>= 1 characters <= 240 characters
city
string
>= 1 characters <= 120 characters
facilityId
string format: uuid
postalCode
string
>= 1 characters <= 24 characters

Example generated

{
  "input": {
    "addressLine": "example",
    "city": "example",
    "facilityId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
    "postalCode": "example"
  }
}

Responses

Section titled “Responses”

200

Section titled “200”

Authorized Proposal operation

Media typeapplication/json
object
actionId
required
string
actionRevision
required
string
application
object
applicationId
required
string format: uuid
effectDigest
required
string
/^sha256:[0-9a-f]{64}$/
resultLinks
required
Array<object>
<= 16 items
object
recordId
required
string format: uuid
recordType
required
string
revision
required
integer
>= 1
submissionVersion
required
integer
>= 1
applicationStatus
object
automaticRetry
object
attempts
required
integer
<= 1000
maximumAttempts
required
integer
>= 1 <= 1000
scheduled
required
boolean
mode
required
Allowed values: automatic manual
reason
Allowed values: package-changed dependency-outage lease-expired application-refused attempts-exhausted
recovery
Allowed values: retry rebase correct-input
state
required
Allowed values: awaiting-review pending applying blocked applied cancelled rejected
attachments
object
<= 8 properties
key
additional properties
object
classification
required
Allowed values: public internal restricted
contentTypes
required
Array<string>
>= 1 items <= 16 items unique items
id
required
string
links
required
object
key
additional properties
object
accessProfile
required
string
availability
object
available
required
boolean
observedRevision
required
integer
>= 1
reason
Allowed values: pending-review review-rejected review-changes-requested review-ended stale-revision package-changed dependency-outage invalid-input already-applied
recovery
Allowed values: refresh revise retry rebase correct-input receipt-only
ifMatch
string
method
required
Allowed values: GET PATCH DELETE
operation
required
Allowed values: download upload remove
path
required
string
maximumBytes
required
integer
>= 1 <= 16777216
required
required
boolean
value
object
byteSize
required
integer
>= 1
contentType
required
string
sha256
required
string
/^[a-f0-9]{64}$/
submissionVersion
required
integer
uploadedAt
string
verificationStatus
required
Allowed values: notRequired pending approved rejected
blockedReason
Allowed values: package-changed
createdAt
string format: date-time
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
string
handoffRefusal
object
code
required
Allowed values: review.initiator-required review.initiator-excluded review.policy-mismatch review.refused
id
required
string format: uuid
input
object
links
required
object
key
additional properties
object
accessProfile
required
string
availability
object
available
required
boolean
observedRevision
required
integer
>= 1
reason
Allowed values: pending-review review-rejected review-changes-requested review-ended stale-revision package-changed dependency-outage invalid-input already-applied
recovery
Allowed values: refresh revise retry rebase correct-input receipt-only
ifMatch
string
method
required
Allowed values: GET POST
operation
required
string
path
required
string
revision
required
integer
>= 1
state
required
Allowed values: draft submitted applied cancelled rejected
submissionVersion
required
integer
title
string
<= 1024 characters
turn
required
Allowed values: party official nobody

Example 

{
  "applicationStatus": {
    "mode": "automatic",
    "reason": "package-changed",
    "recovery": "retry",
    "state": "awaiting-review"
  },
  "attachments": {
    "additionalProperty": {
      "classification": "public",
      "links": {
        "additionalProperty": {
          "availability": {
            "reason": "pending-review",
            "recovery": "refresh"
          },
          "method": "GET",
          "operation": "download"
        }
      },
      "value": {
        "verificationStatus": "notRequired"
      }
    }
  },
  "blockedReason": "package-changed",
  "decision": {
    "status": "approved"
  },
  "handoffRefusal": {
    "code": "review.initiator-required"
  },
  "links": {
    "additionalProperty": {
      "availability": {
        "reason": "pending-review",
        "recovery": "refresh"
      },
      "method": "GET"
    }
  },
  "state": "draft",
  "turn": "party"
}

404

Section titled “404”

Resource unavailable to this caller

409

Section titled “409”

The Proposal was rejected, or the idempotency key was reused with a different request

412

Section titled “412”

Observed authority or lifecycle condition changed