POST api/WorkflowAPIController/SubmitWorkflow

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
ListName	string	None.
ItemId	integer	None.
ListId	globally unique identifier	None.
SiteUrl	string	None.
CurrentUser	FormUser	None.
WebUrl	string	None.
terminatePreviousInstances	boolean	None.
WFTask	WFTask	None.
WorkflowEngine	string	None.
WFName	string	None.
IsRemove	boolean	None.
GroupItemId	string	None.
ApproverItemId	integer	None.
TIID	string	None.

Request Formats

application/json, text/json

Sample:

{
  "ListName": "sample string 1",
  "ItemId": 2,
  "ListId": "7490bdf2-52a2-4e1f-906e-bc23b69fbcab",
  "SiteUrl": "sample string 4",
  "CurrentUser": {
    "Id": 1,
    "Email": "sample string 2",
    "Username": "sample string 3",
    "DisplayName": "sample string 4",
    "PictureURL": "sample string 5"
  },
  "WebUrl": "sample string 5",
  "terminatePreviousInstances": true,
  "WFTask": {
    "TaskID": 1,
    "OutCome": "sample string 2",
    "TaskListName": "sample string 3",
    "ApproverComments": "sample string 4",
    "TaskName": "sample string 5",
    "AssignedTo": {
      "Id": 1,
      "Email": "sample string 2",
      "Username": "sample string 3",
      "DisplayName": "sample string 4",
      "PictureURL": "sample string 5"
    },
    "DelegatedTo": {
      "Id": 1,
      "Email": "sample string 2",
      "Username": "sample string 3",
      "DisplayName": "sample string 4",
      "PictureURL": "sample string 5"
    }
  },
  "WorkflowEngine": "sample string 7",
  "WFName": "sample string 8",
  "IsRemove": true,
  "GroupItemId": "sample string 10",
  "ApproverItemId": 11,
  "TIID": "sample string 12"
}

application/xml, text/xml

Sample:

<WorkflowContext xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Appvity.eOffice.Backend.Models">
  <ApproverItemId>11</ApproverItemId>
  <CurrentUser>
    <DisplayName>sample string 4</DisplayName>
    <Email>sample string 2</Email>
    <Id>1</Id>
    <PictureURL>sample string 5</PictureURL>
    <Username>sample string 3</Username>
  </CurrentUser>
  <GroupItemId>sample string 10</GroupItemId>
  <IsRemove>true</IsRemove>
  <ItemId>2</ItemId>
  <ListId>7490bdf2-52a2-4e1f-906e-bc23b69fbcab</ListId>
  <ListName>sample string 1</ListName>
  <SiteUrl>sample string 4</SiteUrl>
  <TIID>sample string 12</TIID>
  <WFName>sample string 8</WFName>
  <WFTask>
    <ApproverComments>sample string 4</ApproverComments>
    <AssignedTo>
      <DisplayName>sample string 4</DisplayName>
      <Email>sample string 2</Email>
      <Id>1</Id>
      <PictureURL>sample string 5</PictureURL>
      <Username>sample string 3</Username>
    </AssignedTo>
    <DelegatedTo>
      <DisplayName>sample string 4</DisplayName>
      <Email>sample string 2</Email>
      <Id>1</Id>
      <PictureURL>sample string 5</PictureURL>
      <Username>sample string 3</Username>
    </DelegatedTo>
    <OutCome>sample string 2</OutCome>
    <TaskID>1</TaskID>
    <TaskListName>sample string 3</TaskListName>
    <TaskName>sample string 5</TaskName>
  </WFTask>
  <WebUrl>sample string 5</WebUrl>
  <WorkflowEngine>sample string 7</WorkflowEngine>
  <terminatePreviousInstances>true</terminatePreviousInstances>
</WorkflowContext>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'WorkflowContext'.

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json, application/xml, text/xml

Sample:

Sample not available.