POST api/TaskList
Retrieve tasklists for one or more users in the database
Request Information
URI Parameters
None.
Body Parameters
TaskListParameter| Name | 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": [
"f4fd0a19-38de-4b3f-b212-55901e648702",
"c6739d3e-78e2-4ff1-86e7-57bea2906ec9"
],
"StartRange": "2024-12-05T02:14:06Z",
"EndRange": "2024-12-05T02:14:06Z",
"IncludeCleared": true,
"FirstOccurrenceOnly": true
}
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
Collection of Activity| Name | 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": "4315447f-3c0a-49a5-b905-5161de7331d9",
"SeriesId": "81cbd9e4-3a1f-4a0c-8eb5-47f39261a509",
"AccessorID": "da8da824-64a9-4851-875f-bca911ffc0a5",
"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": "f0bf9742-a6fd-4cc2-8110-590ccc239b39",
"ScheduledByID": "4454accb-a874-461d-b3a2-42224053d287",
"DeletedDates": [
"2024-12-05T02:14:06Z",
"2024-12-05T02:14:06Z"
],
"ClearedDates": [
"2024-12-05T02:14:06Z",
"2024-12-05T02:14:06Z"
],
"RecurSpec": {
"Month": 1,
"Frequency": 2,
"Day": {
"DayAsInt": 1
},
"OptOutValue": true,
"Operator": "sample string 4",
"AuthManager": "sample string 5",
"Field": "sample string 6",
"EndDate": "2024-12-05T02:14:06Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2024-12-05T02:14:06Z",
"CreateDate": "2024-12-05T02:14:06Z",
"OccurTime": "2024-12-05T02:14:06Z",
"OccurEndTime": "2024-12-05T02:14:06Z",
"StartTime": "2024-12-05T02:14:06Z",
"EndTime": "2024-12-05T02:14:06Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"54468e17-34f9-47ae-9ac4-3f2c0cdb40d1",
"4d439d7a-957b-45eb-ac5d-988200c7d285"
],
"Companies": [
"c2e1d463-0285-4fde-9e1a-4ca532d82e89",
"0a2c2b1e-2dc4-47f2-bdde-776eb1c82234"
],
"Groups": [
"89363f48-d99d-4e51-844b-fb3836d283f8",
"893b1cef-b1ed-46fa-84c7-4760b8a100a1"
],
"Opportunities": [
"77f221c5-8049-4052-b5e7-57858d770a49",
"29e99937-459d-4afa-b5a8-d33f7e8991db"
]
}
},
{
"Id": "4315447f-3c0a-49a5-b905-5161de7331d9",
"SeriesId": "81cbd9e4-3a1f-4a0c-8eb5-47f39261a509",
"AccessorID": "da8da824-64a9-4851-875f-bca911ffc0a5",
"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": "f0bf9742-a6fd-4cc2-8110-590ccc239b39",
"ScheduledByID": "4454accb-a874-461d-b3a2-42224053d287",
"DeletedDates": [
"2024-12-05T02:14:06Z",
"2024-12-05T02:14:06Z"
],
"ClearedDates": [
"2024-12-05T02:14:06Z",
"2024-12-05T02:14:06Z"
],
"RecurSpec": {
"Month": 1,
"Frequency": 2,
"Day": {
"DayAsInt": 1
},
"OptOutValue": true,
"Operator": "sample string 4",
"AuthManager": "sample string 5",
"Field": "sample string 6",
"EndDate": "2024-12-05T02:14:06Z",
"eValue": 8,
"CallListName": "sample string 9",
"IsEndless": true
},
"EditDate": "2024-12-05T02:14:06Z",
"CreateDate": "2024-12-05T02:14:06Z",
"OccurTime": "2024-12-05T02:14:06Z",
"OccurEndTime": "2024-12-05T02:14:06Z",
"StartTime": "2024-12-05T02:14:06Z",
"EndTime": "2024-12-05T02:14:06Z",
"Details": "sample string 28",
"LinkedEntities": {
"Contacts": [
"54468e17-34f9-47ae-9ac4-3f2c0cdb40d1",
"4d439d7a-957b-45eb-ac5d-988200c7d285"
],
"Companies": [
"c2e1d463-0285-4fde-9e1a-4ca532d82e89",
"0a2c2b1e-2dc4-47f2-bdde-776eb1c82234"
],
"Groups": [
"89363f48-d99d-4e51-844b-fb3836d283f8",
"893b1cef-b1ed-46fa-84c7-4760b8a100a1"
],
"Opportunities": [
"77f221c5-8049-4052-b5e7-57858d770a49",
"29e99937-459d-4afa-b5a8-d33f7e8991db"
]
}
}
]