Planfix API: project filters

From Planfix
Jump to: navigation, search

Project filters are set by the following set of parameters:

  • type - numerical identifier of the filter
  • operator - filter operator, one of the values from the list (equal, notequal, gt, lt) different filters may have different valid operators.
  • value - filter value, can be a string, number, or complex object, depending on the filter type
  • field - identifier of the custom field, for filters by custom fields
Type Name Operators Value format
5005 Due date
  • equal
  • notequal
  • gt
  • lt

object:

<value>
  <datetype></datetype>
  <datevalue></datevalue>
  <datefrom></datefrom>
  <dateto></dateto>
</value>

datetype accepts the following values:

  • today - today
  • yesterday - yesterday
  • tomorrow - tomorrow
  • thisweek - this week
  • lastweek
  • nextweek
  • thismonth
  • lastmonth
  • nextmonth
  • last - last n days, n is passed in datevalue
  • next - next n days, n is passed in datevalue
  • in - in n days, n is passed in datevalue
  • anotherdate - exact date, date is passed in the format dd-mm-yyyy in datefrom
  • anotherperiod - exact period, dates are passed in the format dd-mm-yyyy in datefrom and dateto

examples:

<value>
  <datetype>thisweek</datetype>
</value>
<value>
  <datetype>anotherperiod</datetype>
  <datefrom>01-01-2015</datefrom>
  <dateto>01-02-2015</dateto>
</value>
5004 Author
  • equal
  • notequal
int : employee identifier
5008 Customer-manager
5108 Custom field type Contact
5109 Custom field type Employee
5112 Custom field type Group, employee, contact
5113 Custom field type List of employees
5010 Template
  • equal
  • notequal
int : project template identifier
5014 Parent project
  • equal
  • notequal
int : Parent project identifier
5001 Project name
  • equal
  • notequal
string - filter contains / does not contain
5101 Custom field type String
5102 Custom field type Number
  • equal
  • notequal
  • gt
  • lt
int
5105 Custom field type Checkbox
  • equal
  • notequal
int - 1 / 0
5106 Custom field type List
  • equal
  • notequal
string
5107 Custom field type Directory
  • equal
  • notequal
int - entry identifier
5114 Custom field type Set of directory entries
  • equal
  • notequal
int - record identifier, for condition by several records - identifiers through ; (semicolon)


Go To