Object Interface Related Structures

ObjectInfo

Parameter Name	Required	Type	Explanation
objectId	yes	string	Object ID
objectType	yes	int	Object type
objectName	no	string	Object name
nestedObjects	no	[]NestedObjects	Object properties; for outputObject, its value is: [{destinationObject+encodingObject+nodeObject}]
description	no	string	Description information
admin	no	EntitlementInfo	Administrator permissions for the object
owner	no	EntitlementInfo	Owner permissions for the object
operator	no	EntitlementInfo	Operator permissions for the object; currently not in use
features	no	[]ObjectFeatureInfo	Feature permissions for the object
dmaEmbargo	no	Boolean	DMA Embargo flag for the object
geoInfo	no	[]GeoLocationInfo	Latitude and longitude of the object's geographical location
location	no	[]string	Names of the cities where the object's geographical location is located
origin	no	string	Data source
tags	no	[]string	List of tags bound to the object
tagsInfo	no	[]ObjectTagInfo	List of tags information
holdType	no	Int	Type of the object being used
tangibleInfo	no	[]TangibleInfo	Details of the bound tangibles.

TangibleInfo

Parameter Name	Required	Type	Explanation
tangibleId	yes	string	Tangible ID
tangibleType	yes	string	Tangible type
tangibleName	no	string	Tangible name
distinction	no	string	Distinctions of the tangible, e.g., `rtil`
extraInfo	no	string	Other attributes of the tangible, in JSON string format

EntitlementInfo

Parameter Name	Required	Type	Explanation
groups	no	[]string	Group ID list
users	no	[]string	Users ID list

ObjectFeatureInfo

Parameter Name	Required	Type	Explanation
feature	yes	string	the name of object's feature
groups	yes	[]string	Group ID list
users	yes	[]string	Users ID list

NestedObjects

Parameter Name	Required	Type	Explanation
objectList	no	[]string	List of objects associated with this object.

GeoLocationInfo

Parameter Name	Required	Type	Explanation
lat	no	float	Latitude (lat) measures how far north or south a point is from the Equator, which is defined as 0 degrees latitude. It is also expressed in degrees, with values ranging from 0° to 90° northward and 0° to 90° southward.
lon	no	float	Longitude (lon) measures how far east or west a point is from the Prime Meridian, which is defined as 0 degrees longitude. It is expressed in degrees, with values ranging from 0° to 180° eastward and 0° to 180° westward.

ObjectTagInfo

Parameter Name	Type	Explanation
tagId	string	Tag ID
tagName	string	Tag name
classification	int	Tag type
createTimestamp	long	Tag creation time
groupId	string	Group ID (if applicable)
userId	string	User ID (if applicable)

MediaFileInfo

Parameter Name	Type	Explanation
sourceObjectId	string	The object ID of source
mediaObjectId	string	The object ID of media file.
previewMediaPath	MediaFilePathInfo	Preview media file information
highResMediaPath	MediaFilePathInfo	HD media file information
thumbnailPath	string	Video thumbnail

MediaFilePathInfo

Parameter Name	Type	Explanation
path	string	Full path to media file.
duration	int	Duration of media file.
fileSize	int	Media file size.
startTimestamp	int	Media file start time.
endTimestamp	int	Media file end time.

Modified at 2025-07-14 09:51:57