PUT on Primary Event on Playlist (Version 2.0)

Update a Primary Event definition.

Name, house id and created by can't be adjusted from it's original value.

Description, duration, ignore, trigger id, mark in, mark out and metadata can be empty.

Duration defaults to "00:00:00.000" if empty.

Ignore defaults to "false" if empty.

If mark in and mark out have values when house id is empty, they will be ignored as they can't be set for non-video events.

Metadata section will update completely according to how it is specified. If the metadata section is empty, all metadata will be removed. If a metadata attribute is removed, then that metadata will be removed. If metadata values are updated, they will be updated accordingly.

If any values are set for is manually edited, loaded, available, info integrations hub and error, the payload will be accepted but the values will be ignored as they can't be set.

Note: After this request is done the system performs a Page Content Filling process against Promo Server as soon as there is no immediate additional requests sent.

Note: After this request is done the system runs the rules specified under the Rules section.

Syntax

PUT /api/channels/[channel]/playlists/[playlist]/primaryevents/[primary_event]

Request

PUT /api/channels/test/playlists/continuous/primaryevents/primary_element_1_0_0 HTTP/1.1
Content-Type: application/vizrt.integrationshubv2+xml; type=primaryevent
<inthub:primaryEvent xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:inthub="http://www.vizrt.com/integrationshub">
    <inthub:name>primary_element_1_0_0</inthub:name>
    <inthub:description>New description</inthub:description>
    <inthub:startTime>2018-11-06T07:13:40.000Z</inthub:startTime>
    <inthub:duration>02:12:00.000</inthub:duration>
    <inthub:ignore>False</inthub:ignore>
    <inthub:triggerId>primary1001</inthub:triggerId>
    <inthub:createdBy>schedule</inthub:createdBy>
    <inthub:houseId />
    <inthub:markIn />
    <inthub:markOut />
    <inthub:isLocked>false</inthub:isLocked>
    <inthub:isLive>false</inthub:isLive>
    <inthub:metadata>
        <inthub:attribute name="date">2022-03-10</inthub:attribute>
        <inthub:attribute name="time">21:00:00:00</inthub:attribute>
        <inthub:attribute name="event_type">PRIMARY</inthub:attribute>
        <inthub:attribute name="some_metadata">this shows updated metadata</inthub:attribute>
    </inthub:metadata>
</inthub:primaryEvent>

Response

HTTP/1.1 200 OK
Content-Type: application/vizrt.integrationshubv2+xml; type=primaryevent
<inthub:primaryEvent xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:inthub="http://www.vizrt.com/integrationshub">
    <inthub:name>primary_element_1_0_0</inthub:name>
    <inthub:refLink rel="self" type="application/vizrt.integrationshubv2+xml; type=primaryevent" href="http://127.0.0.1:9991/api/channels/test/playlists/continuous/primaryevents/primary_element_1_0_0" />
    <inthub:refLink rel="secondaryevents" type="application/vizrt.integrationshubv2+xml; type=list" href="http://127.0.0.1:9991/api/channels/test/playlists/continuous/primaryevents/primary_element_1_0_0/secondaryevents" />
    <inthub:refLink rel="edit" type="application/vizrt.integrationshubv2+xml; type=primaryevent" href="http://127.0.0.1:9991/api/channels/test/playlists/continuous/primaryevents/primary_element_1_0_0" />
    <inthub:description>New description</inthub:description>
    <inthub:startTime>2018-11-06T07:13:40.000Z</inthub:startTime>
    <inthub:duration>02:12:00.000</inthub:duration>
    <inthub:ignore>false</inthub:ignore>
    <inthub:triggerId>primary1001</inthub:triggerId>
    <inthub:houseId />
    <inthub:markIn />
    <inthub:markOut />
    <inthub:isLocked>false</inthub:isLocked>
    <inthub:isLive>false</inthub:isLive>
    <inthub:isManuallyEdited>false</inthub:isManuallyEdited>
    <inthub:available />
    <inthub:loaded />
    <inthub:infoIntegrationsHub>[U:16:23:40]</inthub:infoIntegrationsHub>
    <inthub:createdBy>schedule</inthub:createdBy>
    <inthub:error />
    <inthub:metadata>
        <inthub:attribute name="date">2022-03-10</inthub:attribute>
        <inthub:attribute name="time">21:00:00:00</inthub:attribute>
        <inthub:attribute name="event_type">PRIMARY</inthub:attribute>
        <inthub:attribute name="some_metadata">this shows updated metadata</inthub:attribute>
    </inthub:metadata>
</inthub:primaryEvent>

Note: If doing a PUT against a URI that doesn't represent an existing Primary Event, the response is 'HTTP/1.1 404 Can't get primary event 'primary_event' for playlist 'playlist_name' in channel 'channel_name'. Primary event not found ' and no update is performed.

Viz Channel Branding User Guide

PUT on Primary Event on Playlist (Version 2.0)

Search results