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": "64543ca6-6fa9-4b06-995c-680be3ba6f3c", "SeriesId": "abd91bce-5cd6-4cb3-9d11-cdea6db789d2", "AccessorID": "b58e3e8c-89ab-406a-bec2-a6a3a713bb9f", "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": "446441d5-8152-4a3b-99d8-ef932548c357", "ScheduledByID": "f9e20cc8-55e5-43c6-907c-ac60e49dc6a0", "DeletedDates": [ "2024-05-19T03:01:43Z", "2024-05-19T03:01:43Z" ], "ClearedDates": [ "2024-05-19T03:01:43Z", "2024-05-19T03:01:43Z" ], "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-19T03:01:43Z", "eValue": 8, "CallListName": "sample string 9", "IsEndless": true }, "EditDate": "2024-05-19T03:01:43Z", "CreateDate": "2024-05-19T03:01:43Z", "OccurTime": "2024-05-19T03:01:43Z", "OccurEndTime": "2024-05-19T03:01:43Z", "StartTime": "2024-05-19T03:01:43Z", "EndTime": "2024-05-19T03:01:43Z", "Details": "sample string 28", "LinkedEntities": { "Contacts": [ "16abeccf-9808-451c-9a08-39eae4aa4c70", "7749f38d-a98b-4d68-9169-8d8af6c8e4f2" ], "Companies": [ "73f305bb-e17b-4e44-9291-fbe981d79baf", "7825f679-9372-42f0-ab1f-8eb2ffc8bed8" ], "Groups": [ "8000bbf2-db18-485a-b82e-ed1e24e97507", "05732045-e34b-42ee-b788-47cfbbea8a20" ], "Opportunities": [ "5dc7d7e9-0f1a-4a16-8fbc-87d659e55d2e", "60e114f1-cdd4-4619-aaf4-6cc289206386" ] } }, { "Id": "64543ca6-6fa9-4b06-995c-680be3ba6f3c", "SeriesId": "abd91bce-5cd6-4cb3-9d11-cdea6db789d2", "AccessorID": "b58e3e8c-89ab-406a-bec2-a6a3a713bb9f", "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": "446441d5-8152-4a3b-99d8-ef932548c357", "ScheduledByID": "f9e20cc8-55e5-43c6-907c-ac60e49dc6a0", "DeletedDates": [ "2024-05-19T03:01:43Z", "2024-05-19T03:01:43Z" ], "ClearedDates": [ "2024-05-19T03:01:43Z", "2024-05-19T03:01:43Z" ], "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-19T03:01:43Z", "eValue": 8, "CallListName": "sample string 9", "IsEndless": true }, "EditDate": "2024-05-19T03:01:43Z", "CreateDate": "2024-05-19T03:01:43Z", "OccurTime": "2024-05-19T03:01:43Z", "OccurEndTime": "2024-05-19T03:01:43Z", "StartTime": "2024-05-19T03:01:43Z", "EndTime": "2024-05-19T03:01:43Z", "Details": "sample string 28", "LinkedEntities": { "Contacts": [ "16abeccf-9808-451c-9a08-39eae4aa4c70", "7749f38d-a98b-4d68-9169-8d8af6c8e4f2" ], "Companies": [ "73f305bb-e17b-4e44-9291-fbe981d79baf", "7825f679-9372-42f0-ab1f-8eb2ffc8bed8" ], "Groups": [ "8000bbf2-db18-485a-b82e-ed1e24e97507", "05732045-e34b-42ee-b788-47cfbbea8a20" ], "Opportunities": [ "5dc7d7e9-0f1a-4a16-8fbc-87d659e55d2e", "60e114f1-cdd4-4619-aaf4-6cc289206386" ] } } ]