SpiraPlan: SoapService SOAP Web Service

See all operations

SavedFilter_Update

Description

Updates a list page saved filter which is owned by the modifying user. Only the Name, IsShared, and Entries properties can be updated. Use a int value of -999 for (none) option. This API endpoint will let you create invalid saved filters, and this will throw an error on artifact list pages when applied or always return empty results. It is recommended to primarily use this endpoint to update existing filtered fields (Such as updating a ReleaseId within a saved filter to a new release at the beginning of a sprint) In order to influence which columns are viewable and their order, you should modify filters with property names formatted as "_{FieldName}", and set the StringValue to "Y_0" or "N_0" to declare Yes or No for displaying that property. The 0 should be replaced with numbers which convey the order of displayable fields. The UI uses 1 through X where X is the total number of fields, but it is arbitrary. A lower number makes the column closer to the left on the list page. This can be done alongside a filtered field with a property name formatted as "{FieldName}" for the same field, and the one without the underscore (_) should contain the filter value instead of the display order information. Do not try to put both the "Y_0" and the actual filter value in the same RemoteFilter object (the objects in "Filters") as that will not work.

Parameters

Type Name Required
RemoteCredentials? credentials -
RemoteSavedFilter? remoteFilter - Filter which you want to update

Return Value

-