Attribute Update API (Deprecated)

The Attribute API includes the ability to update attributes of assets and channels.

Note: This software is deprecated. Use the latest version.

The Attribute API includes the ability to update attributes of assets and channels. This allows for programmatic control over certain aspects including Title, Description, Status, Hosted At URL, etc. An update request returns a plain text document containing “OK” on success or error text if an issue is encountered. As in the Query API example, interaction with the Attribute API is through signed REST-style GET requests to http://api.ooyala.com/partner/edit.

Required Parameters:

  • pcode – Account Identifier
  • expires – Query expiration date in seconds since epoch (00:00:00 1/1/1970 GMT)
  • embedCode – Content Identifier
  • signature – The digital signature of the request. The signature should be calculated using SHA-256 with the signature generation rules.

Optional Parameters:

  • title – The title of the video or channel.
  • description – The description of the video or channel.
  • flightEnd – Video or Channel will not be available after this time. Time is specified in ISO_8601 format. [YYYY]-[MM]-[DD]T[HH]:[MM]:[SS]Z
  • flightStart – Video or Channel will be available after this time. Time is specified in ISO_8601 format. [YYYY]-[MM]-[DD]T[HH]:[MM]:[SS]Z
  • status – Status of the video or channel. Options are live, paused, or deleted. Paused leaves the video in your Backlot account, but makes it inaccessible to viewers. Deleted removes the video from your Backlot account and makes it inaccessible to viewers.
  • hostedAt – The URL for the main page the video or channel is embedded which is used in the Info panel of the player and in the RSS feed.
  • remoteAssetURL – The URL of a remote asset. Note: the Engagement report (Analytics) may be incorrect if the length of the new asset is different.
  • remoteAssetDuration – The duration of a remote asset. Note: the Engagement report (Analytics) may be incorrect if the length of the new asset is different.

Update Examples

Update Title and Pause
http://api.ooyala.com/partner/edit?pcode=<pcode>&embedCode=<embedCode>&expires=<expiration>
&status=paused&title=updated%20title&signature=<signature>
Update Hosted At
http://api.ooyala.com/partner/edit?pcode=<pcode>&embedCode=<embedCode>&expires=<expiration>
&hostedAt=http%3A%2F%2Fwww.ooyala.com%2Fbacklot&signature=<signature>

Was this article helpful?