Skip to content

Pages

Get all Pages

GET /api/pages

Returns all the Pages that are currently available in your Erizos Studio environment.

Response

The response is an array of Pages

Create a Page

POST /api/pages

Creates a new page in a show.

Info

This API call will create a new page that can be used in other API requests, but the page will not be visible in Erizos Studio. To make the page availble in Erizos Studio, you will need to use the Create a New Page in Playlist API call.

Request Body 

{
  "show": "5d9f3427238f9f0e53b030f2",
  "name": "My New Page",
  "template": "5dada247f0f446a83ef4a3ed",
  "summary": "A Description of My Page"
}

Parameter Value Description
show UUid The id of the show the page belongs to
name String The name of the page
template UUid The id of the template the page is created from
summary String A description of the page

Response Body 

{
    "_id": "5f490e4c9a230f71d7972d45",
    "show": "5d9f3427238f9f0e53b030f2",
    "name": "My New Page",
    "template": "5dada247f0f446a83ef4a3ed",
    "summary": "A Description of My Page",
    "fields": [],
    "createdAt": "2020-08-28T14:01:48.984Z",
    "updatedAt": "2020-08-28T14:01:48.984Z",
    "_type": "PAGE"
}

Parameter Value Description
show UUid The id of the show the page belongs to
name String The name of the page
template UUid The id of the template the page is created from
summary String A description of the page
fields Array A list of fields in the page
createdAt Date Date and time the playlist was created
updatedAt Date Date and time the playlist was last updated

Get Page by ID

GET /api/pages/[ID]

Returns the page that corresponds to the page ID.

Request

Parameter Type Description
ID Uuid id of the Page

Response

Page Object

Update a Page

PUT /api/pages/[ID]

Updates the page.

Request

Parameter Type Description
ID Uuid id of the Page

Request Body

{
    "name": [PAGE NAME (STRING)],
    "summary": [PAGE SUMMARY (STRING)],
}

Response

The updated Page object.

Delete Page by ID

DELETE /api/pages/[ID]

Deletes the page that corresponds to the page ID.

Request

Parameter Type Description
ID Uuid id of the Page