POST api/Forms/RemoveFormSetItemByRef

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
FormSetItemID	string	None.
ParentItem	integer	None.
RemoveItemRef	string	None.
FormContext	FormContext	None.
FormContextReplace	FormContext	None.

Request Formats

application/json, text/json

Sample:

{
  "FormSetItemID": "sample string 1",
  "ParentItem": 2,
  "RemoveItemRef": "sample string 3",
  "FormContext": {
    "DisplayMode": "sample string 1",
    "ListName": "sample string 2",
    "ListGuid": "a7f04cf0-4d86-4aa8-b644-3602dff2ddc9",
    "HistoryListGuid": "7935a2cb-2f23-4255-bef0-7c38a055b548",
    "ItemId": 5,
    "itemId": "sample string 6",
    "ItemUniqueId": "59e76566-fc27-4537-b854-335387aa214a",
    "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": "664fe34b-d4c9-4944-af30-be32c2805259",
    "DocLibListGuid": "60745210-b1cd-4141-80c4-2b47040735a3",
    "Settings": {
      "BackendApiUrl": "sample string 1",
      "EOfficeDataSiteUrl": "sample string 2",
      "HTTMSiteURL": "sample string 3"
    },
    "FormItem": {
      "Id": 1,
      "UniqueId": "887703a7-de7d-4751-885d-0b9c97973d1b",
      "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": "5e2a6c75-57d2-43d4-af5d-0473d550a7ca",
      "FormTemplateSiteGuid": "5d167b44-e336-4450-8b07-51708d27f0ab",
      "FormPublishedDate": "2026-05-07T20:24:49.2628795+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": "08509169-fde4-4424-9ee3-a0a170b322e0",
      "DiscussionListGuid": "88297688-f0d2-4ce2-9176-1643d010e990",
      "DocLibListGuid": "181cf1c8-a3b5-4bb2-bc44-6c8fd261c798",
      "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:24:49.2628795+07:00",
      "SubmittedDate": "2026-05-07T20:24:49.2628795+07:00",
      "CurrentGroup": "sample string 12",
      "CurrentApproverJobTitle": "sample string 13",
      "SubmitCounter": 14,
      "EffectiveDate": "2026-05-07T20:24:49.2628795+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": "77bfd713-d94d-4d3e-a35b-09e2736dd6a0",
        "ListGuid": "a8931584-3e41-4023-9a2f-269e4e2eb084",
        "WebGuid": "20c12fe1-41d8-4fc8-8ab8-73d5edc275ba",
        "ItemId": 7,
        "RefDisplayHTML": "sample string 8",
        "FormCode": "sample string 9",
        "WebUrl": "sample string 10",
        "FormType": "sample string 11"
      },
      "PRItemDetailListGuid": "b5d0a1da-30f3-4c7d-8916-fc3957c750d5"
    },
    "ClearAdditionalItemOnly": true,
    "ClearApprovalGroup": true,
    "SiteGuid": "f41c6c2f-a5ea-46c0-8a52-4371d235f494",
    "WebGuid": "d76581ef-8add-4d69-9319-eca963db007b",
    "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
  },
  "FormContextReplace": {
    "DisplayMode": "sample string 1",
    "ListName": "sample string 2",
    "ListGuid": "a7f04cf0-4d86-4aa8-b644-3602dff2ddc9",
    "HistoryListGuid": "7935a2cb-2f23-4255-bef0-7c38a055b548",
    "ItemId": 5,
    "itemId": "sample string 6",
    "ItemUniqueId": "59e76566-fc27-4537-b854-335387aa214a",
    "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": "664fe34b-d4c9-4944-af30-be32c2805259",
    "DocLibListGuid": "60745210-b1cd-4141-80c4-2b47040735a3",
    "Settings": {
      "BackendApiUrl": "sample string 1",
      "EOfficeDataSiteUrl": "sample string 2",
      "HTTMSiteURL": "sample string 3"
    },
    "FormItem": {
      "Id": 1,
      "UniqueId": "887703a7-de7d-4751-885d-0b9c97973d1b",
      "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": "5e2a6c75-57d2-43d4-af5d-0473d550a7ca",
      "FormTemplateSiteGuid": "5d167b44-e336-4450-8b07-51708d27f0ab",
      "FormPublishedDate": "2026-05-07T20:24:49.2628795+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": "08509169-fde4-4424-9ee3-a0a170b322e0",
      "DiscussionListGuid": "88297688-f0d2-4ce2-9176-1643d010e990",
      "DocLibListGuid": "181cf1c8-a3b5-4bb2-bc44-6c8fd261c798",
      "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:24:49.2628795+07:00",
      "SubmittedDate": "2026-05-07T20:24:49.2628795+07:00",
      "CurrentGroup": "sample string 12",
      "CurrentApproverJobTitle": "sample string 13",
      "SubmitCounter": 14,
      "EffectiveDate": "2026-05-07T20:24:49.2628795+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": "77bfd713-d94d-4d3e-a35b-09e2736dd6a0",
        "ListGuid": "a8931584-3e41-4023-9a2f-269e4e2eb084",
        "WebGuid": "20c12fe1-41d8-4fc8-8ab8-73d5edc275ba",
        "ItemId": 7,
        "RefDisplayHTML": "sample string 8",
        "FormCode": "sample string 9",
        "WebUrl": "sample string 10",
        "FormType": "sample string 11"
      },
      "PRItemDetailListGuid": "b5d0a1da-30f3-4c7d-8916-fc3957c750d5"
    },
    "ClearAdditionalItemOnly": true,
    "ClearApprovalGroup": true,
    "SiteGuid": "f41c6c2f-a5ea-46c0-8a52-4371d235f494",
    "WebGuid": "d76581ef-8add-4d69-9319-eca963db007b",
    "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
  }
}

application/xml, text/xml

Sample:

<FormSetData xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Appvity.eOffice.Backend.Models">
  <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>664fe34b-d4c9-4944-af30-be32c2805259</DiscussionListGuid>
    <DisplayMode>sample string 1</DisplayMode>
    <DocLibListGuid>60745210-b1cd-4141-80c4-2b47040735a3</DocLibListGuid>
    <EOfficeDataSiteUrl>sample string 19</EOfficeDataSiteUrl>
    <FormCode>sample string 20</FormCode>
    <FormItem>
      <ApprovalStatus>sample string 9</ApprovalStatus>
      <CurrentApproverDueDate>2026-05-07T20:24:49.2628795+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>88297688-f0d2-4ce2-9176-1643d010e990</DiscussionListGuid>
      <DocLibListGuid>181cf1c8-a3b5-4bb2-bc44-6c8fd261c798</DocLibListGuid>
      <EffectiveDate>2026-05-07T20:24:49.2628795+07:00</EffectiveDate>
      <FormCategory>sample string 10</FormCategory>
      <FormCode>sample string 4</FormCode>
      <FormNumber>sample string 7</FormNumber>
      <FormPublishedDate>2026-05-07T20:24:49.2628795+07:00</FormPublishedDate>
      <FormSetItemID>sample string 20</FormSetItemID>
      <FormTemplate>sample string 6</FormTemplate>
      <FormTemplateID>8</FormTemplateID>
      <FormTemplateSiteGuid>5d167b44-e336-4450-8b07-51708d27f0ab</FormTemplateSiteGuid>
      <FormTemplateWebGuid>5e2a6c75-57d2-43d4-af5d-0473d550a7ca</FormTemplateWebGuid>
      <FormType>sample string 5</FormType>
      <Group>sample string 18</Group>
      <HasIsoNumber>sample string 17</HasIsoNumber>
      <HasTemplate>sample string 16</HasTemplate>
      <HistoryListGuid>08509169-fde4-4424-9ee3-a0a170b322e0</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>a8931584-3e41-4023-9a2f-269e4e2eb084</d4p1:ListGuid>
        <d4p1:Ref>sample string 3</d4p1:Ref>
        <d4p1:RefDisplayHTML>sample string 8</d4p1:RefDisplayHTML>
        <d4p1:SiteGuid>77bfd713-d94d-4d3e-a35b-09e2736dd6a0</d4p1:SiteGuid>
        <d4p1:Title>sample string 2</d4p1:Title>
        <d4p1:WebGuid>20c12fe1-41d8-4fc8-8ab8-73d5edc275ba</d4p1:WebGuid>
        <d4p1:WebUrl>sample string 10</d4p1:WebUrl>
      </MFItem>
      <PRItemDetailListGuid>b5d0a1da-30f3-4c7d-8916-fc3957c750d5</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:24:49.2628795+07:00</SubmittedDate>
      <Title>sample string 2</Title>
      <UniqueId>887703a7-de7d-4751-885d-0b9c97973d1b</UniqueId>
      <WFName>sample string 11</WFName>
    </FormItem>
    <FormType>sample string 21</FormType>
    <HistoryListGuid>7935a2cb-2f23-4255-bef0-7c38a055b548</HistoryListGuid>
    <IsGenerateApprovalMatrix>true</IsGenerateApprovalMatrix>
    <ItemId>5</ItemId>
    <ItemUniqueId>59e76566-fc27-4537-b854-335387aa214a</ItemUniqueId>
    <KeyValue>sample string 22</KeyValue>
    <ListGuid>a7f04cf0-4d86-4aa8-b644-3602dff2ddc9</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>f41c6c2f-a5ea-46c0-8a52-4371d235f494</SiteGuid>
    <SyncPermission>true</SyncPermission>
    <WFName>sample string 18</WFName>
    <WebGuid>d76581ef-8add-4d69-9319-eca963db007b</WebGuid>
    <WebRelativeUrl>sample string 8</WebRelativeUrl>
    <WebUrl>sample string 10</WebUrl>
    <itemId>sample string 6</itemId>
  </FormContext>
  <FormContextReplace>
    <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>664fe34b-d4c9-4944-af30-be32c2805259</DiscussionListGuid>
    <DisplayMode>sample string 1</DisplayMode>
    <DocLibListGuid>60745210-b1cd-4141-80c4-2b47040735a3</DocLibListGuid>
    <EOfficeDataSiteUrl>sample string 19</EOfficeDataSiteUrl>
    <FormCode>sample string 20</FormCode>
    <FormItem>
      <ApprovalStatus>sample string 9</ApprovalStatus>
      <CurrentApproverDueDate>2026-05-07T20:24:49.2628795+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>88297688-f0d2-4ce2-9176-1643d010e990</DiscussionListGuid>
      <DocLibListGuid>181cf1c8-a3b5-4bb2-bc44-6c8fd261c798</DocLibListGuid>
      <EffectiveDate>2026-05-07T20:24:49.2628795+07:00</EffectiveDate>
      <FormCategory>sample string 10</FormCategory>
      <FormCode>sample string 4</FormCode>
      <FormNumber>sample string 7</FormNumber>
      <FormPublishedDate>2026-05-07T20:24:49.2628795+07:00</FormPublishedDate>
      <FormSetItemID>sample string 20</FormSetItemID>
      <FormTemplate>sample string 6</FormTemplate>
      <FormTemplateID>8</FormTemplateID>
      <FormTemplateSiteGuid>5d167b44-e336-4450-8b07-51708d27f0ab</FormTemplateSiteGuid>
      <FormTemplateWebGuid>5e2a6c75-57d2-43d4-af5d-0473d550a7ca</FormTemplateWebGuid>
      <FormType>sample string 5</FormType>
      <Group>sample string 18</Group>
      <HasIsoNumber>sample string 17</HasIsoNumber>
      <HasTemplate>sample string 16</HasTemplate>
      <HistoryListGuid>08509169-fde4-4424-9ee3-a0a170b322e0</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>a8931584-3e41-4023-9a2f-269e4e2eb084</d4p1:ListGuid>
        <d4p1:Ref>sample string 3</d4p1:Ref>
        <d4p1:RefDisplayHTML>sample string 8</d4p1:RefDisplayHTML>
        <d4p1:SiteGuid>77bfd713-d94d-4d3e-a35b-09e2736dd6a0</d4p1:SiteGuid>
        <d4p1:Title>sample string 2</d4p1:Title>
        <d4p1:WebGuid>20c12fe1-41d8-4fc8-8ab8-73d5edc275ba</d4p1:WebGuid>
        <d4p1:WebUrl>sample string 10</d4p1:WebUrl>
      </MFItem>
      <PRItemDetailListGuid>b5d0a1da-30f3-4c7d-8916-fc3957c750d5</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:24:49.2628795+07:00</SubmittedDate>
      <Title>sample string 2</Title>
      <UniqueId>887703a7-de7d-4751-885d-0b9c97973d1b</UniqueId>
      <WFName>sample string 11</WFName>
    </FormItem>
    <FormType>sample string 21</FormType>
    <HistoryListGuid>7935a2cb-2f23-4255-bef0-7c38a055b548</HistoryListGuid>
    <IsGenerateApprovalMatrix>true</IsGenerateApprovalMatrix>
    <ItemId>5</ItemId>
    <ItemUniqueId>59e76566-fc27-4537-b854-335387aa214a</ItemUniqueId>
    <KeyValue>sample string 22</KeyValue>
    <ListGuid>a7f04cf0-4d86-4aa8-b644-3602dff2ddc9</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>f41c6c2f-a5ea-46c0-8a52-4371d235f494</SiteGuid>
    <SyncPermission>true</SyncPermission>
    <WFName>sample string 18</WFName>
    <WebGuid>d76581ef-8add-4d69-9319-eca963db007b</WebGuid>
    <WebRelativeUrl>sample string 8</WebRelativeUrl>
    <WebUrl>sample string 10</WebUrl>
    <itemId>sample string 6</itemId>
  </FormContextReplace>
  <FormSetItemID>sample string 1</FormSetItemID>
  <ParentItem>2</ParentItem>
  <RemoveItemRef>sample string 3</RemoveItemRef>
</FormSetData>

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

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

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

Sample:

Sample not available.