Resource protection:reservations

New in MC | Cloud UX 2024.10

Overview

The protection:reservations resource represents reservations on assets or location items.

Properties

The protection:reservations resource has the following properties:

reservations

List of reservations.

  • In case of MC|PM, there may be multiple entries, one for each direct reservation on a folder and one for each inherited reservation.

  • In case of MC|AM, there will be at most one item for the reservation on an asset.

Each reservation has the following properties:

creator

Login name of the user that created the reservation.

Currently only available for MC|PM.

expiration

Expiration time. If the value is null or the property is missing, the reservation doesn’t expire.

inherited

  • true: the reservation is inherited from a parent folder.

  • false or missing: the reservation is stored explicitly for the entity and is not inherited.

Currently only available for MC|PM.

Example for an MC|PM reservation:

{
  "creator": "Administrator",
  "expiration": "2024-10-10T11:50:47.069Z",
  "inherited": false
}

Example for an MC|AM reservation:

{
  "expiration": "2024-10-10T11:50:47.069Z"
}

inheritance

  • true: reservations can be inherited from a parent entity (MC|PM)

  • false or missing: no inherited reservations (MC|AM).

perUser

  • true: reservations are created per user and have an owner property (MC|PM)

  • false or missing: reservations are not stored per user (MC|AM).

Link Relations

protection:delete-all-reservations

Deletes all direct reservations on the entity. The caller needs administrative permissions.

protection:delete-reservation-by-creator

Deletes a reservation for a specific user. Only supported for MC|PM. The caller needs administrative permissions.

protection:delete-reservation

Deletes a reservation. If the system uses per-user reservations, the call deletes the reservation of the caller.

protection:set-reservation-for-user

Set a reservation for a specific user. Only supported for MC|PM. The caller needs administrative permissions.

protection:set-reservation

Set a reservation. If the system uses per-user reservations, the reservation is created for the caller.

Examples

Example: MediaCentral Asset Management 
 
{
  "reservations": [
    {
      "expiration": "2024-10-10T13:27:03+02:00"
    }
  ],
  "inheritance": false,
  "perUser": false,
   "_links": {
        "curies": [
            {
                "href": "http://developer.avid.com/ctms/api/protection/linkrels/{rel}.html",
                "name": "protection",
                "templated": true
            }
        ],
        "protection:delete-all-reservations": {
            "href": "https://…​"
        },
        "protection:delete-reservation": {
            "href": "https://…​"
        },
        "protection:set-reservation": {
            "href": "https://…​"
        },
        "self": {
            "href": "https://…​"
        }
    }
}

Example: MediaCentral Production Management 
 
{
  "reservations": [
    {
      "creator": "Administrator",
      "expiration": "2024-10-10T11:50:47.069Z",
      "inherited": false
    },
    {
      "creator": "Administrator",
      "expiration": "2023-11-10T12:50:16.852Z",
      "inherited": true
    }
  ],
  "perUser": true,
  "inheritance": true,
  "_links": {
    "self": {
      "href": "https://…​"
    },
    "protection:set-reservation": {
      "href": "https://…​"
    },
    "protection:set-reservation-for-user": {
      "href": "https://…​"
    },
    "protection:delete-reservation": {
      "href": "https://…​"
    },
    "protection:delete-reservation-by-creator": {
      "href": "https://…​{creator}…​",
      "templated": true
    },
    "protection:delete-all-reservations": {
      "href": "https://…​"
    }
  }
}