GET api/cases/searches

Returns a sample search object

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

CaseSearch

Name	Type	Additional information
Id	globally unique identifier	None.
FriendlyId	string	None.
Organization	OrganizationSearch	None.
ReportTypes	Collection of string	None.
QuestionFilters	Collection of QuestionFilter	None.
DescriptionSearch	string	None.
NameSearch	string	None.
AnyText	string	None.
UserTextSearch	string	None.
SubmittedBy	UserSearch	None.
LastModifiedBy	UserSearch	None.
EverModifiedBy	UserSearch	None.
MinimumRating	decimal number	None.
State	globally unique identifier	None.
Favorite	boolean	None.
SubmittedBefore	date	None.
SubmittedAfter	date	None.
EventBefore	date	None.
EventAfter	date	None.
ClosedBefore	date	None.
ClosedAfter	date	None.
WaitingOnRoleId	globally unique identifier	None.
WaitingOnMyRoles	boolean	None.
IncludeTags	Collection of string	None.
ExcludeTags	Collection of string	None.

Response Formats

application/json, text/json

Sample:

{
  "Id": "887801bd-68d9-44d8-9a8c-ad50527ac068",
  "FriendlyId": "sample string 1",
  "Organization": {
    "NameSearch": "sample string 1",
    "IsPublic": true,
    "DepartmentId": "d713517a-45a2-4915-8c19-1a8d030a378f"
  },
  "ReportTypes": [
    "sample string 1",
    "sample string 2"
  ],
  "QuestionFilters": [
    {
      "Id": "a65e4883-0b66-4b8a-a42e-1e7ae64dc593",
      "Values": [
        "sample string 1",
        "sample string 2"
      ]
    },
    {
      "Id": "a65e4883-0b66-4b8a-a42e-1e7ae64dc593",
      "Values": [
        "sample string 1",
        "sample string 2"
      ]
    }
  ],
  "DescriptionSearch": "sample string 2",
  "NameSearch": "sample string 3",
  "AnyText": "sample string 4",
  "UserTextSearch": "sample string 5",
  "SubmittedBy": {
    "Id": "a68dccb7-7848-4d27-a7e5-5530d2ad1906",
    "OrganizationIds": [
      "cf8b866b-e993-47c9-9332-89a36c7c324e",
      "55b6d0fc-e8cb-4908-bc85-b76c037ce278"
    ],
    "RoleIds": [
      "c207421f-7f14-44c2-a374-be1de0e4ca6b",
      "63bb2585-76cc-45f8-acfd-bf2ce71447d1"
    ],
    "Username": "sample string 1",
    "FirstName": "sample string 2",
    "LastName": "sample string 3",
    "Email": "sample string 4",
    "Title": "sample string 5"
  },
  "LastModifiedBy": {
    "Id": "a68dccb7-7848-4d27-a7e5-5530d2ad1906",
    "OrganizationIds": [
      "cf8b866b-e993-47c9-9332-89a36c7c324e",
      "55b6d0fc-e8cb-4908-bc85-b76c037ce278"
    ],
    "RoleIds": [
      "c207421f-7f14-44c2-a374-be1de0e4ca6b",
      "63bb2585-76cc-45f8-acfd-bf2ce71447d1"
    ],
    "Username": "sample string 1",
    "FirstName": "sample string 2",
    "LastName": "sample string 3",
    "Email": "sample string 4",
    "Title": "sample string 5"
  },
  "EverModifiedBy": {
    "Id": "a68dccb7-7848-4d27-a7e5-5530d2ad1906",
    "OrganizationIds": [
      "cf8b866b-e993-47c9-9332-89a36c7c324e",
      "55b6d0fc-e8cb-4908-bc85-b76c037ce278"
    ],
    "RoleIds": [
      "c207421f-7f14-44c2-a374-be1de0e4ca6b",
      "63bb2585-76cc-45f8-acfd-bf2ce71447d1"
    ],
    "Username": "sample string 1",
    "FirstName": "sample string 2",
    "LastName": "sample string 3",
    "Email": "sample string 4",
    "Title": "sample string 5"
  },
  "MinimumRating": 6.1,
  "State": "90e1576b-216e-4667-a500-6786c4baefd4",
  "Favorite": true,
  "SubmittedBefore": "2025-12-12T01:08:05.8225528+00:00",
  "SubmittedAfter": "2025-12-12T01:08:05.8225528+00:00",
  "EventBefore": "2025-12-12T01:08:05.8225528+00:00",
  "EventAfter": "2025-12-12T01:08:05.8225528+00:00",
  "ClosedBefore": "2025-12-12T01:08:05.8225528+00:00",
  "ClosedAfter": "2025-12-12T01:08:05.8225528+00:00",
  "WaitingOnRoleId": "e59c1f10-2713-494b-b59c-fff7097d117c",
  "WaitingOnMyRoles": true,
  "IncludeTags": [
    "sample string 1",
    "sample string 2"
  ],
  "ExcludeTags": [
    "sample string 1",
    "sample string 2"
  ]
}

application/xml, text/xml

Sample:

<CaseSearch xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/XCapture.DTO">
  <AnyText>sample string 4</AnyText>
  <ClosedAfter>2025-12-12T01:08:05.8225528+00:00</ClosedAfter>
  <ClosedBefore>2025-12-12T01:08:05.8225528+00:00</ClosedBefore>
  <DescriptionSearch>sample string 2</DescriptionSearch>
  <EventAfter>2025-12-12T01:08:05.8225528+00:00</EventAfter>
  <EventBefore>2025-12-12T01:08:05.8225528+00:00</EventBefore>
  <EverModifiedBy>
    <Email>sample string 4</Email>
    <FirstName>sample string 2</FirstName>
    <Id>a68dccb7-7848-4d27-a7e5-5530d2ad1906</Id>
    <LastName>sample string 3</LastName>
    <OrganizationIds xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:guid>cf8b866b-e993-47c9-9332-89a36c7c324e</d3p1:guid>
      <d3p1:guid>55b6d0fc-e8cb-4908-bc85-b76c037ce278</d3p1:guid>
    </OrganizationIds>
    <RoleIds xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:guid>c207421f-7f14-44c2-a374-be1de0e4ca6b</d3p1:guid>
      <d3p1:guid>63bb2585-76cc-45f8-acfd-bf2ce71447d1</d3p1:guid>
    </RoleIds>
    <Title>sample string 5</Title>
    <Username>sample string 1</Username>
  </EverModifiedBy>
  <ExcludeTags xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </ExcludeTags>
  <Favorite>true</Favorite>
  <FriendlyId>sample string 1</FriendlyId>
  <Id>887801bd-68d9-44d8-9a8c-ad50527ac068</Id>
  <IncludeTags xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </IncludeTags>
  <LastModifiedBy>
    <Email>sample string 4</Email>
    <FirstName>sample string 2</FirstName>
    <Id>a68dccb7-7848-4d27-a7e5-5530d2ad1906</Id>
    <LastName>sample string 3</LastName>
    <OrganizationIds xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:guid>cf8b866b-e993-47c9-9332-89a36c7c324e</d3p1:guid>
      <d3p1:guid>55b6d0fc-e8cb-4908-bc85-b76c037ce278</d3p1:guid>
    </OrganizationIds>
    <RoleIds xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:guid>c207421f-7f14-44c2-a374-be1de0e4ca6b</d3p1:guid>
      <d3p1:guid>63bb2585-76cc-45f8-acfd-bf2ce71447d1</d3p1:guid>
    </RoleIds>
    <Title>sample string 5</Title>
    <Username>sample string 1</Username>
  </LastModifiedBy>
  <MinimumRating>6.1</MinimumRating>
  <NameSearch>sample string 3</NameSearch>
  <Organization>
    <DepartmentId>d713517a-45a2-4915-8c19-1a8d030a378f</DepartmentId>
    <IsPublic>true</IsPublic>
    <NameSearch>sample string 1</NameSearch>
  </Organization>
  <QuestionFilters>
    <QuestionFilter>
      <Id>a65e4883-0b66-4b8a-a42e-1e7ae64dc593</Id>
      <Values xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </Values>
    </QuestionFilter>
    <QuestionFilter>
      <Id>a65e4883-0b66-4b8a-a42e-1e7ae64dc593</Id>
      <Values xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </Values>
    </QuestionFilter>
  </QuestionFilters>
  <ReportTypes xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </ReportTypes>
  <State>90e1576b-216e-4667-a500-6786c4baefd4</State>
  <SubmittedAfter>2025-12-12T01:08:05.8225528+00:00</SubmittedAfter>
  <SubmittedBefore>2025-12-12T01:08:05.8225528+00:00</SubmittedBefore>
  <SubmittedBy>
    <Email>sample string 4</Email>
    <FirstName>sample string 2</FirstName>
    <Id>a68dccb7-7848-4d27-a7e5-5530d2ad1906</Id>
    <LastName>sample string 3</LastName>
    <OrganizationIds xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:guid>cf8b866b-e993-47c9-9332-89a36c7c324e</d3p1:guid>
      <d3p1:guid>55b6d0fc-e8cb-4908-bc85-b76c037ce278</d3p1:guid>
    </OrganizationIds>
    <RoleIds xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:guid>c207421f-7f14-44c2-a374-be1de0e4ca6b</d3p1:guid>
      <d3p1:guid>63bb2585-76cc-45f8-acfd-bf2ce71447d1</d3p1:guid>
    </RoleIds>
    <Title>sample string 5</Title>
    <Username>sample string 1</Username>
  </SubmittedBy>
  <UserTextSearch>sample string 5</UserTextSearch>
  <WaitingOnMyRoles>true</WaitingOnMyRoles>
  <WaitingOnRoleId>e59c1f10-2713-494b-b59c-fff7097d117c</WaitingOnRoleId>
</CaseSearch>