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": "d6300672-d48f-4373-8921-09f65d9a167a", "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-08T02:39:44Z", "FileType": "sample string 4", "FileExtension": "sample string 5", "FileName": "sample string 6", "Personal": true, "Shortcut": true }, "IsPrivate": true, "ManageUserId": "1d71776f-ed81-4e26-8bd7-40065f641c74", "EditDate": "2024-05-08T02:39:44Z", "CreateDate": "2024-05-08T02:39:44Z", "StartTime": "2024-05-08T02:39:44Z", "EndTime": "2024-05-08T02:39:44Z", "Details": "sample string 12", "LinkedEntities": { "Contacts": [ "8cdf9718-629a-4003-b28c-07eb4fc4ce21", "f98105d1-7b4b-4bef-a515-6b318a0864b3" ], "Companies": [ "953d0a56-35c9-4ebf-a0ec-99b7adf45420", "79d63bfa-617f-43fb-9ce3-16bc52781448" ], "Groups": [ "68eeedbd-f888-4c86-9b8f-d76b839e70ab", "8fb4e119-a9ea-4665-afd6-8e6eae8950a5" ], "Opportunities": [ "31f374c9-8ece-44f2-9ebb-0d502e1c18fd", "56c9659f-20fa-4520-b990-bed7bbdbdb02" ] } }, { "Id": "d6300672-d48f-4373-8921-09f65d9a167a", "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-08T02:39:44Z", "FileType": "sample string 4", "FileExtension": "sample string 5", "FileName": "sample string 6", "Personal": true, "Shortcut": true }, "IsPrivate": true, "ManageUserId": "1d71776f-ed81-4e26-8bd7-40065f641c74", "EditDate": "2024-05-08T02:39:44Z", "CreateDate": "2024-05-08T02:39:44Z", "StartTime": "2024-05-08T02:39:44Z", "EndTime": "2024-05-08T02:39:44Z", "Details": "sample string 12", "LinkedEntities": { "Contacts": [ "8cdf9718-629a-4003-b28c-07eb4fc4ce21", "f98105d1-7b4b-4bef-a515-6b318a0864b3" ], "Companies": [ "953d0a56-35c9-4ebf-a0ec-99b7adf45420", "79d63bfa-617f-43fb-9ce3-16bc52781448" ], "Groups": [ "68eeedbd-f888-4c86-9b8f-d76b839e70ab", "8fb4e119-a9ea-4665-afd6-8e6eae8950a5" ], "Opportunities": [ "31f374c9-8ece-44f2-9ebb-0d502e1c18fd", "56c9659f-20fa-4520-b990-bed7bbdbdb02" ] } } ]