GET api/cases/{id}/history?includeViews={includeViews}

Get the history (log) of the Case

Request Information

URI Parameters

Name	Description	Type	Additional information
id		globally unique identifier	Required
includeViews		boolean	Default value is False

Body Parameters

None.

Response Information

Resource Description

Collection of CaseHistoryDetail

Name	Type	Additional information
Id	globally unique identifier	None.
User	UserSimple	None.
State	StateSimple	None.
Timestamp	date	None.
Type	string	None.
Description	string	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "Id": "d274b6ef-2b39-4e17-bc97-4219504283d4",
    "User": {
      "Id": "d3902427-ad53-488f-8130-c43f6a8acfd2",
      "Username": "sample string 2",
      "FirstName": "sample string 3",
      "LastName": "sample string 4",
      "Title": "sample string 5",
      "Email": "sample string 6",
      "Phone": "sample string 7",
      "ExternalId": "sample string 8",
      "Roles": [
        {
          "Id": "392cb70b-28c5-4042-a3bd-1f3c97147037",
          "Name": "sample string 2",
          "OrganizationId": "16249712-9bba-41ed-b168-72b019da2892"
        },
        {
          "Id": "392cb70b-28c5-4042-a3bd-1f3c97147037",
          "Name": "sample string 2",
          "OrganizationId": "16249712-9bba-41ed-b168-72b019da2892"
        }
      ]
    },
    "State": {
      "Id": "e4743a48-ca18-48e6-bb1d-b18321cc2536",
      "Name": "sample string 2"
    },
    "Timestamp": "2026-02-04T21:24:36.8833312+00:00",
    "Type": "sample string 3",
    "Description": "sample string 4"
  },
  {
    "Id": "d274b6ef-2b39-4e17-bc97-4219504283d4",
    "User": {
      "Id": "d3902427-ad53-488f-8130-c43f6a8acfd2",
      "Username": "sample string 2",
      "FirstName": "sample string 3",
      "LastName": "sample string 4",
      "Title": "sample string 5",
      "Email": "sample string 6",
      "Phone": "sample string 7",
      "ExternalId": "sample string 8",
      "Roles": [
        {
          "Id": "392cb70b-28c5-4042-a3bd-1f3c97147037",
          "Name": "sample string 2",
          "OrganizationId": "16249712-9bba-41ed-b168-72b019da2892"
        },
        {
          "Id": "392cb70b-28c5-4042-a3bd-1f3c97147037",
          "Name": "sample string 2",
          "OrganizationId": "16249712-9bba-41ed-b168-72b019da2892"
        }
      ]
    },
    "State": {
      "Id": "e4743a48-ca18-48e6-bb1d-b18321cc2536",
      "Name": "sample string 2"
    },
    "Timestamp": "2026-02-04T21:24:36.8833312+00:00",
    "Type": "sample string 3",
    "Description": "sample string 4"
  }
]

application/xml, text/xml

Sample:

<ArrayOfCaseHistoryDetail xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/XCapture.DTO">
  <CaseHistoryDetail>
    <Description>sample string 4</Description>
    <Id>d274b6ef-2b39-4e17-bc97-4219504283d4</Id>
    <State>
      <Id>e4743a48-ca18-48e6-bb1d-b18321cc2536</Id>
      <Name>sample string 2</Name>
    </State>
    <Timestamp>2026-02-04T21:24:36.8833312+00:00</Timestamp>
    <Type>sample string 3</Type>
    <User>
      <Email>sample string 6</Email>
      <ExternalId>sample string 8</ExternalId>
      <FirstName>sample string 3</FirstName>
      <Id>d3902427-ad53-488f-8130-c43f6a8acfd2</Id>
      <LastName>sample string 4</LastName>
      <Phone>sample string 7</Phone>
      <Roles>
        <RoleSimple>
          <Id>392cb70b-28c5-4042-a3bd-1f3c97147037</Id>
          <Name>sample string 2</Name>
          <OrganizationId>16249712-9bba-41ed-b168-72b019da2892</OrganizationId>
        </RoleSimple>
        <RoleSimple>
          <Id>392cb70b-28c5-4042-a3bd-1f3c97147037</Id>
          <Name>sample string 2</Name>
          <OrganizationId>16249712-9bba-41ed-b168-72b019da2892</OrganizationId>
        </RoleSimple>
      </Roles>
      <Title>sample string 5</Title>
      <Username>sample string 2</Username>
    </User>
  </CaseHistoryDetail>
  <CaseHistoryDetail>
    <Description>sample string 4</Description>
    <Id>d274b6ef-2b39-4e17-bc97-4219504283d4</Id>
    <State>
      <Id>e4743a48-ca18-48e6-bb1d-b18321cc2536</Id>
      <Name>sample string 2</Name>
    </State>
    <Timestamp>2026-02-04T21:24:36.8833312+00:00</Timestamp>
    <Type>sample string 3</Type>
    <User>
      <Email>sample string 6</Email>
      <ExternalId>sample string 8</ExternalId>
      <FirstName>sample string 3</FirstName>
      <Id>d3902427-ad53-488f-8130-c43f6a8acfd2</Id>
      <LastName>sample string 4</LastName>
      <Phone>sample string 7</Phone>
      <Roles>
        <RoleSimple>
          <Id>392cb70b-28c5-4042-a3bd-1f3c97147037</Id>
          <Name>sample string 2</Name>
          <OrganizationId>16249712-9bba-41ed-b168-72b019da2892</OrganizationId>
        </RoleSimple>
        <RoleSimple>
          <Id>392cb70b-28c5-4042-a3bd-1f3c97147037</Id>
          <Name>sample string 2</Name>
          <OrganizationId>16249712-9bba-41ed-b168-72b019da2892</OrganizationId>
        </RoleSimple>
      </Roles>
      <Title>sample string 5</Title>
      <Username>sample string 2</Username>
    </User>
  </CaseHistoryDetail>
</ArrayOfCaseHistoryDetail>