v1

latestSwagger 2.02026-07-14311125.2 KB
feature

Search features

get/search

Query parameters

scope'feature' required

Specifies the type of entity being searched for. Must be set to 'feature'

qstring required

The search term.

status'new' | 'waiting' | 'planned' | 'developing' | 'released' | 'declined'

A comma seperated list of status values to filter by, if required. Valid values: 'new', 'waiting', 'planned', 'developing', 'released', 'declined'.

tagsstring

Tags to limit results by - only applies when scope is 'case' or 'feature'. Multiple tags can be provided via comma delimeted string. Tags with contexts can be used. E.g. "....&tags=TagExample,Multi:TagThis,Multi:TagThat".

productsstring

Products to limit results by. Comma delimeted string of either ids or names. E.g. "...&products=1,2,3" or "...products=Product1,Product2".

Response

Success

app_urlstring

URL for this Feature

created_atstring
created_by_user_idinteger
declined_atstring
descriptionstring
developing_atstring
effortinteger

How much Effort is assigned to the development of this Feature. Not visible to EndUsers

form_entrystring

a JSON serialized version of the Form containing the description and other fields for this Feature.

idnumber
is_privateboolean

Is this Feature hidden from EndUsers?

merged_to_feature_idinteger

If this Feature was merged into another, the ID of the preserved Feature

planned_atstring
productsstring[]
released_atstring
resolutionstring

The latest Resolution set by the VendorUser

resolved_by_user_idinteger
status'new' | 'waiting' | 'planned' | 'developing' | 'released' | 'declined'
status_changed_atstring
{"stackTrail":"components:schemas:Tags","oasType":"schema","type":"unknown","description":"Tags can contain simple tags or categorised tags. Simple tags are supplied as an array of Strings\nSimple Tag Example:\n['Foo', 'Bar']. \nTo put the tags in categories replace the Strings with maps of using tag category as the key and tag value as the value where value can be array of strings, e.g\nCategorised Tag Example:\n[\n{'Color':['Red', 'Yellow']}, \n{'Flavor':['Cherry']}\n] \nSimple and categorised tags can be mixed in the same array.\nBelow validations are done on the tag values of both simple and categorised tags:\n1. Tag values must be strings\n2. Tags must be at least 2 characters in length\n3. Invalid characters (we dont accept following characters in tag value) , | { } : < > "}
titlestring
updated_atstring
updated_by_user_idinteger
uploadsstring[]
vendor_idinteger
view_countinteger

How many times has this Feature been viewed. May only be visible to VendorUsers, depending on config

waiting_atstring