API Tester Params —
squish.project.countGET
Takes the same parameters as search, but returns the number of issues that would be returned by that search.
GET Parameters:
- prj: The short name of the project to search
- q: Keywords and/or phrases to search
URL:
https://api.squishlist.com/rest/?method=squish.project.count
Result:
None yet.
squish.project.getFieldsGET
Returns a list of field information for fields defined by the specified project.
GET Parameters:
- prj: The short name of the project
- inactive: Passing a value of 1 will include inactive fields (default=0)
URL:
https://api.squishlist.com/rest/?method=squish.project.getFields
Result:
None yet.
squish.project.getInfoGET
Returns information about the requested project.
GET Parameters:
- prj: The short name of the project
URL:
https://api.squishlist.com/rest/?method=squish.project.getInfo
Result:
None yet.
squish.project.searchGET
Returns issues in from the specified project that match the criteria given.
GET Parameters:
- prj: The short name of the project to search
- raw: Passing a value of 1 will cause values to be returned unformatted (default=0)
- seq: Passing a value of 1 will cause field values to be returned as lists (
[field, value]) instead of objects ({field: value}). This option will also order the fields as they are in Squish. (default=0) - q: Keywords and/or phrases to search
- order: A bug_field to order by (i.e. subject, display_id, date_modified, etc). Currently, only "core" fields are supported for ordering. (default=None)
- n: The maximum number of issues to return (default=ALL)
- d: A field to include in the results. The default behavior is to include any field marked as being shown in search results. Passing one or more
dparameters will return only those fields (specified by ID, bug_field, or name). Passing * will include all fields. - *: All other parameters are interpreted as search criteria. You may specify them as
id=value, whereidcan be the unique number returned from getFields, or thebug_fieldif applicable.valueis dependent on which field it is for, but may be text (will compare case-insensitive) or a lookup choice ID. - *_oper: Optionally specifies an operator to use for a given field. Valid operators are
(exact, gt, gte, lt, lte, range, icontains, isnull, notnull, all, any, none). For example,date_modified_oper=gtwill cause the search engine to parse any criteria fordate_modifiedas "greater than" instead of "equals". For therangeoperator, you should pass 2 values separately, in ascending order.
URL:
https://api.squishlist.com/rest/?method=squish.project.search
Result:
None yet.
squish.project.timelineGET
Returns timeline information about the specified project.
GET Parameters:
- prj: The short name of the project
- raw: Passing a value of 1 will cause values to be returned unformatted (default=0)
- days: The number of days back to return timeline information for (default=4)
URL:
https://api.squishlist.com/rest/?method=squish.project.timeline
Result:
None yet.