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": "335cf4e2-5932-4354-97b6-6e081a368e76", "SeriesId": "6cec7348-1d4d-42d9-b251-b050f9f87ab5", "AccessorID": "78e2930f-8740-413d-b1a4-b007211d3539", "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": "d5df69d7-d4e2-4986-8625-3361602701ed", "ScheduledByID": "ecc76d5b-0a64-4140-a34a-b87ab3327329", "DeletedDates": [ "2024-05-16T00:52:30Z", "2024-05-16T00:52:30Z" ], "ClearedDates": [ "2024-05-16T00:52:30Z", "2024-05-16T00:52:30Z" ], "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-16T00:52:30Z", "eValue": 8, "CallListName": "sample string 9", "IsEndless": true }, "EditDate": "2024-05-16T00:52:30Z", "CreateDate": "2024-05-16T00:52:30Z", "OccurTime": "2024-05-16T00:52:30Z", "OccurEndTime": "2024-05-16T00:52:30Z", "StartTime": "2024-05-16T00:52:30Z", "EndTime": "2024-05-16T00:52:30Z", "Details": "sample string 28", "LinkedEntities": { "Contacts": [ "e571d0f7-15bd-421e-aa8d-102268b86737", "0920236e-dd68-42bb-9a5a-bc8a146195e3" ], "Companies": [ "428f13f5-5ef4-4c25-be5d-1485f6f29c35", "bb37a1c5-8882-4241-881d-b668a4fa9548" ], "Groups": [ "e961ff14-897a-490a-9995-69c11d005912", "65818829-cde0-4c87-b980-ab37dbdd54f5" ], "Opportunities": [ "2351f7fb-82af-4205-af80-1827d66ca695", "5a5f3e83-9036-4161-ba27-8e55385ebaa1" ] } }, { "Id": "335cf4e2-5932-4354-97b6-6e081a368e76", "SeriesId": "6cec7348-1d4d-42d9-b251-b050f9f87ab5", "AccessorID": "78e2930f-8740-413d-b1a4-b007211d3539", "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": "d5df69d7-d4e2-4986-8625-3361602701ed", "ScheduledByID": "ecc76d5b-0a64-4140-a34a-b87ab3327329", "DeletedDates": [ "2024-05-16T00:52:30Z", "2024-05-16T00:52:30Z" ], "ClearedDates": [ "2024-05-16T00:52:30Z", "2024-05-16T00:52:30Z" ], "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-16T00:52:30Z", "eValue": 8, "CallListName": "sample string 9", "IsEndless": true }, "EditDate": "2024-05-16T00:52:30Z", "CreateDate": "2024-05-16T00:52:30Z", "OccurTime": "2024-05-16T00:52:30Z", "OccurEndTime": "2024-05-16T00:52:30Z", "StartTime": "2024-05-16T00:52:30Z", "EndTime": "2024-05-16T00:52:30Z", "Details": "sample string 28", "LinkedEntities": { "Contacts": [ "e571d0f7-15bd-421e-aa8d-102268b86737", "0920236e-dd68-42bb-9a5a-bc8a146195e3" ], "Companies": [ "428f13f5-5ef4-4c25-be5d-1485f6f29c35", "bb37a1c5-8882-4241-881d-b668a4fa9548" ], "Groups": [ "e961ff14-897a-490a-9995-69c11d005912", "65818829-cde0-4c87-b980-ab37dbdd54f5" ], "Opportunities": [ "2351f7fb-82af-4205-af80-1827d66ca695", "5a5f3e83-9036-4161-ba27-8e55385ebaa1" ] } } ]