GET api/Histories/{id}
Get a History by ID. Supported Headers: SelectField, IncludeLink, DetailFormat
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
id | globally unique identifier |
Required |
Body Parameters
None.
Response Information
Resource Description
HistoryName | Description | Type | Additional information |
---|---|---|---|
Id |
SQL Column Name: [HISTORYID] |
globally unique identifier |
None. |
Regarding |
SQL Column Name: [REGARDING] |
string |
None. |
Duration |
SQL Column Name: [DURATION] |
string |
None. |
OutlookID | string |
None. |
|
HistoryTypeID |
SQL Column Name: [HISTORYTYPEID] |
integer |
None. |
HistoryType | HistoryType |
None. |
|
Attachment | Attachment |
None. |
|
IsPrivate | boolean |
None. |
|
ManageUserId | globally unique identifier |
None. |
|
EditDate |
SQL Column Name: [EDIT_DATE] |
date |
None. |
CreateDate |
SQL Column Name: [CREATE_DATE] |
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": "ec00ec0d-9fbb-46e9-a0f6-f6b202c63c19", "Regarding": "sample string 2", "Duration": "sample string 3", "OutlookID": "sample string 4", "HistoryTypeID": 5, "HistoryType": { "Name": "sample string 1", "HistoryTypeId": 2, "Description": "sample string 3", "ActivityTypeID": "sample string 4", "ActivityTypeName": "sample string 5", "IsActive": true, "IsCustom": true, "IsDefault": true, "IsUserRecordable": true }, "Attachment": { "DisplayName": "sample string 1", "FileSize": 2.1, "LastModified": "2024-05-04T14:01:43Z", "FileType": "sample string 4", "FileExtension": "sample string 5", "FileName": "sample string 6", "Personal": true, "Shortcut": true }, "IsPrivate": true, "ManageUserId": "8a8c6ffc-af57-4692-9a48-fa40f8877ddb", "EditDate": "2024-05-04T14:01:43Z", "CreateDate": "2024-05-04T14:01:43Z", "StartTime": "2024-05-04T14:01:43Z", "EndTime": "2024-05-04T14:01:43Z", "Details": "sample string 12", "LinkedEntities": { "Contacts": [ "5cbbe311-b262-484e-a6d2-57426c96a37d", "aa7490b9-e011-4754-ab61-732fd2f3ab0f" ], "Companies": [ "aa5ae82f-6d45-457f-8f6b-ba5c555aa79f", "481cd2af-a0fa-4ab7-8297-a5ecaea2d111" ], "Groups": [ "b10809da-c7d5-48fb-a9fb-8c69d26f691a", "9d40e065-1977-41c3-9165-0e6894b12a36" ], "Opportunities": [ "484701f7-665e-4fcf-b87d-1e8f4a678d1d", "07dac7d1-d5fb-495d-8251-e4d8f50d3b43" ] } }