GET api/Activities
Get all activities matching an optional Filter. Supported Headers: SelectField, Filter, Sort, SortDesc, IncludeClearedDates, IncludeDeletedDates, DetailFormat
Request Information
URI Parameters
None.
Body Parameters
None.
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": "f90e17a0-37db-4fb8-b488-cda8ce28cdea", "SeriesId": "5ba8f4d4-9143-4c0e-a1d1-994298ef0be2", "AccessorID": "eb563e80-a141-4e64-aab3-0ee4e67a7f0d", "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": "4a905383-5941-4802-a0b5-51df9eada210", "ScheduledByID": "dc22bf53-47b1-4ada-9c82-2c483b3a7c97", "DeletedDates": [ "2024-05-19T00:41:13Z", "2024-05-19T00:41:13Z" ], "ClearedDates": [ "2024-05-19T00:41:13Z", "2024-05-19T00:41:13Z" ], "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-19T00:41:13Z", "eValue": 8, "CallListName": "sample string 9", "IsEndless": true }, "EditDate": "2024-05-19T00:41:13Z", "CreateDate": "2024-05-19T00:41:13Z", "OccurTime": "2024-05-19T00:41:13Z", "OccurEndTime": "2024-05-19T00:41:13Z", "StartTime": "2024-05-19T00:41:13Z", "EndTime": "2024-05-19T00:41:13Z", "Details": "sample string 28", "LinkedEntities": { "Contacts": [ "d0239a8a-6c71-472d-824c-30247171f530", "40cb65b2-da9e-4f78-9669-953464f157d7" ], "Companies": [ "d4b1910a-324e-48ee-b89c-23151ed234ee", "4a12bd9a-71c7-41fa-a449-1d5c09e8ec8b" ], "Groups": [ "a2956e5a-dd2b-4255-8779-165ca556440e", "5fe83681-f689-44d5-ab3a-9c9667d9fe04" ], "Opportunities": [ "fb2ef14d-cc78-4e52-883a-7ce9f96083ac", "667bf49b-c30c-48af-9f9c-a275067d0394" ] } }, { "Id": "f90e17a0-37db-4fb8-b488-cda8ce28cdea", "SeriesId": "5ba8f4d4-9143-4c0e-a1d1-994298ef0be2", "AccessorID": "eb563e80-a141-4e64-aab3-0ee4e67a7f0d", "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": "4a905383-5941-4802-a0b5-51df9eada210", "ScheduledByID": "dc22bf53-47b1-4ada-9c82-2c483b3a7c97", "DeletedDates": [ "2024-05-19T00:41:13Z", "2024-05-19T00:41:13Z" ], "ClearedDates": [ "2024-05-19T00:41:13Z", "2024-05-19T00:41:13Z" ], "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-19T00:41:13Z", "eValue": 8, "CallListName": "sample string 9", "IsEndless": true }, "EditDate": "2024-05-19T00:41:13Z", "CreateDate": "2024-05-19T00:41:13Z", "OccurTime": "2024-05-19T00:41:13Z", "OccurEndTime": "2024-05-19T00:41:13Z", "StartTime": "2024-05-19T00:41:13Z", "EndTime": "2024-05-19T00:41:13Z", "Details": "sample string 28", "LinkedEntities": { "Contacts": [ "d0239a8a-6c71-472d-824c-30247171f530", "40cb65b2-da9e-4f78-9669-953464f157d7" ], "Companies": [ "d4b1910a-324e-48ee-b89c-23151ed234ee", "4a12bd9a-71c7-41fa-a449-1d5c09e8ec8b" ], "Groups": [ "a2956e5a-dd2b-4255-8779-165ca556440e", "5fe83681-f689-44d5-ab3a-9c9667d9fe04" ], "Opportunities": [ "fb2ef14d-cc78-4e52-883a-7ce9f96083ac", "667bf49b-c30c-48af-9f9c-a275067d0394" ] } } ]