Skip to content

Create Change Proposal

POST
/v1/admin/semantics/proposals
curl --request POST \
--url https://example.com/v1/admin/semantics/proposals \
--header 'Content-Type: application/json' \
--data '{ "tenant_id": "example", "title": "example", "requested_by": "example", "requested_by_type": "human", "target_type": "example", "target_ref": "example", "change_class": "standard", "authority_scope": "", "jurisdiction": "global", "data_class": "internal", "risk_threshold": 0, "proposal_key": "", "payload": {}, "impact": {}, "approval": {}, "metadata": {} }'
x-pomerium-jwt-assertion
Any of:
string
Media typeapplication/json
ChangeProposalCreateIn
object
tenant_id
required
Tenant Id
string
>= 1 characters
title
required
Title
string
requested_by
required
Requested By
string
requested_by_type
Requested By Type
string
default: human
target_type
required
Target Type
string
target_ref
required
Target Ref
string
change_class
Change Class
string
default: standard
authority_scope
Authority Scope
string
""
jurisdiction
Jurisdiction
string
default: global
data_class
Data Class
string
default: internal
risk_threshold
Risk Threshold
integer
0 <= 100
proposal_key
Proposal Key
string
""
payload
Payload
object
key
additional properties
any
impact
Impact
object
key
additional properties
any
approval
Approval
object
key
additional properties
any
metadata
Metadata
object
key
additional properties
any

Successful Response

Media typeapplication/json
ChangeProposalOut
object
created_at
required
Created At
string format: date-time
updated_at
required
Updated At
string format: date-time
id
required
Id
string
tenant_id
required
Tenant Id
string
proposal_key
required
Proposal Key
string
title
required
Title
string
status
required
Status
string
Allowed values: draft proposed under_review approved rejected published applied verified rolled_back archived
requested_by
required
Requested By
string
requested_by_type
required
Requested By Type
string
target_type
required
Target Type
string
target_ref
required
Target Ref
string
change_class
required
Change Class
string
authority_scope
required
Authority Scope
string
jurisdiction
Jurisdiction
string
default: global
data_class
Data Class
string
default: internal
risk_threshold
Risk Threshold
integer
0
payload
Payload
object
key
additional properties
any
impact
Impact
object
key
additional properties
any
approval
Approval
object
key
additional properties
any
metadata
Metadata
object
key
additional properties
any
Example
{
"status": "draft",
"jurisdiction": "global",
"data_class": "internal",
"risk_threshold": 0
}

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object
Examplegenerated
{
"detail": [
{
"loc": [
"example"
],
"msg": "example",
"type": "example",
"input": "example",
"ctx": {}
}
]
}