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": "805e36ba-ef91-4c56-bb07-e0651ae25368",
  "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-07T21:50:16Z",
    "FileType": "sample string 4",
    "FileExtension": "sample string 5",
    "FileName": "sample string 6",
    "Personal": true,
    "Shortcut": true
  },
  "IsPrivate": true,
  "ManageUserId": "628e761b-7476-4a36-a31e-a46365154a34",
  "EditDate": "2024-05-07T21:50:16Z",
  "CreateDate": "2024-05-07T21:50:16Z",
  "StartTime": "2024-05-07T21:50:16Z",
  "EndTime": "2024-05-07T21:50:16Z",
  "Details": "sample string 12",
  "LinkedEntities": {
    "Contacts": [
      "2ea4c1ab-0728-4d28-82a8-8f5599d56a0e",
      "65eea948-5ea8-456a-95ac-b15d6461b0d4"
    ],
    "Companies": [
      "d04a90c6-7f6f-472a-87c2-473ea337ee4d",
      "3e2477b9-8186-473b-9939-1363469cda6a"
    ],
    "Groups": [
      "7e8cabad-2bca-43c0-9072-1aa65a520fd1",
      "e6b57181-6095-4585-bc5b-7e0d53475b4d"
    ],
    "Opportunities": [
      "a82691eb-5a6c-4c63-a7d3-ce47e84b274a",
      "8477b3f3-4203-4783-bd25-383e62079380"
    ]
  }
}