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": "6e0903e9-cea7-408e-b7af-f7b9a7557d42", "SeriesId": "0c678468-7d16-4d39-aec8-8b5233c6ba03", "AccessorID": "712f8e9f-66fc-4d05-bb40-2fba13d46def", "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": "0259cdb4-5ed4-489e-96a4-c81a7edea2f4", "ScheduledByID": "5336ed16-c15c-47fb-8ce2-4482db3016f5", "DeletedDates": [ "2024-05-04T13:43:37Z", "2024-05-04T13:43:37Z" ], "ClearedDates": [ "2024-05-04T13:43:37Z", "2024-05-04T13:43:37Z" ], "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-04T13:43:37Z", "eValue": 8, "CallListName": "sample string 9", "IsEndless": true }, "EditDate": "2024-05-04T13:43:37Z", "CreateDate": "2024-05-04T13:43:37Z", "OccurTime": "2024-05-04T13:43:37Z", "OccurEndTime": "2024-05-04T13:43:37Z", "StartTime": "2024-05-04T13:43:37Z", "EndTime": "2024-05-04T13:43:37Z", "Details": "sample string 28", "LinkedEntities": { "Contacts": [ "c39bd29a-71d5-4a39-9b78-5138589c8aec", "c97b7d12-5cb2-494b-b113-ab0d524fc7b5" ], "Companies": [ "9d25fb15-80bc-4ae2-aa19-55e0d6d151c3", "ae0db938-64c4-4ed7-8e15-8438903624f5" ], "Groups": [ "9d8ace71-77db-4890-bfe0-834c9941f2bf", "26366ce7-d9f9-4c52-852e-812e8532e756" ], "Opportunities": [ "8ed8d564-e27b-432b-aeab-9c57da8cb496", "8b8c0825-0774-4b42-8ce0-cbf8fe1438f6" ] } }, { "Id": "6e0903e9-cea7-408e-b7af-f7b9a7557d42", "SeriesId": "0c678468-7d16-4d39-aec8-8b5233c6ba03", "AccessorID": "712f8e9f-66fc-4d05-bb40-2fba13d46def", "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": "0259cdb4-5ed4-489e-96a4-c81a7edea2f4", "ScheduledByID": "5336ed16-c15c-47fb-8ce2-4482db3016f5", "DeletedDates": [ "2024-05-04T13:43:37Z", "2024-05-04T13:43:37Z" ], "ClearedDates": [ "2024-05-04T13:43:37Z", "2024-05-04T13:43:37Z" ], "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-04T13:43:37Z", "eValue": 8, "CallListName": "sample string 9", "IsEndless": true }, "EditDate": "2024-05-04T13:43:37Z", "CreateDate": "2024-05-04T13:43:37Z", "OccurTime": "2024-05-04T13:43:37Z", "OccurEndTime": "2024-05-04T13:43:37Z", "StartTime": "2024-05-04T13:43:37Z", "EndTime": "2024-05-04T13:43:37Z", "Details": "sample string 28", "LinkedEntities": { "Contacts": [ "c39bd29a-71d5-4a39-9b78-5138589c8aec", "c97b7d12-5cb2-494b-b113-ab0d524fc7b5" ], "Companies": [ "9d25fb15-80bc-4ae2-aa19-55e0d6d151c3", "ae0db938-64c4-4ed7-8e15-8438903624f5" ], "Groups": [ "9d8ace71-77db-4890-bfe0-834c9941f2bf", "26366ce7-d9f9-4c52-852e-812e8532e756" ], "Opportunities": [ "8ed8d564-e27b-432b-aeab-9c57da8cb496", "8b8c0825-0774-4b42-8ce0-cbf8fe1438f6" ] } } ]