POST api/Forms/AddFormSetItemGF
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": "49a6c408-8ffc-432a-972b-b7e88d92d7b4", "HistoryListGuid": "140dd638-856e-46b4-8aec-330f5d9fd3c9", "ItemId": 5, "itemId": "sample string 6", "ItemUniqueId": "9db74e5c-7fb4-42a7-b80a-30798c85cb93", "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": "bd154474-990f-492e-ab99-d4cf7b5a111e", "DocLibListGuid": "17f25fdd-92ff-4b21-b567-2cfa7ab3ea37", "Settings": { "BackendApiUrl": "sample string 1", "EOfficeDataSiteUrl": "sample string 2", "HTTMSiteURL": "sample string 3" }, "FormItem": { "Id": 1, "UniqueId": "0662fc93-544d-4fe8-8583-856513ae60ca", "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": "1d3d1ba7-fc76-4e20-8138-4f593de93190", "FormTemplateSiteGuid": "6e7129f6-de04-43c8-aabb-082d657d94c4", "FormPublishedDate": "2025-09-11T09:52:09.6451174+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": "d4acc272-c4b1-4e07-aefb-154f6e15cff7", "DiscussionListGuid": "712ec61f-0d2f-476a-bc5a-11e0cb3bf860", "DocLibListGuid": "fdba7a7b-6d15-43bb-8c04-c620280da142", "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:52:09.6451174+07:00", "SubmittedDate": "2025-09-11T09:52:09.6451174+07:00", "CurrentGroup": "sample string 12", "CurrentApproverJobTitle": "sample string 13", "SubmitCounter": 14, "EffectiveDate": "2025-09-11T09:52:09.6451174+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": "1ec5005f-40bd-4023-8a3c-1f8eac455fcb", "ListGuid": "d1ef5386-d978-432f-8079-81a4ba49a4ad", "WebGuid": "6b9c4df8-281e-47eb-a3d2-f52ac6e3db2a", "ItemId": 7, "RefDisplayHTML": "sample string 8", "FormCode": "sample string 9", "WebUrl": "sample string 10", "FormType": "sample string 11" }, "PRItemDetailListGuid": "acfbf6fa-81ea-4669-b3b9-6fb163ed40e3" }, "ClearAdditionalItemOnly": true, "ClearApprovalGroup": true, "SiteGuid": "e73a7ba8-fe76-4c7e-8c90-f44719eef661", "WebGuid": "80f1e254-b55d-43ba-9c3f-1d43cc659eee", "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": "49a6c408-8ffc-432a-972b-b7e88d92d7b4", "HistoryListGuid": "140dd638-856e-46b4-8aec-330f5d9fd3c9", "ItemId": 5, "itemId": "sample string 6", "ItemUniqueId": "9db74e5c-7fb4-42a7-b80a-30798c85cb93", "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": "bd154474-990f-492e-ab99-d4cf7b5a111e", "DocLibListGuid": "17f25fdd-92ff-4b21-b567-2cfa7ab3ea37", "Settings": { "BackendApiUrl": "sample string 1", "EOfficeDataSiteUrl": "sample string 2", "HTTMSiteURL": "sample string 3" }, "FormItem": { "Id": 1, "UniqueId": "0662fc93-544d-4fe8-8583-856513ae60ca", "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": "1d3d1ba7-fc76-4e20-8138-4f593de93190", "FormTemplateSiteGuid": "6e7129f6-de04-43c8-aabb-082d657d94c4", "FormPublishedDate": "2025-09-11T09:52:09.6451174+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": "d4acc272-c4b1-4e07-aefb-154f6e15cff7", "DiscussionListGuid": "712ec61f-0d2f-476a-bc5a-11e0cb3bf860", "DocLibListGuid": "fdba7a7b-6d15-43bb-8c04-c620280da142", "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:52:09.6451174+07:00", "SubmittedDate": "2025-09-11T09:52:09.6451174+07:00", "CurrentGroup": "sample string 12", "CurrentApproverJobTitle": "sample string 13", "SubmitCounter": 14, "EffectiveDate": "2025-09-11T09:52:09.6451174+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": "1ec5005f-40bd-4023-8a3c-1f8eac455fcb", "ListGuid": "d1ef5386-d978-432f-8079-81a4ba49a4ad", "WebGuid": "6b9c4df8-281e-47eb-a3d2-f52ac6e3db2a", "ItemId": 7, "RefDisplayHTML": "sample string 8", "FormCode": "sample string 9", "WebUrl": "sample string 10", "FormType": "sample string 11" }, "PRItemDetailListGuid": "acfbf6fa-81ea-4669-b3b9-6fb163ed40e3" }, "ClearAdditionalItemOnly": true, "ClearApprovalGroup": true, "SiteGuid": "e73a7ba8-fe76-4c7e-8c90-f44719eef661", "WebGuid": "80f1e254-b55d-43ba-9c3f-1d43cc659eee", "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>bd154474-990f-492e-ab99-d4cf7b5a111e</DiscussionListGuid> <DisplayMode>sample string 1</DisplayMode> <DocLibListGuid>17f25fdd-92ff-4b21-b567-2cfa7ab3ea37</DocLibListGuid> <EOfficeDataSiteUrl>sample string 19</EOfficeDataSiteUrl> <FormCode>sample string 20</FormCode> <FormItem> <ApprovalStatus>sample string 9</ApprovalStatus> <CurrentApproverDueDate>2025-09-11T09:52:09.6451174+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>712ec61f-0d2f-476a-bc5a-11e0cb3bf860</DiscussionListGuid> <DocLibListGuid>fdba7a7b-6d15-43bb-8c04-c620280da142</DocLibListGuid> <EffectiveDate>2025-09-11T09:52:09.6451174+07:00</EffectiveDate> <FormCategory>sample string 10</FormCategory> <FormCode>sample string 4</FormCode> <FormNumber>sample string 7</FormNumber> <FormPublishedDate>2025-09-11T09:52:09.6451174+07:00</FormPublishedDate> <FormSetItemID>sample string 20</FormSetItemID> <FormTemplate>sample string 6</FormTemplate> <FormTemplateID>8</FormTemplateID> <FormTemplateSiteGuid>6e7129f6-de04-43c8-aabb-082d657d94c4</FormTemplateSiteGuid> <FormTemplateWebGuid>1d3d1ba7-fc76-4e20-8138-4f593de93190</FormTemplateWebGuid> <FormType>sample string 5</FormType> <Group>sample string 18</Group> <HasIsoNumber>sample string 17</HasIsoNumber> <HasTemplate>sample string 16</HasTemplate> <HistoryListGuid>d4acc272-c4b1-4e07-aefb-154f6e15cff7</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>d1ef5386-d978-432f-8079-81a4ba49a4ad</d4p1:ListGuid> <d4p1:Ref>sample string 3</d4p1:Ref> <d4p1:RefDisplayHTML>sample string 8</d4p1:RefDisplayHTML> <d4p1:SiteGuid>1ec5005f-40bd-4023-8a3c-1f8eac455fcb</d4p1:SiteGuid> <d4p1:Title>sample string 2</d4p1:Title> <d4p1:WebGuid>6b9c4df8-281e-47eb-a3d2-f52ac6e3db2a</d4p1:WebGuid> <d4p1:WebUrl>sample string 10</d4p1:WebUrl> </MFItem> <PRItemDetailListGuid>acfbf6fa-81ea-4669-b3b9-6fb163ed40e3</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:52:09.6451174+07:00</SubmittedDate> <Title>sample string 2</Title> <UniqueId>0662fc93-544d-4fe8-8583-856513ae60ca</UniqueId> <WFName>sample string 11</WFName> </FormItem> <FormType>sample string 21</FormType> <HistoryListGuid>140dd638-856e-46b4-8aec-330f5d9fd3c9</HistoryListGuid> <IsGenerateApprovalMatrix>true</IsGenerateApprovalMatrix> <ItemId>5</ItemId> <ItemUniqueId>9db74e5c-7fb4-42a7-b80a-30798c85cb93</ItemUniqueId> <KeyValue>sample string 22</KeyValue> <ListGuid>49a6c408-8ffc-432a-972b-b7e88d92d7b4</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>e73a7ba8-fe76-4c7e-8c90-f44719eef661</SiteGuid> <SyncPermission>true</SyncPermission> <WFName>sample string 18</WFName> <WebGuid>80f1e254-b55d-43ba-9c3f-1d43cc659eee</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>bd154474-990f-492e-ab99-d4cf7b5a111e</DiscussionListGuid> <DisplayMode>sample string 1</DisplayMode> <DocLibListGuid>17f25fdd-92ff-4b21-b567-2cfa7ab3ea37</DocLibListGuid> <EOfficeDataSiteUrl>sample string 19</EOfficeDataSiteUrl> <FormCode>sample string 20</FormCode> <FormItem> <ApprovalStatus>sample string 9</ApprovalStatus> <CurrentApproverDueDate>2025-09-11T09:52:09.6451174+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>712ec61f-0d2f-476a-bc5a-11e0cb3bf860</DiscussionListGuid> <DocLibListGuid>fdba7a7b-6d15-43bb-8c04-c620280da142</DocLibListGuid> <EffectiveDate>2025-09-11T09:52:09.6451174+07:00</EffectiveDate> <FormCategory>sample string 10</FormCategory> <FormCode>sample string 4</FormCode> <FormNumber>sample string 7</FormNumber> <FormPublishedDate>2025-09-11T09:52:09.6451174+07:00</FormPublishedDate> <FormSetItemID>sample string 20</FormSetItemID> <FormTemplate>sample string 6</FormTemplate> <FormTemplateID>8</FormTemplateID> <FormTemplateSiteGuid>6e7129f6-de04-43c8-aabb-082d657d94c4</FormTemplateSiteGuid> <FormTemplateWebGuid>1d3d1ba7-fc76-4e20-8138-4f593de93190</FormTemplateWebGuid> <FormType>sample string 5</FormType> <Group>sample string 18</Group> <HasIsoNumber>sample string 17</HasIsoNumber> <HasTemplate>sample string 16</HasTemplate> <HistoryListGuid>d4acc272-c4b1-4e07-aefb-154f6e15cff7</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>d1ef5386-d978-432f-8079-81a4ba49a4ad</d4p1:ListGuid> <d4p1:Ref>sample string 3</d4p1:Ref> <d4p1:RefDisplayHTML>sample string 8</d4p1:RefDisplayHTML> <d4p1:SiteGuid>1ec5005f-40bd-4023-8a3c-1f8eac455fcb</d4p1:SiteGuid> <d4p1:Title>sample string 2</d4p1:Title> <d4p1:WebGuid>6b9c4df8-281e-47eb-a3d2-f52ac6e3db2a</d4p1:WebGuid> <d4p1:WebUrl>sample string 10</d4p1:WebUrl> </MFItem> <PRItemDetailListGuid>acfbf6fa-81ea-4669-b3b9-6fb163ed40e3</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:52:09.6451174+07:00</SubmittedDate> <Title>sample string 2</Title> <UniqueId>0662fc93-544d-4fe8-8583-856513ae60ca</UniqueId> <WFName>sample string 11</WFName> </FormItem> <FormType>sample string 21</FormType> <HistoryListGuid>140dd638-856e-46b4-8aec-330f5d9fd3c9</HistoryListGuid> <IsGenerateApprovalMatrix>true</IsGenerateApprovalMatrix> <ItemId>5</ItemId> <ItemUniqueId>9db74e5c-7fb4-42a7-b80a-30798c85cb93</ItemUniqueId> <KeyValue>sample string 22</KeyValue> <ListGuid>49a6c408-8ffc-432a-972b-b7e88d92d7b4</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>e73a7ba8-fe76-4c7e-8c90-f44719eef661</SiteGuid> <SyncPermission>true</SyncPermission> <WFName>sample string 18</WFName> <WebGuid>80f1e254-b55d-43ba-9c3f-1d43cc659eee</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.