GET api/Histories/{id}?mainEntityType={mainEntityType}
Get all Histories linked to a main entity record. Supported Headers: SelectField, IncludeLink, DetailFormat
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
id |
Id of the main entity record |
globally unique identifier |
Required |
mainEntityType | MainEntityType |
Required |
Body Parameters
None.
Response Information
Resource Description
Collection of 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": "805c4c53-2e37-46f1-8655-44db9d182ec5", "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-19T00:58:29Z", "FileType": "sample string 4", "FileExtension": "sample string 5", "FileName": "sample string 6", "Personal": true, "Shortcut": true }, "IsPrivate": true, "ManageUserId": "ec40b88c-8a76-41f3-a81a-8cb780313244", "EditDate": "2024-05-19T00:58:29Z", "CreateDate": "2024-05-19T00:58:29Z", "StartTime": "2024-05-19T00:58:29Z", "EndTime": "2024-05-19T00:58:29Z", "Details": "sample string 12", "LinkedEntities": { "Contacts": [ "54491833-2689-470d-b308-028f945366ec", "187e7009-551c-4465-86f3-cd5235415956" ], "Companies": [ "622c0861-8159-45b7-96cd-4841c93dabc2", "37a577b6-e723-4117-af12-2053e3057ec5" ], "Groups": [ "290023c2-35bf-4a62-9967-ebea4949a54e", "9fee5220-ffa6-4e43-9b8a-e3478ea08453" ], "Opportunities": [ "74a3b69a-2a9f-4850-b291-c56c33ef8d4f", "0910b098-c9e5-42d1-99b5-e9eccbd2a35e" ] } }, { "Id": "805c4c53-2e37-46f1-8655-44db9d182ec5", "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-19T00:58:29Z", "FileType": "sample string 4", "FileExtension": "sample string 5", "FileName": "sample string 6", "Personal": true, "Shortcut": true }, "IsPrivate": true, "ManageUserId": "ec40b88c-8a76-41f3-a81a-8cb780313244", "EditDate": "2024-05-19T00:58:29Z", "CreateDate": "2024-05-19T00:58:29Z", "StartTime": "2024-05-19T00:58:29Z", "EndTime": "2024-05-19T00:58:29Z", "Details": "sample string 12", "LinkedEntities": { "Contacts": [ "54491833-2689-470d-b308-028f945366ec", "187e7009-551c-4465-86f3-cd5235415956" ], "Companies": [ "622c0861-8159-45b7-96cd-4841c93dabc2", "37a577b6-e723-4117-af12-2053e3057ec5" ], "Groups": [ "290023c2-35bf-4a62-9967-ebea4949a54e", "9fee5220-ffa6-4e43-9b8a-e3478ea08453" ], "Opportunities": [ "74a3b69a-2a9f-4850-b291-c56c33ef8d4f", "0910b098-c9e5-42d1-99b5-e9eccbd2a35e" ] } } ]