Robohead API Documentation - User Filter

Rest API Documentation for User Filter module

EP : Extended Permissions

+  : Consider the permission with + and all permissions above it.
     Permission hierarchy : Account Admin > Project Manager > Project Member > Contact

					

Following is the json format for filter criteria with an example. You can provide more than one criteria's.

To get list of columns, give call to ListListColumns of Account module. Pass account Id and form type(ie. 2 = Project form) to the call. The response contains list of ListColumn object. The ListColumn object contains Field object which will give the field details. The Field object contains the GlobalList object.

Filter can be applied to any of these fields depending on their types.

To get operator list for the field give call to ListFieldComparator of form module and provide field type Id in parameter 'fieldTypeId', provide mode 'report'. Then provide the operator Id which is to be set for the filter, in parameter 'operatorId'.

Provide operator Id in parameter 'operator'.

Provide field type Id in parameter 'fieldType'.

Provide filter type in parameter 'filterType'. There are two Filter Types CommonFilter = 1, TagFilter = 2. Common Filter is used in multi-filter case. In Case of TagFilter you have to pass only tagId under 'value' field in JSON. You will get list of tags for user refer this.

Provide value for the filter depending on the type of field in parameter 'value'.

[
  {
    "fieldId": "Provide field Id on which you want to apply criteria",
    "operator": "Provide operator Id",
    "fieldType": "Provide field type",
    "filterType": "Provide filter type",
    "value": "Provide criteria value"
  }
]

[
  {
    "fieldId": 94269,
    "operator": 1,
    "fieldType": 7,
    "value": 112666,
    "filterType": 1
  },
  {
    "filterType": 2,
    "value": "7966"
  }
]

Following are object types and their Ids where notes can be added,

 Request  = 2
       Project  = 3
       Client   = 5
       Campaign = 6
       Task     = 9
       Review   = 10
	   Note		= 11
       File     = 12
       Todo     = 13

					

Paths List all operations