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": "94c851a0-0037-4827-89eb-f3e1c847b829",
"FriendlyId": "sample string 1",
"Owner": {
"Id": "e885b2ef-e872-461f-a0b3-85ea292cc91a",
"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": "b5feb022-8c95-47f8-a5ce-ff34be4a141c",
"Name": "sample string 2",
"OrganizationId": "f0a006fe-ea9d-42e4-972e-ef757fe55ad4"
},
{
"Id": "b5feb022-8c95-47f8-a5ce-ff34be4a141c",
"Name": "sample string 2",
"OrganizationId": "f0a006fe-ea9d-42e4-972e-ef757fe55ad4"
}
]
},
"CurrentState": {
"Id": "0423bfc1-4694-4821-bff0-7983682d8422",
"Name": "sample string 2"
},
"Organization": {
"Id": "805244f3-5aa5-4c4b-8c34-cd001f8ab4be",
"Name": "sample string 2",
"IconUrl": "sample string 3"
},
"WaitingOnRoles": [
{
"Id": "b5feb022-8c95-47f8-a5ce-ff34be4a141c",
"Name": "sample string 2",
"OrganizationId": "f0a006fe-ea9d-42e4-972e-ef757fe55ad4"
},
{
"Id": "b5feb022-8c95-47f8-a5ce-ff34be4a141c",
"Name": "sample string 2",
"OrganizationId": "f0a006fe-ea9d-42e4-972e-ef757fe55ad4"
}
],
"EntryTimestamp": "2025-12-14T19:14:18.466784+00:00",
"ModifiedTimestamp": "2025-12-14T19:14:18.466784+00:00",
"EventTimestamp": "2025-12-14T19:14:18.466784+00:00",
"CompletedTransitions": 5,
"TotalTransitions": 6,
"Name": "sample string 7",
"OrganizationId": "df00ff3a-7a39-4da4-a62c-bab6c314d786",
"AvailableReports": [
{
"Id": "f22122af-2cb3-472b-b4fc-abe1e7f9acf9",
"Name": "sample string 2"
},
{
"Id": "f22122af-2cb3-472b-b4fc-abe1e7f9acf9",
"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>f22122af-2cb3-472b-b4fc-abe1e7f9acf9</Id>
<Name>sample string 2</Name>
</ReportSimple>
<ReportSimple>
<Id>f22122af-2cb3-472b-b4fc-abe1e7f9acf9</Id>
<Name>sample string 2</Name>
</ReportSimple>
</AvailableReports>
<CompletedTransitions>5</CompletedTransitions>
<CurrentState>
<Id>0423bfc1-4694-4821-bff0-7983682d8422</Id>
<Name>sample string 2</Name>
</CurrentState>
<EntryTimestamp xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
<d2p1:DateTime>2025-12-14T19:14:18.466784Z</d2p1:DateTime>
<d2p1:OffsetMinutes>0</d2p1:OffsetMinutes>
</EntryTimestamp>
<EventTimestamp xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
<d2p1:DateTime>2025-12-14T19:14:18.466784Z</d2p1:DateTime>
<d2p1:OffsetMinutes>0</d2p1:OffsetMinutes>
</EventTimestamp>
<FriendlyId>sample string 1</FriendlyId>
<Id>94c851a0-0037-4827-89eb-f3e1c847b829</Id>
<ModifiedTimestamp xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
<d2p1:DateTime>2025-12-14T19:14:18.466784Z</d2p1:DateTime>
<d2p1:OffsetMinutes>0</d2p1:OffsetMinutes>
</ModifiedTimestamp>
<Name>sample string 7</Name>
<Organization>
<IconUrl>sample string 3</IconUrl>
<Id>805244f3-5aa5-4c4b-8c34-cd001f8ab4be</Id>
<Name>sample string 2</Name>
</Organization>
<OrganizationId>df00ff3a-7a39-4da4-a62c-bab6c314d786</OrganizationId>
<Owner>
<Email>sample string 6</Email>
<ExternalId>sample string 8</ExternalId>
<FirstName>sample string 3</FirstName>
<Id>e885b2ef-e872-461f-a0b3-85ea292cc91a</Id>
<LastName>sample string 4</LastName>
<Phone>sample string 7</Phone>
<Roles>
<RoleSimple>
<Id>b5feb022-8c95-47f8-a5ce-ff34be4a141c</Id>
<Name>sample string 2</Name>
<OrganizationId>f0a006fe-ea9d-42e4-972e-ef757fe55ad4</OrganizationId>
</RoleSimple>
<RoleSimple>
<Id>b5feb022-8c95-47f8-a5ce-ff34be4a141c</Id>
<Name>sample string 2</Name>
<OrganizationId>f0a006fe-ea9d-42e4-972e-ef757fe55ad4</OrganizationId>
</RoleSimple>
</Roles>
<Title>sample string 5</Title>
<Username>sample string 2</Username>
</Owner>
<TotalTransitions>6</TotalTransitions>
<WaitingOnRoles>
<RoleSimple>
<Id>b5feb022-8c95-47f8-a5ce-ff34be4a141c</Id>
<Name>sample string 2</Name>
<OrganizationId>f0a006fe-ea9d-42e4-972e-ef757fe55ad4</OrganizationId>
</RoleSimple>
<RoleSimple>
<Id>b5feb022-8c95-47f8-a5ce-ff34be4a141c</Id>
<Name>sample string 2</Name>
<OrganizationId>f0a006fe-ea9d-42e4-972e-ef757fe55ad4</OrganizationId>
</RoleSimple>
</WaitingOnRoles>
</CaseSimple>