SelfResource Resource

User: david Date: 5/16/12 Time: 4:04 PM

GET /self

Gets the User object representing the authenticated user.

Request Parameters
name type description default constraints
description_format query text  
include_attachments query Configures whether attachments should be included in the returned User object. true boolean
include_groups query false boolean
include_mobile_devices query false boolean
Response Body
media type data type description
application/json User (JSON) Returns the authenticated User object
application/xml user (XML)

GET /self/favorites

Returns the authenticated user's favorite binders

Response Body
media type data type description
application/json SearchResultList (JSON) Returns a list of BinderBrief objects.
application/xml searchResultList (XML)

GET /self/teams

Returns the teams that the authenticated user is a member of.

Response Body
media type data type description
application/json SearchResultList (JSON) Returns a list of BinderBrief objects.
application/xml searchResultList (XML)

GET /self/roots

This method has been deprecated. This operation is temporary and is very likely to change.

Returns a list of virtual workspace roots for the authenticated user. This is useful for displaying starting points for browsing different parts of the workspace hierarchy.

Response Body
media type data type description
application/json SearchResultList (JSON) Returns a list of BinderBrief objects.
application/xml searchResultList (XML)

GET /self/net_folders

Response Body
media type data type
application/json BinderBrief (JSON)
application/xml binderBrief (XML)

GET /self/public_shares

Response Body
media type data type
application/json BinderBrief (JSON)
application/xml binderBrief (XML)

GET /self/public_shares/library_info

Response Body
media type data type
application/json LibraryInfo (JSON)
application/xml libraryInfo (XML)

GET /self/shared_with_me

Request Parameters
name type description default constraints
library_info query false boolean
Response Body
media type data type
application/json BinderBrief (JSON)
application/xml binderBrief (XML)

GET /self/shared_with_me/library_info

Response Body
media type data type
application/json LibraryInfo (JSON)
application/xml libraryInfo (XML)

GET /self/shared_by_me

Response Body
media type data type
application/json BinderBrief (JSON)
application/xml binderBrief (XML)

GET /self/shared_by_me/library_info

Response Body
media type data type
application/json LibraryInfo (JSON)
application/xml libraryInfo (XML)

GET /self/my_files

Request Parameters
name type description default constraints
library_info query false boolean
Response Body
media type data type
application/json BinderBrief (JSON)
application/xml binderBrief (XML)

GET /self/my_files/library_info

Response Body
media type data type
application/json LibraryInfo (JSON)
application/xml libraryInfo (XML)

GET /self/my_files/library_children

Request Parameters
name type description default constraints
allow_jits query true boolean
count query 100 int
description_format query text  
first query 0 int
title query    
Response Body
media type data type
application/json object (JSON)
application/xml anyType (XML)

GET /self/my_files/library_folders

Request Parameters
name type description default constraints
count query 100 int
description_format query text  
first query 0 int
title query    
Response Body
media type data type
application/json object (JSON)
application/xml anyType (XML)

POST /self/my_files/library_folders

Request Parameters
name type description default constraints
source_id form   long
title form    
description_format query text  
Response Body
media type data type
application/json Folder (JSON)
application/xml folder (XML)

POST /self/my_files/library_folders

Request Parameters
name type description default
description_format query text
Request Body
media type data type
application/json BinderBrief (JSON)
application/xml binderBrief (XML)
Response Body
media type data type
application/json Folder (JSON)
application/xml folder (XML)

GET /self/my_files/library_changes

Request Parameters
name type description default constraints
count query 500 int
description_format query text  
recursive query true boolean
since query    
Response Body
media type data type
application/json BinderChanges (JSON)
application/xml binderChanges (XML)

GET /self/my_files/library_tree

Request Parameters
name type description default
description_format query text
Response Body
media type data type
application/json BinderTree (JSON)
application/xml binderTree (XML)

GET /self/my_files/library_entities

Request Parameters
name type description default constraints
binders query true boolean
count query 100 int
description_format query text  
files query true boolean
first query 0 int
folder_entries query true boolean
keyword query    
parent_binder_paths query false boolean
recursive query false boolean
replies query true boolean
Response Body
media type data type
application/json SearchResultList (JSON)
application/xml searchResultList (XML)

GET /self/my_files/library_files

Request Parameters
name type description default constraints
count query   int
file_name query    
first query   int
parent_binder_paths query false boolean
recursive query false boolean
Response Body
media type data type
application/json object (JSON)
application/xml anyType (XML)

POST /self/my_files/library_files

Request Parameters
name type description
file_name form
source_id form
Response Body
media type data type
application/json FileProperties (JSON)
application/xml fileProperties (XML)

POST /self/my_files/library_files

Request Parameters
name type description default constraints
file_name query    
md5 query    
mod_date query    
overwrite_existing query false boolean
Response Body
media type data type
application/json FileProperties (JSON)
application/xml fileProperties (XML)

POST /self/my_files/library_files

Request Parameters
name type description default constraints
file_name query    
md5 query    
mod_date query    
overwrite_existing query false boolean
Response Body
media type data type
application/json FileProperties (JSON)
application/xml fileProperties (XML)

GET /self/my_files/recent_activity

Request Parameters
name type description default constraints
count query 20 int
description_format query text  
file_name query    
first query 0 int
parent_binder_paths query false boolean
Response Body
media type data type
application/json SearchResultList (JSON)
application/xml searchResultList (XML)

POST /self/my_files/initial_sync

Response Body
media type data type
application/json object (JSON)
application/xml anyType (XML)

GET /self/mobile_devices

Response Body
media type data type
application/json SearchResultList (JSON)
application/xml searchResultList (XML)

POST /self/mobile_devices

Request Body
media type data type
application/json MobileDevice (JSON)
application/xml mobileDevice (XML)
Response Body
media type data type
application/json MobileDevice (JSON)
application/xml mobileDevice (XML)

GET /self/mobile_devices/{id}

Request Parameters
name type description
id path
Response Body
media type data type
application/json MobileDevice (JSON)
application/xml mobileDevice (XML)

PUT /self/mobile_devices/{id}

Request Parameters
name type description
id path
Request Body
media type data type
application/json MobileDevice (JSON)
application/xml mobileDevice (XML)
Response Body
media type data type
application/json MobileDevice (JSON)
application/xml mobileDevice (XML)

DELETE /self/mobile_devices/{id}

Request Parameters
name type description
id path

GET /self/my_teams

Request Parameters
name type description default constraints
library_info query false boolean
Response Body
media type data type
application/json BinderBrief (JSON)
application/xml binderBrief (XML)

GET /self/my_favorites

Request Parameters
name type description default constraints
library_info query false boolean
Response Body
media type data type
application/json BinderBrief (JSON)
application/xml binderBrief (XML)