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": "5a438c6a-5730-49f3-b542-5ee94ae910ec",
"FriendlyId": "sample string 1",
"Owner": {
"Id": "edbdd1b3-47d3-4236-bba9-13e8f959837c",
"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": "76bb5b76-dddb-40b5-9d40-df82b0e18d9c",
"Name": "sample string 2",
"OrganizationId": "570822dd-d69a-4c65-81cc-d035bda6d8ca"
},
{
"Id": "76bb5b76-dddb-40b5-9d40-df82b0e18d9c",
"Name": "sample string 2",
"OrganizationId": "570822dd-d69a-4c65-81cc-d035bda6d8ca"
}
]
},
"CurrentState": {
"Id": "ac46328d-18f7-4f10-b069-4f5e03512674",
"Name": "sample string 2"
},
"Organization": {
"Id": "bbc50ed2-2b7a-4953-a156-4dc0a575cba9",
"Name": "sample string 2",
"IconUrl": "sample string 3"
},
"WaitingOnRoles": [
{
"Id": "76bb5b76-dddb-40b5-9d40-df82b0e18d9c",
"Name": "sample string 2",
"OrganizationId": "570822dd-d69a-4c65-81cc-d035bda6d8ca"
},
{
"Id": "76bb5b76-dddb-40b5-9d40-df82b0e18d9c",
"Name": "sample string 2",
"OrganizationId": "570822dd-d69a-4c65-81cc-d035bda6d8ca"
}
],
"EntryTimestamp": "2026-05-31T00:52:22.1560567+00:00",
"ModifiedTimestamp": "2026-05-31T00:52:22.1560567+00:00",
"EventTimestamp": "2026-05-31T00:52:22.1560567+00:00",
"CompletedTransitions": 5,
"TotalTransitions": 6,
"Name": "sample string 7",
"OrganizationId": "596d7180-b096-4d52-b3f9-666323e08ddf",
"AvailableReports": [
{
"Id": "8e82901e-8245-4641-af0f-652507be148a",
"Name": "sample string 2"
},
{
"Id": "8e82901e-8245-4641-af0f-652507be148a",
"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>8e82901e-8245-4641-af0f-652507be148a</Id>
<Name>sample string 2</Name>
</ReportSimple>
<ReportSimple>
<Id>8e82901e-8245-4641-af0f-652507be148a</Id>
<Name>sample string 2</Name>
</ReportSimple>
</AvailableReports>
<CompletedTransitions>5</CompletedTransitions>
<CurrentState>
<Id>ac46328d-18f7-4f10-b069-4f5e03512674</Id>
<Name>sample string 2</Name>
</CurrentState>
<EntryTimestamp xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
<d2p1:DateTime>2026-05-31T00:52:22.1560567Z</d2p1:DateTime>
<d2p1:OffsetMinutes>0</d2p1:OffsetMinutes>
</EntryTimestamp>
<EventTimestamp xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
<d2p1:DateTime>2026-05-31T00:52:22.1560567Z</d2p1:DateTime>
<d2p1:OffsetMinutes>0</d2p1:OffsetMinutes>
</EventTimestamp>
<FriendlyId>sample string 1</FriendlyId>
<Id>5a438c6a-5730-49f3-b542-5ee94ae910ec</Id>
<ModifiedTimestamp xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
<d2p1:DateTime>2026-05-31T00:52:22.1560567Z</d2p1:DateTime>
<d2p1:OffsetMinutes>0</d2p1:OffsetMinutes>
</ModifiedTimestamp>
<Name>sample string 7</Name>
<Organization>
<IconUrl>sample string 3</IconUrl>
<Id>bbc50ed2-2b7a-4953-a156-4dc0a575cba9</Id>
<Name>sample string 2</Name>
</Organization>
<OrganizationId>596d7180-b096-4d52-b3f9-666323e08ddf</OrganizationId>
<Owner>
<Email>sample string 6</Email>
<ExternalId>sample string 8</ExternalId>
<FirstName>sample string 3</FirstName>
<Id>edbdd1b3-47d3-4236-bba9-13e8f959837c</Id>
<LastName>sample string 4</LastName>
<Phone>sample string 7</Phone>
<Roles>
<RoleSimple>
<Id>76bb5b76-dddb-40b5-9d40-df82b0e18d9c</Id>
<Name>sample string 2</Name>
<OrganizationId>570822dd-d69a-4c65-81cc-d035bda6d8ca</OrganizationId>
</RoleSimple>
<RoleSimple>
<Id>76bb5b76-dddb-40b5-9d40-df82b0e18d9c</Id>
<Name>sample string 2</Name>
<OrganizationId>570822dd-d69a-4c65-81cc-d035bda6d8ca</OrganizationId>
</RoleSimple>
</Roles>
<Title>sample string 5</Title>
<Username>sample string 2</Username>
</Owner>
<TotalTransitions>6</TotalTransitions>
<WaitingOnRoles>
<RoleSimple>
<Id>76bb5b76-dddb-40b5-9d40-df82b0e18d9c</Id>
<Name>sample string 2</Name>
<OrganizationId>570822dd-d69a-4c65-81cc-d035bda6d8ca</OrganizationId>
</RoleSimple>
<RoleSimple>
<Id>76bb5b76-dddb-40b5-9d40-df82b0e18d9c</Id>
<Name>sample string 2</Name>
<OrganizationId>570822dd-d69a-4c65-81cc-d035bda6d8ca</OrganizationId>
</RoleSimple>
</WaitingOnRoles>
</CaseSimple>