GET api/NE/GetHistoryItems?linkedEntityNameId={linkedEntityNameId}&linkedEntityId={linkedEntityId}&includeArchived={includeArchived}&includeCancelled={includeCancelled}&sourceEntityNameId={sourceEntityNameId}&historyTypeId={historyTypeId}&maxHistoryItemId={maxHistoryItemId}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
linkedEntityNameId

integer

Required

linkedEntityId

integer

Required

includeArchived

boolean

Default value is True

includeCancelled

boolean

Default value is False

sourceEntityNameId

integer

None.

historyTypeId

integer

None.

maxHistoryItemId

integer

None.

Body Parameters

None.

Response Information

Resource Description

Collection of HistoryItem
NameDescriptionTypeAdditional information
HistoryItemId

integer

None.

HistoryTypeId

integer

None.

ActionDate

date

None.

SourceEntityNameId

integer

None.

SourceEntityId

integer

None.

Description

string

None.

LinkedEntityNameId

integer

None.

LinkedEntityId

integer

None.

CreatedBy

integer

None.

IsCancelled

boolean

None.

LinkedEntityName

EntityName

None.

SourceEntityName

EntityName

None.

CreatedByUser

User

None.

HistoryType

HistoryType

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "$id": "1",
    "$type": "NE.Entities.Server.HIST.HistoryItem, NE.Entities.Server",
    "HistoryItemId": 1,
    "HistoryTypeId": 2,
    "ActionDate": "2022-08-13T22:28:35.311+00:00",
    "SourceEntityNameId": 4,
    "SourceEntityId": 5,
    "Description": "sample string 6",
    "LinkedEntityNameId": 7,
    "LinkedEntityId": 8,
    "CreatedBy": 9,
    "IsCancelled": true,
    "LinkedEntityName": {
      "$id": "2",
      "$type": "AHS.Server.Entities.EntityName, AHS.Server",
      "EntityNameId": 1,
      "Description": "sample string 2",
      "CodeName": "sample string 3"
    },
    "SourceEntityName": {
      "$ref": "2"
    },
    "CreatedByUser": {
      "$id": "3",
      "$type": "AHS.Server.Entities.User, AHS.Server",
      "UserId": 1,
      "Username": "sample string 2",
      "FirstName": "sample string 3",
      "LastName": "sample string 4",
      "Email": "sample string 5",
      "IsActive": true,
      "IsSystem": true,
      "IsADBased": true,
      "BusinessUnitId": 9,
      "PermissionIds": [
        1,
        2
      ],
      "FullName": "sample string 3 sample string 4",
      "BusinessUnit": {
        "$id": "4",
        "$type": "AHS.Server.Entities.BusinessUnit, AHS.Server",
        "BusinessUnitId": 1,
        "Description": "sample string 2",
        "IsAHS": true
      }
    },
    "HistoryType": {
      "$id": "5",
      "$type": "NE.Entities.Server.HIST.HistoryType, NE.Entities.Server",
      "HistoryTypeID": 1,
      "HistoryTypeCategoryID": 2,
      "Description": "sample string 3",
      "PrimaryTable": "sample string 4",
      "CodeName": "sample string 5",
      "CanEdit": true,
      "CanRedeliver": true,
      "CanReplace": true,
      "CanCancel": true,
      "HistoryItems": [
        {
          "$ref": "1"
        },
        {
          "$ref": "1"
        }
      ],
      "HistoryTypeCategory": {
        "$id": "6",
        "$type": "NE.Entities.Server.HIST.HistoryTypeCategory, NE.Entities.Server",
        "HistoryTypeCategoryID": 1,
        "Description": "sample string 2",
        "CodeName": "sample string 3",
        "DisplayInBriefMode": true,
        "HistoryTypes": [
          {
            "$ref": "5"
          },
          {
            "$ref": "5"
          }
        ]
      }
    }
  },
  {
    "$ref": "1"
  }
]