DELETE api/Cases/{id}
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| id | globally unique identifier |
Required |
Body Parameters
None.
Response Information
Resource Description
CaseSimple| Name | Description | Type | Additional information |
|---|---|---|---|
| Id | globally unique identifier |
None. |
|
| FriendlyId | string |
None. |
|
| Owner | UserSimple |
None. |
|
| CurrentState | StateSimple |
None. |
|
| Organization | OrganizationSimple |
None. |
|
| WaitingOnRoles | Collection of RoleSimple |
None. |
|
| EntryTimestamp | date |
None. |
|
| ModifiedTimestamp | date |
None. |
|
| EventTimestamp | date |
None. |
|
| CompletedTransitions | integer |
None. |
|
| TotalTransitions | integer |
None. |
|
| Name | string |
Required |
|
| OrganizationId | globally unique identifier |
Required |
|
| AvailableReports | Collection of ReportSimple |
None. |
|
| Links | Collection of Link |
None. |
Response Formats
application/json, text/json
Sample:
{
"Id": "155982b0-b052-412d-9681-d24100f092ff",
"FriendlyId": "sample string 1",
"Owner": {
"Id": "9c7e0cbf-5bf8-48cb-987d-8bcf23abc1f5",
"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": "643d5e66-67ef-4e9f-b756-acb1929afc29",
"Name": "sample string 2",
"OrganizationId": "c9ba89c5-034c-42d4-99d9-eab768dce3ce"
},
{
"Id": "643d5e66-67ef-4e9f-b756-acb1929afc29",
"Name": "sample string 2",
"OrganizationId": "c9ba89c5-034c-42d4-99d9-eab768dce3ce"
}
]
},
"CurrentState": {
"Id": "aa49dc0d-3ac6-43ad-9905-4050ae0b9ccc",
"Name": "sample string 2"
},
"Organization": {
"Id": "ddc9fdfe-5c76-4841-9e94-26a9356e24b5",
"Name": "sample string 2",
"IconUrl": "sample string 3"
},
"WaitingOnRoles": [
{
"Id": "643d5e66-67ef-4e9f-b756-acb1929afc29",
"Name": "sample string 2",
"OrganizationId": "c9ba89c5-034c-42d4-99d9-eab768dce3ce"
},
{
"Id": "643d5e66-67ef-4e9f-b756-acb1929afc29",
"Name": "sample string 2",
"OrganizationId": "c9ba89c5-034c-42d4-99d9-eab768dce3ce"
}
],
"EntryTimestamp": "2026-08-01T03:18:19.2946397+00:00",
"ModifiedTimestamp": "2026-08-01T03:18:19.2946397+00:00",
"EventTimestamp": "2026-08-01T03:18:19.2946397+00:00",
"CompletedTransitions": 5,
"TotalTransitions": 6,
"Name": "sample string 7",
"OrganizationId": "1341a3fd-fbad-42fa-bb6e-0c40705eeef3",
"AvailableReports": [
{
"Id": "c2e16198-7d20-4458-a494-93343d918065",
"Name": "sample string 2"
},
{
"Id": "c2e16198-7d20-4458-a494-93343d918065",
"Name": "sample string 2"
}
],
"Links": []
}
application/xml, text/xml
Sample:
<CaseSimple xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/XCapture.DTO">
<Links />
<AvailableReports>
<ReportSimple>
<Id>c2e16198-7d20-4458-a494-93343d918065</Id>
<Name>sample string 2</Name>
</ReportSimple>
<ReportSimple>
<Id>c2e16198-7d20-4458-a494-93343d918065</Id>
<Name>sample string 2</Name>
</ReportSimple>
</AvailableReports>
<CompletedTransitions>5</CompletedTransitions>
<CurrentState>
<Id>aa49dc0d-3ac6-43ad-9905-4050ae0b9ccc</Id>
<Name>sample string 2</Name>
</CurrentState>
<EntryTimestamp xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
<d2p1:DateTime>2026-08-01T03:18:19.2946397Z</d2p1:DateTime>
<d2p1:OffsetMinutes>0</d2p1:OffsetMinutes>
</EntryTimestamp>
<EventTimestamp xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
<d2p1:DateTime>2026-08-01T03:18:19.2946397Z</d2p1:DateTime>
<d2p1:OffsetMinutes>0</d2p1:OffsetMinutes>
</EventTimestamp>
<FriendlyId>sample string 1</FriendlyId>
<Id>155982b0-b052-412d-9681-d24100f092ff</Id>
<ModifiedTimestamp xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
<d2p1:DateTime>2026-08-01T03:18:19.2946397Z</d2p1:DateTime>
<d2p1:OffsetMinutes>0</d2p1:OffsetMinutes>
</ModifiedTimestamp>
<Name>sample string 7</Name>
<Organization>
<IconUrl>sample string 3</IconUrl>
<Id>ddc9fdfe-5c76-4841-9e94-26a9356e24b5</Id>
<Name>sample string 2</Name>
</Organization>
<OrganizationId>1341a3fd-fbad-42fa-bb6e-0c40705eeef3</OrganizationId>
<Owner>
<Email>sample string 6</Email>
<ExternalId>sample string 8</ExternalId>
<FirstName>sample string 3</FirstName>
<Id>9c7e0cbf-5bf8-48cb-987d-8bcf23abc1f5</Id>
<LastName>sample string 4</LastName>
<Phone>sample string 7</Phone>
<Roles>
<RoleSimple>
<Id>643d5e66-67ef-4e9f-b756-acb1929afc29</Id>
<Name>sample string 2</Name>
<OrganizationId>c9ba89c5-034c-42d4-99d9-eab768dce3ce</OrganizationId>
</RoleSimple>
<RoleSimple>
<Id>643d5e66-67ef-4e9f-b756-acb1929afc29</Id>
<Name>sample string 2</Name>
<OrganizationId>c9ba89c5-034c-42d4-99d9-eab768dce3ce</OrganizationId>
</RoleSimple>
</Roles>
<Title>sample string 5</Title>
<Username>sample string 2</Username>
</Owner>
<TotalTransitions>6</TotalTransitions>
<WaitingOnRoles>
<RoleSimple>
<Id>643d5e66-67ef-4e9f-b756-acb1929afc29</Id>
<Name>sample string 2</Name>
<OrganizationId>c9ba89c5-034c-42d4-99d9-eab768dce3ce</OrganizationId>
</RoleSimple>
<RoleSimple>
<Id>643d5e66-67ef-4e9f-b756-acb1929afc29</Id>
<Name>sample string 2</Name>
<OrganizationId>c9ba89c5-034c-42d4-99d9-eab768dce3ce</OrganizationId>
</RoleSimple>
</WaitingOnRoles>
</CaseSimple>