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": [ "d733c528-99be-4b57-be2e-3f3854bdd54a", "969626d5-fd3a-4978-a87d-bab192d1fdb7" ], "StartRange": "2024-05-15T01:51:36Z", "EndRange": "2024-05-15T01:51:36Z", "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": "ff8452ff-e053-4186-bff0-f4c153a61c47", "SeriesId": "41612e7a-3ced-4a24-b1bb-ae7ba0e4050f", "AccessorID": "0005da58-825e-4a80-9f90-66ee2df91148", "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": "a379b17f-a0d1-4dc4-acaa-a2b188f28416", "ScheduledByID": "c0290919-0926-4031-9f42-96c0462b0c6f", "DeletedDates": [ "2024-05-15T01:51:36Z", "2024-05-15T01:51:36Z" ], "ClearedDates": [ "2024-05-15T01:51:36Z", "2024-05-15T01:51:36Z" ], "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-15T01:51:36Z", "eValue": 8, "CallListName": "sample string 9", "IsEndless": true }, "EditDate": "2024-05-15T01:51:36Z", "CreateDate": "2024-05-15T01:51:36Z", "OccurTime": "2024-05-15T01:51:36Z", "OccurEndTime": "2024-05-15T01:51:36Z", "StartTime": "2024-05-15T01:51:36Z", "EndTime": "2024-05-15T01:51:36Z", "Details": "sample string 28", "LinkedEntities": { "Contacts": [ "c3b162f3-c63e-4edc-9ce5-6c34523ff672", "a63013be-f927-4e53-b7c3-4bcc7e0a4b15" ], "Companies": [ "93c3deb2-4a55-448c-ba74-80a75bdfb004", "68f692a8-65a6-43e8-9425-a53fee093a62" ], "Groups": [ "0e49f9b7-c1af-46a5-8ed5-ac07dcd81fdf", "964b677d-393e-4241-8e4e-191bdc1fea6f" ], "Opportunities": [ "e2f7c35a-3a6f-41c4-875d-cfc37305f762", "1122e3a7-eaec-4e51-8ca0-534ba2bc5a53" ] } }, { "Id": "ff8452ff-e053-4186-bff0-f4c153a61c47", "SeriesId": "41612e7a-3ced-4a24-b1bb-ae7ba0e4050f", "AccessorID": "0005da58-825e-4a80-9f90-66ee2df91148", "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": "a379b17f-a0d1-4dc4-acaa-a2b188f28416", "ScheduledByID": "c0290919-0926-4031-9f42-96c0462b0c6f", "DeletedDates": [ "2024-05-15T01:51:36Z", "2024-05-15T01:51:36Z" ], "ClearedDates": [ "2024-05-15T01:51:36Z", "2024-05-15T01:51:36Z" ], "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-15T01:51:36Z", "eValue": 8, "CallListName": "sample string 9", "IsEndless": true }, "EditDate": "2024-05-15T01:51:36Z", "CreateDate": "2024-05-15T01:51:36Z", "OccurTime": "2024-05-15T01:51:36Z", "OccurEndTime": "2024-05-15T01:51:36Z", "StartTime": "2024-05-15T01:51:36Z", "EndTime": "2024-05-15T01:51:36Z", "Details": "sample string 28", "LinkedEntities": { "Contacts": [ "c3b162f3-c63e-4edc-9ce5-6c34523ff672", "a63013be-f927-4e53-b7c3-4bcc7e0a4b15" ], "Companies": [ "93c3deb2-4a55-448c-ba74-80a75bdfb004", "68f692a8-65a6-43e8-9425-a53fee093a62" ], "Groups": [ "0e49f9b7-c1af-46a5-8ed5-ac07dcd81fdf", "964b677d-393e-4241-8e4e-191bdc1fea6f" ], "Opportunities": [ "e2f7c35a-3a6f-41c4-875d-cfc37305f762", "1122e3a7-eaec-4e51-8ca0-534ba2bc5a53" ] } } ]