GET api/Histories/{id}

Get a History by ID. Supported Headers: SelectField, IncludeLink, DetailFormat

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

globally unique identifier

Required

Body Parameters

None.

Response Information

Resource Description

History
NameDescriptionTypeAdditional 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": "62a9792e-decd-4591-81cf-a7784112c825",
  "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:38:47Z",
    "FileType": "sample string 4",
    "FileExtension": "sample string 5",
    "FileName": "sample string 6",
    "Personal": true,
    "Shortcut": true
  },
  "IsPrivate": true,
  "ManageUserId": "27f3bdfb-b959-4aa4-9ad5-370a0d16b981",
  "EditDate": "2024-12-05T02:38:47Z",
  "CreateDate": "2024-12-05T02:38:47Z",
  "StartTime": "2024-12-05T02:38:47Z",
  "EndTime": "2024-12-05T02:38:47Z",
  "Details": "sample string 12",
  "LinkedEntities": {
    "Contacts": [
      "edb0a5dc-b858-4f6c-bb53-fd963113e3ff",
      "5293df39-68f0-4202-88cd-e9f5397fccbf"
    ],
    "Companies": [
      "e524fbc0-7ddd-4b37-90dd-a10123388adf",
      "da3ce18d-b048-47b6-b6d3-fa41c37a18cd"
    ],
    "Groups": [
      "371e166b-9ac3-4202-b7e9-7a3d79b0c3fa",
      "3ca92052-8a3f-44ef-9362-91f4dd0f2878"
    ],
    "Opportunities": [
      "9798b9c4-71ff-41cf-b670-2211bff4fc6b",
      "e4fb4b69-e906-4ff3-b8ad-de2def0f8ed1"
    ]
  }
}