POST api/Forms/WorkflowStartedAction

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
Id	Collection of integer	None.
LoginName	Collection of string	None.
IsUseLoginName	boolean	None.
CopyRoleAssignments	boolean	None.
ClearSubscopes	boolean	None.
FormContext	FormContext	None.
RoleType	RoleType	None.

Request Formats

application/json, text/json

Sample:

{
  "Id": [
    1,
    2
  ],
  "LoginName": [
    "sample string 1",
    "sample string 2"
  ],
  "IsUseLoginName": true,
  "CopyRoleAssignments": true,
  "ClearSubscopes": true,
  "FormContext": {
    "DisplayMode": "sample string 1",
    "ListName": "sample string 2",
    "ListGuid": "2ff50ba2-8a68-470a-8315-93ec614f03dc",
    "HistoryListGuid": "ccff0f91-cda9-461b-ac2d-305f79c0f8d6",
    "ItemId": 5,
    "itemId": "sample string 6",
    "ItemUniqueId": "8b95fa66-d30e-44df-a830-c68f6c713a8f",
    "CurrentUser": {
      "Id": 1,
      "Email": "sample string 2",
      "Username": "sample string 3",
      "DisplayName": "sample string 4",
      "PictureURL": "sample string 5"
    },
    "WebRelativeUrl": "sample string 8",
    "RootSiteUrl": "sample string 9",
    "WebUrl": "sample string 10",
    "DiscussionListGuid": "6cfe32ae-4c64-45fc-b67e-a9c6a42ec169",
    "DocLibListGuid": "4f268e38-e44a-4e80-b205-121ca9c896dd",
    "Settings": {
      "BackendApiUrl": "sample string 1",
      "EOfficeDataSiteUrl": "sample string 2",
      "HTTMSiteURL": "sample string 3"
    },
    "FormItem": {
      "Id": 1,
      "UniqueId": "79ad48b9-f152-4efa-822a-76b9725d0271",
      "Title": "sample string 2",
      "Ref": "sample string 3",
      "Requester": {
        "Id": 1,
        "Email": "sample string 2",
        "Username": "sample string 3",
        "DisplayName": "sample string 4",
        "PictureURL": "sample string 5"
      },
      "FormCode": "sample string 4",
      "FormType": "sample string 5",
      "FormTemplate": "sample string 6",
      "FormNumber": "sample string 7",
      "FormTemplateID": 8,
      "FormTemplateWebGuid": "e59780bf-f530-4b6a-8d48-3798850ab2f9",
      "FormTemplateSiteGuid": "546df15b-0fa1-4055-8d32-c9ef11ca1ee7",
      "FormPublishedDate": "2026-05-07T20:26:53.9142728+07:00",
      "ApprovalStatus": "sample string 9",
      "CurrentApprovers": [
        {
          "Id": 1,
          "Email": "sample string 2",
          "Username": "sample string 3",
          "DisplayName": "sample string 4",
          "PictureURL": "sample string 5"
        },
        {
          "Id": 1,
          "Email": "sample string 2",
          "Username": "sample string 3",
          "DisplayName": "sample string 4",
          "PictureURL": "sample string 5"
        }
      ],
      "HistoryListGuid": "b39c53bf-ff5b-4d6b-bc21-be443665d8dc",
      "DiscussionListGuid": "5582560f-0592-40e6-8060-396a96d08ee6",
      "DocLibListGuid": "4aed2570-a5e6-423f-98b4-744935b91b2a",
      "FormCategory": "sample string 10",
      "Department": {
        "Label": "sample string 1",
        "TermGuid": "sample string 2",
        "WssId": 3,
        "TypeId": "{19e70ed0-4177-456b-8156-015e4d163ff8}"
      },
      "WFName": "sample string 11",
      "CurrentApproverDueDate": "2026-05-07T20:26:53.9142728+07:00",
      "SubmittedDate": "2026-05-07T20:26:53.9142728+07:00",
      "CurrentGroup": "sample string 12",
      "CurrentApproverJobTitle": "sample string 13",
      "SubmitCounter": 14,
      "EffectiveDate": "2026-05-07T20:26:53.9142728+07:00",
      "IsoNumber": "sample string 15",
      "HasTemplate": "sample string 16",
      "HasIsoNumber": "sample string 17",
      "Group": "sample string 18",
      "DepartmentCode": {},
      "FormSetItemID": "sample string 20",
      "RefDisplayHTML": "sample string 21",
      "MFItem": {
        "Id": 1,
        "Title": "sample string 2",
        "Ref": "sample string 3",
        "SiteGuid": "c34c8286-f7f0-4ad3-b88a-b54f44b011cc",
        "ListGuid": "ecdfe88c-efb0-491c-8404-4c4101325fc9",
        "WebGuid": "17174200-cb43-4ced-a7b1-3a518013e533",
        "ItemId": 7,
        "RefDisplayHTML": "sample string 8",
        "FormCode": "sample string 9",
        "WebUrl": "sample string 10",
        "FormType": "sample string 11"
      },
      "PRItemDetailListGuid": "06201f99-ba6e-421a-882a-56b4d01b5d18"
    },
    "ClearAdditionalItemOnly": true,
    "ClearApprovalGroup": true,
    "SiteGuid": "2a4d79bc-3fb6-43e8-9ab0-530c09e14d8d",
    "WebGuid": "b1cea3d3-5182-4b63-af26-a4df7bbf2f92",
    "SyncPermission": true,
    "ClearApprovalMatrix": true,
    "WFName": "sample string 18",
    "EOfficeDataSiteUrl": "sample string 19",
    "FormCode": "sample string 20",
    "FormType": "sample string 21",
    "KeyValue": "sample string 22",
    "IsGenerateApprovalMatrix": true
  },
  "RoleType": 0
}

application/xml, text/xml

Sample:

<ItemPermission xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Appvity.eOffice.Backend.Models">
  <ClearSubscopes>true</ClearSubscopes>
  <CopyRoleAssignments>true</CopyRoleAssignments>
  <FormContext>
    <ClearAdditionalItemOnly>true</ClearAdditionalItemOnly>
    <ClearApprovalGroup>true</ClearApprovalGroup>
    <ClearApprovalMatrix>true</ClearApprovalMatrix>
    <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>
    <DiscussionListGuid>6cfe32ae-4c64-45fc-b67e-a9c6a42ec169</DiscussionListGuid>
    <DisplayMode>sample string 1</DisplayMode>
    <DocLibListGuid>4f268e38-e44a-4e80-b205-121ca9c896dd</DocLibListGuid>
    <EOfficeDataSiteUrl>sample string 19</EOfficeDataSiteUrl>
    <FormCode>sample string 20</FormCode>
    <FormItem>
      <ApprovalStatus>sample string 9</ApprovalStatus>
      <CurrentApproverDueDate>2026-05-07T20:26:53.9142728+07:00</CurrentApproverDueDate>
      <CurrentApproverJobTitle>sample string 13</CurrentApproverJobTitle>
      <CurrentApprovers>
        <FormUser>
          <DisplayName>sample string 4</DisplayName>
          <Email>sample string 2</Email>
          <Id>1</Id>
          <PictureURL>sample string 5</PictureURL>
          <Username>sample string 3</Username>
        </FormUser>
        <FormUser>
          <DisplayName>sample string 4</DisplayName>
          <Email>sample string 2</Email>
          <Id>1</Id>
          <PictureURL>sample string 5</PictureURL>
          <Username>sample string 3</Username>
        </FormUser>
      </CurrentApprovers>
      <CurrentGroup>sample string 12</CurrentGroup>
      <Department xmlns:d4p1="http://schemas.datacontract.org/2004/07/Microsoft.SharePoint.Client.Taxonomy">
        <d4p1:Label>sample string 1</d4p1:Label>
        <d4p1:TermGuid>sample string 2</d4p1:TermGuid>
        <d4p1:WssId>3</d4p1:WssId>
      </Department>
      <DiscussionListGuid>5582560f-0592-40e6-8060-396a96d08ee6</DiscussionListGuid>
      <DocLibListGuid>4aed2570-a5e6-423f-98b4-744935b91b2a</DocLibListGuid>
      <EffectiveDate>2026-05-07T20:26:53.9142728+07:00</EffectiveDate>
      <FormCategory>sample string 10</FormCategory>
      <FormCode>sample string 4</FormCode>
      <FormNumber>sample string 7</FormNumber>
      <FormPublishedDate>2026-05-07T20:26:53.9142728+07:00</FormPublishedDate>
      <FormSetItemID>sample string 20</FormSetItemID>
      <FormTemplate>sample string 6</FormTemplate>
      <FormTemplateID>8</FormTemplateID>
      <FormTemplateSiteGuid>546df15b-0fa1-4055-8d32-c9ef11ca1ee7</FormTemplateSiteGuid>
      <FormTemplateWebGuid>e59780bf-f530-4b6a-8d48-3798850ab2f9</FormTemplateWebGuid>
      <FormType>sample string 5</FormType>
      <Group>sample string 18</Group>
      <HasIsoNumber>sample string 17</HasIsoNumber>
      <HasTemplate>sample string 16</HasTemplate>
      <HistoryListGuid>b39c53bf-ff5b-4d6b-bc21-be443665d8dc</HistoryListGuid>
      <Id>1</Id>
      <IsoNumber>sample string 15</IsoNumber>
      <MFItem xmlns:d4p1="http://schemas.datacontract.org/2004/07/Appvity.eOffice.Backend.Services.MFService">
        <d4p1:FormCode>sample string 9</d4p1:FormCode>
        <d4p1:FormType>sample string 11</d4p1:FormType>
        <d4p1:Id>1</d4p1:Id>
        <d4p1:ItemId>7</d4p1:ItemId>
        <d4p1:ListGuid>ecdfe88c-efb0-491c-8404-4c4101325fc9</d4p1:ListGuid>
        <d4p1:Ref>sample string 3</d4p1:Ref>
        <d4p1:RefDisplayHTML>sample string 8</d4p1:RefDisplayHTML>
        <d4p1:SiteGuid>c34c8286-f7f0-4ad3-b88a-b54f44b011cc</d4p1:SiteGuid>
        <d4p1:Title>sample string 2</d4p1:Title>
        <d4p1:WebGuid>17174200-cb43-4ced-a7b1-3a518013e533</d4p1:WebGuid>
        <d4p1:WebUrl>sample string 10</d4p1:WebUrl>
      </MFItem>
      <PRItemDetailListGuid>06201f99-ba6e-421a-882a-56b4d01b5d18</PRItemDetailListGuid>
      <Ref>sample string 3</Ref>
      <RefDisplayHTML>sample string 21</RefDisplayHTML>
      <Requester>
        <DisplayName>sample string 4</DisplayName>
        <Email>sample string 2</Email>
        <Id>1</Id>
        <PictureURL>sample string 5</PictureURL>
        <Username>sample string 3</Username>
      </Requester>
      <SubmitCounter>14</SubmitCounter>
      <SubmittedDate>2026-05-07T20:26:53.9142728+07:00</SubmittedDate>
      <Title>sample string 2</Title>
      <UniqueId>79ad48b9-f152-4efa-822a-76b9725d0271</UniqueId>
      <WFName>sample string 11</WFName>
    </FormItem>
    <FormType>sample string 21</FormType>
    <HistoryListGuid>ccff0f91-cda9-461b-ac2d-305f79c0f8d6</HistoryListGuid>
    <IsGenerateApprovalMatrix>true</IsGenerateApprovalMatrix>
    <ItemId>5</ItemId>
    <ItemUniqueId>8b95fa66-d30e-44df-a830-c68f6c713a8f</ItemUniqueId>
    <KeyValue>sample string 22</KeyValue>
    <ListGuid>2ff50ba2-8a68-470a-8315-93ec614f03dc</ListGuid>
    <ListName>sample string 2</ListName>
    <RootSiteUrl>sample string 9</RootSiteUrl>
    <Settings>
      <BackendApiUrl>sample string 1</BackendApiUrl>
      <EOfficeDataSiteUrl>sample string 2</EOfficeDataSiteUrl>
      <HTTMSiteURL>sample string 3</HTTMSiteURL>
    </Settings>
    <SiteGuid>2a4d79bc-3fb6-43e8-9ab0-530c09e14d8d</SiteGuid>
    <SyncPermission>true</SyncPermission>
    <WFName>sample string 18</WFName>
    <WebGuid>b1cea3d3-5182-4b63-af26-a4df7bbf2f92</WebGuid>
    <WebRelativeUrl>sample string 8</WebRelativeUrl>
    <WebUrl>sample string 10</WebUrl>
    <itemId>sample string 6</itemId>
  </FormContext>
  <Id xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </Id>
  <IsUseLoginName>true</IsUseLoginName>
  <LoginName xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </LoginName>
  <RoleType>None</RoleType>
</ItemPermission>

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 'ItemPermission'.

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

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

Sample:

Sample not available.