Planfix API: Task filters

From Planfix
Jump to: navigation, search

Task filters are set by the following set of parameters:

  • type - numeric identifier of the filter
  • operator - filter operator, one of the values from the list (equal, notequal, gt, lt) different filters may have different permissible operators.
  • value - filter value, can be a string, number or complex object, depending on the type of filter
  • field - identifier of the custom field, for filters by custom fields
Type Name Operators Value format
12 Creation 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
  • anotherdate_withtime - exact date-time, date is passed in the format "dd-mm-yyyy hh:mm" in datefrom
  • anotherperiod_withtime - exact period with set time, dates are passed in the format "dd-mm-yyyy hh:mm" in datefrom and dateto

dates are considered to be passed in the employee's timezone, on behalf of whom the request was made

examples:

<value>
  <datetype>thisweek</datetype>
</value>
<value>
  <datetype>anotherperiod</datetype>
  <datefrom>01-01-2015</datefrom>
  <dateto>01-02-2015</dateto>
</value>
<value>
  <datetype>anotherdate_withtime</datetype>
  <datefrom>01-01-2015 12:00</datefrom>
</value>
13 Planned start date
14 Planned due date
21 Date of last activity (last added comment)
19 Actual completion date
20 Completion date
38 Date of last modification
79 Date of last modification or comment
103 Custom field of type Date
1 Assigner
  • equal
  • notequal
int : employee identifier
2 Assignee
39 Participant
3 Auditor of task or project
59 Project auditor
60 Task auditor
108 Custom field of type Contact
109 Custom field of type Employee
112 Custom field of type Group, employee, contact
113 Custom field of type Employee list
22 Without start date
  • equal
int - 1
23 Without due date
25 With start date
26 With due date
16 Recurring
28 Non-recurring
17 Overdue
29 Not overdue
33 Without assignees
41 Without participants
34 Assigner - employee
35 Assigner - contact
71 Assignee - employee
69 Assignee - contact
72 Participant - employee
70 Participant - contact
8 Task name
  • equal
  • notequal
string - filter contains / does not contain
101 Custom field type String
102 Custom field type Number
  • equal
  • notequal
  • gt
  • lt
int
105 Custom field type Checkbox
  • equal
  • notequal
int - 1 / 0
106 Custom field type List
  • equal
  • notequal
string
107 Custom field of type Directory
  • equal
  • notequal
int - entry identifier
114 Custom field type Set of directory entries
  • equal
  • notequal
int - ntry identifier, for condition by several entries- identifiers through ; (semicolon)
152 Contains value in a custom field
  • equal
int - field identifier
153 Does not contain value in custom field
  • equal
int - field identifier
11 Contains data tag
  • equal
int - data tag identifier
18 Does not contain data tag
  • equal
int - data tag identifier
73 Direct parent task
  • equal
  • notequal
int - parent task identifier
51 Template
  • equal
  • notequal
int - template identifier
10 Status
  • equal
  • notequal
int - status identifier, for condition by several statuses - identifiers through ; (semicolon)
7 Counterparty
  • equal
  • notequal
int - counterparty identifier ( id in responses contact.get / contact.getList )
24 Process
  • equal
  • notequal
int - process identifier ( id in responses taskStatus.getSetList )


Go To