Skip to content
AveraAveraAvera Documentation

Stage a permission rule update into a change request

PUT
/api/v1/projects/{projectIdOrKey}/permission-rules/{ruleId}
curl --request PUT \
  --url 'https://app.avera.io/api/v1/projects/example/permission-rules/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0?sandboxId=example' \
  --header 'Content-Type: application/json' \
  --data '{ "principal": "example", "verb": "example", "itemTypes": [ "example" ], "states": [ "example" ], "fields": [ "example" ], "relationshipTypes": [ "example" ], "transitionIds": [ "example" ] }'

The change is staged into the change request named by sandboxId and applies only at promotion.

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
projectIdOrKey
required
string
ruleId
required
string format: uuid

Query Parameters

Section titled “Query Parameters”
sandboxId
required
string

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
principal
required
string
verb
required
string
itemTypes
Array<string> | null
states
Array<string> | null
fields
Array<string> | null
relationshipTypes
Array<string> | null
transitionIds
Array<string> | null

Example generated

{
  "principal": "example",
  "verb": "example",
  "itemTypes": [
    "example"
  ],
  "states": [
    "example"
  ],
  "fields": [
    "example"
  ],
  "relationshipTypes": [
    "example"
  ],
  "transitionIds": [
    "example"
  ]
}

Responses

Section titled “Responses”

200

Section titled “200”

OK

Media type*/*
object
id
required
string format: uuid
citation
required
string
principal
required
string
verb
required
string
itemTypes
Array<string> | null
states
Array<string> | null
fields
Array<string> | null
relationshipTypes
Array<string> | null
transitionIds
Array<string> | null
templateKey
string | null
origin
required
string
modifiedAt
required
string format: date-time