{"_id":"54ad5a55f6f5b10b0066dcb7","version":{"_id":"54343531bfaa3d0800c4d4af","project":"54343170fa5527080064f449","__v":27,"forked_from":"54343170fa5527080064f44c","createdAt":"2014-10-07T18:47:13.086Z","releaseDate":"2014-10-07T18:47:13.086Z","categories":["54343531bfaa3d0800c4d4b0","543435b1edce040800409240","543435b9edce040800409241","543435bcedce040800409243","543435bfedce040800409244","543435c2edce040800409245","54370cc426469424002a6dfa","54370cf026469424002a6dfd","5437129d26469424002a6e2f","543712d226469424002a6e30","5480c8fd74904f1a00053c86","54aafc6eefb39016009e4d71","54ac1d36de18cc1400226e01","54ad59369219922100751732","54b41bcf4f25cb1600518d2c","54b533a3a806f40c0050d53c","54b54bbf96fe3c0b00d38d2a","54b688a27379a90c00f53a8a","54b699efbc1a46160005edfa","54b8191691011f0b00068804","54bfb002d03bfc0d0000e814","54bfb33ed03bfc0d0000e816","55a3e94e912a6e2300882cdb","55a56c370f354f0d00fd02a8","55e85ad034516037002e9325","5638ecb62fc5520d001a4cf9","572cba2fc310640e008f63d5"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"3.0.0","version":"3.0"},"category":{"_id":"54ad59369219922100751732","version":"54343531bfaa3d0800c4d4af","__v":10,"project":"54343170fa5527080064f449","pages":["54ad5a55f6f5b10b0066dcb7","54ad659a9219922100751754","54ad6e40921992210075176c","54ad7476921992210075178b","54ad7514f6f5b10b0066dceb","54ad91e35ff7ef2a009ce66a","54b407c773abe90b0010709b","54b410d8fed7861600c31e31","54b413dffed7861600c31e3e","54b417994f25cb1600518d19"],"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-01-07T16:05:10.498Z","from_sync":false,"order":8,"slug":"quick-links","title":"Quick Links"},"project":"54343170fa5527080064f449","parentDoc":null,"user":"543532513513400800a144f4","__v":18,"updates":["54c6ab43f0320f0d00ac9c3b"],"next":{"pages":[],"description":""},"createdAt":"2015-01-07T16:09:57.552Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"auth":"required","params":[],"url":""},"isReference":false,"order":0,"body":"QuickLinks allow you to share your assets with others. QuickLinks are links to groups of your assets that can be viewed in the cloud through MediaSilo.\n\nQuickLinks support authorization to keep your assets secure. Each QuickLink can be public, protected with a password, or it can be limited to only specific recipients who are MediaSilo users on your team.\n\nQuickLinks are collaborative. Your team can make comments on your assets and you'll be notified when they do. Comments on time-based media are also time-stamped so your reviewers can leave comments at a specific moment in your video or audio assets.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Configuration\"\n}\n[/block]\nQuickLinks are configurable. Each QuickLink has an embedded object in it that defines its configuration. The following configurations can be made to each QuickLink:\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Setting\",\n    \"h-1\": \"Possible Values\",\n    \"0-0\": \"audience - \\n*Defines who has access to the QuickLink*\",\n    \"0-1\": \"**private**: only the audience of the QuickLink can view the QuickLink. The audience is anyone who the QuickLink was shared with via the share API.\\n\\n**password**: Anyone with the password can access the QuickLink. The password for the QuickLink is set through the *password* configuration.\\n\\n**public**: Anyone with the link can view the QuickLink.\",\n    \"1-0\": \"allow_download -\\n*Defines if the assets source file can be downloaded through the QuickLink. *\",\n    \"1-1\": \"**true/false**\",\n    \"2-0\": \"allow_feedback - *Turns commenting on the QuickLink on and off.*\",\n    \"2-1\": \"**true/false**\",\n    \"3-0\": \"show_metadata - *Turns the display of the assets meta data on and off*\",\n    \"3-1\": \"**true/false**\",\n    \"4-0\": \"include_directlink - *Turns the ability to deep link to the assets within MediaSilo on and off*\",\n    \"4-1\": \"**true/false**\",\n    \"5-0\": \"password - *For password protected QuickLinks, sets the password for users to access the QuickLink*\",\n    \"5-1\": \"*Your password*\",\n    \"6-0\": \"expiration_unit - *Sets the time period unit used in conjunction with expiration_value to expire a QuickLink*\",\n    \"6-1\": \"**days/weeks**\",\n    \"7-0\": \"expiration_value - *Used in conjuntion with expiration_unit to expire a QuickLink*\",\n    \"7-1\": \"*Integer*\"\n  },\n  \"cols\": 2,\n  \"rows\": 8\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Sharing\"\n}\n[/block]\nEach QuickLink can be shared via email. By using QuickLink sharing we can track who is sharing assets, who has access to the QuickLink, as well as who is viewing the QuickLink. Each share has an audience, as well as a subject and message that will be delivered to each person in the audience. See the share endpoint for more details. \n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Data\"\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n    \\\"id\\\": \\\"54XX0448X4X0X05XX72X7009\\\",\\n    \\\"title\\\": \\\"hot_air_baloon.jpg\\\",\\n    \\\"description\\\": \\\"Baloon Festival\\\",\\n    \\\"assetIds\\\": [\\n        \\\"6X6X3X61-51XX-4X2X-XXXX-03X358X74971\\\"\\n    ],\\n    \\\"configuration\\\": {\\n        \\\"id\\\": \\\"6X6X3X61-51XX-4X2X-XXXX-03X358X74972\\\",\\n        \\\"settings\\\": [\\n            {\\n                \\\"key\\\": \\\"notify_email\\\",\\n                \\\"value\\\": \\\"true\\\"\\n            },\\n            {\\n                \\\"key\\\": \\\"allow_download\\\",\\n                \\\"value\\\": \\\"true\\\"\\n            },\\n            {\\n                \\\"key\\\": \\\"show_metadata\\\",\\n                \\\"value\\\": \\\"false\\\"\\n            },\\n            {\\n                \\\"key\\\": \\\"audience\\\",\\n                \\\"value\\\": \\\"public\\\"\\n            },\\n            {\\n                \\\"key\\\": \\\"playback\\\",\\n                \\\"value\\\": \\\"progressive\\\"\\n            },\\n            {\\n                \\\"key\\\": \\\"password\\\",\\n                \\\"value\\\": \\\"\\\"\\n            },\\n            {\\n                \\\"key\\\": \\\"allow_feedback\\\",\\n                \\\"value\\\": \\\"true\\\"\\n            },\\n            {\\n                \\\"key\\\": \\\"include_directlink\\\",\\n                \\\"value\\\": \\\"false\\\"\\n            }\\n        ]\\n    },\\n    \\\"shares\\\":[\\n        {\\n            \\\"id\\\": \\\"54ad5dd4e4b08fc2e3e63ab4\\\",\\n            \\\"targetObjectId\\\": \\\"54ac0448e4b0b05ce72f7009\\\",\\n            \\\"emailShare\\\": {\\n                \\\"audience\\\": [\\n                    {\\n                        \\\"firstName\\\": \\\"Mike\\\",\\n                        \\\"lastName\\\": \\\"McGum\\\",\\n                        \\\"email\\\": \\\"mike:::at:::example.com\\\",\\n                        \\\"userId\\\": \\\"5991XX46-9XXX-4XXX-9XXX-6181014866XX\\\"\\n                    }\\n                ],\\n                \\\"subject\\\": \\\"Check out the baloon festival!\\\",\\n                \\\"message\\\": \\\"\\\"\\n            },\\n            \\\"created\\\": 1420647892779,\\n            \\\"sharedBy\\\": \\\"6EF6C1E9-E130-2427-8641E1A2E3DA4C8D\\\",\\n            \\\"sharedByFirstName\\\": \\\"Simon\\\",\\n            \\\"sharedByLastName\\\": \\\"Smith\\\",\\n            \\\"sharedByEmail\\\": \\\"simon@example.com\\\"\\n        }\\n    ],\\n    \\\"ownerId\\\": \\\"X94X820X-094X-4304-9XXX-1X141XXX5X6\\\",\\n    \\\"accountId\\\": \\\"1234567XXXXXXX\\\",\\n    \\\"created\\\": 1420559432202,\\n    \\\"modified\\\": 1420559432202,\\n    \\\"expires\\\": 1428335432214,\\n    \\\"url\\\": \\\"https://qlnk.io/ql/54XX0448X4X0X05XX72X7009\\\",\\n    \\\"private\\\": false\\n}\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]","excerpt":"","slug":"overview-4","type":"basic","title":"Overview"}
QuickLinks allow you to share your assets with others. QuickLinks are links to groups of your assets that can be viewed in the cloud through MediaSilo. QuickLinks support authorization to keep your assets secure. Each QuickLink can be public, protected with a password, or it can be limited to only specific recipients who are MediaSilo users on your team. QuickLinks are collaborative. Your team can make comments on your assets and you'll be notified when they do. Comments on time-based media are also time-stamped so your reviewers can leave comments at a specific moment in your video or audio assets. [block:api-header] { "type": "basic", "title": "Configuration" } [/block] QuickLinks are configurable. Each QuickLink has an embedded object in it that defines its configuration. The following configurations can be made to each QuickLink: [block:parameters] { "data": { "h-0": "Setting", "h-1": "Possible Values", "0-0": "audience - \n*Defines who has access to the QuickLink*", "0-1": "**private**: only the audience of the QuickLink can view the QuickLink. The audience is anyone who the QuickLink was shared with via the share API.\n\n**password**: Anyone with the password can access the QuickLink. The password for the QuickLink is set through the *password* configuration.\n\n**public**: Anyone with the link can view the QuickLink.", "1-0": "allow_download -\n*Defines if the assets source file can be downloaded through the QuickLink. *", "1-1": "**true/false**", "2-0": "allow_feedback - *Turns commenting on the QuickLink on and off.*", "2-1": "**true/false**", "3-0": "show_metadata - *Turns the display of the assets meta data on and off*", "3-1": "**true/false**", "4-0": "include_directlink - *Turns the ability to deep link to the assets within MediaSilo on and off*", "4-1": "**true/false**", "5-0": "password - *For password protected QuickLinks, sets the password for users to access the QuickLink*", "5-1": "*Your password*", "6-0": "expiration_unit - *Sets the time period unit used in conjunction with expiration_value to expire a QuickLink*", "6-1": "**days/weeks**", "7-0": "expiration_value - *Used in conjuntion with expiration_unit to expire a QuickLink*", "7-1": "*Integer*" }, "cols": 2, "rows": 8 } [/block] [block:api-header] { "type": "basic", "title": "Sharing" } [/block] Each QuickLink can be shared via email. By using QuickLink sharing we can track who is sharing assets, who has access to the QuickLink, as well as who is viewing the QuickLink. Each share has an audience, as well as a subject and message that will be delivered to each person in the audience. See the share endpoint for more details. [block:api-header] { "type": "basic", "title": "Data" } [/block] [block:code] { "codes": [ { "code": "{\n \"id\": \"54XX0448X4X0X05XX72X7009\",\n \"title\": \"hot_air_baloon.jpg\",\n \"description\": \"Baloon Festival\",\n \"assetIds\": [\n \"6X6X3X61-51XX-4X2X-XXXX-03X358X74971\"\n ],\n \"configuration\": {\n \"id\": \"6X6X3X61-51XX-4X2X-XXXX-03X358X74972\",\n \"settings\": [\n {\n \"key\": \"notify_email\",\n \"value\": \"true\"\n },\n {\n \"key\": \"allow_download\",\n \"value\": \"true\"\n },\n {\n \"key\": \"show_metadata\",\n \"value\": \"false\"\n },\n {\n \"key\": \"audience\",\n \"value\": \"public\"\n },\n {\n \"key\": \"playback\",\n \"value\": \"progressive\"\n },\n {\n \"key\": \"password\",\n \"value\": \"\"\n },\n {\n \"key\": \"allow_feedback\",\n \"value\": \"true\"\n },\n {\n \"key\": \"include_directlink\",\n \"value\": \"false\"\n }\n ]\n },\n \"shares\":[\n {\n \"id\": \"54ad5dd4e4b08fc2e3e63ab4\",\n \"targetObjectId\": \"54ac0448e4b0b05ce72f7009\",\n \"emailShare\": {\n \"audience\": [\n {\n \"firstName\": \"Mike\",\n \"lastName\": \"McGum\",\n \"email\": \"mike@example.com\",\n \"userId\": \"5991XX46-9XXX-4XXX-9XXX-6181014866XX\"\n }\n ],\n \"subject\": \"Check out the baloon festival!\",\n \"message\": \"\"\n },\n \"created\": 1420647892779,\n \"sharedBy\": \"6EF6C1E9-E130-2427-8641E1A2E3DA4C8D\",\n \"sharedByFirstName\": \"Simon\",\n \"sharedByLastName\": \"Smith\",\n \"sharedByEmail\": \"simon@example.com\"\n }\n ],\n \"ownerId\": \"X94X820X-094X-4304-9XXX-1X141XXX5X6\",\n \"accountId\": \"1234567XXXXXXX\",\n \"created\": 1420559432202,\n \"modified\": 1420559432202,\n \"expires\": 1428335432214,\n \"url\": \"https://qlnk.io/ql/54XX0448X4X0X05XX72X7009\",\n \"private\": false\n}", "language": "json" } ] } [/block]