GroupResource Resource

GET /groups

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

POST /groups

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

GET /groups/name/{name}

Request Parameters
name type description default constraints
name path    
description_format query text  
include_attachments query true boolean
Response Body
media type data type
application/json Group (JSON)
application/xml group (XML)

GET /groups/{id}

Request Parameters
name type description default constraints
id path   long
description_format query text  
include_attachments query true boolean
Response Body
media type data type
application/json Group (JSON)
application/xml group (XML)

PUT /groups/{id}

Request Parameters
name type description constraints
id path long
Request Body
media type data type
application/json Group (JSON)
application/xml group (XML)

GET /groups/{id}/members

Request Parameters
name type description default constraints
id path   long
count query -1 int
first query 0 int
Response Body
media type data type
application/json SearchResultList (JSON)
application/xml searchResultList (XML)

POST /groups/{id}/members

Request Parameters
name type description constraints
id path long
Request Body
media type data type
application/json PrincipalBrief (JSON)
application/xml principalBrief (XML)

DELETE /groups/{id}/members/{memberId}

Request Parameters
name type description constraints
id path long
memberId path long

GET /groups/{id}/ancestry

Request Parameters
name type description constraints
id path long
Response Body
media type data type
application/json array of BinderBrief (JSON)
application/xml list of binderBrief (XML)

GET /groups/{id}/attachments

Request Parameters
name type description constraints
id path long
Response Body
media type data type
application/json SearchResultList (JSON)
application/xml searchResultList (XML)

POST /groups/{id}/attachments

Request Parameters
name type description constraints
id path long
data_name query  
file_name query  
md5 query  
mod_date query  
Response Body
media type data type
application/json FileProperties (JSON)
application/xml fileProperties (XML)

POST /groups/{id}/attachments

Request Parameters
name type description constraints
id path long
data_name query  
file_name query  
md5 query  
mod_date query  
Response Body
media type data type
application/json FileProperties (JSON)
application/xml fileProperties (XML)

POST /groups/{id}/attachments

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