Retrieving a folder
Added by IBM contributorIBM | Edited by IBM contributorElizabeth Bowling on November 9, 2015
Rate this article 1 starsRate this article 2 starsRate this article 3 starsRate this article 4 starsRate this article 5 stars

Retrieve an Atom document representation of a file folder. This method returns the Atom document of a file folder. If you want to retrieve a feed of folders, see Getting a feed of folders. You might want to use this request to retrieve a file folder before you update it.
Note: {collection-id} is the value of the <td:uuid> element in the collection's Atom entry document.

 

Input
Method URI Description
GET /files/{auth}/api/collection/{collection-id}/entry Returns a collection Atom document.
GET /files/{auth}/api/communitycollection/{community-id}/entry Retrieve a community collection resource
Name Type Optional Description
collection-id
string No {collection-id} is the value of the <td:uuid> element in the collection's Atom entry document.
auth
enumerated No The authorization protocol being used by your application to access Connections Cloud.
Authorized values:
  • basic
  • oauth
Name Type Optional Description
includeNotification
enumerated Yes Specify if the notification information will be included in the collection entry.
Default value is false.
Authorized values:
  • true
  • false
includeFavorite
enumerated Yes Specify if the favorite information will be included in the collection entry.
Default value is false.
Authorized values:
  • true
  • false
acIs
enumerated Yes Specify whether to return information about the caller's permissions in the collection entry.
Default value is false.
Authorized values:
  • true
  • false
includeAncestors
enumerated Yes Specify whether to return ancestors of the collection. If it is a top level collection, there is no element in <td:ancestors>.
Default value is false.
Authorized values:
  • true
  • false
Name Type Optional Description
Authorization
enumerated No The authentication mechanism selected by your application to access the API.
Basic is the Base64 encoding of the IBM Connections Cloud username and password: Base64(username:password). For example, Base64(twatson@us.ibm.com:password).
Bearer is the oauth 2.0 access token that is generated when the user grants your application access to IBM Connections Cloud services.
See the reference topic "OAuth 2.0 APIs for web server flow" for more information.
Authorized values:
  • bearer
  • basic
Output
Content Type: application/atom+xml
Code Description
200
OK. Indicates that the file folder was successfully found and returned. If an error occurs, this header will contain one of the error codes below.
401
Unauthorized.
404
Not Found.
500
Internal server error. The server encountered an unexpected condition that prevented it from fulfilling the request.
403
Forbidden. The server refuses to fulfill a request, typically because the request was for an object that you don't have permission to access.
Examples
GET /files/basic/api/collection/b1edcb90-a77d-4f05-9ab1-566655066f5c/entry?includeNotification=true&includeFavorite=true HTTP/1.1
Host: example.com
User-Agent:Thingio/1.0

Response returned by the server
<entry xmlns="http://www.w3.org/2005/Atom">
    <id>urn:lsid:ibm.com:td:b1edcb90-a77d-4f05-9ab1-566655066f5c</id>
    <td:uuid xmlns:td="urn:ibm.com/td">b1edcb90-a77d-4f05-9ab1-566655066f5c</td:uuid>
    <td:label xmlns:td="urn:ibm.com/td">Test Collection Title Entry 1247645673359_Label</td:label>
    <snx:rank scheme="http://www.ibm.com/xmlns/prod/sn/item" xmlns:snx="http://www.ibm.com/xmlns/prod/sn">0</snx:rank>
    <snx:rank scheme="http://www.ibm.com/xmlns/prod/sn/user" xmlns:snx="http://www.ibm.com/xmlns/prod/sn">0</snx:rank>
    <snx:rank scheme="http://www.ibm.com/xmlns/prod/sn/group" xmlns:snx="http://www.ibm.com/xmlns/prod/sn">0</snx:rank>
    <link href="http://example.com:9080/files/basic/api/collection/b1edcb90-a77d-4f05-9ab1-566655066f5c/entry" rel="self" />
    <link href="http://example.com:9080/files/app/collection/b1edcb90-a77d-4f05-9ab1-566655066f5c/" rel="alternate" type="text/html" />
    <link href="http://example.com:9080/files/basic/api/collection/b1edcb90-a77d-4f05-9ab1-566655066f5c/entry" rel="edit" />
    <category label="collection" scheme="tag:ibm.com,2006:td/type" term="collection"></category>
    <author>
        <name>Monifa Shani</name>
        <snx:userid xmlns:snx="http://www.ibm.com/xmlns/prod/sn">mshani</snx:userid>
        <email>mshani@renovations.com</email>
    </author>
    <td:modifier xmlns:td="urn:ibm.com/td">
        <name>Monifa Shani</name>
        <snx:userid xmlns:snx="http://www.ibm.com/xmlns/prod/sn">mshani</snx:userid>
        <email>mshani@renovations.com</email>
    </td:modifier>
    <title type="text"></title>
    <published>2009-07-15T08:14:33.359Z</published>
    <updated>2009-07-15T08:14:33.359Z</updated>
    <td:created xmlns:td="urn:ibm.com/td">2009-07-15T08:14:33.359Z</td:created>
    <td:modified xmlns:td="urn:ibm.com/td">2009-07-15T08:14:33.359Z</td:modified>
    <summary type="text">_Summary</summary>
    <td:type xmlns:td="urn:ibm.com/td">personal</td:type>
    <td:visibility xmlns:td="urn:ibm.com/td">private</td:visibility>
    <td:notifications>
        <td:filesadded>on</td:filesadded>
    </td:notifications>
    <td:favorite>true</td:favorite>
    <content src="http://example.com:9080/files/basic/api/collection/b1edcb90-a77d-4f05-9ab1-566655066f5c/feed" type="application/atom+xml"></content>
</entry>

Response returned by the server
<entry>
    <id>urn:lsid:ibm.com:td:c26f6259-bd2b-4225-a094-859e5e199eee</id>
    <td:uuid>c26f6259-bd2b-4225-a094-859e5e199eee</td:uuid>
    <td:label>testCreateFolderAndShareWithCommunitycf91aa27-a8d5-417c-8822-768abcf66eb3 </td:label>
    <snx:rank scheme="http://www.ibm.com/xmlns/prod/sn/item">1</snx:rank>
    <snx:rank scheme="http://www.ibm.com/xmlns/prod/sn/user">0</snx:rank>
    <snx:rank scheme="http://www.ibm.com/xmlns/prod/sn/group">2</snx:rank>
    <link href="https://example.com:9443/files/basic/api/collection/c26f6259-bd2b-4225-a094-859e5e199eee/entry" rel="self" />
    <link href="https://example.com:9443/files/app/folder/c26f6259-bd2b-4225-a094-859e5e199eee/" rel="alternate" type="text/html" />
    <link href="https://example.com:9443/files/basic/api/collection/c26f6259-bd2b-4225-a094-859e5e199eee/entry" rel="edit" />
    <link href="https://example.com:9443/files/basic/api/collection/c26f6259-bd2b-4225-a094-859e5e199eee/feed" rel="files" />
    <category label="collection" scheme="tag:ibm.com,2006:td/type" term="collection"></category>
    <author>
        <name>Amy Blanks</name>
        <snx:userid>ablanks</snx:userid>
        <email>ablanks@renovations.com</email>
        <snx:userstate>active</snx:userstate>
    </author>
    <td:modifier>
        <name>Charles Bounar</name>
        <snx:userid>cbounar</snx:userid>
        <email>cbounar@renovations.com</email>
        <snx:userstate>active</snx:userstate>
    </td:modifier>
    <title type="text"></title>
    <published>2011-04-15T07:28:42.575Z</published>
    <updated>2011-04-15T07:28:42.903Z</updated>
    <td:created>2011-04-15T07:28:42.575Z</td:created>
    <td:modified>2011-04-15T07:28:42.903Z</td:modified>
    <summary type="text"></summary>
    <td:visibility>public</td:visibility>
    <td:type>personal</td:type>
    <content src="https://example.com:9443/files/basic/api/collection/c26f6259-bd2b-4225-a094-859e5e199eee/feed" type="application/atom+xml"></content>
</entry>

Response returned by the server
<entry>
    <id>urn:lsid:ibm.com:td:ffbd2939-219b-4d06-914a-a8b711df2ceb</id>
    <td:uuid>ffbd2939-219b-4d06-914a-a8b711df2ceb</td:uuid>
    <td:label>c77b804e-9ec9-45a8-bdf4-305478adab4c</td:label>
    <snx:rank scheme="http://www.ibm.com/xmlns/prod/sn/item">120</snx:rank>
    <snx:rank scheme="http://www.ibm.com/xmlns/prod/sn/user">0</snx:rank>
    <snx:rank scheme="http://www.ibm.com/xmlns/prod/sn/group">2</snx:rank>
    <link href="https://example.com:9443/files/basic/api/collection/ffbd2939-219b-4d06-914a-a8b711df2ceb/entry" rel="self" />
    <link href="https://example.com:9443/files/basic/api/collection/ffbd2939-219b-4d06-914a-a8b711df2ceb/entry" rel="edit" />
    <link href="https://example.com:9443/files/basic/api/collection/ffbd2939-219b-4d06-914a-a8b711df2ceb/feed" rel="files" />
    <category label="collection" scheme="tag:ibm.com,2006:td/type" term="collection"></category>
    <author>
        <name>System User</name>
        <snx:userid>00000000-0000-0000-0000-000000000000</snx:userid>
    </author>
    <td:modifier>
        <name>الهدف 最佳產</name>
        <snx:userid>dbcsuser</snx:userid>
        <email>dbcsuser@renovations.com</email>
        <snx:userstate>active</snx:userstate>
    </td:modifier>
    <title type="text"></title>
    <published>2011-04-11T05:48:25.140Z</published>
    <updated>2011-04-15T07:27:53.966Z</updated>
    <td:created>2011-04-11T05:48:25.140Z</td:created>
    <td:modified>2011-04-14T14:04:23.966Z</td:modified>
    <summary type="text"></summary>
    <td:visibility>public</td:visibility>
    <td:type>community</td:type>
    <td:externalcontainerid>c77b804e-9ec9-45a8-bdf4-305478adab4c</td:externalcontainerid>
    <snx:communityuuid>c77b804e-9ec9-45a8-bdf4-305478adab4c</snx:communityuuid>
    <link href="http://example.com:9080/communities/service/atom/community/instance? communityUuid=c77b804e-9ec9-45a8-bdf4-305478adab4c" rel="http://www.ibm.com/xmlns/prod/sn/container" type="application/atom+xml" />
    <content src="https://example.com:9443/files/basic/api/collection/ffbd2939-219b-4d06-914a-a8b711df2ceb/feed" type="application/atom+xml"></content>
</entry>