PUT api/list/todos/savefilter
Save Todo List Filter. Processes this list API request. The parameter and response sections describe the data exchanged with the API.
Request Information
URI Parameters
None.
Body Parameters
The save todo list filter data contract supplied with the request.
SaveTodoListFilterDataContract| Name | Description | Type | Additional information |
|---|---|---|---|
| Context |
The context classification. |
ListContext |
None. |
| FilterCategory |
The filter category value. |
string |
None. |
| IncludeGlobal |
Indicates whether include global is true. |
boolean |
None. |
| OnlyGlobal |
Indicates whether only global is true. |
boolean |
None. |
| OwningNegotiatorId |
The unique identifier of the related owning negotiator resource. |
integer |
None. |
| NegotiatorIds |
The unique identifiers of the related negotiator resources. |
Collection of integer |
None. |
| Statuses |
The collection of statuses. |
Collection of string |
None. |
| ToDoTypes |
The collection of to do types. |
Collection of string |
None. |
| Schedules |
The collection of schedules. |
Collection of string |
None. |
| Priorities |
The collection of priorities. |
Collection of string |
None. |
| Intervals |
The collection of intervals. |
Collection of string |
None. |
| DateTo |
The date to, expressed as a date and time. |
date |
None. |
| DateFrom |
The date from, expressed as a date and time. |
date |
None. |
| Date |
The date value. |
DateRangeFilterDataContract |
None. |
| Sort |
The sort classification. |
TodoListSort |
None. |
| AdditionalIds |
The unique identifiers of the related additional resources. |
Collection of integer |
None. |
| ExcludedIds |
The unique identifiers of the related excluded resources. |
Collection of integer |
None. |
| Name |
The name value. |
string |
None. |
| CustomFilterConfig |
The custom filter config value. |
string |
None. |
| BranchId |
The unique identifier of the related branch resource. |
integer |
None. |
| BranchIds |
The unique identifiers of the related branch resources. |
Collection of integer |
None. |
| EventBranchIds |
The unique identifiers of the related event branch resources. |
Collection of integer |
None. |
| Order |
The order classification. |
ListOrder |
None. |
| SearchTerm |
The search term value. |
string |
None. |
| FilterType |
The filter type value. |
EnumDataContract |
None. |
| ShowDeleted |
Indicates whether show deleted is true. |
boolean |
None. |
| ShowCancelled |
Indicates whether show cancelled is true. |
boolean |
None. |
| OwningTeamId |
The unique identifier of the related owning team resource. |
integer |
None. |
| Id |
The unique identifier of this resource. |
integer |
None. |
Request Formats
application/x-www-form-urlencoded
Sample not available.
application/json, text/json
{
"Context": 0,
"FilterCategory": "sample string 1",
"IncludeGlobal": true,
"OnlyGlobal": true,
"OwningNegotiatorId": 1,
"NegotiatorIds": [
1,
2
],
"Statuses": [
"sample string 1",
"sample string 2"
],
"ToDoTypes": [
"sample string 1",
"sample string 2"
],
"Schedules": [
"sample string 1",
"sample string 2"
],
"Priorities": [
"sample string 1",
"sample string 2"
],
"Intervals": [
"sample string 1",
"sample string 2"
],
"DateTo": "2026-07-23T20:15:37.7317704Z",
"DateFrom": "2026-07-23T20:15:37.7317704Z",
"Date": {
"FromStaticDate": "2026-07-23T20:15:37.7317704Z",
"ToStaticDate": "2026-07-23T20:15:37.7317704Z",
"PredefinedDateRange": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"FromExpression": "sample string 1",
"ToExpression": "sample string 2",
"Id": 3
},
"Sort": 0,
"AdditionalIds": [
1,
2
],
"ExcludedIds": [
1,
2
],
"Name": "sample string 4",
"CustomFilterConfig": "sample string 5",
"BranchId": 1,
"BranchIds": [
1,
2
],
"EventBranchIds": [
1,
2
],
"Order": 0,
"SearchTerm": "sample string 6",
"FilterType": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"ShowDeleted": true,
"ShowCancelled": true,
"OwningTeamId": 9,
"Id": 10
}
Response Information
Resource Description
The response returned after the operation completes.
TodoListFilterDataContract| Name | Description | Type | Additional information |
|---|---|---|---|
| FilterCategory |
The filter category value. |
string |
None. |
| IncludeGlobal |
Indicates whether include global is true. |
boolean |
None. |
| OnlyGlobal |
Indicates whether only global is true. |
boolean |
None. |
| OwningNegotiatorId |
The unique identifier of the related owning negotiator resource. |
integer |
None. |
| NegotiatorIds |
The unique identifiers of the related negotiator resources. |
Collection of integer |
None. |
| Statuses |
The collection of statuses. |
Collection of string |
None. |
| ToDoTypes |
The collection of to do types. |
Collection of string |
None. |
| Schedules |
The collection of schedules. |
Collection of string |
None. |
| Priorities |
The collection of priorities. |
Collection of string |
None. |
| Intervals |
The collection of intervals. |
Collection of string |
None. |
| DateTo |
The date to, expressed as a date and time. |
date |
None. |
| DateFrom |
The date from, expressed as a date and time. |
date |
None. |
| Date |
The date value. |
DateRangeFilterDataContract |
None. |
| Sort |
The sort classification. |
TodoListSort |
None. |
| AdditionalIds |
The unique identifiers of the related additional resources. |
Collection of integer |
None. |
| ExcludedIds |
The unique identifiers of the related excluded resources. |
Collection of integer |
None. |
| Name |
The name value. |
string |
None. |
| CustomFilterConfig |
The custom filter config value. |
string |
None. |
| BranchId |
The unique identifier of the related branch resource. |
integer |
None. |
| BranchIds |
The unique identifiers of the related branch resources. |
Collection of integer |
None. |
| EventBranchIds |
The unique identifiers of the related event branch resources. |
Collection of integer |
None. |
| Order |
The order classification. |
ListOrder |
None. |
| SearchTerm |
The search term value. |
string |
None. |
| FilterType |
The filter type value. |
EnumDataContract |
None. |
| ShowDeleted |
Indicates whether show deleted is true. |
boolean |
None. |
| ShowCancelled |
Indicates whether show cancelled is true. |
boolean |
None. |
| OwningTeamId |
The unique identifier of the related owning team resource. |
integer |
None. |
| Id |
The unique identifier of this resource. |
integer |
None. |
Response Formats
application/json, text/json
{
"FilterCategory": "sample string 1",
"IncludeGlobal": true,
"OnlyGlobal": true,
"OwningNegotiatorId": 1,
"NegotiatorIds": [
1,
2
],
"Statuses": [
"sample string 1",
"sample string 2"
],
"ToDoTypes": [
"sample string 1",
"sample string 2"
],
"Schedules": [
"sample string 1",
"sample string 2"
],
"Priorities": [
"sample string 1",
"sample string 2"
],
"Intervals": [
"sample string 1",
"sample string 2"
],
"DateTo": "2026-07-23T20:15:37.7317704Z",
"DateFrom": "2026-07-23T20:15:37.7317704Z",
"Date": {
"FromStaticDate": "2026-07-23T20:15:37.7317704Z",
"ToStaticDate": "2026-07-23T20:15:37.7317704Z",
"PredefinedDateRange": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"FromExpression": "sample string 1",
"ToExpression": "sample string 2",
"Id": 3
},
"Sort": 0,
"AdditionalIds": [
1,
2
],
"ExcludedIds": [
1,
2
],
"Name": "sample string 4",
"CustomFilterConfig": "sample string 5",
"BranchId": 1,
"BranchIds": [
1,
2
],
"EventBranchIds": [
1,
2
],
"Order": 0,
"SearchTerm": "sample string 6",
"FilterType": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"ShowDeleted": true,
"ShowCancelled": true,
"OwningTeamId": 9,
"Id": 10
}