POST api/Forms/AddFormSetItemGF
Request Information
URI Parameters
None.
Body Parameters
FormSetData| Name | 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": "1d94b3c2-d6aa-4ae8-87e2-3305b08a7a13",
"HistoryListGuid": "fbca8410-eb57-475c-b292-6f05f4a2550c",
"ItemId": 5,
"itemId": "sample string 6",
"ItemUniqueId": "00f15cae-03ee-4886-b1b5-2de43be19fe5",
"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": "a4d52f69-01af-49a9-9159-0360e61d4ec6",
"DocLibListGuid": "d6d2b169-c5b0-4b65-b929-65bcca6ec9a1",
"Settings": {
"BackendApiUrl": "sample string 1",
"EOfficeDataSiteUrl": "sample string 2",
"HTTMSiteURL": "sample string 3"
},
"FormItem": {
"Id": 1,
"UniqueId": "0b6c156b-73f1-4c0b-a07c-34bc11383300",
"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": "a6df92e5-3c9c-4e24-809b-6160edb49661",
"FormTemplateSiteGuid": "2e049540-1bf3-42c2-add2-2f753c380611",
"FormPublishedDate": "2025-12-16T07:41:18.9528534+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": "91a3f36b-0eb3-4e7c-a113-ac7313e71be3",
"DiscussionListGuid": "9173dca7-976a-4af5-83df-e2a8428eb2a2",
"DocLibListGuid": "12bed191-fbd9-4e9c-95bc-ba24e35b9fe0",
"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-12-16T07:41:18.9528534+07:00",
"SubmittedDate": "2025-12-16T07:41:18.9528534+07:00",
"CurrentGroup": "sample string 12",
"CurrentApproverJobTitle": "sample string 13",
"SubmitCounter": 14,
"EffectiveDate": "2025-12-16T07:41:18.9528534+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": "741c4016-b846-4ea9-b74a-a941bb8f1a7c",
"ListGuid": "6aa598e5-7018-4a47-9322-68ca9ebc3802",
"WebGuid": "1ca77cf8-17ab-4348-8546-cbb94286ab11",
"ItemId": 7,
"RefDisplayHTML": "sample string 8",
"FormCode": "sample string 9",
"WebUrl": "sample string 10",
"FormType": "sample string 11"
},
"PRItemDetailListGuid": "477250c3-20f1-48fe-90e1-5e77ec9f0727"
},
"ClearAdditionalItemOnly": true,
"ClearApprovalGroup": true,
"SiteGuid": "7a404c4c-beeb-4a45-b1f3-9af613f09fbf",
"WebGuid": "55c5aa58-9807-48ae-8271-38cd7ef93a87",
"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": "1d94b3c2-d6aa-4ae8-87e2-3305b08a7a13",
"HistoryListGuid": "fbca8410-eb57-475c-b292-6f05f4a2550c",
"ItemId": 5,
"itemId": "sample string 6",
"ItemUniqueId": "00f15cae-03ee-4886-b1b5-2de43be19fe5",
"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": "a4d52f69-01af-49a9-9159-0360e61d4ec6",
"DocLibListGuid": "d6d2b169-c5b0-4b65-b929-65bcca6ec9a1",
"Settings": {
"BackendApiUrl": "sample string 1",
"EOfficeDataSiteUrl": "sample string 2",
"HTTMSiteURL": "sample string 3"
},
"FormItem": {
"Id": 1,
"UniqueId": "0b6c156b-73f1-4c0b-a07c-34bc11383300",
"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": "a6df92e5-3c9c-4e24-809b-6160edb49661",
"FormTemplateSiteGuid": "2e049540-1bf3-42c2-add2-2f753c380611",
"FormPublishedDate": "2025-12-16T07:41:18.9528534+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": "91a3f36b-0eb3-4e7c-a113-ac7313e71be3",
"DiscussionListGuid": "9173dca7-976a-4af5-83df-e2a8428eb2a2",
"DocLibListGuid": "12bed191-fbd9-4e9c-95bc-ba24e35b9fe0",
"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-12-16T07:41:18.9528534+07:00",
"SubmittedDate": "2025-12-16T07:41:18.9528534+07:00",
"CurrentGroup": "sample string 12",
"CurrentApproverJobTitle": "sample string 13",
"SubmitCounter": 14,
"EffectiveDate": "2025-12-16T07:41:18.9528534+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": "741c4016-b846-4ea9-b74a-a941bb8f1a7c",
"ListGuid": "6aa598e5-7018-4a47-9322-68ca9ebc3802",
"WebGuid": "1ca77cf8-17ab-4348-8546-cbb94286ab11",
"ItemId": 7,
"RefDisplayHTML": "sample string 8",
"FormCode": "sample string 9",
"WebUrl": "sample string 10",
"FormType": "sample string 11"
},
"PRItemDetailListGuid": "477250c3-20f1-48fe-90e1-5e77ec9f0727"
},
"ClearAdditionalItemOnly": true,
"ClearApprovalGroup": true,
"SiteGuid": "7a404c4c-beeb-4a45-b1f3-9af613f09fbf",
"WebGuid": "55c5aa58-9807-48ae-8271-38cd7ef93a87",
"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>a4d52f69-01af-49a9-9159-0360e61d4ec6</DiscussionListGuid>
<DisplayMode>sample string 1</DisplayMode>
<DocLibListGuid>d6d2b169-c5b0-4b65-b929-65bcca6ec9a1</DocLibListGuid>
<EOfficeDataSiteUrl>sample string 19</EOfficeDataSiteUrl>
<FormCode>sample string 20</FormCode>
<FormItem>
<ApprovalStatus>sample string 9</ApprovalStatus>
<CurrentApproverDueDate>2025-12-16T07:41:18.9528534+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>9173dca7-976a-4af5-83df-e2a8428eb2a2</DiscussionListGuid>
<DocLibListGuid>12bed191-fbd9-4e9c-95bc-ba24e35b9fe0</DocLibListGuid>
<EffectiveDate>2025-12-16T07:41:18.9528534+07:00</EffectiveDate>
<FormCategory>sample string 10</FormCategory>
<FormCode>sample string 4</FormCode>
<FormNumber>sample string 7</FormNumber>
<FormPublishedDate>2025-12-16T07:41:18.9528534+07:00</FormPublishedDate>
<FormSetItemID>sample string 20</FormSetItemID>
<FormTemplate>sample string 6</FormTemplate>
<FormTemplateID>8</FormTemplateID>
<FormTemplateSiteGuid>2e049540-1bf3-42c2-add2-2f753c380611</FormTemplateSiteGuid>
<FormTemplateWebGuid>a6df92e5-3c9c-4e24-809b-6160edb49661</FormTemplateWebGuid>
<FormType>sample string 5</FormType>
<Group>sample string 18</Group>
<HasIsoNumber>sample string 17</HasIsoNumber>
<HasTemplate>sample string 16</HasTemplate>
<HistoryListGuid>91a3f36b-0eb3-4e7c-a113-ac7313e71be3</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>6aa598e5-7018-4a47-9322-68ca9ebc3802</d4p1:ListGuid>
<d4p1:Ref>sample string 3</d4p1:Ref>
<d4p1:RefDisplayHTML>sample string 8</d4p1:RefDisplayHTML>
<d4p1:SiteGuid>741c4016-b846-4ea9-b74a-a941bb8f1a7c</d4p1:SiteGuid>
<d4p1:Title>sample string 2</d4p1:Title>
<d4p1:WebGuid>1ca77cf8-17ab-4348-8546-cbb94286ab11</d4p1:WebGuid>
<d4p1:WebUrl>sample string 10</d4p1:WebUrl>
</MFItem>
<PRItemDetailListGuid>477250c3-20f1-48fe-90e1-5e77ec9f0727</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-12-16T07:41:18.9528534+07:00</SubmittedDate>
<Title>sample string 2</Title>
<UniqueId>0b6c156b-73f1-4c0b-a07c-34bc11383300</UniqueId>
<WFName>sample string 11</WFName>
</FormItem>
<FormType>sample string 21</FormType>
<HistoryListGuid>fbca8410-eb57-475c-b292-6f05f4a2550c</HistoryListGuid>
<IsGenerateApprovalMatrix>true</IsGenerateApprovalMatrix>
<ItemId>5</ItemId>
<ItemUniqueId>00f15cae-03ee-4886-b1b5-2de43be19fe5</ItemUniqueId>
<KeyValue>sample string 22</KeyValue>
<ListGuid>1d94b3c2-d6aa-4ae8-87e2-3305b08a7a13</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>7a404c4c-beeb-4a45-b1f3-9af613f09fbf</SiteGuid>
<SyncPermission>true</SyncPermission>
<WFName>sample string 18</WFName>
<WebGuid>55c5aa58-9807-48ae-8271-38cd7ef93a87</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>a4d52f69-01af-49a9-9159-0360e61d4ec6</DiscussionListGuid>
<DisplayMode>sample string 1</DisplayMode>
<DocLibListGuid>d6d2b169-c5b0-4b65-b929-65bcca6ec9a1</DocLibListGuid>
<EOfficeDataSiteUrl>sample string 19</EOfficeDataSiteUrl>
<FormCode>sample string 20</FormCode>
<FormItem>
<ApprovalStatus>sample string 9</ApprovalStatus>
<CurrentApproverDueDate>2025-12-16T07:41:18.9528534+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>9173dca7-976a-4af5-83df-e2a8428eb2a2</DiscussionListGuid>
<DocLibListGuid>12bed191-fbd9-4e9c-95bc-ba24e35b9fe0</DocLibListGuid>
<EffectiveDate>2025-12-16T07:41:18.9528534+07:00</EffectiveDate>
<FormCategory>sample string 10</FormCategory>
<FormCode>sample string 4</FormCode>
<FormNumber>sample string 7</FormNumber>
<FormPublishedDate>2025-12-16T07:41:18.9528534+07:00</FormPublishedDate>
<FormSetItemID>sample string 20</FormSetItemID>
<FormTemplate>sample string 6</FormTemplate>
<FormTemplateID>8</FormTemplateID>
<FormTemplateSiteGuid>2e049540-1bf3-42c2-add2-2f753c380611</FormTemplateSiteGuid>
<FormTemplateWebGuid>a6df92e5-3c9c-4e24-809b-6160edb49661</FormTemplateWebGuid>
<FormType>sample string 5</FormType>
<Group>sample string 18</Group>
<HasIsoNumber>sample string 17</HasIsoNumber>
<HasTemplate>sample string 16</HasTemplate>
<HistoryListGuid>91a3f36b-0eb3-4e7c-a113-ac7313e71be3</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>6aa598e5-7018-4a47-9322-68ca9ebc3802</d4p1:ListGuid>
<d4p1:Ref>sample string 3</d4p1:Ref>
<d4p1:RefDisplayHTML>sample string 8</d4p1:RefDisplayHTML>
<d4p1:SiteGuid>741c4016-b846-4ea9-b74a-a941bb8f1a7c</d4p1:SiteGuid>
<d4p1:Title>sample string 2</d4p1:Title>
<d4p1:WebGuid>1ca77cf8-17ab-4348-8546-cbb94286ab11</d4p1:WebGuid>
<d4p1:WebUrl>sample string 10</d4p1:WebUrl>
</MFItem>
<PRItemDetailListGuid>477250c3-20f1-48fe-90e1-5e77ec9f0727</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-12-16T07:41:18.9528534+07:00</SubmittedDate>
<Title>sample string 2</Title>
<UniqueId>0b6c156b-73f1-4c0b-a07c-34bc11383300</UniqueId>
<WFName>sample string 11</WFName>
</FormItem>
<FormType>sample string 21</FormType>
<HistoryListGuid>fbca8410-eb57-475c-b292-6f05f4a2550c</HistoryListGuid>
<IsGenerateApprovalMatrix>true</IsGenerateApprovalMatrix>
<ItemId>5</ItemId>
<ItemUniqueId>00f15cae-03ee-4886-b1b5-2de43be19fe5</ItemUniqueId>
<KeyValue>sample string 22</KeyValue>
<ListGuid>1d94b3c2-d6aa-4ae8-87e2-3305b08a7a13</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>7a404c4c-beeb-4a45-b1f3-9af613f09fbf</SiteGuid>
<SyncPermission>true</SyncPermission>
<WFName>sample string 18</WFName>
<WebGuid>55c5aa58-9807-48ae-8271-38cd7ef93a87</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.