GET api/Activities/{id}
Get activity instances of an Activity by ID. Supported Headers: SelectField, IncludeClearedDates, IncludeDeletedDates, DetailFormat
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
id | globally unique identifier |
Required |
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": "34afff0e-94d1-473a-a21d-e57ce61b3da4", "SeriesId": "7084aab0-0800-4ea8-aeba-b55f5088b451", "AccessorID": "9d0ef40b-b30f-4375-b80e-c1f0bd8b036d", "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": "95da4074-5827-4d51-95f1-edeace07e85c", "ScheduledByID": "73202579-3eb6-4226-8575-e537394a6892", "DeletedDates": [ "2024-05-08T02:22:36Z", "2024-05-08T02:22:36Z" ], "ClearedDates": [ "2024-05-08T02:22:36Z", "2024-05-08T02:22: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-08T02:22:36Z", "eValue": 8, "CallListName": "sample string 9", "IsEndless": true }, "EditDate": "2024-05-08T02:22:36Z", "CreateDate": "2024-05-08T02:22:36Z", "OccurTime": "2024-05-08T02:22:36Z", "OccurEndTime": "2024-05-08T02:22:36Z", "StartTime": "2024-05-08T02:22:36Z", "EndTime": "2024-05-08T02:22:36Z", "Details": "sample string 28", "LinkedEntities": { "Contacts": [ "55b551c4-d2f5-4bfa-8755-c421b8f044d3", "2d4a9865-5493-48d8-bf91-95c851a41bfc" ], "Companies": [ "5310f7fe-41d9-4182-aae0-7acb58c522a8", "6d5c00e1-db70-4493-a50d-3000677b0e70" ], "Groups": [ "30dfd73b-14fb-4ae6-8c40-d860345b637e", "fa9e6404-2bf7-475f-9bcc-347eda105f8b" ], "Opportunities": [ "11b9abdd-846a-4354-9ec6-966081973f82", "89856457-8009-4785-bd7e-90ec5e5df500" ] } }, { "Id": "34afff0e-94d1-473a-a21d-e57ce61b3da4", "SeriesId": "7084aab0-0800-4ea8-aeba-b55f5088b451", "AccessorID": "9d0ef40b-b30f-4375-b80e-c1f0bd8b036d", "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": "95da4074-5827-4d51-95f1-edeace07e85c", "ScheduledByID": "73202579-3eb6-4226-8575-e537394a6892", "DeletedDates": [ "2024-05-08T02:22:36Z", "2024-05-08T02:22:36Z" ], "ClearedDates": [ "2024-05-08T02:22:36Z", "2024-05-08T02:22: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-08T02:22:36Z", "eValue": 8, "CallListName": "sample string 9", "IsEndless": true }, "EditDate": "2024-05-08T02:22:36Z", "CreateDate": "2024-05-08T02:22:36Z", "OccurTime": "2024-05-08T02:22:36Z", "OccurEndTime": "2024-05-08T02:22:36Z", "StartTime": "2024-05-08T02:22:36Z", "EndTime": "2024-05-08T02:22:36Z", "Details": "sample string 28", "LinkedEntities": { "Contacts": [ "55b551c4-d2f5-4bfa-8755-c421b8f044d3", "2d4a9865-5493-48d8-bf91-95c851a41bfc" ], "Companies": [ "5310f7fe-41d9-4182-aae0-7acb58c522a8", "6d5c00e1-db70-4493-a50d-3000677b0e70" ], "Groups": [ "30dfd73b-14fb-4ae6-8c40-d860345b637e", "fa9e6404-2bf7-475f-9bcc-347eda105f8b" ], "Opportunities": [ "11b9abdd-846a-4354-9ec6-966081973f82", "89856457-8009-4785-bd7e-90ec5e5df500" ] } } ]