GET v1/{subscriptionID}/filteredLists/{filteredListID}
Gets a filtered list.
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
subscriptionID |
The Circle subscription ID. |
globally unique identifier |
Required |
filteredListID |
The filtered list ID to be retrieved. |
globally unique identifier |
Required |
Body Parameters
None.
Response Information
Resource Description
Returns a filtered list for the specified filtered list ID.
FilteredListModelName | Description | Type | Additional information |
---|---|---|---|
ID |
Gets the filtered list ID. |
globally unique identifier |
None. |
SubscriptionID |
Gets the subscription ID of the filtered list. |
globally unique identifier |
None. |
ProjectID |
Gets the project ID of the filtered list. |
globally unique identifier |
None. |
Name |
Gets and sets the filtered list name. |
string |
None. |
CreationTime |
Gets the creation time of the filtered list. |
date |
None. |
Creator |
Gets the user who created the filtered list. |
UserViewModel |
None. |
ModificationTime |
Gets the last modification time of the filtered list. |
date |
None. |
Modifier |
Gets the user who was the last to modify the filtered list. |
UserViewModel |
None. |
Description |
Gets and sets the filtered list description. |
string |
None. |
PlanFilterName |
Gets and sets the plan filter name of the filtered list. |
string |
None. |
EventFilters |
Gets and sets the event filters of the filtered list. |
Collection of EventFilterModel |
None. |
Response Formats
application/json, text/json
{ "ID": "75cac884-70af-496b-99bc-71c318a53348", "SubscriptionID": "193f0511-8c2a-44f1-bba8-b51c2765e2bf", "ProjectID": "309290a3-d6f7-4350-bd41-8cdf31a15b64", "Name": "sample string 4", "CreationTime": "2022-05-22T22:30:21.2512818Z", "Creator": { "ID": "ab36a113-f567-4a4f-a3ce-2708ef83ee4a", "Name": "sample string 2" }, "ModificationTime": "2022-05-22T22:30:21.2512818Z", "Modifier": { "ID": "ab36a113-f567-4a4f-a3ce-2708ef83ee4a", "Name": "sample string 2" }, "Description": "sample string 7", "PlanFilterName": "sample string 8", "EventFilters": [ { "TouchPointID": "b215df78-c0e0-467a-bee0-1259ba559974", "TouchPoint": { "FriendlyID": "sample string 1", "ID": "7ea4da7c-7d96-4c6b-a479-6d076bb8e7e5", "Name": "sample string 3", "Type": 1, "Status": 1, "ModificationTime": "2022-05-22T22:30:21.2512818Z", "Modifier": { "ID": "ab36a113-f567-4a4f-a3ce-2708ef83ee4a", "Name": "sample string 2" } }, "EventType": 1, "TrackingActionName": "sample string 2", "EventCondition": { "Comparison": { "Parameter": "sample string 1", "Operand": 1 }, "Type": 1 } }, { "TouchPointID": "b215df78-c0e0-467a-bee0-1259ba559974", "TouchPoint": { "FriendlyID": "sample string 1", "ID": "7ea4da7c-7d96-4c6b-a479-6d076bb8e7e5", "Name": "sample string 3", "Type": 1, "Status": 1, "ModificationTime": "2022-05-22T22:30:21.2512818Z", "Modifier": { "ID": "ab36a113-f567-4a4f-a3ce-2708ef83ee4a", "Name": "sample string 2" } }, "EventType": 1, "TrackingActionName": "sample string 2", "EventCondition": { "Comparison": { "Parameter": "sample string 1", "Operand": 1 }, "Type": 1 } } ] }