Set Activity Filter
using RestSharp;
var options = new RestClientOptions("http://localhost:56350/api/v1/Agents/Archive/SetActivityFilter");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddJsonBody("{\n \"ActivityFilter\": {\n \"FromDate\": \"2023-11-07T05:31:56Z\",\n \"ToDate\": \"2023-11-07T05:31:56Z\",\n \"AssociateList\": [\n {\n \"Id\": 123,\n \"Name\": \"<string>\",\n \"ToolTip\": \"<string>\",\n \"Deleted\": true,\n \"Rank\": 123,\n \"Type\": \"<string>\",\n \"ColorBlock\": 123,\n \"IconHint\": \"<string>\",\n \"Selected\": true,\n \"LastChanged\": \"2023-11-07T05:31:56Z\",\n \"ChildItems\": \"<array>\",\n \"ExtraInfo\": \"<string>\",\n \"StyleHint\": \"<string>\",\n \"Hidden\": true,\n \"FullName\": \"<string>\",\n \"TableRight\": {\n \"Mask\": \"<string>\",\n \"Reason\": \"<string>\"\n },\n \"FieldProperties\": {}\n }\n ],\n \"GroupList\": [\n {\n \"Id\": 123,\n \"Name\": \"<string>\",\n \"ToolTip\": \"<string>\",\n \"Deleted\": true,\n \"Rank\": 123,\n \"Type\": \"<string>\",\n \"ColorBlock\": 123,\n \"IconHint\": \"<string>\",\n \"Selected\": true,\n \"LastChanged\": \"2023-11-07T05:31:56Z\",\n \"ChildItems\": \"<array>\",\n \"ExtraInfo\": \"<string>\",\n \"StyleHint\": \"<string>\",\n \"Hidden\": true,\n \"FullName\": \"<string>\",\n \"TableRight\": {\n \"Mask\": \"<string>\",\n \"Reason\": \"<string>\"\n },\n \"FieldProperties\": {}\n }\n ],\n \"FutureDateList\": [\n {\n \"Id\": 123,\n \"Name\": \"<string>\",\n \"ToolTip\": \"<string>\",\n \"Deleted\": true,\n \"Rank\": 123,\n \"Type\": \"<string>\",\n \"ChildItems\": \"<array>\",\n \"IconHint\": \"<string>\",\n \"ColorBlock\": 123,\n \"ExtraInfo\": \"<string>\",\n \"StyleHint\": \"<string>\",\n \"FullName\": \"<string>\",\n \"TableRight\": {\n \"Mask\": \"<string>\",\n \"Reason\": \"<string>\"\n },\n \"FieldProperties\": {}\n }\n ],\n \"TableRight\": {\n \"Mask\": \"<string>\",\n \"Reason\": \"<string>\"\n },\n \"FieldProperties\": {}\n }\n}", false);
var response = await client.PostAsync(request);
Console.WriteLine("{0}", response.Content);const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
ActivityFilter: {
FromDate: '2023-11-07T05:31:56Z',
ToDate: '2023-11-07T05:31:56Z',
AssociateList: [
{
Id: 123,
Name: '<string>',
ToolTip: '<string>',
Deleted: true,
Rank: 123,
Type: '<string>',
ColorBlock: 123,
IconHint: '<string>',
Selected: true,
LastChanged: '2023-11-07T05:31:56Z',
ChildItems: '<array>',
ExtraInfo: '<string>',
StyleHint: '<string>',
Hidden: true,
FullName: '<string>',
TableRight: {Mask: '<string>', Reason: '<string>'},
FieldProperties: {}
}
],
GroupList: [
{
Id: 123,
Name: '<string>',
ToolTip: '<string>',
Deleted: true,
Rank: 123,
Type: '<string>',
ColorBlock: 123,
IconHint: '<string>',
Selected: true,
LastChanged: '2023-11-07T05:31:56Z',
ChildItems: '<array>',
ExtraInfo: '<string>',
StyleHint: '<string>',
Hidden: true,
FullName: '<string>',
TableRight: {Mask: '<string>', Reason: '<string>'},
FieldProperties: {}
}
],
FutureDateList: [
{
Id: 123,
Name: '<string>',
ToolTip: '<string>',
Deleted: true,
Rank: 123,
Type: '<string>',
ChildItems: '<array>',
IconHint: '<string>',
ColorBlock: 123,
ExtraInfo: '<string>',
StyleHint: '<string>',
FullName: '<string>',
TableRight: {Mask: '<string>', Reason: '<string>'},
FieldProperties: {}
}
],
TableRight: {Mask: '<string>', Reason: '<string>'},
FieldProperties: {}
}
})
};
fetch('http://localhost:56350/api/v1/Agents/Archive/SetActivityFilter', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "56350",
CURLOPT_URL => "http://localhost:56350/api/v1/Agents/Archive/SetActivityFilter",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'ActivityFilter' => [
'FromDate' => '2023-11-07T05:31:56Z',
'ToDate' => '2023-11-07T05:31:56Z',
'AssociateList' => [
[
'Id' => 123,
'Name' => '<string>',
'ToolTip' => '<string>',
'Deleted' => true,
'Rank' => 123,
'Type' => '<string>',
'ColorBlock' => 123,
'IconHint' => '<string>',
'Selected' => true,
'LastChanged' => '2023-11-07T05:31:56Z',
'ChildItems' => '<array>',
'ExtraInfo' => '<string>',
'StyleHint' => '<string>',
'Hidden' => true,
'FullName' => '<string>',
'TableRight' => [
'Mask' => '<string>',
'Reason' => '<string>'
],
'FieldProperties' => [
]
]
],
'GroupList' => [
[
'Id' => 123,
'Name' => '<string>',
'ToolTip' => '<string>',
'Deleted' => true,
'Rank' => 123,
'Type' => '<string>',
'ColorBlock' => 123,
'IconHint' => '<string>',
'Selected' => true,
'LastChanged' => '2023-11-07T05:31:56Z',
'ChildItems' => '<array>',
'ExtraInfo' => '<string>',
'StyleHint' => '<string>',
'Hidden' => true,
'FullName' => '<string>',
'TableRight' => [
'Mask' => '<string>',
'Reason' => '<string>'
],
'FieldProperties' => [
]
]
],
'FutureDateList' => [
[
'Id' => 123,
'Name' => '<string>',
'ToolTip' => '<string>',
'Deleted' => true,
'Rank' => 123,
'Type' => '<string>',
'ChildItems' => '<array>',
'IconHint' => '<string>',
'ColorBlock' => 123,
'ExtraInfo' => '<string>',
'StyleHint' => '<string>',
'FullName' => '<string>',
'TableRight' => [
'Mask' => '<string>',
'Reason' => '<string>'
],
'FieldProperties' => [
]
]
],
'TableRight' => [
'Mask' => '<string>',
'Reason' => '<string>'
],
'FieldProperties' => [
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}import requests
url = "http://localhost:56350/api/v1/Agents/Archive/SetActivityFilter"
payload = { "ActivityFilter": {
"FromDate": "2023-11-07T05:31:56Z",
"ToDate": "2023-11-07T05:31:56Z",
"AssociateList": [
{
"Id": 123,
"Name": "<string>",
"ToolTip": "<string>",
"Deleted": True,
"Rank": 123,
"Type": "<string>",
"ColorBlock": 123,
"IconHint": "<string>",
"Selected": True,
"LastChanged": "2023-11-07T05:31:56Z",
"ChildItems": "<array>",
"ExtraInfo": "<string>",
"StyleHint": "<string>",
"Hidden": True,
"FullName": "<string>",
"TableRight": {
"Mask": "<string>",
"Reason": "<string>"
},
"FieldProperties": {}
}
],
"GroupList": [
{
"Id": 123,
"Name": "<string>",
"ToolTip": "<string>",
"Deleted": True,
"Rank": 123,
"Type": "<string>",
"ColorBlock": 123,
"IconHint": "<string>",
"Selected": True,
"LastChanged": "2023-11-07T05:31:56Z",
"ChildItems": "<array>",
"ExtraInfo": "<string>",
"StyleHint": "<string>",
"Hidden": True,
"FullName": "<string>",
"TableRight": {
"Mask": "<string>",
"Reason": "<string>"
},
"FieldProperties": {}
}
],
"FutureDateList": [
{
"Id": 123,
"Name": "<string>",
"ToolTip": "<string>",
"Deleted": True,
"Rank": 123,
"Type": "<string>",
"ChildItems": "<array>",
"IconHint": "<string>",
"ColorBlock": 123,
"ExtraInfo": "<string>",
"StyleHint": "<string>",
"FullName": "<string>",
"TableRight": {
"Mask": "<string>",
"Reason": "<string>"
},
"FieldProperties": {}
}
],
"TableRight": {
"Mask": "<string>",
"Reason": "<string>"
},
"FieldProperties": {}
} }
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
ActivityFilter: {
FromDate: '2023-11-07T05:31:56Z',
ToDate: '2023-11-07T05:31:56Z',
AssociateList: [
{
Id: 123,
Name: '<string>',
ToolTip: '<string>',
Deleted: true,
Rank: 123,
Type: '<string>',
ColorBlock: 123,
IconHint: '<string>',
Selected: true,
LastChanged: '2023-11-07T05:31:56Z',
ChildItems: '<array>',
ExtraInfo: '<string>',
StyleHint: '<string>',
Hidden: true,
FullName: '<string>',
TableRight: {Mask: '<string>', Reason: '<string>'},
FieldProperties: {}
}
],
GroupList: [
{
Id: 123,
Name: '<string>',
ToolTip: '<string>',
Deleted: true,
Rank: 123,
Type: '<string>',
ColorBlock: 123,
IconHint: '<string>',
Selected: true,
LastChanged: '2023-11-07T05:31:56Z',
ChildItems: '<array>',
ExtraInfo: '<string>',
StyleHint: '<string>',
Hidden: true,
FullName: '<string>',
TableRight: {Mask: '<string>', Reason: '<string>'},
FieldProperties: {}
}
],
FutureDateList: [
{
Id: 123,
Name: '<string>',
ToolTip: '<string>',
Deleted: true,
Rank: 123,
Type: '<string>',
ChildItems: '<array>',
IconHint: '<string>',
ColorBlock: 123,
ExtraInfo: '<string>',
StyleHint: '<string>',
FullName: '<string>',
TableRight: {Mask: '<string>', Reason: '<string>'},
FieldProperties: {}
}
],
TableRight: {Mask: '<string>', Reason: '<string>'},
FieldProperties: {}
}
})
};
fetch('http://localhost:56350/api/v1/Agents/Archive/SetActivityFilter', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));Set Activity Filter
Set activity filter for the specified list.
NsApiSlow threshold: 5000 ms.
Set Activity Filter
using RestSharp;
var options = new RestClientOptions("http://localhost:56350/api/v1/Agents/Archive/SetActivityFilter");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddJsonBody("{\n \"ActivityFilter\": {\n \"FromDate\": \"2023-11-07T05:31:56Z\",\n \"ToDate\": \"2023-11-07T05:31:56Z\",\n \"AssociateList\": [\n {\n \"Id\": 123,\n \"Name\": \"<string>\",\n \"ToolTip\": \"<string>\",\n \"Deleted\": true,\n \"Rank\": 123,\n \"Type\": \"<string>\",\n \"ColorBlock\": 123,\n \"IconHint\": \"<string>\",\n \"Selected\": true,\n \"LastChanged\": \"2023-11-07T05:31:56Z\",\n \"ChildItems\": \"<array>\",\n \"ExtraInfo\": \"<string>\",\n \"StyleHint\": \"<string>\",\n \"Hidden\": true,\n \"FullName\": \"<string>\",\n \"TableRight\": {\n \"Mask\": \"<string>\",\n \"Reason\": \"<string>\"\n },\n \"FieldProperties\": {}\n }\n ],\n \"GroupList\": [\n {\n \"Id\": 123,\n \"Name\": \"<string>\",\n \"ToolTip\": \"<string>\",\n \"Deleted\": true,\n \"Rank\": 123,\n \"Type\": \"<string>\",\n \"ColorBlock\": 123,\n \"IconHint\": \"<string>\",\n \"Selected\": true,\n \"LastChanged\": \"2023-11-07T05:31:56Z\",\n \"ChildItems\": \"<array>\",\n \"ExtraInfo\": \"<string>\",\n \"StyleHint\": \"<string>\",\n \"Hidden\": true,\n \"FullName\": \"<string>\",\n \"TableRight\": {\n \"Mask\": \"<string>\",\n \"Reason\": \"<string>\"\n },\n \"FieldProperties\": {}\n }\n ],\n \"FutureDateList\": [\n {\n \"Id\": 123,\n \"Name\": \"<string>\",\n \"ToolTip\": \"<string>\",\n \"Deleted\": true,\n \"Rank\": 123,\n \"Type\": \"<string>\",\n \"ChildItems\": \"<array>\",\n \"IconHint\": \"<string>\",\n \"ColorBlock\": 123,\n \"ExtraInfo\": \"<string>\",\n \"StyleHint\": \"<string>\",\n \"FullName\": \"<string>\",\n \"TableRight\": {\n \"Mask\": \"<string>\",\n \"Reason\": \"<string>\"\n },\n \"FieldProperties\": {}\n }\n ],\n \"TableRight\": {\n \"Mask\": \"<string>\",\n \"Reason\": \"<string>\"\n },\n \"FieldProperties\": {}\n }\n}", false);
var response = await client.PostAsync(request);
Console.WriteLine("{0}", response.Content);const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
ActivityFilter: {
FromDate: '2023-11-07T05:31:56Z',
ToDate: '2023-11-07T05:31:56Z',
AssociateList: [
{
Id: 123,
Name: '<string>',
ToolTip: '<string>',
Deleted: true,
Rank: 123,
Type: '<string>',
ColorBlock: 123,
IconHint: '<string>',
Selected: true,
LastChanged: '2023-11-07T05:31:56Z',
ChildItems: '<array>',
ExtraInfo: '<string>',
StyleHint: '<string>',
Hidden: true,
FullName: '<string>',
TableRight: {Mask: '<string>', Reason: '<string>'},
FieldProperties: {}
}
],
GroupList: [
{
Id: 123,
Name: '<string>',
ToolTip: '<string>',
Deleted: true,
Rank: 123,
Type: '<string>',
ColorBlock: 123,
IconHint: '<string>',
Selected: true,
LastChanged: '2023-11-07T05:31:56Z',
ChildItems: '<array>',
ExtraInfo: '<string>',
StyleHint: '<string>',
Hidden: true,
FullName: '<string>',
TableRight: {Mask: '<string>', Reason: '<string>'},
FieldProperties: {}
}
],
FutureDateList: [
{
Id: 123,
Name: '<string>',
ToolTip: '<string>',
Deleted: true,
Rank: 123,
Type: '<string>',
ChildItems: '<array>',
IconHint: '<string>',
ColorBlock: 123,
ExtraInfo: '<string>',
StyleHint: '<string>',
FullName: '<string>',
TableRight: {Mask: '<string>', Reason: '<string>'},
FieldProperties: {}
}
],
TableRight: {Mask: '<string>', Reason: '<string>'},
FieldProperties: {}
}
})
};
fetch('http://localhost:56350/api/v1/Agents/Archive/SetActivityFilter', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "56350",
CURLOPT_URL => "http://localhost:56350/api/v1/Agents/Archive/SetActivityFilter",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'ActivityFilter' => [
'FromDate' => '2023-11-07T05:31:56Z',
'ToDate' => '2023-11-07T05:31:56Z',
'AssociateList' => [
[
'Id' => 123,
'Name' => '<string>',
'ToolTip' => '<string>',
'Deleted' => true,
'Rank' => 123,
'Type' => '<string>',
'ColorBlock' => 123,
'IconHint' => '<string>',
'Selected' => true,
'LastChanged' => '2023-11-07T05:31:56Z',
'ChildItems' => '<array>',
'ExtraInfo' => '<string>',
'StyleHint' => '<string>',
'Hidden' => true,
'FullName' => '<string>',
'TableRight' => [
'Mask' => '<string>',
'Reason' => '<string>'
],
'FieldProperties' => [
]
]
],
'GroupList' => [
[
'Id' => 123,
'Name' => '<string>',
'ToolTip' => '<string>',
'Deleted' => true,
'Rank' => 123,
'Type' => '<string>',
'ColorBlock' => 123,
'IconHint' => '<string>',
'Selected' => true,
'LastChanged' => '2023-11-07T05:31:56Z',
'ChildItems' => '<array>',
'ExtraInfo' => '<string>',
'StyleHint' => '<string>',
'Hidden' => true,
'FullName' => '<string>',
'TableRight' => [
'Mask' => '<string>',
'Reason' => '<string>'
],
'FieldProperties' => [
]
]
],
'FutureDateList' => [
[
'Id' => 123,
'Name' => '<string>',
'ToolTip' => '<string>',
'Deleted' => true,
'Rank' => 123,
'Type' => '<string>',
'ChildItems' => '<array>',
'IconHint' => '<string>',
'ColorBlock' => 123,
'ExtraInfo' => '<string>',
'StyleHint' => '<string>',
'FullName' => '<string>',
'TableRight' => [
'Mask' => '<string>',
'Reason' => '<string>'
],
'FieldProperties' => [
]
]
],
'TableRight' => [
'Mask' => '<string>',
'Reason' => '<string>'
],
'FieldProperties' => [
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}import requests
url = "http://localhost:56350/api/v1/Agents/Archive/SetActivityFilter"
payload = { "ActivityFilter": {
"FromDate": "2023-11-07T05:31:56Z",
"ToDate": "2023-11-07T05:31:56Z",
"AssociateList": [
{
"Id": 123,
"Name": "<string>",
"ToolTip": "<string>",
"Deleted": True,
"Rank": 123,
"Type": "<string>",
"ColorBlock": 123,
"IconHint": "<string>",
"Selected": True,
"LastChanged": "2023-11-07T05:31:56Z",
"ChildItems": "<array>",
"ExtraInfo": "<string>",
"StyleHint": "<string>",
"Hidden": True,
"FullName": "<string>",
"TableRight": {
"Mask": "<string>",
"Reason": "<string>"
},
"FieldProperties": {}
}
],
"GroupList": [
{
"Id": 123,
"Name": "<string>",
"ToolTip": "<string>",
"Deleted": True,
"Rank": 123,
"Type": "<string>",
"ColorBlock": 123,
"IconHint": "<string>",
"Selected": True,
"LastChanged": "2023-11-07T05:31:56Z",
"ChildItems": "<array>",
"ExtraInfo": "<string>",
"StyleHint": "<string>",
"Hidden": True,
"FullName": "<string>",
"TableRight": {
"Mask": "<string>",
"Reason": "<string>"
},
"FieldProperties": {}
}
],
"FutureDateList": [
{
"Id": 123,
"Name": "<string>",
"ToolTip": "<string>",
"Deleted": True,
"Rank": 123,
"Type": "<string>",
"ChildItems": "<array>",
"IconHint": "<string>",
"ColorBlock": 123,
"ExtraInfo": "<string>",
"StyleHint": "<string>",
"FullName": "<string>",
"TableRight": {
"Mask": "<string>",
"Reason": "<string>"
},
"FieldProperties": {}
}
],
"TableRight": {
"Mask": "<string>",
"Reason": "<string>"
},
"FieldProperties": {}
} }
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
ActivityFilter: {
FromDate: '2023-11-07T05:31:56Z',
ToDate: '2023-11-07T05:31:56Z',
AssociateList: [
{
Id: 123,
Name: '<string>',
ToolTip: '<string>',
Deleted: true,
Rank: 123,
Type: '<string>',
ColorBlock: 123,
IconHint: '<string>',
Selected: true,
LastChanged: '2023-11-07T05:31:56Z',
ChildItems: '<array>',
ExtraInfo: '<string>',
StyleHint: '<string>',
Hidden: true,
FullName: '<string>',
TableRight: {Mask: '<string>', Reason: '<string>'},
FieldProperties: {}
}
],
GroupList: [
{
Id: 123,
Name: '<string>',
ToolTip: '<string>',
Deleted: true,
Rank: 123,
Type: '<string>',
ColorBlock: 123,
IconHint: '<string>',
Selected: true,
LastChanged: '2023-11-07T05:31:56Z',
ChildItems: '<array>',
ExtraInfo: '<string>',
StyleHint: '<string>',
Hidden: true,
FullName: '<string>',
TableRight: {Mask: '<string>', Reason: '<string>'},
FieldProperties: {}
}
],
FutureDateList: [
{
Id: 123,
Name: '<string>',
ToolTip: '<string>',
Deleted: true,
Rank: 123,
Type: '<string>',
ChildItems: '<array>',
IconHint: '<string>',
ColorBlock: 123,
ExtraInfo: '<string>',
StyleHint: '<string>',
FullName: '<string>',
TableRight: {Mask: '<string>', Reason: '<string>'},
FieldProperties: {}
}
],
TableRight: {Mask: '<string>', Reason: '<string>'},
FieldProperties: {}
}
})
};
fetch('http://localhost:56350/api/v1/Agents/Archive/SetActivityFilter', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));Headers
The application token that identifies the partner app. Used when calling Online WebAPI from a server.
Query Parameters
Optional comma separated list of properties to include in the result. Other fields are then nulled out to reduce payload size: "Name,department,category". Default = show all fields.
Body
application/jsontext/jsonapplication/xmltext/xmlapplication/x-www-form-urlencodedapplication/json-patch+jsonapplication/merge-patch+json
ActivityFilter
SetActivityFilter: Set activity filter for the specified list.
Activity list filter information. Carrier object for ActivityFilter. Services for the ActivityFilter Carrier is available from the Archive Agent.
Show child attributes
Show child attributes
Response
204
No Content
Related topics
NSArchiveAgentiarchiveagentNSActivityFilterGet Activity FilterHow to use ActivityArchive filtersActivities tab⌘I