BinderResource Resource

GET /binders

Request Parameters
name type description default constraints
count query 100 int
description_format query text  
first query 0 int
id query   long
library_info query false boolean
library_mod_times query false boolean
Response Body
media type data type
application/json SearchResultList (JSON)
application/xml searchResultList (XML)

POST /binders/legacy_query

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

GET /binders/library_children

Request Parameters
name type description default constraints
count query 100 int
description_format query text  
first query 0 int
first_id query   long
id query   long
Response Body
media type data type
application/json array of BinderChildren (JSON)
application/xml list of binderChildren (XML)

GET /binders/{id}

Returns the Binder with the specified ID.

Request Parameters
name type description default constraints
id path The ID of the binder to return.   long
description_format query text  
include_attachments query Configures whether attachments should be included in the returned Binder object. true boolean
Response Body
media type data type description
application/json Binder (JSON) Returns a subclass of Binder.
application/xml binder (XML)