Skip to content
AveraAveraAvera Documentation

Stage a batch of permission rule changes as one gesture

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

Creates, updates and deletes staged into one change request all-or-nothing, so a save never leaves fragments.

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
projectIdOrKey
required
string

Query Parameters

Section titled “Query Parameters”
sandboxId
required
string

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
ops
required
Array<object>
object
op
required
string
ruleId
string | null format: uuid
rule
One of:
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

{
  "ops": [
    {
      "op": "example",
      "ruleId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "rule": {
        "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*/*
Array<object>
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