POST api/Cases?transitionId={transitionId}

Create a case from the data in CaseSimple If no transitionId is supplied, use the first "Create" transition If a transitionId is supplied, use that if it is a "Create" transition

Request Information

URI Parameters

Name	Description	Type	Additional information
transitionId	Optional, the particular transition to use to create the case	globally unique identifier	None.

Body Parameters

The Name and OrganizationId to create a new case for

CaseSimple

Name	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.

Request Formats

application/json, text/json

Sample:

{
  "Id": "823939b3-a84f-45c2-ad65-c52491a339bd",
  "FriendlyId": "sample string 1",
  "Owner": {
    "Id": "23499b75-37f1-40f5-bd86-6353c56156ea",
    "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": "bb4f6642-710c-4546-b63b-7647fa462035",
        "Name": "sample string 2",
        "OrganizationId": "7ef6f92e-e2ac-4c47-8350-2988c0401552"
      },
      {
        "Id": "bb4f6642-710c-4546-b63b-7647fa462035",
        "Name": "sample string 2",
        "OrganizationId": "7ef6f92e-e2ac-4c47-8350-2988c0401552"
      }
    ]
  },
  "CurrentState": {
    "Id": "9641c170-141e-4ccc-86c1-699e044e6ff8",
    "Name": "sample string 2"
  },
  "Organization": {
    "Id": "5fd2173d-81a1-4d96-b545-a00e1dcdbf6d",
    "Name": "sample string 2",
    "IconUrl": "sample string 3"
  },
  "WaitingOnRoles": [
    {
      "Id": "bb4f6642-710c-4546-b63b-7647fa462035",
      "Name": "sample string 2",
      "OrganizationId": "7ef6f92e-e2ac-4c47-8350-2988c0401552"
    },
    {
      "Id": "bb4f6642-710c-4546-b63b-7647fa462035",
      "Name": "sample string 2",
      "OrganizationId": "7ef6f92e-e2ac-4c47-8350-2988c0401552"
    }
  ],
  "EntryTimestamp": "2025-12-12T16:35:29.4687579+00:00",
  "ModifiedTimestamp": "2025-12-12T16:35:29.4687579+00:00",
  "EventTimestamp": "2025-12-12T16:35:29.4687579+00:00",
  "CompletedTransitions": 5,
  "TotalTransitions": 6,
  "Name": "sample string 7",
  "OrganizationId": "e30aa15d-d39b-4002-a137-4a59654a2d62",
  "AvailableReports": [
    {
      "Id": "94d67506-3973-4bb3-9ad7-ad7ba47140e4",
      "Name": "sample string 2"
    },
    {
      "Id": "94d67506-3973-4bb3-9ad7-ad7ba47140e4",
      "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>94d67506-3973-4bb3-9ad7-ad7ba47140e4</Id>
      <Name>sample string 2</Name>
    </ReportSimple>
    <ReportSimple>
      <Id>94d67506-3973-4bb3-9ad7-ad7ba47140e4</Id>
      <Name>sample string 2</Name>
    </ReportSimple>
  </AvailableReports>
  <CompletedTransitions>5</CompletedTransitions>
  <CurrentState>
    <Id>9641c170-141e-4ccc-86c1-699e044e6ff8</Id>
    <Name>sample string 2</Name>
  </CurrentState>
  <EntryTimestamp xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:DateTime>2025-12-12T16:35:29.4687579Z</d2p1:DateTime>
    <d2p1:OffsetMinutes>0</d2p1:OffsetMinutes>
  </EntryTimestamp>
  <EventTimestamp xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:DateTime>2025-12-12T16:35:29.4687579Z</d2p1:DateTime>
    <d2p1:OffsetMinutes>0</d2p1:OffsetMinutes>
  </EventTimestamp>
  <FriendlyId>sample string 1</FriendlyId>
  <Id>823939b3-a84f-45c2-ad65-c52491a339bd</Id>
  <ModifiedTimestamp xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:DateTime>2025-12-12T16:35:29.4687579Z</d2p1:DateTime>
    <d2p1:OffsetMinutes>0</d2p1:OffsetMinutes>
  </ModifiedTimestamp>
  <Name>sample string 7</Name>
  <Organization>
    <IconUrl>sample string 3</IconUrl>
    <Id>5fd2173d-81a1-4d96-b545-a00e1dcdbf6d</Id>
    <Name>sample string 2</Name>
  </Organization>
  <OrganizationId>e30aa15d-d39b-4002-a137-4a59654a2d62</OrganizationId>
  <Owner>
    <Email>sample string 6</Email>
    <ExternalId>sample string 8</ExternalId>
    <FirstName>sample string 3</FirstName>
    <Id>23499b75-37f1-40f5-bd86-6353c56156ea</Id>
    <LastName>sample string 4</LastName>
    <Phone>sample string 7</Phone>
    <Roles>
      <RoleSimple>
        <Id>bb4f6642-710c-4546-b63b-7647fa462035</Id>
        <Name>sample string 2</Name>
        <OrganizationId>7ef6f92e-e2ac-4c47-8350-2988c0401552</OrganizationId>
      </RoleSimple>
      <RoleSimple>
        <Id>bb4f6642-710c-4546-b63b-7647fa462035</Id>
        <Name>sample string 2</Name>
        <OrganizationId>7ef6f92e-e2ac-4c47-8350-2988c0401552</OrganizationId>
      </RoleSimple>
    </Roles>
    <Title>sample string 5</Title>
    <Username>sample string 2</Username>
  </Owner>
  <TotalTransitions>6</TotalTransitions>
  <WaitingOnRoles>
    <RoleSimple>
      <Id>bb4f6642-710c-4546-b63b-7647fa462035</Id>
      <Name>sample string 2</Name>
      <OrganizationId>7ef6f92e-e2ac-4c47-8350-2988c0401552</OrganizationId>
    </RoleSimple>
    <RoleSimple>
      <Id>bb4f6642-710c-4546-b63b-7647fa462035</Id>
      <Name>sample string 2</Name>
      <OrganizationId>7ef6f92e-e2ac-4c47-8350-2988c0401552</OrganizationId>
    </RoleSimple>
  </WaitingOnRoles>
</CaseSimple>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

CaseSimple

Name	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": "76b973c9-d40e-4b08-9c05-69bcd38a2725",
  "FriendlyId": "sample string 1",
  "Owner": {
    "Id": "dfdfd74b-9ea5-4111-8787-f961fc676a4a",
    "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": "c479e180-ac3b-4f8a-9b54-26212d03fa59",
        "Name": "sample string 2",
        "OrganizationId": "80ad08c7-4c62-450f-b0a3-1f627b878820"
      },
      {
        "Id": "c479e180-ac3b-4f8a-9b54-26212d03fa59",
        "Name": "sample string 2",
        "OrganizationId": "80ad08c7-4c62-450f-b0a3-1f627b878820"
      }
    ]
  },
  "CurrentState": {
    "Id": "6a72e87f-8244-486f-a8f8-9d32d003b5f8",
    "Name": "sample string 2"
  },
  "Organization": {
    "Id": "a66594fa-196b-4779-84da-4c7ba3b1991d",
    "Name": "sample string 2",
    "IconUrl": "sample string 3"
  },
  "WaitingOnRoles": [
    {
      "Id": "c479e180-ac3b-4f8a-9b54-26212d03fa59",
      "Name": "sample string 2",
      "OrganizationId": "80ad08c7-4c62-450f-b0a3-1f627b878820"
    },
    {
      "Id": "c479e180-ac3b-4f8a-9b54-26212d03fa59",
      "Name": "sample string 2",
      "OrganizationId": "80ad08c7-4c62-450f-b0a3-1f627b878820"
    }
  ],
  "EntryTimestamp": "2025-12-12T16:35:29.4687579+00:00",
  "ModifiedTimestamp": "2025-12-12T16:35:29.4687579+00:00",
  "EventTimestamp": "2025-12-12T16:35:29.4687579+00:00",
  "CompletedTransitions": 5,
  "TotalTransitions": 6,
  "Name": "sample string 7",
  "OrganizationId": "0d7779c2-48e8-4298-9749-103103fc0088",
  "AvailableReports": [
    {
      "Id": "50ed0d03-df71-4f33-ad27-ac80aeff5152",
      "Name": "sample string 2"
    },
    {
      "Id": "50ed0d03-df71-4f33-ad27-ac80aeff5152",
      "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>50ed0d03-df71-4f33-ad27-ac80aeff5152</Id>
      <Name>sample string 2</Name>
    </ReportSimple>
    <ReportSimple>
      <Id>50ed0d03-df71-4f33-ad27-ac80aeff5152</Id>
      <Name>sample string 2</Name>
    </ReportSimple>
  </AvailableReports>
  <CompletedTransitions>5</CompletedTransitions>
  <CurrentState>
    <Id>6a72e87f-8244-486f-a8f8-9d32d003b5f8</Id>
    <Name>sample string 2</Name>
  </CurrentState>
  <EntryTimestamp xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:DateTime>2025-12-12T16:35:29.4687579Z</d2p1:DateTime>
    <d2p1:OffsetMinutes>0</d2p1:OffsetMinutes>
  </EntryTimestamp>
  <EventTimestamp xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:DateTime>2025-12-12T16:35:29.4687579Z</d2p1:DateTime>
    <d2p1:OffsetMinutes>0</d2p1:OffsetMinutes>
  </EventTimestamp>
  <FriendlyId>sample string 1</FriendlyId>
  <Id>76b973c9-d40e-4b08-9c05-69bcd38a2725</Id>
  <ModifiedTimestamp xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:DateTime>2025-12-12T16:35:29.4687579Z</d2p1:DateTime>
    <d2p1:OffsetMinutes>0</d2p1:OffsetMinutes>
  </ModifiedTimestamp>
  <Name>sample string 7</Name>
  <Organization>
    <IconUrl>sample string 3</IconUrl>
    <Id>a66594fa-196b-4779-84da-4c7ba3b1991d</Id>
    <Name>sample string 2</Name>
  </Organization>
  <OrganizationId>0d7779c2-48e8-4298-9749-103103fc0088</OrganizationId>
  <Owner>
    <Email>sample string 6</Email>
    <ExternalId>sample string 8</ExternalId>
    <FirstName>sample string 3</FirstName>
    <Id>dfdfd74b-9ea5-4111-8787-f961fc676a4a</Id>
    <LastName>sample string 4</LastName>
    <Phone>sample string 7</Phone>
    <Roles>
      <RoleSimple>
        <Id>c479e180-ac3b-4f8a-9b54-26212d03fa59</Id>
        <Name>sample string 2</Name>
        <OrganizationId>80ad08c7-4c62-450f-b0a3-1f627b878820</OrganizationId>
      </RoleSimple>
      <RoleSimple>
        <Id>c479e180-ac3b-4f8a-9b54-26212d03fa59</Id>
        <Name>sample string 2</Name>
        <OrganizationId>80ad08c7-4c62-450f-b0a3-1f627b878820</OrganizationId>
      </RoleSimple>
    </Roles>
    <Title>sample string 5</Title>
    <Username>sample string 2</Username>
  </Owner>
  <TotalTransitions>6</TotalTransitions>
  <WaitingOnRoles>
    <RoleSimple>
      <Id>c479e180-ac3b-4f8a-9b54-26212d03fa59</Id>
      <Name>sample string 2</Name>
      <OrganizationId>80ad08c7-4c62-450f-b0a3-1f627b878820</OrganizationId>
    </RoleSimple>
    <RoleSimple>
      <Id>c479e180-ac3b-4f8a-9b54-26212d03fa59</Id>
      <Name>sample string 2</Name>
      <OrganizationId>80ad08c7-4c62-450f-b0a3-1f627b878820</OrganizationId>
    </RoleSimple>
  </WaitingOnRoles>
</CaseSimple>