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": [ "448056d3-76ec-4bd9-a3d2-0b3b4ea83d59", "e8abe6d3-9b82-4da4-a332-2508fb60a0bb" ], "StartRange": "2024-05-04T10:55:19Z", "EndRange": "2024-05-04T10:55:19Z", "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": "8e77d158-790d-4060-8f48-e1255dc2f042", "SeriesId": "f6f27369-60cd-498f-901f-4292accb0eae", "AccessorID": "4a21d37b-3af0-466f-89a0-a472f37a9ff4", "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": "985b7a8b-0c77-4329-af48-d7e8b8ae5218", "ScheduledByID": "e551ee73-e17c-453b-89a8-c2e1d3a70740", "DeletedDates": [ "2024-05-04T10:55:19Z", "2024-05-04T10:55:19Z" ], "ClearedDates": [ "2024-05-04T10:55:19Z", "2024-05-04T10:55:19Z" ], "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-04T10:55:19Z", "eValue": 8, "CallListName": "sample string 9", "IsEndless": true }, "EditDate": "2024-05-04T10:55:19Z", "CreateDate": "2024-05-04T10:55:19Z", "OccurTime": "2024-05-04T10:55:19Z", "OccurEndTime": "2024-05-04T10:55:19Z", "StartTime": "2024-05-04T10:55:19Z", "EndTime": "2024-05-04T10:55:19Z", "Details": "sample string 28", "LinkedEntities": { "Contacts": [ "4935b152-c05c-4cd4-9cd0-f3c040aa9868", "1f959411-bb32-4e30-8d9d-087bf89eb215" ], "Companies": [ "569da6ff-9be7-4679-8705-3bea90553f38", "25aee8e2-5826-48f6-8440-30c4098fee6c" ], "Groups": [ "429e2577-b842-4a50-b134-8e2b982befa7", "a99ac3e0-7003-4d20-a0f4-e91aaf4ae86b" ], "Opportunities": [ "58012fcf-a2aa-4517-9773-97a6516a48c3", "7f822073-96eb-466e-8e26-3a335ad7560a" ] } }, { "Id": "8e77d158-790d-4060-8f48-e1255dc2f042", "SeriesId": "f6f27369-60cd-498f-901f-4292accb0eae", "AccessorID": "4a21d37b-3af0-466f-89a0-a472f37a9ff4", "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": "985b7a8b-0c77-4329-af48-d7e8b8ae5218", "ScheduledByID": "e551ee73-e17c-453b-89a8-c2e1d3a70740", "DeletedDates": [ "2024-05-04T10:55:19Z", "2024-05-04T10:55:19Z" ], "ClearedDates": [ "2024-05-04T10:55:19Z", "2024-05-04T10:55:19Z" ], "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-04T10:55:19Z", "eValue": 8, "CallListName": "sample string 9", "IsEndless": true }, "EditDate": "2024-05-04T10:55:19Z", "CreateDate": "2024-05-04T10:55:19Z", "OccurTime": "2024-05-04T10:55:19Z", "OccurEndTime": "2024-05-04T10:55:19Z", "StartTime": "2024-05-04T10:55:19Z", "EndTime": "2024-05-04T10:55:19Z", "Details": "sample string 28", "LinkedEntities": { "Contacts": [ "4935b152-c05c-4cd4-9cd0-f3c040aa9868", "1f959411-bb32-4e30-8d9d-087bf89eb215" ], "Companies": [ "569da6ff-9be7-4679-8705-3bea90553f38", "25aee8e2-5826-48f6-8440-30c4098fee6c" ], "Groups": [ "429e2577-b842-4a50-b134-8e2b982befa7", "a99ac3e0-7003-4d20-a0f4-e91aaf4ae86b" ], "Opportunities": [ "58012fcf-a2aa-4517-9773-97a6516a48c3", "7f822073-96eb-466e-8e26-3a335ad7560a" ] } } ]