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 History

Name	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": "977028ea-76ec-446f-bec8-6406c534a5a8",
    "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-12-05T02:30:37Z",
      "FileType": "sample string 4",
      "FileExtension": "sample string 5",
      "FileName": "sample string 6",
      "Personal": true,
      "Shortcut": true
    },
    "IsPrivate": true,
    "ManageUserId": "2b4f8fe1-2330-4985-9373-e55f901114a8",
    "EditDate": "2024-12-05T02:30:37Z",
    "CreateDate": "2024-12-05T02:30:37Z",
    "StartTime": "2024-12-05T02:30:37Z",
    "EndTime": "2024-12-05T02:30:37Z",
    "Details": "sample string 12",
    "LinkedEntities": {
      "Contacts": [
        "c85519a7-2397-487a-972b-56e9ae91b4b6",
        "aa82fb92-1b87-4d20-9439-ebc2c9b19272"
      ],
      "Companies": [
        "ef89de6e-32e7-4a70-966a-100e0bbf8c76",
        "95913728-9907-4559-9f9e-34712ca82d3f"
      ],
      "Groups": [
        "08e201a9-8f91-4bb3-a73d-93460e5fdfb1",
        "c9a199a4-4deb-4cb6-bed2-e6a62ec51975"
      ],
      "Opportunities": [
        "459f6120-d40e-411a-a021-f36326487254",
        "22f8bd20-eac2-4c26-965f-d137d606cd91"
      ]
    }
  },
  {
    "Id": "977028ea-76ec-446f-bec8-6406c534a5a8",
    "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-12-05T02:30:37Z",
      "FileType": "sample string 4",
      "FileExtension": "sample string 5",
      "FileName": "sample string 6",
      "Personal": true,
      "Shortcut": true
    },
    "IsPrivate": true,
    "ManageUserId": "2b4f8fe1-2330-4985-9373-e55f901114a8",
    "EditDate": "2024-12-05T02:30:37Z",
    "CreateDate": "2024-12-05T02:30:37Z",
    "StartTime": "2024-12-05T02:30:37Z",
    "EndTime": "2024-12-05T02:30:37Z",
    "Details": "sample string 12",
    "LinkedEntities": {
      "Contacts": [
        "c85519a7-2397-487a-972b-56e9ae91b4b6",
        "aa82fb92-1b87-4d20-9439-ebc2c9b19272"
      ],
      "Companies": [
        "ef89de6e-32e7-4a70-966a-100e0bbf8c76",
        "95913728-9907-4559-9f9e-34712ca82d3f"
      ],
      "Groups": [
        "08e201a9-8f91-4bb3-a73d-93460e5fdfb1",
        "c9a199a4-4deb-4cb6-bed2-e6a62ec51975"
      ],
      "Opportunities": [
        "459f6120-d40e-411a-a021-f36326487254",
        "22f8bd20-eac2-4c26-965f-d137d606cd91"
      ]
    }
  }
]