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": "a733854c-552b-4878-8b0f-68953ef11a93", "SeriesId": "f1b69954-0763-44b3-ac66-0e9251c10641", "AccessorID": "2bae383c-cf84-44f0-82e4-c22e31b0604e", "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": "cd494164-a623-48a9-aa78-9731c9563739", "ScheduledByID": "079a8f0e-0f4f-4ba6-9132-c97a2b571ded", "DeletedDates": [ "2024-12-05T02:39:13Z", "2024-12-05T02:39:13Z" ], "ClearedDates": [ "2024-12-05T02:39:13Z", "2024-12-05T02:39: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-12-05T02:39:13Z", "eValue": 8, "CallListName": "sample string 9", "IsEndless": true }, "EditDate": "2024-12-05T02:39:13Z", "CreateDate": "2024-12-05T02:39:13Z", "OccurTime": "2024-12-05T02:39:13Z", "OccurEndTime": "2024-12-05T02:39:13Z", "StartTime": "2024-12-05T02:39:13Z", "EndTime": "2024-12-05T02:39:13Z", "Details": "sample string 28", "LinkedEntities": { "Contacts": [ "9acdd110-3663-4299-b397-d098f1d77481", "6511971d-3c25-4932-9d0a-c5390540422e" ], "Companies": [ "74058fae-6e52-4149-bdbc-0acd6531227f", "8a1aa096-78c2-4495-a73b-a7a30591ef74" ], "Groups": [ "c12ec8a8-0a14-4984-98e9-6af149997dc7", "51bc0696-ae51-466f-bb71-9f927406566f" ], "Opportunities": [ "34741357-de0b-4ba5-ae94-c9eb3d1dabb4", "69b65ad4-9643-4158-ab73-97ec579ccdac" ] } }, { "Id": "a733854c-552b-4878-8b0f-68953ef11a93", "SeriesId": "f1b69954-0763-44b3-ac66-0e9251c10641", "AccessorID": "2bae383c-cf84-44f0-82e4-c22e31b0604e", "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": "cd494164-a623-48a9-aa78-9731c9563739", "ScheduledByID": "079a8f0e-0f4f-4ba6-9132-c97a2b571ded", "DeletedDates": [ "2024-12-05T02:39:13Z", "2024-12-05T02:39:13Z" ], "ClearedDates": [ "2024-12-05T02:39:13Z", "2024-12-05T02:39: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-12-05T02:39:13Z", "eValue": 8, "CallListName": "sample string 9", "IsEndless": true }, "EditDate": "2024-12-05T02:39:13Z", "CreateDate": "2024-12-05T02:39:13Z", "OccurTime": "2024-12-05T02:39:13Z", "OccurEndTime": "2024-12-05T02:39:13Z", "StartTime": "2024-12-05T02:39:13Z", "EndTime": "2024-12-05T02:39:13Z", "Details": "sample string 28", "LinkedEntities": { "Contacts": [ "9acdd110-3663-4299-b397-d098f1d77481", "6511971d-3c25-4932-9d0a-c5390540422e" ], "Companies": [ "74058fae-6e52-4149-bdbc-0acd6531227f", "8a1aa096-78c2-4495-a73b-a7a30591ef74" ], "Groups": [ "c12ec8a8-0a14-4984-98e9-6af149997dc7", "51bc0696-ae51-466f-bb71-9f927406566f" ], "Opportunities": [ "34741357-de0b-4ba5-ae94-c9eb3d1dabb4", "69b65ad4-9643-4158-ab73-97ec579ccdac" ] } } ]