FLS admin API Resource

Abstract class for REST webservices

GET /admin/fls/json

Response Body
media type data type description
application/json object

POST /admin/fls/assign/{flsId}

Assign user or group to given Field Level Security definition

Request Parameters
name type description default constraints
flsId path ID of FLS   long
Request Body
media type data type
application/json string
Response Body
media type data type description
application/json object JSON Response with information, whether the assignment has or has not been succeeded.

GET /admin/fls/json/{classId}

Request Parameters
name type description default constraints
classId path   long
Response Body
media type data type description
application/json object

POST /admin/fls/json/{clsId}

Add fls for class.

Example of request:

{ "classId": "98", "name": "name of the fls", "defaultFls": false }

Request Parameters
name type description default constraints
clsId path   required long
Request Body
media type data type description
application/json object The specification of fls for class that has to be added.
Response Body
media type data type description
application/json object JSON with flsId, name and description of created fls for class

{"id":"created fls id", "classId": "98", "name":"name of the fls", "defaultFls": false} *

DELETE /admin/fls/json/{flsId}

Remove fls for class.

Request Parameters
name type description default constraints
flsId path   long
Response Body
media type data type description
application/json object JSON Response with information, whether the removing has or has not been succeeded.

PUT /admin/fls/json/{flsId}

Update fls for class.

Example of request:

{"flsId":"created fls id", "classId": "98", "name":"name of the fls", "defaultFls": false}

Request Parameters
name type description default constraints
flsId path   required long
Request Body
media type data type description
application/json object The id of fls that has to be updated.
Response Body
media type data type description
application/json object JSON Response with information, whether the update has or has not been succeeded.

POST /admin/fls/unassign/{flsId}

Unassign user or group to given Field Level Security definition

Request Parameters
name type description default constraints
flsId path ID of FLS   long
Request Body
media type data type
application/json string
Response Body
media type data type description
application/json object

GET /admin/fls/fields/json/{flsId}

Request Parameters
name type description default constraints
flsId path   long
Response Body
media type data type description
application/json object

PUT /admin/fls/fields/json/{flsId}

update fls field mask.

Example of request:

{"flsId":"fls id", "fields":[{"label":"field1 name","fieldId":"field1 system name","mask":"field1 mask"},{"label":"field2 name","fieldId":"field2 system name","mask":"field2 mask"},{"label":"field3 name","fieldId":"field3 system name","mask":"field3 mask"}]}

Request Parameters
name type description default constraints
flsId path   required long
Request Body
media type data type description
application/json object The id of fls that has to be updated.
Response Body
media type data type description
application/json object JSON Response with information, whether the update has or has not been succeeded.

PUT /admin/fls/json/{clsId}/{flsId}

set default fls for the specified class.

Request Parameters
name type description default constraints
clsId path The id of the class.   required long
flsId path The id of fls that has to be made the default fls.   required long
Response Body
media type data type description
application/json object JSON Response with information, whether the setting has or has not been succeeded.

GET /admin/fls/members/json/{flsId}

Get list of fls members (users or groups)

Request Parameters
name type description default constraints
flsId path ID of FLS   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

GET /admin/fls/user/json/{userId}

Request Parameters
name type description default constraints
userId path   long
Response Body
media type data type description
application/json object