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": "1d8b92ba-d439-4d7c-84db-df146062c4bb",
"FriendlyId": "sample string 1",
"Owner": {
"Id": "babbcdf6-bd85-4410-9d5e-09c14f9bf1ff",
"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": "075e86df-6b10-4399-969c-610f307d20bb",
"Name": "sample string 2",
"OrganizationId": "e3a8a6d9-a3c4-4d27-a159-1bc5dbffd950"
},
{
"Id": "075e86df-6b10-4399-969c-610f307d20bb",
"Name": "sample string 2",
"OrganizationId": "e3a8a6d9-a3c4-4d27-a159-1bc5dbffd950"
}
]
},
"CurrentState": {
"Id": "c7d553f1-33cf-438e-9819-de74c37df110",
"Name": "sample string 2"
},
"Organization": {
"Id": "d6c4992f-7984-4a2f-b156-7ea8c6c9de75",
"Name": "sample string 2",
"IconUrl": "sample string 3"
},
"WaitingOnRoles": [
{
"Id": "075e86df-6b10-4399-969c-610f307d20bb",
"Name": "sample string 2",
"OrganizationId": "e3a8a6d9-a3c4-4d27-a159-1bc5dbffd950"
},
{
"Id": "075e86df-6b10-4399-969c-610f307d20bb",
"Name": "sample string 2",
"OrganizationId": "e3a8a6d9-a3c4-4d27-a159-1bc5dbffd950"
}
],
"EntryTimestamp": "2026-03-30T23:16:44.6020007+00:00",
"ModifiedTimestamp": "2026-03-30T23:16:44.6020007+00:00",
"EventTimestamp": "2026-03-30T23:16:44.6020007+00:00",
"CompletedTransitions": 5,
"TotalTransitions": 6,
"Name": "sample string 7",
"OrganizationId": "bb664534-3524-4609-bd42-2c952610e69a",
"AvailableReports": [
{
"Id": "f350328a-b763-4aaa-a916-da5471a2e5c0",
"Name": "sample string 2"
},
{
"Id": "f350328a-b763-4aaa-a916-da5471a2e5c0",
"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>f350328a-b763-4aaa-a916-da5471a2e5c0</Id>
<Name>sample string 2</Name>
</ReportSimple>
<ReportSimple>
<Id>f350328a-b763-4aaa-a916-da5471a2e5c0</Id>
<Name>sample string 2</Name>
</ReportSimple>
</AvailableReports>
<CompletedTransitions>5</CompletedTransitions>
<CurrentState>
<Id>c7d553f1-33cf-438e-9819-de74c37df110</Id>
<Name>sample string 2</Name>
</CurrentState>
<EntryTimestamp xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
<d2p1:DateTime>2026-03-30T23:16:44.6020007Z</d2p1:DateTime>
<d2p1:OffsetMinutes>0</d2p1:OffsetMinutes>
</EntryTimestamp>
<EventTimestamp xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
<d2p1:DateTime>2026-03-30T23:16:44.6020007Z</d2p1:DateTime>
<d2p1:OffsetMinutes>0</d2p1:OffsetMinutes>
</EventTimestamp>
<FriendlyId>sample string 1</FriendlyId>
<Id>1d8b92ba-d439-4d7c-84db-df146062c4bb</Id>
<ModifiedTimestamp xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
<d2p1:DateTime>2026-03-30T23:16:44.6020007Z</d2p1:DateTime>
<d2p1:OffsetMinutes>0</d2p1:OffsetMinutes>
</ModifiedTimestamp>
<Name>sample string 7</Name>
<Organization>
<IconUrl>sample string 3</IconUrl>
<Id>d6c4992f-7984-4a2f-b156-7ea8c6c9de75</Id>
<Name>sample string 2</Name>
</Organization>
<OrganizationId>bb664534-3524-4609-bd42-2c952610e69a</OrganizationId>
<Owner>
<Email>sample string 6</Email>
<ExternalId>sample string 8</ExternalId>
<FirstName>sample string 3</FirstName>
<Id>babbcdf6-bd85-4410-9d5e-09c14f9bf1ff</Id>
<LastName>sample string 4</LastName>
<Phone>sample string 7</Phone>
<Roles>
<RoleSimple>
<Id>075e86df-6b10-4399-969c-610f307d20bb</Id>
<Name>sample string 2</Name>
<OrganizationId>e3a8a6d9-a3c4-4d27-a159-1bc5dbffd950</OrganizationId>
</RoleSimple>
<RoleSimple>
<Id>075e86df-6b10-4399-969c-610f307d20bb</Id>
<Name>sample string 2</Name>
<OrganizationId>e3a8a6d9-a3c4-4d27-a159-1bc5dbffd950</OrganizationId>
</RoleSimple>
</Roles>
<Title>sample string 5</Title>
<Username>sample string 2</Username>
</Owner>
<TotalTransitions>6</TotalTransitions>
<WaitingOnRoles>
<RoleSimple>
<Id>075e86df-6b10-4399-969c-610f307d20bb</Id>
<Name>sample string 2</Name>
<OrganizationId>e3a8a6d9-a3c4-4d27-a159-1bc5dbffd950</OrganizationId>
</RoleSimple>
<RoleSimple>
<Id>075e86df-6b10-4399-969c-610f307d20bb</Id>
<Name>sample string 2</Name>
<OrganizationId>e3a8a6d9-a3c4-4d27-a159-1bc5dbffd950</OrganizationId>
</RoleSimple>
</WaitingOnRoles>
</CaseSimple>