Grid objectSets admin API Resource

Object Sets admin API

POST /objectset/addobjects

add new object Set

Request Body
media type data type description
*/* object - objectSet data
Response Body
media type data type description
application/json object JSON Response with success information

DELETE /objectset/json

delete user object Set

Request Body
media type data type description
*/* object - object with id of object Set
Response Body
media type data type description
application/json object JSON Response with information if operation succeeded

GET /objectset/json

Get all objectSets for session user

Response Body
media type data type description
application/json object JSON Response with objectSet data

Example of response:

POST /objectset/json

add new object Set for user

Request Body
media type data type description
*/* object - objectSet data
Response Body
media type data type description
application/json object JSON Response with description of objectSet with unique ID and success information

PUT /objectset/json

update object Set for user

Request Body
media type data type description
*/* object - objectSet data
Response Body
media type data type description
application/json object JSON Response with success information

DELETE /objectset/removeobjects

delete objects from object Set

Request Body
media type data type description
*/* object - objectSet data
Response Body
media type data type description
application/json object JSON Response with information if operation succeeded

GET /admin/objectset/json

Get all objectSets

Response Body
media type data type description
application/json object JSON Response with objectSet data

Example of response:

POST /admin/objectset/json

add new object Set for user

Request Body
media type data type description
*/* object - objectSet data
Response Body
media type data type description
application/json object JSON Response with object set data with Identifier and success information

PUT /admin/objectset/json

update object Set for user

Request Body
media type data type description
*/* object - objectSet data
Response Body
media type data type description
application/json object JSON Response with success information

POST /objectset/assign/{osId}

Assign user to object set

Request Parameters
name type description default constraints
osId path Id of object set   required long
Request Body
media type data type
*/* string
Response Body
media type data type description
application/json object JSON Response with information if operation succeeded

GET /objectset/json/{objectSetId}

Get user object Set

Request Parameters
name type description default constraints
objectSetId path - id of object Set   long
Response Body
media type data type description
application/json object JSON Response with objectSet data

GET /objectset/members/{objectSetId}

Get list of object set members (users or groups)

Request Parameters
name type description default constraints
objectSetId path   long
mode query    
Response Body
media type data type description
application/json object JSON with list of groups

Example of response:

{"list":[{"id":"x","description":"Members of Tessel Crew group","name":"Tessel Crew"},{"id":"y","description":"aaa bbb ccc ddd eee fff ggg hhh iii jjj kkk lll ","name":"Group B"}]} or JSON with list of users

Example of response:

{"list":[{"id":1,"name":"admin","userFullName":"Admin","description":"","enabled":true,"email":"","loginCount":1840,"lastLoginDate":"2013-09-26T10:18:36.199072+02:00"},{"id":2,"name":"user1","userFullName":"User 1","description":"","enabled":true,"email":"","loginCount":784,"lastLoginDate":"2013-09-25T13:16:12.990218+02:00"}]}

POST /objectset/unassign/{osId}

Unassign user to object set

Request Parameters
name type description default constraints
osId path Id of object set   required long
Request Body
media type data type
*/* string
Response Body
media type data type description
application/json object JSON Response with information if operation succeeded

POST /admin/objectset/assign/{osId}

Assign user to object set

Request Parameters
name type description default constraints
osId path Id of object set   required long
Request Body
media type data type
*/* string
Response Body
media type data type description
application/json object JSON Response with information if operation succeeded

DELETE /admin/objectset/json/{objectSetId}

delete user object Set

Request Parameters
name type description default constraints
objectSetId path - id of object Set   long
Response Body
media type data type description
application/json object JSON Response with information if operation succeeded

GET /admin/objectset/json/{objectSetId}

Get user object Set

Request Parameters
name type description default constraints
objectSetId path - id of object Set   long
Response Body
media type data type description
application/json object JSON Response with objectSet data

GET /admin/objectset/members/{objectSetId}

Get list of object set members (users or groups)

Request Parameters
name type description default constraints
objectSetId path   long
mode query    
Response Body
media type data type description
application/json object JSON with list of groups

Example of response:

{"list":[{"id":"x","description":"Members of Tessel Crew group","name":"Tessel Crew"},{"id":"y","description":"aaa bbb ccc ddd eee fff ggg hhh iii jjj kkk lll ","name":"Group B"}]} or JSON with list of users

Example of response:

{"list":[{"id":1,"name":"admin","userFullName":"Admin","description":"","enabled":true,"email":"","loginCount":1840,"lastLoginDate":"2013-09-26T10:18:36.199072+02:00"},{"id":2,"name":"user1","userFullName":"User 1","description":"","enabled":true,"email":"","loginCount":784,"lastLoginDate":"2013-09-25T13:16:12.990218+02:00"}]}

DELETE /admin/objectset/removeobjects/{objectSetId}

delete objects from object Set

Request Parameters
name type description default constraints
objectSetId path - id of object Set   long
Request Body
media type data type description
*/* object - objectSet data
Response Body
media type data type description
application/json object JSON Response with information if operation succeeded

POST /admin/objectset/unassign/{osId}

Unassign user to object set

Request Parameters
name type description default constraints
osId path Id of object set   required long
Request Body
media type data type
*/* string
Response Body
media type data type description
application/json object JSON Response with information if operation succeeded