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 Activity

Name	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": "d84083b5-6752-4ab4-bbd6-676df4de8eba",
    "SeriesId": "dbba70e3-ff6f-41f8-8f46-aea7eba9e512",
    "AccessorID": "c32dbb17-10a0-4859-bde6-d6e583286480",
    "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": "17acf383-9ae0-4638-88b4-cc955bb32ce3",
    "ScheduledByID": "3bf1ba07-d0e2-47b8-9c8e-e89f1997b8da",
    "DeletedDates": [
      "2024-05-04T17:13:36Z",
      "2024-05-04T17:13:36Z"
    ],
    "ClearedDates": [
      "2024-05-04T17:13:36Z",
      "2024-05-04T17:13: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-04T17:13:36Z",
      "eValue": 8,
      "CallListName": "sample string 9",
      "IsEndless": true
    },
    "EditDate": "2024-05-04T17:13:36Z",
    "CreateDate": "2024-05-04T17:13:36Z",
    "OccurTime": "2024-05-04T17:13:36Z",
    "OccurEndTime": "2024-05-04T17:13:36Z",
    "StartTime": "2024-05-04T17:13:36Z",
    "EndTime": "2024-05-04T17:13:36Z",
    "Details": "sample string 28",
    "LinkedEntities": {
      "Contacts": [
        "8ad703b9-350c-4448-a3b1-7361331c6676",
        "31f9a9f5-0ff2-4a2a-a389-09653f5efe53"
      ],
      "Companies": [
        "a43a8935-9699-4be5-a889-20188246d137",
        "e72e61d7-26d2-41c3-980e-fe2f5cf8108f"
      ],
      "Groups": [
        "cf8ed9fa-dbcf-48d3-b716-e4a57e6a268a",
        "d203b875-c66f-4e7f-96fd-c458937f7a4d"
      ],
      "Opportunities": [
        "a97530a9-a7b5-49bf-bf4d-11fc35b01937",
        "fc97a56d-00cf-4dad-8f7a-8358f4d23721"
      ]
    }
  },
  {
    "Id": "d84083b5-6752-4ab4-bbd6-676df4de8eba",
    "SeriesId": "dbba70e3-ff6f-41f8-8f46-aea7eba9e512",
    "AccessorID": "c32dbb17-10a0-4859-bde6-d6e583286480",
    "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": "17acf383-9ae0-4638-88b4-cc955bb32ce3",
    "ScheduledByID": "3bf1ba07-d0e2-47b8-9c8e-e89f1997b8da",
    "DeletedDates": [
      "2024-05-04T17:13:36Z",
      "2024-05-04T17:13:36Z"
    ],
    "ClearedDates": [
      "2024-05-04T17:13:36Z",
      "2024-05-04T17:13: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-04T17:13:36Z",
      "eValue": 8,
      "CallListName": "sample string 9",
      "IsEndless": true
    },
    "EditDate": "2024-05-04T17:13:36Z",
    "CreateDate": "2024-05-04T17:13:36Z",
    "OccurTime": "2024-05-04T17:13:36Z",
    "OccurEndTime": "2024-05-04T17:13:36Z",
    "StartTime": "2024-05-04T17:13:36Z",
    "EndTime": "2024-05-04T17:13:36Z",
    "Details": "sample string 28",
    "LinkedEntities": {
      "Contacts": [
        "8ad703b9-350c-4448-a3b1-7361331c6676",
        "31f9a9f5-0ff2-4a2a-a389-09653f5efe53"
      ],
      "Companies": [
        "a43a8935-9699-4be5-a889-20188246d137",
        "e72e61d7-26d2-41c3-980e-fe2f5cf8108f"
      ],
      "Groups": [
        "cf8ed9fa-dbcf-48d3-b716-e4a57e6a268a",
        "d203b875-c66f-4e7f-96fd-c458937f7a4d"
      ],
      "Opportunities": [
        "a97530a9-a7b5-49bf-bf4d-11fc35b01937",
        "fc97a56d-00cf-4dad-8f7a-8358f4d23721"
      ]
    }
  }
]