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": [ "c14c4330-6e72-4753-8d0b-c74f60a8328e", "0fe7bfdb-362f-4db6-a44a-46e76a637037" ], "StartRange": "2024-05-19T02:42:47Z", "EndRange": "2024-05-19T02:42:47Z", "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": "8d485201-d09b-43fb-bf48-63e966b8ddff", "SeriesId": "849c196e-cc50-4a3e-98ee-4f4c6505bf0d", "AccessorID": "fde32fe7-94de-4ef9-b88a-09079f5f86c3", "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": "43cfe404-cb8a-42c0-a551-11ba7fbfcea1", "ScheduledByID": "d169c93d-6e67-42af-9755-babee2429ad2", "DeletedDates": [ "2024-05-19T02:42:47Z", "2024-05-19T02:42:47Z" ], "ClearedDates": [ "2024-05-19T02:42:47Z", "2024-05-19T02:42:47Z" ], "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-19T02:42:47Z", "eValue": 8, "CallListName": "sample string 9", "IsEndless": true }, "EditDate": "2024-05-19T02:42:47Z", "CreateDate": "2024-05-19T02:42:47Z", "OccurTime": "2024-05-19T02:42:47Z", "OccurEndTime": "2024-05-19T02:42:47Z", "StartTime": "2024-05-19T02:42:47Z", "EndTime": "2024-05-19T02:42:47Z", "Details": "sample string 28", "LinkedEntities": { "Contacts": [ "ea5ad12c-1c0d-4b1f-9ea4-254a62f0c7f5", "f84e2aee-a6e3-4d42-be5e-54995a1db5a4" ], "Companies": [ "2ebffd0d-ec6a-495b-80b2-c4c07655e850", "d76745d3-0c64-4a4d-8d5b-b587ebda82ce" ], "Groups": [ "b5f7f3ce-f94a-4a4a-a0b3-dc3154d38c05", "f0682940-2393-46e0-83af-104739e84652" ], "Opportunities": [ "23311969-8341-4a7b-ae4d-13c5e0c2df33", "15ee6d8b-fd62-4b2a-b3cb-c84977d045d2" ] } }, { "Id": "8d485201-d09b-43fb-bf48-63e966b8ddff", "SeriesId": "849c196e-cc50-4a3e-98ee-4f4c6505bf0d", "AccessorID": "fde32fe7-94de-4ef9-b88a-09079f5f86c3", "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": "43cfe404-cb8a-42c0-a551-11ba7fbfcea1", "ScheduledByID": "d169c93d-6e67-42af-9755-babee2429ad2", "DeletedDates": [ "2024-05-19T02:42:47Z", "2024-05-19T02:42:47Z" ], "ClearedDates": [ "2024-05-19T02:42:47Z", "2024-05-19T02:42:47Z" ], "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-19T02:42:47Z", "eValue": 8, "CallListName": "sample string 9", "IsEndless": true }, "EditDate": "2024-05-19T02:42:47Z", "CreateDate": "2024-05-19T02:42:47Z", "OccurTime": "2024-05-19T02:42:47Z", "OccurEndTime": "2024-05-19T02:42:47Z", "StartTime": "2024-05-19T02:42:47Z", "EndTime": "2024-05-19T02:42:47Z", "Details": "sample string 28", "LinkedEntities": { "Contacts": [ "ea5ad12c-1c0d-4b1f-9ea4-254a62f0c7f5", "f84e2aee-a6e3-4d42-be5e-54995a1db5a4" ], "Companies": [ "2ebffd0d-ec6a-495b-80b2-c4c07655e850", "d76745d3-0c64-4a4d-8d5b-b587ebda82ce" ], "Groups": [ "b5f7f3ce-f94a-4a4a-a0b3-dc3154d38c05", "f0682940-2393-46e0-83af-104739e84652" ], "Opportunities": [ "23311969-8341-4a7b-ae4d-13c5e0c2df33", "15ee6d8b-fd62-4b2a-b3cb-c84977d045d2" ] } } ]