POST api/Forms/AddFormSetItemVendor

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": "8d4f42e7-edc2-459c-a73c-2378baf8bb7a",
    "HistoryListGuid": "777c3b27-707a-4aa0-a04c-6c62951b2427",
    "ItemId": 5,
    "itemId": "sample string 6",
    "ItemUniqueId": "4feafd62-cf33-4e55-a1ca-ba431a53e133",
    "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": "7b3e233d-8dfe-44cb-a564-747089e14114",
    "DocLibListGuid": "6b4e1a12-ed7c-4e94-904a-196f8884c730",
    "Settings": {
      "BackendApiUrl": "sample string 1",
      "EOfficeDataSiteUrl": "sample string 2",
      "HTTMSiteURL": "sample string 3"
    },
    "FormItem": {
      "Id": 1,
      "UniqueId": "c1e8b422-bb33-490c-8744-38cd54e32585",
      "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": "fed0dcb2-ebc9-440f-b2a8-797e65115fed",
      "FormTemplateSiteGuid": "a674be48-d4e0-41f4-84e5-0061c4807948",
      "FormPublishedDate": "2025-09-11T09:53:38.466644+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": "d1df5382-0f57-488f-9781-a99ca705fb9e",
      "DiscussionListGuid": "42b60b4f-cd23-4456-ad01-c207a10189e5",
      "DocLibListGuid": "48eb0766-7c0d-45eb-9778-6c891a89098c",
      "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": "2025-09-11T09:53:38.466644+07:00",
      "SubmittedDate": "2025-09-11T09:53:38.466644+07:00",
      "CurrentGroup": "sample string 12",
      "CurrentApproverJobTitle": "sample string 13",
      "SubmitCounter": 14,
      "EffectiveDate": "2025-09-11T09:53:38.466644+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": "90ab97fe-f2d7-42e6-9a88-78eaa1453e39",
        "ListGuid": "199214f6-4e1c-43a6-8eac-64b5e442f470",
        "WebGuid": "67907b48-8342-42c0-b5cd-a14dffcef354",
        "ItemId": 7,
        "RefDisplayHTML": "sample string 8",
        "FormCode": "sample string 9",
        "WebUrl": "sample string 10",
        "FormType": "sample string 11"
      },
      "PRItemDetailListGuid": "340810e1-5c86-4bb1-a6ed-4744f7321622"
    },
    "ClearAdditionalItemOnly": true,
    "ClearApprovalGroup": true,
    "SiteGuid": "082e823c-357b-4634-b713-027638166ff3",
    "WebGuid": "52775a69-3a07-496a-9d41-5a3ca3ac623d",
    "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": "8d4f42e7-edc2-459c-a73c-2378baf8bb7a",
    "HistoryListGuid": "777c3b27-707a-4aa0-a04c-6c62951b2427",
    "ItemId": 5,
    "itemId": "sample string 6",
    "ItemUniqueId": "4feafd62-cf33-4e55-a1ca-ba431a53e133",
    "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": "7b3e233d-8dfe-44cb-a564-747089e14114",
    "DocLibListGuid": "6b4e1a12-ed7c-4e94-904a-196f8884c730",
    "Settings": {
      "BackendApiUrl": "sample string 1",
      "EOfficeDataSiteUrl": "sample string 2",
      "HTTMSiteURL": "sample string 3"
    },
    "FormItem": {
      "Id": 1,
      "UniqueId": "c1e8b422-bb33-490c-8744-38cd54e32585",
      "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": "fed0dcb2-ebc9-440f-b2a8-797e65115fed",
      "FormTemplateSiteGuid": "a674be48-d4e0-41f4-84e5-0061c4807948",
      "FormPublishedDate": "2025-09-11T09:53:38.466644+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": "d1df5382-0f57-488f-9781-a99ca705fb9e",
      "DiscussionListGuid": "42b60b4f-cd23-4456-ad01-c207a10189e5",
      "DocLibListGuid": "48eb0766-7c0d-45eb-9778-6c891a89098c",
      "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": "2025-09-11T09:53:38.466644+07:00",
      "SubmittedDate": "2025-09-11T09:53:38.466644+07:00",
      "CurrentGroup": "sample string 12",
      "CurrentApproverJobTitle": "sample string 13",
      "SubmitCounter": 14,
      "EffectiveDate": "2025-09-11T09:53:38.466644+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": "90ab97fe-f2d7-42e6-9a88-78eaa1453e39",
        "ListGuid": "199214f6-4e1c-43a6-8eac-64b5e442f470",
        "WebGuid": "67907b48-8342-42c0-b5cd-a14dffcef354",
        "ItemId": 7,
        "RefDisplayHTML": "sample string 8",
        "FormCode": "sample string 9",
        "WebUrl": "sample string 10",
        "FormType": "sample string 11"
      },
      "PRItemDetailListGuid": "340810e1-5c86-4bb1-a6ed-4744f7321622"
    },
    "ClearAdditionalItemOnly": true,
    "ClearApprovalGroup": true,
    "SiteGuid": "082e823c-357b-4634-b713-027638166ff3",
    "WebGuid": "52775a69-3a07-496a-9d41-5a3ca3ac623d",
    "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>7b3e233d-8dfe-44cb-a564-747089e14114</DiscussionListGuid>
    <DisplayMode>sample string 1</DisplayMode>
    <DocLibListGuid>6b4e1a12-ed7c-4e94-904a-196f8884c730</DocLibListGuid>
    <EOfficeDataSiteUrl>sample string 19</EOfficeDataSiteUrl>
    <FormCode>sample string 20</FormCode>
    <FormItem>
      <ApprovalStatus>sample string 9</ApprovalStatus>
      <CurrentApproverDueDate>2025-09-11T09:53:38.466644+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>42b60b4f-cd23-4456-ad01-c207a10189e5</DiscussionListGuid>
      <DocLibListGuid>48eb0766-7c0d-45eb-9778-6c891a89098c</DocLibListGuid>
      <EffectiveDate>2025-09-11T09:53:38.466644+07:00</EffectiveDate>
      <FormCategory>sample string 10</FormCategory>
      <FormCode>sample string 4</FormCode>
      <FormNumber>sample string 7</FormNumber>
      <FormPublishedDate>2025-09-11T09:53:38.466644+07:00</FormPublishedDate>
      <FormSetItemID>sample string 20</FormSetItemID>
      <FormTemplate>sample string 6</FormTemplate>
      <FormTemplateID>8</FormTemplateID>
      <FormTemplateSiteGuid>a674be48-d4e0-41f4-84e5-0061c4807948</FormTemplateSiteGuid>
      <FormTemplateWebGuid>fed0dcb2-ebc9-440f-b2a8-797e65115fed</FormTemplateWebGuid>
      <FormType>sample string 5</FormType>
      <Group>sample string 18</Group>
      <HasIsoNumber>sample string 17</HasIsoNumber>
      <HasTemplate>sample string 16</HasTemplate>
      <HistoryListGuid>d1df5382-0f57-488f-9781-a99ca705fb9e</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>199214f6-4e1c-43a6-8eac-64b5e442f470</d4p1:ListGuid>
        <d4p1:Ref>sample string 3</d4p1:Ref>
        <d4p1:RefDisplayHTML>sample string 8</d4p1:RefDisplayHTML>
        <d4p1:SiteGuid>90ab97fe-f2d7-42e6-9a88-78eaa1453e39</d4p1:SiteGuid>
        <d4p1:Title>sample string 2</d4p1:Title>
        <d4p1:WebGuid>67907b48-8342-42c0-b5cd-a14dffcef354</d4p1:WebGuid>
        <d4p1:WebUrl>sample string 10</d4p1:WebUrl>
      </MFItem>
      <PRItemDetailListGuid>340810e1-5c86-4bb1-a6ed-4744f7321622</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>2025-09-11T09:53:38.466644+07:00</SubmittedDate>
      <Title>sample string 2</Title>
      <UniqueId>c1e8b422-bb33-490c-8744-38cd54e32585</UniqueId>
      <WFName>sample string 11</WFName>
    </FormItem>
    <FormType>sample string 21</FormType>
    <HistoryListGuid>777c3b27-707a-4aa0-a04c-6c62951b2427</HistoryListGuid>
    <IsGenerateApprovalMatrix>true</IsGenerateApprovalMatrix>
    <ItemId>5</ItemId>
    <ItemUniqueId>4feafd62-cf33-4e55-a1ca-ba431a53e133</ItemUniqueId>
    <KeyValue>sample string 22</KeyValue>
    <ListGuid>8d4f42e7-edc2-459c-a73c-2378baf8bb7a</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>082e823c-357b-4634-b713-027638166ff3</SiteGuid>
    <SyncPermission>true</SyncPermission>
    <WFName>sample string 18</WFName>
    <WebGuid>52775a69-3a07-496a-9d41-5a3ca3ac623d</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>7b3e233d-8dfe-44cb-a564-747089e14114</DiscussionListGuid>
    <DisplayMode>sample string 1</DisplayMode>
    <DocLibListGuid>6b4e1a12-ed7c-4e94-904a-196f8884c730</DocLibListGuid>
    <EOfficeDataSiteUrl>sample string 19</EOfficeDataSiteUrl>
    <FormCode>sample string 20</FormCode>
    <FormItem>
      <ApprovalStatus>sample string 9</ApprovalStatus>
      <CurrentApproverDueDate>2025-09-11T09:53:38.466644+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>42b60b4f-cd23-4456-ad01-c207a10189e5</DiscussionListGuid>
      <DocLibListGuid>48eb0766-7c0d-45eb-9778-6c891a89098c</DocLibListGuid>
      <EffectiveDate>2025-09-11T09:53:38.466644+07:00</EffectiveDate>
      <FormCategory>sample string 10</FormCategory>
      <FormCode>sample string 4</FormCode>
      <FormNumber>sample string 7</FormNumber>
      <FormPublishedDate>2025-09-11T09:53:38.466644+07:00</FormPublishedDate>
      <FormSetItemID>sample string 20</FormSetItemID>
      <FormTemplate>sample string 6</FormTemplate>
      <FormTemplateID>8</FormTemplateID>
      <FormTemplateSiteGuid>a674be48-d4e0-41f4-84e5-0061c4807948</FormTemplateSiteGuid>
      <FormTemplateWebGuid>fed0dcb2-ebc9-440f-b2a8-797e65115fed</FormTemplateWebGuid>
      <FormType>sample string 5</FormType>
      <Group>sample string 18</Group>
      <HasIsoNumber>sample string 17</HasIsoNumber>
      <HasTemplate>sample string 16</HasTemplate>
      <HistoryListGuid>d1df5382-0f57-488f-9781-a99ca705fb9e</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>199214f6-4e1c-43a6-8eac-64b5e442f470</d4p1:ListGuid>
        <d4p1:Ref>sample string 3</d4p1:Ref>
        <d4p1:RefDisplayHTML>sample string 8</d4p1:RefDisplayHTML>
        <d4p1:SiteGuid>90ab97fe-f2d7-42e6-9a88-78eaa1453e39</d4p1:SiteGuid>
        <d4p1:Title>sample string 2</d4p1:Title>
        <d4p1:WebGuid>67907b48-8342-42c0-b5cd-a14dffcef354</d4p1:WebGuid>
        <d4p1:WebUrl>sample string 10</d4p1:WebUrl>
      </MFItem>
      <PRItemDetailListGuid>340810e1-5c86-4bb1-a6ed-4744f7321622</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>2025-09-11T09:53:38.466644+07:00</SubmittedDate>
      <Title>sample string 2</Title>
      <UniqueId>c1e8b422-bb33-490c-8744-38cd54e32585</UniqueId>
      <WFName>sample string 11</WFName>
    </FormItem>
    <FormType>sample string 21</FormType>
    <HistoryListGuid>777c3b27-707a-4aa0-a04c-6c62951b2427</HistoryListGuid>
    <IsGenerateApprovalMatrix>true</IsGenerateApprovalMatrix>
    <ItemId>5</ItemId>
    <ItemUniqueId>4feafd62-cf33-4e55-a1ca-ba431a53e133</ItemUniqueId>
    <KeyValue>sample string 22</KeyValue>
    <ListGuid>8d4f42e7-edc2-459c-a73c-2378baf8bb7a</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>082e823c-357b-4634-b713-027638166ff3</SiteGuid>
    <SyncPermission>true</SyncPermission>
    <WFName>sample string 18</WFName>
    <WebGuid>52775a69-3a07-496a-9d41-5a3ca3ac623d</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.