Update restrictions

Introduction

It is possible to update the restrictions of an activity definition with the PUT call. This allows you to control which activity definitions can be selected at different levels in the structure.

Endpoint details

URL parameters

These parameters need to be filled in when calling this endpoint.

Body properties

This list of properties is applicable for this endpoint.

External references

It’s possible to use predefined external references and custom external references. More information can be found on the External References Page.

For a list of predefined external references, see the external reference options section.

Examples

Update restrictions with single level

Example updating restrictions for activity definition with internal ID 38fc2206-b51f-434a-9c36-9e0esfc5e70e:

{
  "restrictions": [
    {
      "level": 1,
      "activityDefinitions": [
        {
          "id": "a7d853ea-89eb-4735-83d1-b891c6fde398"
        },
        {
          "id": "22d320ed-f6ed-44bd-b7b1-fe58f518960c"
        }
      ]
    }
  ]
}

Update restrictions with multiple levels

Example updating restrictions across multiple levels:

{
  "restrictions": [
    {
      "level": 1,
      "activityDefinitions": [
        {
          "id": "a7d853ea-89eb-4735-83d1-b891c6fde398"
        },
        {
          "id": "22d320ed-f6ed-44bd-b7b1-fe58f518960c"
        }
      ]
    },
    {
      "level": 3,
      "activityDefinitions": [
        {
          "id": "b2593723-9574-4659-8367-706645454367"
        }
      ]
    }
  ]
}

Clear all restrictions

Example clearing all restrictions for activity definition with internal ID 22d320ed-f6ed-44bd-b7b1-fe58f518960c:

{
  "restrictions": []
}