Get binders by ID.
This resource supports top level folder IDs, such as -100 (My Files)
Example: GET /rest/binders?id=-100&id=46&id=48
name | type | description | default | constraints | multivalued |
---|---|---|---|---|---|
count | query | 100 | int | no | |
description_format | query | The desired format for the binder descriptions. Can be "html" or "text". | text | no | |
first | query | 0 | int | no | |
id | query | The ID of a binder. Can be specified multiple times. | long | yes | |
library_info | query | Whether to calculate and return additional folder statistics for the binders. These calculations can be very expensive. | false | boolean | no |
library_mod_times | query | false | boolean | no |
media type | data type | description |
---|---|---|
application/json | SearchResultList (JSON) | A SearchResultList of BinderBrief objects. |
application/xml | searchResultList (XML) |
List the children of the specified binders.
count
specifies the total number of children to return. For example, id=-100&id=48&id=49&count=10
might return all 6 children of folder 48, the first 4 children of folder 49 and no results for folder -100. The order that the binder IDs are
processed in is non-deterministic.
The first_id
and first
parameters can be used to continue retrieving results from binders
whose children are only partially listed in the previous request. The children of the binder specified by
first_id
are included first, beginning with the first + 1
child.
For example, id=-100&id=48&first_id=48&first=4&count=10
is will return results 5-14 of
folder 48. If folder 48 has fewer than 14 children, then the first few children of folder -100 will also be included
in the response.
Paging the results of the Shared with Me (-101), Shared by Me (-102) and Public (-104) top level folders is not
supported. This resource will return all children of those folders, even if that means that more than count
children are returned.
If an error occurs listing the children of a particular binder, a BinderChildren object for that binder will be included in the results with information about the error that occurred.
This resource supports top level folder IDs, such as -100 (My Files)
name | type | description | default | constraints | multivalued |
---|---|---|---|---|---|
count | query | The maximum number of children to return. | 100 | int | no |
description_format | query | The desired format for the binder descriptions. Can be "html" or "text". | text | no | |
first | query | Specifies the first child to return. Ignored if first_id is not specified. |
0 | int | no |
first_id | query | The binder to start with. | long | no | |
id | query | The ID of a binder whose children are to be listed. Can be specified multiple times. | long | yes |
media type | data type | description |
---|---|---|
application/json | array of BinderChildren (JSON) | A list of BinderChildren resources. |
application/xml | list of binderChildren (XML) |
Get the Binder with the specified ID.
name | type | description | default | constraints |
---|---|---|---|---|
id | path | The ID of the binder to return. | long | |
description_format | query | The desired format for the binder description. Can be "html" or "text". | text | |
include_attachments | query | Configures whether attachments should be included in the returned Binder object. | true | boolean |
media type | data type | description |
---|---|---|
application/json | Binder (JSON) | Returns a subclass of Binder (Folder or Workspace). |
application/xml | binder (XML) |