POST api/TaskList
Retrieve tasklists for one or more users in the database
Request Information
URI Parameters
None.
Body Parameters
TaskListParameterName | Description | Type | Additional information |
---|---|---|---|
UserIds | Collection of globally unique identifier |
None. |
|
StartRange | date |
None. |
|
EndRange | date |
None. |
|
IncludeCleared | boolean |
None. |
|
FirstOccurrenceOnly | boolean |
None. |
Request Formats
application/json, text/json
Sample:
{ "UserIds": [ "ae6bdc32-13b3-4aba-97c7-ce4e1e4b53db", "0e903980-c657-47f7-a34d-c8f224e397ca" ], "StartRange": "2024-05-08T02:33:58Z", "EndRange": "2024-05-08T02:33:58Z", "IncludeCleared": true, "FirstOccurrenceOnly": true }
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
Collection of ActivityName | Description | Type | Additional information |
---|---|---|---|
Id | globally unique identifier |
None. |
|
SeriesId | globally unique identifier |
None. |
|
AccessorID | globally unique identifier |
None. |
|
IsCleared | boolean |
None. |
|
IsAlarmCreated | boolean |
None. |
|
IsAlarmed | boolean |
None. |
|
LeadMinutes | integer |
None. |
|
AlarmDue | string |
None. |
|
ExternalID | string |
None. |
|
Location | string |
None. |
|
IsTimeless | boolean |
None. |
|
IsPrivate | boolean |
None. |
|
PriorityId | integer |
None. |
|
ActivityPriorityName | string |
None. |
|
ActivityTypeId | integer |
None. |
|
ActivityTypeName | string |
None. |
|
Subject | string |
None. |
|
ScheduledBy | string |
None. |
|
ScheduledFor | string |
None. |
|
ScheduledForID | globally unique identifier |
None. |
|
ScheduledByID | globally unique identifier |
None. |
|
DeletedDates | Collection of date |
None. |
|
ClearedDates | Collection of date |
None. |
|
RecurSpec | ActivityRecurSpec |
None. |
|
EditDate | date |
None. |
|
CreateDate | date |
None. |
|
OccurTime | date |
None. |
|
OccurEndTime | date |
None. |
|
StartTime |
SQL Column Name: [START_DATE_TIME] |
date |
None. |
EndTime |
SQL Column Name: [END_DATE_TIME] |
date |
None. |
Details |
SQL Column Name: [DETAILS] |
string |
None. |
LinkedEntities | LinkedEntities |
None. |
Response Formats
application/json, text/json
Sample:
[ { "Id": "4612112d-66d0-4912-be73-de4b21634897", "SeriesId": "7aa59875-66fd-4a56-889c-425d1a9d5eea", "AccessorID": "c0510b72-dbd9-4ece-98c4-bce518441d15", "IsCleared": true, "IsAlarmCreated": true, "IsAlarmed": true, "LeadMinutes": 7, "AlarmDue": "sample string 8", "ExternalID": "sample string 9", "Location": "sample string 10", "IsTimeless": true, "IsPrivate": true, "PriorityId": 13, "ActivityPriorityName": "sample string 14", "ActivityTypeId": 15, "ActivityTypeName": "sample string 16", "Subject": "sample string 17", "ScheduledBy": "sample string 18", "ScheduledFor": "sample string 19", "ScheduledForID": "6952a187-ef83-4bd9-b291-08bfbd65796c", "ScheduledByID": "6b349817-f7b2-4671-84a8-3c5482f56e61", "DeletedDates": [ "2024-05-08T02:33:58Z", "2024-05-08T02:33:58Z" ], "ClearedDates": [ "2024-05-08T02:33:58Z", "2024-05-08T02:33:58Z" ], "RecurSpec": { "Month": 1, "Frequency": 2, "Day": { "DayAsInt": 1 }, "OptOutValue": true, "Operator": "sample string 4", "AuthManager": "sample string 5", "Field": "sample string 6", "EndDate": "2024-05-08T02:33:58Z", "eValue": 8, "CallListName": "sample string 9", "IsEndless": true }, "EditDate": "2024-05-08T02:33:58Z", "CreateDate": "2024-05-08T02:33:58Z", "OccurTime": "2024-05-08T02:33:58Z", "OccurEndTime": "2024-05-08T02:33:58Z", "StartTime": "2024-05-08T02:33:58Z", "EndTime": "2024-05-08T02:33:58Z", "Details": "sample string 28", "LinkedEntities": { "Contacts": [ "61aa1e90-b083-487a-9819-343a43102960", "30870a85-d63c-4c6f-9fd8-b3efbb62a7e1" ], "Companies": [ "d3c5561d-6c60-43fd-ae8d-d44db4549d6e", "f6c6cc26-ed0b-4cf5-89f9-84caa2b9d25a" ], "Groups": [ "2fe81a9a-07f5-4a59-890e-f045bfe36e9b", "59124daf-992f-49b5-897b-6dfee7cb812d" ], "Opportunities": [ "eb49ced6-1dff-40ff-810e-97d35cf24618", "fb3d9740-fdf0-4911-888e-e73157fcd5f3" ] } }, { "Id": "4612112d-66d0-4912-be73-de4b21634897", "SeriesId": "7aa59875-66fd-4a56-889c-425d1a9d5eea", "AccessorID": "c0510b72-dbd9-4ece-98c4-bce518441d15", "IsCleared": true, "IsAlarmCreated": true, "IsAlarmed": true, "LeadMinutes": 7, "AlarmDue": "sample string 8", "ExternalID": "sample string 9", "Location": "sample string 10", "IsTimeless": true, "IsPrivate": true, "PriorityId": 13, "ActivityPriorityName": "sample string 14", "ActivityTypeId": 15, "ActivityTypeName": "sample string 16", "Subject": "sample string 17", "ScheduledBy": "sample string 18", "ScheduledFor": "sample string 19", "ScheduledForID": "6952a187-ef83-4bd9-b291-08bfbd65796c", "ScheduledByID": "6b349817-f7b2-4671-84a8-3c5482f56e61", "DeletedDates": [ "2024-05-08T02:33:58Z", "2024-05-08T02:33:58Z" ], "ClearedDates": [ "2024-05-08T02:33:58Z", "2024-05-08T02:33:58Z" ], "RecurSpec": { "Month": 1, "Frequency": 2, "Day": { "DayAsInt": 1 }, "OptOutValue": true, "Operator": "sample string 4", "AuthManager": "sample string 5", "Field": "sample string 6", "EndDate": "2024-05-08T02:33:58Z", "eValue": 8, "CallListName": "sample string 9", "IsEndless": true }, "EditDate": "2024-05-08T02:33:58Z", "CreateDate": "2024-05-08T02:33:58Z", "OccurTime": "2024-05-08T02:33:58Z", "OccurEndTime": "2024-05-08T02:33:58Z", "StartTime": "2024-05-08T02:33:58Z", "EndTime": "2024-05-08T02:33:58Z", "Details": "sample string 28", "LinkedEntities": { "Contacts": [ "61aa1e90-b083-487a-9819-343a43102960", "30870a85-d63c-4c6f-9fd8-b3efbb62a7e1" ], "Companies": [ "d3c5561d-6c60-43fd-ae8d-d44db4549d6e", "f6c6cc26-ed0b-4cf5-89f9-84caa2b9d25a" ], "Groups": [ "2fe81a9a-07f5-4a59-890e-f045bfe36e9b", "59124daf-992f-49b5-897b-6dfee7cb812d" ], "Opportunities": [ "eb49ced6-1dff-40ff-810e-97d35cf24618", "fb3d9740-fdf0-4911-888e-e73157fcd5f3" ] } } ]