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": "65aa8682-349b-49f2-ab51-ff0d4fafff63", "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-19T02:42:46Z", "FileType": "sample string 4", "FileExtension": "sample string 5", "FileName": "sample string 6", "Personal": true, "Shortcut": true }, "IsPrivate": true, "ManageUserId": "7be1ec6e-c036-47f5-9a18-56b129153059", "EditDate": "2024-05-19T02:42:46Z", "CreateDate": "2024-05-19T02:42:46Z", "StartTime": "2024-05-19T02:42:46Z", "EndTime": "2024-05-19T02:42:46Z", "Details": "sample string 12", "LinkedEntities": { "Contacts": [ "d4786e1f-8741-4b13-bcad-de5ca9ef5776", "5729240c-08d9-46bc-bb73-f7f912afbe76" ], "Companies": [ "79cf92b3-33e7-4b37-a348-b9752666de0f", "71e588fb-d973-44d7-a443-ef069c967b91" ], "Groups": [ "cbe69f1a-9922-4c5b-a555-a7808e449950", "dcb76703-c76b-4fc1-b512-ec353a640be3" ], "Opportunities": [ "6bed10b5-ab8a-4e50-87a5-57c687568345", "c29f991f-9365-4dbb-b6b9-747d5c8d5b9e" ] } }