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": "a6c8896b-7e5c-47bb-aced-543c4be45fc1", "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-16T00:41:34Z", "FileType": "sample string 4", "FileExtension": "sample string 5", "FileName": "sample string 6", "Personal": true, "Shortcut": true }, "IsPrivate": true, "ManageUserId": "063d0326-31f2-4e10-8165-989285010ae6", "EditDate": "2024-05-16T00:41:34Z", "CreateDate": "2024-05-16T00:41:34Z", "StartTime": "2024-05-16T00:41:34Z", "EndTime": "2024-05-16T00:41:34Z", "Details": "sample string 12", "LinkedEntities": { "Contacts": [ "bd22a878-d3af-468d-9c86-b2a36f05e649", "ee67d5cb-452e-4029-83ac-7b1e153ae65a" ], "Companies": [ "20b35540-e696-41d1-97e6-5ef628ce88b1", "e3142d03-5b38-4dc5-99d4-ca8768b74c36" ], "Groups": [ "b0295ef1-0c2c-447b-b3cb-b51fba7c3aa7", "1266b55b-4fd5-4632-9fe9-ad2029cd5052" ], "Opportunities": [ "175eab21-2397-447d-b060-505311ba9a31", "443f3c19-28bb-4bf7-b6ca-0c09d7f1b2d8" ] } }, { "Id": "a6c8896b-7e5c-47bb-aced-543c4be45fc1", "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-16T00:41:34Z", "FileType": "sample string 4", "FileExtension": "sample string 5", "FileName": "sample string 6", "Personal": true, "Shortcut": true }, "IsPrivate": true, "ManageUserId": "063d0326-31f2-4e10-8165-989285010ae6", "EditDate": "2024-05-16T00:41:34Z", "CreateDate": "2024-05-16T00:41:34Z", "StartTime": "2024-05-16T00:41:34Z", "EndTime": "2024-05-16T00:41:34Z", "Details": "sample string 12", "LinkedEntities": { "Contacts": [ "bd22a878-d3af-468d-9c86-b2a36f05e649", "ee67d5cb-452e-4029-83ac-7b1e153ae65a" ], "Companies": [ "20b35540-e696-41d1-97e6-5ef628ce88b1", "e3142d03-5b38-4dc5-99d4-ca8768b74c36" ], "Groups": [ "b0295ef1-0c2c-447b-b3cb-b51fba7c3aa7", "1266b55b-4fd5-4632-9fe9-ad2029cd5052" ], "Opportunities": [ "175eab21-2397-447d-b060-505311ba9a31", "443f3c19-28bb-4bf7-b6ca-0c09d7f1b2d8" ] } } ]