PrincipalResource Resource

GET /principals

Request Parameters
name type description default constraints
count query 25 int
description_format query text  
first query 0 int
id query   long
include_all_users_group query true boolean
included_groups query all  
included_users query all  
keyword query    
Response Body
media type data type
application/json SearchResultList (JSON)
application/xml searchResultList (XML)

GET /principals/{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 Principal (JSON)
application/xml principal (XML)

GET /principals/{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 /principals/{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 /principals/{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 /principals/{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 /principals/{id}/attachments

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