Difference between revisions of "API Assets List"

From unroole CMS wiki
Jump to: navigation, search
(Created page with "== Summary == Allows querying for a list of assets. The query is a wildcard search on the asset's: * id * name * description * content_type * type * file_name * upload_id * ta...")
 
 
(20 intermediate revisions by 3 users not shown)
Line 11: Line 11:
  
 
== URI ==
 
== URI ==
−
http://[channel_subdomain]-[account_subdomain].unroole.com/unroole/admin/assets/list
+
{{:API_Base_URI}}accounts/[account-id]/assets
−
 
+
−
[channel_subdomain] is optional
+
  
 
== HTTP Method ==
 
== HTTP Method ==
 
GET
 
GET
 +
 
== Required Paramaters ==
 
== Required Paramaters ==
  
Line 26: Line 25:
 
! Accepted Values
 
! Accepted Values
 
! Description
 
! Description
 +
{{:API Required Parameter Common}}
 +
|}
 +
 +
== Optional Paramaters ==
 +
 +
{| class="wikitable"
 
|-
 
|-
−
| token
+
! Paramater
 +
! Default
 +
! Maximum Length
 +
! Accepted Values
 +
! Description
 +
|-
 +
| search
 +
| string
 
|  
 
|  
 
|
 
|
 +
| The search terms to be used in the query.
 +
|-
 +
| limit
 +
| 500
 +
|
 
|
 
|
−
| [[API Persistence Token]] that identifies this user and its permissions.
+
| The maximum number of assets to return.
 +
|-
 +
| fields
 +
| id, name, file_name, url
 +
|
 +
| [[API Asset Fields]]
 +
| List of comma separated fields to be returned in the response.
 +
|-
 +
| page
 +
| 1
 +
| Depends on query
 +
| Integer
 +
| The current pages to display based on the limit.
 +
|-
 +
| url_time_limit
 +
| 60
 +
|
 +
|
 +
| The length of time (in seconds) that the asset url will be accessible for if the asset is private. This only applies to the response.
 +
|}
 +
 
 +
== Response ==
 +
 
 +
{| class="wikitable"
 +
|-
 +
! Field
 +
! Type
 +
! Description
 +
{{:API Response Common}}
 +
|-
 +
| assets
 +
| array of [[API Asset Fields]]
 +
| List of files that matched the search query
 +
|-
 +
| page
 +
| integer
 +
| The current viewed page of results.
 +
|-
 +
| per-page
 +
| integer
 +
| The maximum number of results to return per page.
 +
|-
 +
| total-pages
 +
| integer
 +
| The total number of pages that exist.
 +
|-
 +
| total-entries
 +
| integer
 +
| The total number of entries found from all pages.
 +
|-
 +
| result_length
 +
| integer
 +
| Total number of results that have been returned on this page. This may differ from the per-page/limit value on the last page.
 +
|}
 +
 
 +
== Examples ==
 +
 
 +
=== All assets on an account ===
 +
 
 +
{| class="wikitable"
 +
|-
 +
! Parameters
 +
! Values
 +
|-
 +
| token
 +
| 1f0qpLwoV5oIcfnU2yvO
 +
|}
 +
 
 +
{| class="wikitable collapsible collapsed"
 +
|-
 +
! JSON
 +
|-
 +
| <nowiki>http://api.unroole.com/accounts/1/assets.json?token=1f0qpLwoV5oIcfnU2yvO</nowiki>
 +
|-
 +
| <blockquote>
 +
<nowiki>
 +
{ "assets" : [ { "file_name" : "に頭頂高18ｍ.jpg",
 +
        "id" : 303,
 +
        "name" : "に頭頂高18ｍ",
 +
        "url" : "https://cdn-unroole-dev.s3.amazonaws.com/system/asset_images/303/original/%E3%81%AB%E9%A0%AD%E9%A0%82%E9%AB%9818%EF%BD%8D.jpg?AWSAccessKeyId=AKIAI54VTHLBTQ46H3FA&Signature=ClwlDVpA2qgA9ho18aObeqPPFKc%3D&Expires=1340637051&updated_at=1340636398"
 +
      },
 +
      { "file_name" : "GONews_SpecEd_ENG.pdf",
 +
        "id" : 302,
 +
        "name" : "GONews_SpecEd_ENG",
 +
        "url" : "https://cdn-unroole-dev.s3.amazonaws.com/system/asset_pdfs/302/original/GONews_SpecEd_ENG.pdf?AWSAccessKeyId=AKIAI54VTHLBTQ46H3FA&Signature=t1%2B%2BK7MKBS97C2RpHuy0n%2FM5GZk%3D&Expires=1340637051&updated_at=1340636388"
 +
      },
 +
      { "file_name" : "crowd_outside_1.wav",
 +
        "id" : 301,
 +
        "name" : "crowd_outside_1",
 +
        "url" : "https://cdn-unroole-dev.s3.amazonaws.com/system/asset_documents/301/original/crowd_outside_1.wav?AWSAccessKeyId=AKIAI54VTHLBTQ46H3FA&Signature=Xk6IM4l2mdAHyzIZWOeH4AxynQA%3D&Expires=1340637051&updated_at=1340636375"
 +
      },
 +
      { "file_name" : "bash.pdf",
 +
        "id" : 300,
 +
        "name" : "bash",
 +
        "url" : "https://cdn-unroole-dev.s3.amazonaws.com/system/asset_pdfs/300/original/bash.pdf?AWSAccessKeyId=AKIAI54VTHLBTQ46H3FA&Signature=qbKYr0pPpNKbm5ZF4EDP%2FMWa%2FJE%3D&Expires=1340637051&updated_at=1340636372"
 +
      },
 +
      { "file_name" : "Ace_Auto_Parts.xls",
 +
        "id" : 299,
 +
        "name" : "Ace_Auto_Parts",
 +
        "url" : "https://cdn-unroole-dev.s3.amazonaws.com/system/asset_documents/299/original/Ace_Auto_Parts.xls?AWSAccessKeyId=AKIAI54VTHLBTQ46H3FA&Signature=I5mdAQIr0VGZh1QyoBXcoeGOrhw%3D&Expires=1340637051&updated_at=1340636363"
 +
      },
 +
      { "file_name" : "another-earth-in-outer-space.jpg",
 +
        "id" : 108,
 +
        "name" : "Another Earth in Outer Space?",
 +
        "url" : "http://www.youtube.com/v/j1GOm1mxHA8&feature=youtube_gdata_player"
 +
      },
 +
      { "file_name" : "seeing-earth-in-space-new-iss-timelapse-footage.jpg",
 +
        "id" : 107,
 +
        "name" : "Seeing Earth IN Space [new ISS timelapse footage]",
 +
        "url" : "http://www.youtube.com/v/BEhIGoq9tow&feature=youtube_gdata_player"
 +
      },
 +
      { "file_name" : "ad_1a.jpg",
 +
        "id" : 104,
 +
        "name" : "ad_1a",
 +
        "url" : "https://cdn-unroole-dev.s3.amazonaws.com/system/asset_images/104/original/ad_1a.jpg?1340116307&updated_at=1340116308"
 +
      },
 +
      { "file_name" : "ad_1.jpg",
 +
        "id" : 103,
 +
        "name" : "ad_1",
 +
        "url" : "https://cdn-unroole-dev.s3.amazonaws.com/system/asset_images/103/original/ad_1.jpg?1340116301&updated_at=1340116303"
 +
      },
 +
      { "file_name" : "1024x748.jpg",
 +
        "id" : 6,
 +
        "name" : "1024x748",
 +
        "url" : "https://cdn-unroole-dev.s3.amazonaws.com/system/asset_images/6/original/1024x748.jpg?1340033051&updated_at=1340636799"
 +
      },
 +
      { "file_name" : "opo0301a.jpg",
 +
        "id" : 5,
 +
        "name" : "opo0301a",
 +
        "url" : "https://cdn-unroole-dev.s3.amazonaws.com/system/asset_images/5/original/opo0301a.jpg?1339696912&updated_at=1340636802"
 +
      },
 +
      { "file_name" : "opo0214a.jpg",
 +
        "id" : 4,
 +
        "name" : "opo0214a",
 +
        "url" : "https://cdn-unroole-dev.s3.amazonaws.com/system/asset_images/4/original/opo0214a.jpg?1339696908&updated_at=1340636803"
 +
      },
 +
      { "file_name" : "opo0212a.jpg",
 +
        "id" : 3,
 +
        "name" : "opo0212a",
 +
        "url" : "https://cdn-unroole-dev.s3.amazonaws.com/system/asset_images/3/original/opo0212a.jpg?AWSAccessKeyId=AKIAI54VTHLBTQ46H3FA&Signature=ROGyrA5fb7tWnKg92XVL%2FWp0bR8%3D&Expires=1340637051&updated_at=1339696904"
 +
      },
 +
      { "file_name" : "opo0207a.jpg",
 +
        "id" : 2,
 +
        "name" : "opo0207a",
 +
        "url" : "https://cdn-unroole-dev.s3.amazonaws.com/system/asset_images/2/original/opo0207a.jpg?AWSAccessKeyId=AKIAI54VTHLBTQ46H3FA&Signature=8LsKc4CzUrRnmzXtpy16qQW%2Fsew%3D&Expires=1340637051&updated_at=1339696900"
 +
      },
 +
      { "file_name" : "opo0201a.jpg",
 +
        "id" : 1,
 +
        "name" : "opo0201a",
 +
        "url" : "https://cdn-unroole-dev.s3.amazonaws.com/system/asset_images/1/original/opo0201a.jpg?AWSAccessKeyId=AKIAI54VTHLBTQ46H3FA&Signature=QVzWq6td%2BI8dp4UiTGHyNBomOWg%3D&Expires=1340637051&updated_at=1339696895"
 +
      }
 +
    ],
 +
  "http_status" : 200,
 +
  “page” : 1,
 +
  “per-page” : 500,
 +
  “total-pages” : 1
 +
  “total-entries” : 15,
 +
  “result_length” : 15
 +
}
 +
</nowiki>
 +
</blockquote>
 +
|}
 +
 
 +
{| class="wikitable collapsible collapsed"
 +
|-
 +
! XML
 +
|-
 +
| <nowiki>http://api.unroole.com/accounts.xml?token=1f0qpLwoV5oIcfnU2yvO</nowiki>
 +
|-
 +
| <blockquote>
 +
<nowiki>
 +
<?xml version="1.0" encoding="UTF-8"?>
 +
<hash>
 +
  <assets type="array">
 +
    <asset>
 +
      <id type="integer">303</id>
 +
      <name>に頭頂高18ｍ</name>
 +
      <file-name>に頭頂高18ｍ.jpg</file-name>
 +
      <url>https://cdn-unroole-dev.s3.amazonaws.com/system/asset_images/303/original/%E3%81%AB%E9%A0%AD%E9%A0%82%E9%AB%9818%EF%BD%8D.jpg?AWSAccessKeyId=AKIAI54VTHLBTQ46H3FA&amp;Signature=xtjsSeNcGkCv9rqz08xgV2ZE230%3D&amp;Expires=1340637308&amp;updated_at=1340636398</url>
 +
    </asset>
 +
    <asset>
 +
      <id type="integer">302</id>
 +
      <name>GONews_SpecEd_ENG</name>
 +
      <file-name>GONews_SpecEd_ENG.pdf</file-name>
 +
      <url>https://cdn-unroole-dev.s3.amazonaws.com/system/asset_pdfs/302/original/GONews_SpecEd_ENG.pdf?AWSAccessKeyId=AKIAI54VTHLBTQ46H3FA&amp;Signature=KfXZSbE8bA4N4yErZX0Me2Kazgo%3D&amp;Expires=1340637308&amp;updated_at=1340636388</url>
 +
    </asset>
 +
    <asset>
 +
      <id type="integer">301</id>
 +
      <name>crowd_outside_1</name>
 +
      <file-name>crowd_outside_1.wav</file-name>
 +
      <url>https://cdn-unroole-dev.s3.amazonaws.com/system/asset_documents/301/original/crowd_outside_1.wav?AWSAccessKeyId=AKIAI54VTHLBTQ46H3FA&amp;Signature=pwTlFVdqv%2B9zIEoTU4ULEOAgAtc%3D&amp;Expires=1340637308&amp;updated_at=1340636375</url>
 +
    </asset>
 +
    <asset>
 +
      <id type="integer">300</id>
 +
      <name>bash</name>
 +
      <file-name>bash.pdf</file-name>
 +
      <url>https://cdn-unroole-dev.s3.amazonaws.com/system/asset_pdfs/300/original/bash.pdf?AWSAccessKeyId=AKIAI54VTHLBTQ46H3FA&amp;Signature=aiDi7sjv%2BJlU93q52bGVuPAQd60%3D&amp;Expires=1340637308&amp;updated_at=1340636372</url>
 +
    </asset>
 +
    <asset>
 +
      <id type="integer">299</id>
 +
      <name>Ace_Auto_Parts</name>
 +
      <file-name>Ace_Auto_Parts.xls</file-name>
 +
      <url>https://cdn-unroole-dev.s3.amazonaws.com/system/asset_documents/299/original/Ace_Auto_Parts.xls?AWSAccessKeyId=AKIAI54VTHLBTQ46H3FA&amp;Signature=gqltD%2BTlw%2Bsa1dxQyt4rnVRRyjM%3D&amp;Expires=1340637308&amp;updated_at=1340636363</url>
 +
    </asset>
 +
    <asset>
 +
      <id type="integer">108</id>
 +
      <name>Another Earth in Outer Space?</name>
 +
      <file-name>another-earth-in-outer-space.jpg</file-name>
 +
      <url>http://www.youtube.com/v/j1GOm1mxHA8&amp;feature=youtube_gdata_player</url>
 +
    </asset>
 +
    <asset>
 +
      <id type="integer">107</id>
 +
      <name>Seeing Earth IN Space [new ISS timelapse footage]</name>
 +
      <file-name>seeing-earth-in-space-new-iss-timelapse-footage.jpg</file-name>
 +
      <url>http://www.youtube.com/v/BEhIGoq9tow&amp;feature=youtube_gdata_player</url>
 +
    </asset>
 +
    <asset>
 +
      <id type="integer">104</id>
 +
      <name>ad_1a</name>
 +
      <file-name>ad_1a.jpg</file-name>
 +
      <url>https://cdn-unroole-dev.s3.amazonaws.com/system/asset_images/104/original/ad_1a.jpg?1340116307&amp;updated_at=1340116308</url>
 +
    </asset>
 +
    <asset>
 +
      <id type="integer">103</id>
 +
      <name>ad_1</name>
 +
      <file-name>ad_1.jpg</file-name>
 +
      <url>https://cdn-unroole-dev.s3.amazonaws.com/system/asset_images/103/original/ad_1.jpg?1340116301&amp;updated_at=1340116303</url>
 +
    </asset>
 +
    <asset>
 +
      <id type="integer">6</id>
 +
      <name>1024x748</name>
 +
      <file-name>1024x748.jpg</file-name>
 +
      <url>https://cdn-unroole-dev.s3.amazonaws.com/system/asset_images/6/original/1024x748.jpg?1340033051&amp;updated_at=1340636799</url>
 +
    </asset>
 +
    <asset>
 +
      <id type="integer">5</id>
 +
      <name>opo0301a</name>
 +
      <file-name>opo0301a.jpg</file-name>
 +
      <url>https://cdn-unroole-dev.s3.amazonaws.com/system/asset_images/5/original/opo0301a.jpg?1339696912&amp;updated_at=1340636802</url>
 +
    </asset>
 +
    <asset>
 +
      <id type="integer">4</id>
 +
      <name>opo0214a</name>
 +
      <file-name>opo0214a.jpg</file-name>
 +
      <url>https://cdn-unroole-dev.s3.amazonaws.com/system/asset_images/4/original/opo0214a.jpg?1339696908&amp;updated_at=1340636803</url>
 +
    </asset>
 +
    <asset>
 +
      <id type="integer">3</id>
 +
      <name>opo0212a</name>
 +
      <file-name>opo0212a.jpg</file-name>
 +
      <url>https://cdn-unroole-dev.s3.amazonaws.com/system/asset_images/3/original/opo0212a.jpg?AWSAccessKeyId=AKIAI54VTHLBTQ46H3FA&amp;Signature=j0InYb5bsws6PDB%2FUuonwRz6DdE%3D&amp;Expires=1340637311&amp;updated_at=1339696904</url>
 +
    </asset>
 +
    <asset>
 +
      <id type="integer">2</id>
 +
      <name>opo0207a</name>
 +
      <file-name>opo0207a.jpg</file-name>
 +
      <url>https://cdn-unroole-dev.s3.amazonaws.com/system/asset_images/2/original/opo0207a.jpg?AWSAccessKeyId=AKIAI54VTHLBTQ46H3FA&amp;Signature=%2FaS%2FTzrmn%2BmylErDfz%2FXnlyYuAg%3D&amp;Expires=1340637311&amp;updated_at=1339696900</url>
 +
    </asset>
 +
    <asset>
 +
      <id type="integer">1</id>
 +
      <name>opo0201a</name>
 +
      <file-name>opo0201a.jpg</file-name>
 +
      <url>https://cdn-unroole-dev.s3.amazonaws.com/system/asset_images/1/original/opo0201a.jpg?AWSAccessKeyId=AKIAI54VTHLBTQ46H3FA&amp;Signature=j24MQmhxX54Qvju9o1DflXCBqew%3D&amp;Expires=1340637311&amp;updated_at=1339696895</url>
 +
    </asset>
 +
  </assets>
 +
  <page type="integer">1</page>
 +
  <per-page” type="integer">500</per-page”>
 +
  <total-pages type="integer">1</total-pages>
 +
  <total-entries type="integer">15</total-entries>
 +
  <result-length type="integer">15</result-length>
 +
  <http-status type="integer">200</http-status>
 +
</hash>
 +
 
 +
</nowiki>
 +
</blockquote>
 +
|}
 +
 
 +
=== All pdfs on an account ===
 +
 
 +
{| class="wikitable"
 +
|-
 +
! Parameters
 +
! Values
 +
|-
 +
| token
 +
| 1f0qpLwoV5oIcfnU2yvO
 +
|-
 +
| search
 +
| pdf
 +
|-
 +
| fields
 +
| id,name,description,file_name,content_type,file_size,updated_at,created_at,type,video_id,dimensions,upload_id,private,sharable,editable,printable,used,tags,url,styles
 +
|}
 +
 
 +
{| class="wikitable collapsible collapsed"
 +
|-
 +
! JSON
 +
|-
 +
| <nowiki>http://api.unroole.com/accounts/1/assets.json?token=1f0qpLwoV5oIcfnU2yvO&search=pdf&fields=id,name,description,file_name,content_type,file_size,updated_at,created_at,type,video_id,dimensions,upload_id,private,sharable,editable,printable,used,tags,url,styles</nowiki>
 +
|-
 +
| <blockquote>
 +
<nowiki>
 +
{ "assets" : [ { "content_type" : "application/pdf",
 +
        "created_at" : "2012-06-25T14:59:48Z",
 +
        "description" : "",
 +
        "dimensions" : {  },
 +
        "editable" : false,
 +
        "file_name" : "GONews_SpecEd_ENG.pdf",
 +
        "file_size" : 692261,
 +
        "id" : 302,
 +
        "name" : "GONews_SpecEd_ENG",
 +
        "printable" : true,
 +
        "private" : true,
 +
        "sharable" : false,
 +
        "styles" : {  },
 +
        "tags" : [ "pdf",
 +
            "train",
 +
            "go",
 +
            "newsletter"
 +
          ],
 +
        "type" : "Pdf",
 +
        "upload_id" : "asset_upload_d04ea4e4",
 +
        "url" : "https://cdn-unroole-dev.s3.amazonaws.com/system/asset_pdfs/302/original/GONews_SpecEd_ENG.pdf?AWSAccessKeyId=AKIAI54VTHLBTQ46H3FA&Signature=SqhpaVHcf%2BdCv8QE%2BAM32AADg20%3D&Expires=1340638792&updated_at=1340636388",
 +
        "video_id" : null
 +
      },
 +
      { "content_type" : "application/pdf",
 +
        "created_at" : "2012-06-25T14:59:32Z",
 +
        "description" : "",
 +
        "dimensions" : {  },
 +
        "editable" : false,
 +
        "file_name" : "bash.pdf",
 +
        "file_size" : 928014,
 +
        "id" : 300,
 +
        "name" : "bash",
 +
        "printable" : false,
 +
        "private" : true,
 +
        "sharable" : false,
 +
        "styles" : {  },
 +
        "tags" : [  ],
 +
        "type" : "Pdf",
 +
        "upload_id" : "asset_upload_d04ea4e4",
 +
        "url" : "https://cdn-unroole-dev.s3.amazonaws.com/system/asset_pdfs/300/original/bash.pdf?AWSAccessKeyId=AKIAI54VTHLBTQ46H3FA&Signature=oZmflRCdGOuZeUEFjLgvNqEWWig%3D&Expires=1340638792&updated_at=1340636372",
 +
        "video_id" : null
 +
      }
 +
    ],
 +
  "http_status" : 200,
 +
  “page” : 1,
 +
  “per-page” : 500,
 +
  “total-pages” : 1,
 +
  “total-entries” : 2,
 +
  “result_length” : 2
 +
}
 +
</nowiki>
 +
</blockquote>
 +
|}
 +
 
 +
{| class="wikitable collapsible collapsed"
 +
|-
 +
! XML
 +
|-
 +
| <nowiki>http://api.unroole.com/accounts/1/assets.xml?token=1f0qpLwoV5oIcfnU2yvO&search=pdf&fields=id,name,description,file_name,content_type,file_size,updated_at,created_at,type,video_id,dimensions,upload_id,private,sharable,editable,printable,used,tags,url,styles</nowiki>
 +
|-
 +
| <blockquote>
 +
<nowiki>
 +
<?xml version="1.0" encoding="UTF-8"?>
 +
<hash>
 +
  <assets type="array">
 +
    <asset>
 +
      <id type="integer">302</id>
 +
      <name>GONews_SpecEd_ENG</name>
 +
      <description></description>
 +
      <file-name>GONews_SpecEd_ENG.pdf</file-name>
 +
      <content-type>application/pdf</content-type>
 +
      <file-size type="integer">692261</file-size>
 +
      <created-at type="datetime">2012-06-25T14:59:48Z</created-at>
 +
      <type>Pdf</type>
 +
      <video-id nil="true">
 +
    </video-id>
 +
      <dimensions></dimensions>
 +
      <upload-id>asset_upload_d04ea4e4</upload-id>
 +
      <private type="boolean">true</private>
 +
      <sharable type="boolean">false</sharable>
 +
      <editable type="boolean">false</editable>
 +
      <printable type="boolean">true</printable>
 +
      <tags type="array">
 +
        <tag>pdf</tag>
 +
        <tag>train</tag>
 +
        <tag>go</tag>
 +
        <tag>newsletter</tag>
 +
      </tags>
 +
      <url>https://cdn-unroole-dev.s3.amazonaws.com/system/asset_pdfs/302/original/GONews_SpecEd_ENG.pdf?AWSAccessKeyId=AKIAI54VTHLBTQ46H3FA&amp;Signature=IlCGHZFkCPXafVJXIGWRGUM2Qic%3D&amp;Expires=1340638461&amp;updated_at=1340636388</url>
 +
      <styles></styles>
 +
    </asset>
 +
    <asset>
 +
      <id type="integer">300</id>
 +
      <name>bash</name>
 +
      <description></description>
 +
      <file-name>bash.pdf</file-name>
 +
      <content-type>application/pdf</content-type>
 +
      <file-size type="integer">928014</file-size>
 +
      <created-at type="datetime">2012-06-25T14:59:32Z</created-at>
 +
      <type>Pdf</type>
 +
      <video-id nil="true">
 +
    </video-id>
 +
      <dimensions></dimensions>
 +
      <upload-id>asset_upload_d04ea4e4</upload-id>
 +
      <private type="boolean">true</private>
 +
      <sharable type="boolean">false</sharable>
 +
      <editable type="boolean">false</editable>
 +
      <printable type="boolean">false</printable>
 +
      <tags type="array"/>
 +
      <url>https://cdn-unroole-dev.s3.amazonaws.com/system/asset_pdfs/300/original/bash.pdf?AWSAccessKeyId=AKIAI54VTHLBTQ46H3FA&amp;Signature=NTA2Z6AySAd3qg2c4JIbMbR6Hz8%3D&amp;Expires=1340638461&amp;updated_at=1340636372</url>
 +
      <styles></styles>
 +
    </asset>
 +
  </assets>
 +
  <page type="integer">1</page>
 +
  <per-page” type="integer">500</per-page”>
 +
  <total-pages type="integer">1</total-pages>
 +
  <total-entries type="integer">2</total-entries>
 +
  <result-length type="integer">2</result-length>
 +
  <http-status type="integer">200</http-status>
 +
</hash>
 +
</nowiki>
 +
</blockquote>
 +
|}
 +
 
 +
=== Search by mime type ===
 +
 
 +
{| class="wikitable"
 +
|-
 +
! Parameters
 +
! Values
 +
|-
 +
| token
 +
| 1f0qpLwoV5oIcfnU2yvO
 +
|-
 +
| search
 +
| audio
 +
|-
 +
| fields
 +
| id,name,description,file_name,content_type,file_size,updated_at,created_at,type,video_id,dimensions,upload_id,private,sharable,editable,printable,used,tags,url,styles
 +
|}
 +
 
 +
{| class="wikitable collapsible collapsed"
 +
|-
 +
! JSON
 +
|-
 +
| <nowiki>http://api.unroole.com/accounts/1/assets.json?token=1f0qpLwoV5oIcfnU2yvO&search=audio&fields=id,name,description,file_name,content_type,file_size,updated_at,created_at,type,video_id,dimensions,upload_id,private,sharable,editable,printable,used,tags,url,styles</nowiki>
 +
|-
 +
| <blockquote>
 +
<nowiki>
 +
{ "assets" : [ { "content_type" : "audio/x-wav",
 +
        "created_at" : "2012-06-25T14:59:35Z",
 +
        "description" : "",
 +
        "dimensions" : {  },
 +
        "editable" : false,
 +
        "file_name" : "crowd_outside_1.wav",
 +
        "file_size" : 1779054,
 +
        "id" : 301,
 +
        "name" : "crowd_outside_1",
 +
        "printable" : false,
 +
        "private" : true,
 +
        "sharable" : false,
 +
        "styles" : {  },
 +
        "tags" : [  ],
 +
        "type" : "Document",
 +
        "upload_id" : "asset_upload_d04ea4e4",
 +
        "url" : "https://cdn-unroole-dev.s3.amazonaws.com/system/asset_documents/301/original/crowd_outside_1.wav?AWSAccessKeyId=AKIAI54VTHLBTQ46H3FA&Signature=0ixBoW33U1byJf%2F8AwiXrZ%2BaKYc%3D&Expires=1340639827&updated_at=1340636375",
 +
        "video_id" : null
 +
      } ],
 +
  "http_status" : 200,
 +
  “page” : 1,
 +
  “per-page” : 500,
 +
  “total-pages” : 1,
 +
  “total-entries” : 1,
 +
  “result_length” : 1
 +
}
 +
</nowiki>
 +
</blockquote>
 +
|}
 +
 
 +
{| class="wikitable collapsible collapsed"
 +
|-
 +
! XML
 +
|-
 +
| <nowiki>http://api.unroole.com/accounts/1/assets.xml?token=1f0qpLwoV5oIcfnU2yvO&search=audio&fields=id,name,description,file_name,content_type,file_size,updated_at,created_at,type,video_id,dimensions,upload_id,private,sharable,editable,printable,used,tags,url,styles</nowiki>
 +
|-
 +
| <blockquote>
 +
<nowiki>
 +
<?xml version="1.0" encoding="UTF-8"?>
 +
<hash>
 +
  <assets type="array">
 +
    <asset>
 +
      <id type="integer">301</id>
 +
      <name>crowd_outside_1</name>
 +
      <description></description>
 +
      <file-name>crowd_outside_1.wav</file-name>
 +
      <content-type>audio/x-wav</content-type>
 +
      <file-size type="integer">1779054</file-size>
 +
      <created-at type="datetime">2012-06-25T14:59:35Z</created-at>
 +
      <type>Document</type>
 +
      <video-id nil="true">
 +
    </video-id>
 +
      <dimensions></dimensions>
 +
      <upload-id>asset_upload_d04ea4e4</upload-id>
 +
      <private type="boolean">true</private>
 +
      <sharable type="boolean">false</sharable>
 +
      <editable type="boolean">false</editable>
 +
      <printable type="boolean">false</printable>
 +
      <tags type="array"/>
 +
      <url>https://cdn-unroole-dev.s3.amazonaws.com/system/asset_documents/301/original/crowd_outside_1.wav?AWSAccessKeyId=AKIAI54VTHLBTQ46H3FA&amp;Signature=Bhm0T2E950u69lQVcJ3eP9wIDVI%3D&amp;Expires=1340639684&amp;updated_at=1340636375</url>
 +
      <styles></styles>
 +
    </asset>
 +
  </assets>
 +
  <page type="integer">1</page>
 +
  <per-page” type="integer">500</per-page”>
 +
  <total-pages type="integer">1</total-pages>
 +
  <total-entries type="integer">1</total-entries>
 +
  <result-length type="integer">1</result-length>
 +
  <http-status type="integer">200</http-status>
 +
</hash>
 +
 
 +
</nowiki>
 +
</blockquote>
 +
|}
 +
 
 +
=== Search by tag and name returning first 3 matches ===
 +
''result_length is 7 because there are 7 assets that can be returned, but the user requested only for 3''
 +
 
 +
{| class="wikitable"
 +
|-
 +
! Parameters
 +
! Values
 +
|-
 +
| token
 +
| 1f0qpLwoV5oIcfnU2yvO
 +
|-
 +
| search
 +
| space
 +
|-
 +
| limit
 +
| 3
 +
|-
 +
| fields
 +
| id,name,description,file_name,content_type,file_size,updated_at,created_at,type,video_id,dimensions,upload_id,private,sharable,editable,printable,used,tags,url,styles
 +
|}
 +
 
 +
{| class="wikitable collapsible collapsed"
 +
|-
 +
! JSON
 +
|-
 +
| <nowiki>http://api.unroole.com/accounts/1/assets.json?token=1f0qpLwoV5oIcfnU2yvO&search=space&limit=3&fields=id,name,description,file_name,content_type,file_size,updated_at,created_at,type,video_id,dimensions,upload_id,private,sharable,editable,printable,used,tags,url,styles</nowiki>
 +
|-
 +
| <blockquote>
 +
<nowiki>
 +
{ "assets" : [ { "content_type" : "image/jpeg",
 +
        "created_at" : "2012-06-19T14:32:31Z",
 +
        "description" : null,
 +
        "dimensions" : { "icon" : { "height" : "32",
 +
                "width" : "32"
 +
              },
 +
            "original" : { "height" : "90",
 +
                "width" : "120"
 +
              },
 +
            "thumb" : { "height" : "150",
 +
                "width" : "150"
 +
              }
 +
          },
 +
        "editable" : false,
 +
        "file_name" : "another-earth-in-outer-space.jpg",
 +
        "file_size" : 4502,
 +
        "id" : 108,
 +
        "name" : "Another Earth in Outer Space?",
 +
        "printable" : false,
 +
        "private" : null,
 +
        "sharable" : false,
 +
        "styles" : { "icon" : "https://cdn-unroole-dev.s3.amazonaws.com/system/asset_yt_videos/108/icon/another-earth-in-outer-space.jpg?AWSAccessKeyId=AKIAI54VTHLBTQ46H3FA&Signature=Nz9OrotCBejmkw%2BpWrYTwhrFIW4%3D&Expires=1340640174&updated_at=1340116351",
 +
            "original" : "http://www.youtube.com/v/j1GOm1mxHA8&feature=youtube_gdata_player",
 +
            "thumb" : "https://cdn-unroole-dev.s3.amazonaws.com/system/asset_yt_videos/108/thumb/another-earth-in-outer-space.jpg?AWSAccessKeyId=AKIAI54VTHLBTQ46H3FA&Signature=eVwMwrGSiTQxWbYlkIGCT%2FUGhU4%3D&Expires=1340640174&updated_at=1340116351"
 +
          },
 +
        "tags" : [  ],
 +
        "type" : "Video",
 +
        "upload_id" : "asset_upload_71b69654",
 +
        "url" : "http://www.youtube.com/v/j1GOm1mxHA8&feature=youtube_gdata_player",
 +
        "video_id" : "j1GOm1mxHA8"
 +
      },
 +
      { "content_type" : "image/jpeg",
 +
        "created_at" : "2012-06-19T14:32:30Z",
 +
        "description" : null,
 +
        "dimensions" : { "icon" : { "height" : "32",
 +
                "width" : "32"
 +
              },
 +
            "original" : { "height" : "90",
 +
                "width" : "120"
 +
              },
 +
            "thumb" : { "height" : "150",
 +
                "width" : "150"
 +
              }
 +
          },
 +
        "editable" : false,
 +
        "file_name" : "seeing-earth-in-space-new-iss-timelapse-footage.jpg",
 +
        "file_size" : 4826,
 +
        "id" : 107,
 +
        "name" : "Seeing Earth IN Space [new ISS timelapse footage]",
 +
        "printable" : false,
 +
        "private" : null,
 +
        "sharable" : false,
 +
        "styles" : { "icon" : "https://cdn-unroole-dev.s3.amazonaws.com/system/asset_yt_videos/107/icon/seeing-earth-in-space-new-iss-timelapse-footage.jpg?AWSAccessKeyId=AKIAI54VTHLBTQ46H3FA&Signature=ZHia0dMJUqQO0Opl3XcqtQDiXBw%3D&Expires=1340640175&updated_at=1340116350",
 +
            "original" : "http://www.youtube.com/v/BEhIGoq9tow&feature=youtube_gdata_player",
 +
            "thumb" : "https://cdn-unroole-dev.s3.amazonaws.com/system/asset_yt_videos/107/thumb/seeing-earth-in-space-new-iss-timelapse-footage.jpg?AWSAccessKeyId=AKIAI54VTHLBTQ46H3FA&Signature=G69GzxJElMEeZLrg8CfMGzmmxd4%3D&Expires=1340640174&updated_at=1340116350"
 +
          },
 +
        "tags" : [  ],
 +
        "type" : "Video",
 +
        "upload_id" : "asset_upload_71b69654",
 +
        "url" : "http://www.youtube.com/v/BEhIGoq9tow&feature=youtube_gdata_player",
 +
        "video_id" : "BEhIGoq9tow"
 +
      },
 +
      { "content_type" : "image/jpeg",
 +
        "created_at" : "2012-06-14T18:01:54Z",
 +
        "description" : "",
 +
        "dimensions" : { "icon" : { "height" : "32",
 +
                "width" : "32"
 +
              },
 +
            "original" : { "height" : "1329",
 +
                "width" : "1280"
 +
              },
 +
            "thumb" : { "height" : "150",
 +
                "width" : "150"
 +
              }
 +
          },
 +
        "editable" : false,
 +
        "file_name" : "opo0301a.jpg",
 +
        "file_size" : 623601,
 +
        "id" : 5,
 +
        "name" : "opo0301a",
 +
        "printable" : false,
 +
        "private" : false,
 +
        "sharable" : false,
 +
        "styles" : { "icon" : "https://cdn-unroole-dev.s3.amazonaws.com/system/asset_images/5/icon/opo0301a.jpg?1339696912&updated_at=1340636802",
 +
            "original" : "https://cdn-unroole-dev.s3.amazonaws.com/system/asset_images/5/original/opo0301a.jpg?1339696912&updated_at=1340636802",
 +
            "thumb" : "https://cdn-unroole-dev.s3.amazonaws.com/system/asset_images/5/thumb/opo0301a.jpg?1339696912&updated_at=1340636802"
 +
          },
 +
        "tags" : [ "space",
 +
            "stars"
 +
          ],
 +
        "type" : "Image",
 +
        "upload_id" : "asset_upload_f064de41",
 +
        "url" : "https://cdn-unroole-dev.s3.amazonaws.com/system/asset_images/5/original/opo0301a.jpg?1339696912&updated_at=1340636802",
 +
        "video_id" : null
 +
      }
 +
    ],
 +
  "http_status" : 200,
 +
  “page” : 1,
 +
  “per-page” : 3,
 +
  “total-pages” : 3,
 +
  “total-entries” : 7,
 +
  “result_length” : 3
 +
}
 +
</nowiki>
 +
</blockquote>
 +
|}
 +
 
 +
{| class="wikitable collapsible collapsed"
 +
|-
 +
! XML
 +
|-
 +
| <nowiki>http://api.unroole.com/accounts/1/assets.xml?token=1f0qpLwoV5oIcfnU2yvO&search=audio&fields=id,name,description,file_name,content_type,file_size,updated_at,created_at,type,video_id,dimensions,upload_id,private,sharable,editable,printable,used,tags,url,styles</nowiki>
 +
|-
 +
| <blockquote>
 +
<nowiki>
 +
<?xml version="1.0" encoding="UTF-8"?>
 +
<hash>
 +
  <assets type="array">
 +
    <asset>
 +
      <id type="integer">108</id>
 +
      <name>Another Earth in Outer Space?</name>
 +
      <description nil="true">
 +
    </description>
 +
      <file-name>another-earth-in-outer-space.jpg</file-name>
 +
      <content-type>image/jpeg</content-type>
 +
      <file-size type="integer">4502</file-size>
 +
      <created-at type="datetime">2012-06-19T14:32:31Z</created-at>
 +
      <type>Video</type>
 +
      <video-id>j1GOm1mxHA8</video-id>
 +
      <dimensions>
 +
        <original>
 +
          <width>120</width>
 +
          <height>90</height>
 +
        </original>
 +
        <thumb>
 +
          <width>150</width>
 +
          <height>150</height>
 +
        </thumb>
 +
        <icon>
 +
          <width>32</width>
 +
          <height>32</height>
 +
        </icon>
 +
      </dimensions>
 +
      <upload-id>asset_upload_71b69654</upload-id>
 +
      <private nil="true">
 +
    </private>
 +
      <sharable type="boolean">false</sharable>
 +
      <editable type="boolean">false</editable>
 +
      <printable type="boolean">false</printable>
 +
      <tags type="array"/>
 +
      <url>http://www.youtube.com/v/j1GOm1mxHA8&amp;feature=youtube_gdata_player</url>
 +
      <styles>
 +
        <original>http://www.youtube.com/v/j1GOm1mxHA8&amp;feature=youtube_gdata_player</original>
 +
        <thumb>https://cdn-unroole-dev.s3.amazonaws.com/system/asset_yt_videos/108/thumb/another-earth-in-outer-space.jpg?AWSAccessKeyId=AKIAI54VTHLBTQ46H3FA&amp;Signature=qI5zlUYosn7MeH6OFewlinf3WzI%3D&amp;Expires=1340640950&amp;updated_at=1340116351</thumb>
 +
        <icon>https://cdn-unroole-dev.s3.amazonaws.com/system/asset_yt_videos/108/icon/another-earth-in-outer-space.jpg?AWSAccessKeyId=AKIAI54VTHLBTQ46H3FA&amp;Signature=BTPpaSlwPfxgWGsLYxcNWirvXko%3D&amp;Expires=1340640950&amp;updated_at=1340116351</icon>
 +
      </styles>
 +
    </asset>
 +
    <asset>
 +
      <id type="integer">107</id>
 +
      <name>Seeing Earth IN Space [new ISS timelapse footage]</name>
 +
      <description nil="true">
 +
    </description>
 +
      <file-name>seeing-earth-in-space-new-iss-timelapse-footage.jpg</file-name>
 +
      <content-type>image/jpeg</content-type>
 +
      <file-size type="integer">4826</file-size>
 +
      <created-at type="datetime">2012-06-19T14:32:30Z</created-at>
 +
      <type>Video</type>
 +
      <video-id>BEhIGoq9tow</video-id>
 +
      <dimensions>
 +
        <original>
 +
          <width>120</width>
 +
          <height>90</height>
 +
        </original>
 +
        <thumb>
 +
          <width>150</width>
 +
          <height>150</height>
 +
        </thumb>
 +
        <icon>
 +
          <width>32</width>
 +
          <height>32</height>
 +
        </icon>
 +
      </dimensions>
 +
      <upload-id>asset_upload_71b69654</upload-id>
 +
      <private nil="true">
 +
    </private>
 +
      <sharable type="boolean">false</sharable>
 +
      <editable type="boolean">false</editable>
 +
      <printable type="boolean">false</printable>
 +
      <tags type="array"/>
 +
      <url>http://www.youtube.com/v/BEhIGoq9tow&amp;feature=youtube_gdata_player</url>
 +
      <styles>
 +
        <original>http://www.youtube.com/v/BEhIGoq9tow&amp;feature=youtube_gdata_player</original>
 +
        <thumb>https://cdn-unroole-dev.s3.amazonaws.com/system/asset_yt_videos/107/thumb/seeing-earth-in-space-new-iss-timelapse-footage.jpg?AWSAccessKeyId=AKIAI54VTHLBTQ46H3FA&amp;Signature=bouXvD6JFegsBXN8nHhODmbR8bg%3D&amp;Expires=1340640951&amp;updated_at=1340116350</thumb>
 +
        <icon>https://cdn-unroole-dev.s3.amazonaws.com/system/asset_yt_videos/107/icon/seeing-earth-in-space-new-iss-timelapse-footage.jpg?AWSAccessKeyId=AKIAI54VTHLBTQ46H3FA&amp;Signature=87edS%2BXl%2BZip8rmO4jAfLvLhK40%3D&amp;Expires=1340640951&amp;updated_at=1340116350</icon>
 +
      </styles>
 +
    </asset>
 +
    <asset>
 +
      <id type="integer">5</id>
 +
      <name>opo0301a</name>
 +
      <description></description>
 +
      <file-name>opo0301a.jpg</file-name>
 +
      <content-type>image/jpeg</content-type>
 +
      <file-size type="integer">623601</file-size>
 +
      <created-at type="datetime">2012-06-14T18:01:54Z</created-at>
 +
      <type>Image</type>
 +
      <video-id nil="true">
 +
    </video-id>
 +
      <dimensions>
 +
        <original>
 +
          <width>1280</width>
 +
          <height>1329</height>
 +
        </original>
 +
        <thumb>
 +
          <width>150</width>
 +
          <height>150</height>
 +
        </thumb>
 +
        <icon>
 +
          <width>32</width>
 +
          <height>32</height>
 +
        </icon>
 +
      </dimensions>
 +
      <upload-id>asset_upload_f064de41</upload-id>
 +
      <private type="boolean">false</private>
 +
      <sharable type="boolean">false</sharable>
 +
      <editable type="boolean">false</editable>
 +
      <printable type="boolean">false</printable>
 +
      <tags type="array">
 +
        <tag>space</tag>
 +
        <tag>stars</tag>
 +
      </tags>
 +
      <url>https://cdn-unroole-dev.s3.amazonaws.com/system/asset_images/5/original/opo0301a.jpg?1339696912&amp;updated_at=1340636802</url>
 +
      <styles>
 +
        <original>https://cdn-unroole-dev.s3.amazonaws.com/system/asset_images/5/original/opo0301a.jpg?1339696912&amp;updated_at=1340636802</original>
 +
        <thumb>https://cdn-unroole-dev.s3.amazonaws.com/system/asset_images/5/thumb/opo0301a.jpg?1339696912&amp;updated_at=1340636802</thumb>
 +
        <icon>https://cdn-unroole-dev.s3.amazonaws.com/system/asset_images/5/icon/opo0301a.jpg?1339696912&amp;updated_at=1340636802</icon>
 +
      </styles>
 +
    </asset>
 +
  </assets>
 +
  <page type="integer">1</page>
 +
  <per-page” type="integer">3</per-page”>
 +
  <total-pages type="integer">3</total-pages>
 +
  <total-entries type="integer">7</total-entries>
 +
  <result-length type="integer">3</result-length>
 +
  <http-status type="integer">200</http-status>
 +
</hash>
 +
</nowiki>
 +
</blockquote>
 
|}
 
|}

Latest revision as of 10:04, 29 November 2013

Summary

Allows querying for a list of assets. The query is a wildcard search on the asset's:

  • id
  • name
  • description
  • content_type
  • type
  • file_name
  • upload_id
  • tags

URI

https://api.unroole.com/accounts/[account-id]/assets

HTTP Method

GET

Required Paramaters

Paramater Default Maximum Length Accepted Values Description
token API Persistence Token that identifies this user and its permissions.

Optional Paramaters

Paramater Default Maximum Length Accepted Values Description
search string The search terms to be used in the query.
limit 500 The maximum number of assets to return.
fields id, name, file_name, url API Asset Fields List of comma separated fields to be returned in the response.
page 1 Depends on query Integer The current pages to display based on the limit.
url_time_limit 60 The length of time (in seconds) that the asset url will be accessible for if the asset is private. This only applies to the response.

Response

Field Type Description
http_status integer API Status Code
http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html
error Rails default
assets array of API Asset Fields List of files that matched the search query
page integer The current viewed page of results.
per-page integer The maximum number of results to return per page.
total-pages integer The total number of pages that exist.
total-entries integer The total number of entries found from all pages.
result_length integer Total number of results that have been returned on this page. This may differ from the per-page/limit value on the last page.

Examples

All assets on an account

Parameters Values
token 1f0qpLwoV5oIcfnU2yvO

All pdfs on an account

Parameters Values
token 1f0qpLwoV5oIcfnU2yvO
search pdf
fields id,name,description,file_name,content_type,file_size,updated_at,created_at,type,video_id,dimensions,upload_id,private,sharable,editable,printable,used,tags,url,styles

Search by mime type

Parameters Values
token 1f0qpLwoV5oIcfnU2yvO
search audio
fields id,name,description,file_name,content_type,file_size,updated_at,created_at,type,video_id,dimensions,upload_id,private,sharable,editable,printable,used,tags,url,styles

Search by tag and name returning first 3 matches

result_length is 7 because there are 7 assets that can be returned, but the user requested only for 3

Parameters Values
token 1f0qpLwoV5oIcfnU2yvO
search space
limit 3
fields id,name,description,file_name,content_type,file_size,updated_at,created_at,type,video_id,dimensions,upload_id,private,sharable,editable,printable,used,tags,url,styles
Retrieved from "https://wiki.unroole.com/index.php?title=API_Assets_List&oldid=2083"