getEffectivePolicy

GET

/api/v1/screens/{id}/effective-policy

curl --request GET \
  --url https://example.com/api/v1/screens/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/effective-policy \
  --cookie tilecast_session=<tilecast_session>

Requires an authenticated user with the read scope. Reports the effective player policy for one screen with inheritance sources. A screen outside the caller’s scope answers 404.

Authorizations

• sessionCookie
• userBearer

Parameters

Path Parameters

id

required

string format: uuid

Responses

200

Effective policy

Media typeapplication/json

object

data

required

Effective player policy for one screen with inheritance sources.

object

values

required

object

key

additional properties

object

value

required

source

required

string

sourceId

string format: uuid

organizationRevision

required

integer format: int64

groupRevisions

required

object

key

additional properties

integer format: int64

screenRevision

required

integer format: int64

configRevision

required

integer format: int64

hash

required

string

Example^generated

{
  "data": {
    "values": {
      "additionalProperty": {
        "value": "example",
        "source": "example",
        "sourceId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
      }
    },
    "organizationRevision": 1,
    "groupRevisions": {
      "additionalProperty": 1
    },
    "screenRevision": 1,
    "configRevision": 1,
    "hash": "example"
  }
}

401

Dashboard authentication required

404

Screen unknown or outside caller scope