Robohead API Documentation - File

REST API Documentation - File Module

  EP : Extended Permissions
  +  : Consider the permission and all permissions above it.
      Permission sequence is : Account Admin > Project Manager > Project Member > Contact

Following are filter details to be used for File list calls. Pass filter column name to parameter filterColumn. Then provide what type of filter is to be applied like 'is' or 'is not' or 'not in' etc. This value is to be passed in the comparatorId parameter. Pass filter value in parameter filterValue. If filter value is of option type, then pass comma separated option Ids. Every column has a type. Hence pass this type in the parameter fieldType.

  filterColumn    : Field Id of the standard column on which filter is to be applied.
  comparatorId    : Comaparators that can be used for the column.
                    Give call to ListFieldComparator of Form module to get list of comparators.
                    Provide column type as fieldTypeId to the call.
                    It will return list of comparators that can use for the field.
  filterValue     : Type of filter value that can be provide to the column.
  fieldType       : Type of column.
                    Following are the types of columns and their ids :
                        1 : text
                        3 : number
                        4 : date
                        7 : single select
                        9 : multi select

Filter Types :

   filtercolumn: title
        fieldType: 1
        comparatorId: Provide comparator Id from the list.
        filterValue: Provide string value

  filtercolumn: createdOn
        fieldType: 4
        comparatorId: Provide comparator Id from the list.
        filterValue: Provide date value

  filtercolumn: kind
       fieldType: 1
       comparatorId: Provide comparator Id from the list.
       filterValue: Provide string value

  filtercolumn: size
       fieldType: 3
       comparatorId: Provide comparator Id from the list.
       filterValue: Provide integer value

  filtercolumn: createdBy
       fieldType: 9
       comparatorId: Provide comparator Id from the list.
       filterValue: Provide comma separated user ids. Give call to ListAccountActiveUser of user module to get list of active users.

Following is the list of object types and their ids

  1 : Account
  3 : Project
  4 : Folder
  6 : Campaign
 10 : Review

Paths List all operations