FileInfo Entity and Derived Structures (2020/10)

12 min

fileinfo is primarily related to the presentation entity but is used in limited way by other entities as well see fileinfo entity and derived structures (2020/10) /#mapping media type references for more information about using this data type the fileinfo collection may contain the elements below in json representation dynamicplaylistfile entity dynamicplaylistflle ('fileinfo type' property set to "dynamicplaylist") is derived from the 'storedfile' structure, and is used to reference dynamic playlists existing in bsn by id see the example below (your values will vary for all but "type") { "type" "dynamicplaylist", // \[string], structure data type visible only in json representation and used by de serializer to determine expected property set of this object instance "name" "my first dynamic playlist", // \[string] "size" 912, // \[uint] "hash" "sha1\ e7ba1a1668ab68e6a0090a0a950d43a25a316d8e", // \[string] "creationdate" "2017 01 15t23 46 46 287z", // \[datetime] "lastmodifieddate" "2018 01 11t10 17 17 960z", // \[datetime] "id" 31711, // \[int] "path" "http //localhost 8081/content/dynamicplaylists/my first dynamic playlist xml" // \[uri] } livemediafeedfile entity livemediafeedfile ('fileinfo type' property set to "livemediafeed") is derived from the 'storedfile' structure, and is used to reference live media feeds existing in bsn by id see the example below (your values will vary for all but "type") { "type" "livemediafeed", // \[string], structure data type visible only in json representation and used by de serializer to determine expected property set of this object instance "name" "my first live media feed", // \[string] "size" 378, // \[uint] "hash" "sha1 4da06fee7fdda07511bc4a876cf79989d034550b", // \[string] "creationdate" "2017 02 08t00 17 38 130z", // \[datetime] "lastmodifieddate" "2017 06 08t11 32 41 280z", // \[datetime] "id" 47324, // \[int] "path" "http //localhost 8081/content/livemediafeeds/my first live media feed xml" // \[uri] } livetextfeedfile entity livetextfeedfile ('fileinfo type' property set to "livetextfeed") is derived from the 'storedfile' structure, and is used to reference live text feeds existing in bsn by id see the example below (your values will vary for all but "type") { "type" "livetextfeed", // \[string], structure data type visible only in json representation and used by de serializer to determine expected property set of this object instance "name" "my first live text feed", // \[string] "size" 912, // \[uint] "hash" "sha1 2c95b879dd75a398cb37aaa7851f3acbc5ce7419", // \[string] "creationdate" "2017 02 08t00 17 57 573z", // \[datetime] "lastmodifieddate" "2018 01 09t23 39 02 123z", // \[datetime] "id" 47325, // \[int] "path" "http //localhost 8081/content/eugene/feeds/my first live text feed xml" // \[uri] } mapping media type references given the fileinfo data types hierarchy, this chart describes the mapping between media types and how to reference them in a presentation creation or update request note that elements will be upgraded to the highest matching type in the server response for example, if you reference "dynamic playlist" by the "storedfile" element it will be returned as a "dynamicplaylistfile" (external) auxiliary stylesheet font text image video audio dynamic playlist tagged playlist live text feed live media feed webpage newfile x x x x x x x x remotefile x x x x x x x x x x x x x storedfile x x x x x x x x x x x x mediafile x x x x dynamicplaylistfile x taggedplaylistfile x livetextfeedfile x livemediafeedfile x webpagefile x mediafile entity mediafile('fileinfo type' property set to "media") derived from the 'storedfile' structure, and is used to reference uploaded files visible in the bsn content library by id see the example below (your values will vary for all but "type") { "type" "media", // \[string], structure data type visible only in json representation and used by de serializer to determine expected property set of this object instance "name" "odessa rain jpg", // \[string] "size" 226675, // \[uint] "hash" "sha1 4b55491958fc06e904d78bf2c965b47629fc5d16", // \[string] "creationdate" "2017 05 22t16 20 26 430z", // \[datetime] "lastmodifieddate" "2016 09 20t09 39 42 253z", // \[datetime] "id" 64947, // \[int] "mediatype" "image", // one of { "text", "image", "video", "audio" } enumeration values "path" "http //localhost 8081/content/images/782e4c7d f5a1 4b21 bd76 3706fff20063 jpg" // \[uri] } newfile entity newfile ('fileinfo type' property set to "new") is derived from the abstract 'fileinfo' structure, and is used to upload small files and for complete presentation creation or updates see the example below (your values will vary for all but "type") { "type" "new", // \[string], structure data type visible only in json representation and used by de serializer to determine expected property set of this object instance "name" "hello txt", // \[string] "size" 12, // \[uint] "hash" "", // \[string] "creationdate" null, // \[datetime] "lastmodifieddate" null, // \[datetime] "body" "sgvsbg8gv29ybgqh", // \[string] "transferencoding" "base64" // one of { "none", "base64" } enumeration values } remotefile entity remotefile ('fileinfo type' property set to "remote") is derived from the abstract 'fileinfo' structure, and is used to reference remote resources or even files uploaded to bsn by url see the example below (your values will vary for all but "type") { "type" "remote", // \[string], structure data type visible only in json representation and used by de serializer to determine expected property set of this object instance "name" "autoplugins brs", // \[string] "size" 222, // \[uint] "hash" "sha1\ ec121a89dfee4e62aa94fac4b9d80f13ea6b0fd6", // \[string] "creationdate" null, // \[datetime] "lastmodifieddate" null, // \[datetime] "path" "https //bsn staging s3 amazonaws com/content/autoplugins/autoplugins ec121a89dfee4e62aa94fac4b9d80f13ea6b0fd6 brs" // one of { "none", "base64" } enumeration values } storedfile entity storedfile ('fileinfo type' property set to "stored") is derived from the abstract 'fileinfo' structure, and is used to reference any file uploaded to bsn by id see the example below (your values will vary for all but "type") { "type" "stored", // \[string], structure data type visible only in json representation and used by de serializer to determine expected property set of this object instance "name" "autoplugins brs", // \[string] "size" 222, // \[uint] "hash" "sha1\ ec121a89dfee4e62aa94fac4b9d80f13ea6b0fd6", // \[string] "creationdate" null, // \[datetime] "lastmodifieddate" null, // \[datetime] "id" 9804728, // \[int] "path" "https //bsn staging s3 amazonaws com/content/autoplugins/autoplugins ec121a89dfee4e62aa94fac4b9d80f13ea6b0fd6 brs" // \[uri] } taggedplaylistfile entity taggedplaylistfile ('fileinfo type' property set to "taggedplaylist") is derived from the 'storedfile' structure, and is used to reference tagged playlists existing in bsn by id see the example below (your values will vary for all but "type") { "type" "taggedplaylist", // \[string], structure data type visible only in json representation and used by de serializer to determine expected property set of this object instance "name" "my first tagged playlist", // \[string] "size" 0, // \[uint] "hash" "sha1\ e7ba1a1668ab68e6a0090a0a950d43a25a316d8e", // \[string] "creationdate" "2017 02 08t00 00 55 273z", // \[datetime] "lastmodifieddate" "2017 02 08t00 00 55 273z", // \[datetime] "id" 47323, // \[int] "path" "http //localhost 8080/bs/getfile ashx?type=taggedplaylist\&token=7e2dbc0cc21e2449d06ca32836ad86bb" // \[uri] } webpagefile entity webpagefile ('fileinfo type' property set to "webpage") is derived from the 'storedfile' structure, and is used to reference (regular) webpages uploaded to bsn by id see the example below (your values will vary for all but "type") { "type" "webpage", // \[string], structure data type visible only in json representation and used by de serializer to determine expected property set of this object instance "name" "my first web page", // \[string] "size" 20224, // \[uint] "hash" "sha1 1f224e31b9265062be58e7d12fe3332e03536d48", // \[string] "creationdate" "2017 02 19t20 10 11 287z", // \[datetime] "lastmodifieddate" "2016 12 01t23 46 35 793z", // \[datetime] "id" 47487, // \[int] "path" "http //localhost 8081/content/webpages/9184f22b 51da 42e3 9900 c9c5bba03e6e html" // \[uri] }