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": "a016c0e4-da8b-4f8b-8845-e21ad7e67c46", "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-15T03:39:24Z", "FileType": "sample string 4", "FileExtension": "sample string 5", "FileName": "sample string 6", "Personal": true, "Shortcut": true }, "IsPrivate": true, "ManageUserId": "d8454ba0-99fa-462c-90e5-9cde1e99f7a3", "EditDate": "2024-05-15T03:39:24Z", "CreateDate": "2024-05-15T03:39:24Z", "StartTime": "2024-05-15T03:39:24Z", "EndTime": "2024-05-15T03:39:24Z", "Details": "sample string 12", "LinkedEntities": { "Contacts": [ "2a5837a0-48d5-4177-acb8-3737ed548112", "a18a506f-1076-4673-97b4-19723fa2d05d" ], "Companies": [ "77318ef5-308b-47dc-aa33-cccb6087d518", "b05bbbff-46f9-4bdb-baa9-533cdfac04cb" ], "Groups": [ "9ac3cd70-eebf-495b-b513-f385c7f78cda", "7eb67c27-99f3-4b6b-ac3e-d70c7ae4c8c8" ], "Opportunities": [ "419ee1d8-7b94-41d5-a931-2544d9131d88", "d94a27e7-5d0a-4e54-8d48-ab6791034fcb" ] } }