POST api/Forms/AddNewFormSetItemGF
Request Information
URI Parameters
None.
Body Parameters
FormSetDataName | Description | 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": "2883bd72-533a-465b-a62b-c2f7afc2eb35", "HistoryListGuid": "e864478d-ec90-4d8a-a9dd-3598177b480e", "ItemId": 5, "itemId": "sample string 6", "ItemUniqueId": "f2cd398d-41ec-488d-9bc4-06b19eab8763", "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": "d46602cd-a103-4757-896f-18be8679fa27", "DocLibListGuid": "7bf1cf5a-8ec4-4871-b7c6-07e55976625a", "Settings": { "BackendApiUrl": "sample string 1", "EOfficeDataSiteUrl": "sample string 2", "HTTMSiteURL": "sample string 3" }, "FormItem": { "Id": 1, "UniqueId": "683d0e54-d917-4f05-b6cb-18b8cc89e8bb", "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": "db322d95-2cbc-41be-b952-5e4c7e4f545b", "FormTemplateSiteGuid": "df5ecc30-886a-4c6f-b348-84209d285e94", "FormPublishedDate": "2025-09-11T09:53:38.5993074+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": "2b1ae45e-0be6-4182-ab12-4b48772e22dd", "DiscussionListGuid": "d820077e-572c-4e87-b4d3-1f8f0c85ed67", "DocLibListGuid": "5f61381c-a50a-4112-b9e6-8cb396c89cb4", "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.5993074+07:00", "SubmittedDate": "2025-09-11T09:53:38.5993074+07:00", "CurrentGroup": "sample string 12", "CurrentApproverJobTitle": "sample string 13", "SubmitCounter": 14, "EffectiveDate": "2025-09-11T09:53:38.5993074+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": "d024d145-cb30-485e-a272-59dc92a37db6", "ListGuid": "8e5569b3-8081-4ae9-b1f3-066d41954c77", "WebGuid": "a3a7e76f-7c96-4c84-8052-859705f22ac3", "ItemId": 7, "RefDisplayHTML": "sample string 8", "FormCode": "sample string 9", "WebUrl": "sample string 10", "FormType": "sample string 11" }, "PRItemDetailListGuid": "098cbfa9-1358-482f-8ea2-a0f65023d8a6" }, "ClearAdditionalItemOnly": true, "ClearApprovalGroup": true, "SiteGuid": "ceb9580c-3680-401c-8e3c-14bfbb045321", "WebGuid": "84b2de2f-65d7-4c0c-8eb4-eed1052e8981", "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": "2883bd72-533a-465b-a62b-c2f7afc2eb35", "HistoryListGuid": "e864478d-ec90-4d8a-a9dd-3598177b480e", "ItemId": 5, "itemId": "sample string 6", "ItemUniqueId": "f2cd398d-41ec-488d-9bc4-06b19eab8763", "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": "d46602cd-a103-4757-896f-18be8679fa27", "DocLibListGuid": "7bf1cf5a-8ec4-4871-b7c6-07e55976625a", "Settings": { "BackendApiUrl": "sample string 1", "EOfficeDataSiteUrl": "sample string 2", "HTTMSiteURL": "sample string 3" }, "FormItem": { "Id": 1, "UniqueId": "683d0e54-d917-4f05-b6cb-18b8cc89e8bb", "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": "db322d95-2cbc-41be-b952-5e4c7e4f545b", "FormTemplateSiteGuid": "df5ecc30-886a-4c6f-b348-84209d285e94", "FormPublishedDate": "2025-09-11T09:53:38.5993074+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": "2b1ae45e-0be6-4182-ab12-4b48772e22dd", "DiscussionListGuid": "d820077e-572c-4e87-b4d3-1f8f0c85ed67", "DocLibListGuid": "5f61381c-a50a-4112-b9e6-8cb396c89cb4", "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.5993074+07:00", "SubmittedDate": "2025-09-11T09:53:38.5993074+07:00", "CurrentGroup": "sample string 12", "CurrentApproverJobTitle": "sample string 13", "SubmitCounter": 14, "EffectiveDate": "2025-09-11T09:53:38.5993074+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": "d024d145-cb30-485e-a272-59dc92a37db6", "ListGuid": "8e5569b3-8081-4ae9-b1f3-066d41954c77", "WebGuid": "a3a7e76f-7c96-4c84-8052-859705f22ac3", "ItemId": 7, "RefDisplayHTML": "sample string 8", "FormCode": "sample string 9", "WebUrl": "sample string 10", "FormType": "sample string 11" }, "PRItemDetailListGuid": "098cbfa9-1358-482f-8ea2-a0f65023d8a6" }, "ClearAdditionalItemOnly": true, "ClearApprovalGroup": true, "SiteGuid": "ceb9580c-3680-401c-8e3c-14bfbb045321", "WebGuid": "84b2de2f-65d7-4c0c-8eb4-eed1052e8981", "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>d46602cd-a103-4757-896f-18be8679fa27</DiscussionListGuid> <DisplayMode>sample string 1</DisplayMode> <DocLibListGuid>7bf1cf5a-8ec4-4871-b7c6-07e55976625a</DocLibListGuid> <EOfficeDataSiteUrl>sample string 19</EOfficeDataSiteUrl> <FormCode>sample string 20</FormCode> <FormItem> <ApprovalStatus>sample string 9</ApprovalStatus> <CurrentApproverDueDate>2025-09-11T09:53:38.5993074+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>d820077e-572c-4e87-b4d3-1f8f0c85ed67</DiscussionListGuid> <DocLibListGuid>5f61381c-a50a-4112-b9e6-8cb396c89cb4</DocLibListGuid> <EffectiveDate>2025-09-11T09:53:38.5993074+07:00</EffectiveDate> <FormCategory>sample string 10</FormCategory> <FormCode>sample string 4</FormCode> <FormNumber>sample string 7</FormNumber> <FormPublishedDate>2025-09-11T09:53:38.5993074+07:00</FormPublishedDate> <FormSetItemID>sample string 20</FormSetItemID> <FormTemplate>sample string 6</FormTemplate> <FormTemplateID>8</FormTemplateID> <FormTemplateSiteGuid>df5ecc30-886a-4c6f-b348-84209d285e94</FormTemplateSiteGuid> <FormTemplateWebGuid>db322d95-2cbc-41be-b952-5e4c7e4f545b</FormTemplateWebGuid> <FormType>sample string 5</FormType> <Group>sample string 18</Group> <HasIsoNumber>sample string 17</HasIsoNumber> <HasTemplate>sample string 16</HasTemplate> <HistoryListGuid>2b1ae45e-0be6-4182-ab12-4b48772e22dd</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>8e5569b3-8081-4ae9-b1f3-066d41954c77</d4p1:ListGuid> <d4p1:Ref>sample string 3</d4p1:Ref> <d4p1:RefDisplayHTML>sample string 8</d4p1:RefDisplayHTML> <d4p1:SiteGuid>d024d145-cb30-485e-a272-59dc92a37db6</d4p1:SiteGuid> <d4p1:Title>sample string 2</d4p1:Title> <d4p1:WebGuid>a3a7e76f-7c96-4c84-8052-859705f22ac3</d4p1:WebGuid> <d4p1:WebUrl>sample string 10</d4p1:WebUrl> </MFItem> <PRItemDetailListGuid>098cbfa9-1358-482f-8ea2-a0f65023d8a6</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.5993074+07:00</SubmittedDate> <Title>sample string 2</Title> <UniqueId>683d0e54-d917-4f05-b6cb-18b8cc89e8bb</UniqueId> <WFName>sample string 11</WFName> </FormItem> <FormType>sample string 21</FormType> <HistoryListGuid>e864478d-ec90-4d8a-a9dd-3598177b480e</HistoryListGuid> <IsGenerateApprovalMatrix>true</IsGenerateApprovalMatrix> <ItemId>5</ItemId> <ItemUniqueId>f2cd398d-41ec-488d-9bc4-06b19eab8763</ItemUniqueId> <KeyValue>sample string 22</KeyValue> <ListGuid>2883bd72-533a-465b-a62b-c2f7afc2eb35</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>ceb9580c-3680-401c-8e3c-14bfbb045321</SiteGuid> <SyncPermission>true</SyncPermission> <WFName>sample string 18</WFName> <WebGuid>84b2de2f-65d7-4c0c-8eb4-eed1052e8981</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>d46602cd-a103-4757-896f-18be8679fa27</DiscussionListGuid> <DisplayMode>sample string 1</DisplayMode> <DocLibListGuid>7bf1cf5a-8ec4-4871-b7c6-07e55976625a</DocLibListGuid> <EOfficeDataSiteUrl>sample string 19</EOfficeDataSiteUrl> <FormCode>sample string 20</FormCode> <FormItem> <ApprovalStatus>sample string 9</ApprovalStatus> <CurrentApproverDueDate>2025-09-11T09:53:38.5993074+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>d820077e-572c-4e87-b4d3-1f8f0c85ed67</DiscussionListGuid> <DocLibListGuid>5f61381c-a50a-4112-b9e6-8cb396c89cb4</DocLibListGuid> <EffectiveDate>2025-09-11T09:53:38.5993074+07:00</EffectiveDate> <FormCategory>sample string 10</FormCategory> <FormCode>sample string 4</FormCode> <FormNumber>sample string 7</FormNumber> <FormPublishedDate>2025-09-11T09:53:38.5993074+07:00</FormPublishedDate> <FormSetItemID>sample string 20</FormSetItemID> <FormTemplate>sample string 6</FormTemplate> <FormTemplateID>8</FormTemplateID> <FormTemplateSiteGuid>df5ecc30-886a-4c6f-b348-84209d285e94</FormTemplateSiteGuid> <FormTemplateWebGuid>db322d95-2cbc-41be-b952-5e4c7e4f545b</FormTemplateWebGuid> <FormType>sample string 5</FormType> <Group>sample string 18</Group> <HasIsoNumber>sample string 17</HasIsoNumber> <HasTemplate>sample string 16</HasTemplate> <HistoryListGuid>2b1ae45e-0be6-4182-ab12-4b48772e22dd</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>8e5569b3-8081-4ae9-b1f3-066d41954c77</d4p1:ListGuid> <d4p1:Ref>sample string 3</d4p1:Ref> <d4p1:RefDisplayHTML>sample string 8</d4p1:RefDisplayHTML> <d4p1:SiteGuid>d024d145-cb30-485e-a272-59dc92a37db6</d4p1:SiteGuid> <d4p1:Title>sample string 2</d4p1:Title> <d4p1:WebGuid>a3a7e76f-7c96-4c84-8052-859705f22ac3</d4p1:WebGuid> <d4p1:WebUrl>sample string 10</d4p1:WebUrl> </MFItem> <PRItemDetailListGuid>098cbfa9-1358-482f-8ea2-a0f65023d8a6</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.5993074+07:00</SubmittedDate> <Title>sample string 2</Title> <UniqueId>683d0e54-d917-4f05-b6cb-18b8cc89e8bb</UniqueId> <WFName>sample string 11</WFName> </FormItem> <FormType>sample string 21</FormType> <HistoryListGuid>e864478d-ec90-4d8a-a9dd-3598177b480e</HistoryListGuid> <IsGenerateApprovalMatrix>true</IsGenerateApprovalMatrix> <ItemId>5</ItemId> <ItemUniqueId>f2cd398d-41ec-488d-9bc4-06b19eab8763</ItemUniqueId> <KeyValue>sample string 22</KeyValue> <ListGuid>2883bd72-533a-465b-a62b-c2f7afc2eb35</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>ceb9580c-3680-401c-8e3c-14bfbb045321</SiteGuid> <SyncPermission>true</SyncPermission> <WFName>sample string 18</WFName> <WebGuid>84b2de2f-65d7-4c0c-8eb4-eed1052e8981</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:
Response Information
Resource Description
IHttpActionResultNone.
Response Formats
application/json, text/json, application/xml, text/xml
Sample:
Sample not available.