POST api/Forms/AddFormSetItem
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": "987b6025-5b24-4a1d-9b88-6b638bf7d06a",
"HistoryListGuid": "82b3faa5-9527-4b1b-9930-e94edcf783a9",
"ItemId": 5,
"itemId": "sample string 6",
"ItemUniqueId": "383c9834-54e2-4875-bea0-991a85764c4f",
"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": "e4d7db66-98ea-4981-be99-fdfc45b571d1",
"DocLibListGuid": "98b29db8-6a7b-4622-a50e-8f916e685685",
"Settings": {
"BackendApiUrl": "sample string 1",
"EOfficeDataSiteUrl": "sample string 2",
"HTTMSiteURL": "sample string 3"
},
"FormItem": {
"Id": 1,
"UniqueId": "9cfa35ee-1e93-4cc2-bc78-e8dbc4c36c5a",
"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": "f16cf0ee-baed-4959-99d3-114d48b33b6f",
"FormTemplateSiteGuid": "131bc73a-afca-4697-96bb-1a63a13bf707",
"FormPublishedDate": "2026-03-23T04:24:20.7077303+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": "bb4dd7f2-d590-40d9-b8e1-a6776b363cef",
"DiscussionListGuid": "8c31c335-68bd-4d54-bd86-3d93601d0717",
"DocLibListGuid": "82870d52-b4c3-4b87-80d4-68b24e5c63d8",
"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-03-23T04:24:20.7077303+07:00",
"SubmittedDate": "2026-03-23T04:24:20.7077303+07:00",
"CurrentGroup": "sample string 12",
"CurrentApproverJobTitle": "sample string 13",
"SubmitCounter": 14,
"EffectiveDate": "2026-03-23T04:24:20.7077303+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": "ff2a92d5-7db3-4f65-9465-5caab4ab1afc",
"ListGuid": "a09887c4-7ef5-4616-9439-9e99e20a4178",
"WebGuid": "ec1224d4-e1f9-4a36-8b75-abb346e961f1",
"ItemId": 7,
"RefDisplayHTML": "sample string 8",
"FormCode": "sample string 9",
"WebUrl": "sample string 10",
"FormType": "sample string 11"
},
"PRItemDetailListGuid": "24563dce-a25d-4dd4-a79b-6a49633f707d"
},
"ClearAdditionalItemOnly": true,
"ClearApprovalGroup": true,
"SiteGuid": "109653ee-3ec5-4f09-80ab-2ac58ad5040c",
"WebGuid": "9d84864e-7069-4f0f-b6f7-c7a111bd318b",
"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": "987b6025-5b24-4a1d-9b88-6b638bf7d06a",
"HistoryListGuid": "82b3faa5-9527-4b1b-9930-e94edcf783a9",
"ItemId": 5,
"itemId": "sample string 6",
"ItemUniqueId": "383c9834-54e2-4875-bea0-991a85764c4f",
"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": "e4d7db66-98ea-4981-be99-fdfc45b571d1",
"DocLibListGuid": "98b29db8-6a7b-4622-a50e-8f916e685685",
"Settings": {
"BackendApiUrl": "sample string 1",
"EOfficeDataSiteUrl": "sample string 2",
"HTTMSiteURL": "sample string 3"
},
"FormItem": {
"Id": 1,
"UniqueId": "9cfa35ee-1e93-4cc2-bc78-e8dbc4c36c5a",
"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": "f16cf0ee-baed-4959-99d3-114d48b33b6f",
"FormTemplateSiteGuid": "131bc73a-afca-4697-96bb-1a63a13bf707",
"FormPublishedDate": "2026-03-23T04:24:20.7077303+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": "bb4dd7f2-d590-40d9-b8e1-a6776b363cef",
"DiscussionListGuid": "8c31c335-68bd-4d54-bd86-3d93601d0717",
"DocLibListGuid": "82870d52-b4c3-4b87-80d4-68b24e5c63d8",
"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-03-23T04:24:20.7077303+07:00",
"SubmittedDate": "2026-03-23T04:24:20.7077303+07:00",
"CurrentGroup": "sample string 12",
"CurrentApproverJobTitle": "sample string 13",
"SubmitCounter": 14,
"EffectiveDate": "2026-03-23T04:24:20.7077303+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": "ff2a92d5-7db3-4f65-9465-5caab4ab1afc",
"ListGuid": "a09887c4-7ef5-4616-9439-9e99e20a4178",
"WebGuid": "ec1224d4-e1f9-4a36-8b75-abb346e961f1",
"ItemId": 7,
"RefDisplayHTML": "sample string 8",
"FormCode": "sample string 9",
"WebUrl": "sample string 10",
"FormType": "sample string 11"
},
"PRItemDetailListGuid": "24563dce-a25d-4dd4-a79b-6a49633f707d"
},
"ClearAdditionalItemOnly": true,
"ClearApprovalGroup": true,
"SiteGuid": "109653ee-3ec5-4f09-80ab-2ac58ad5040c",
"WebGuid": "9d84864e-7069-4f0f-b6f7-c7a111bd318b",
"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>e4d7db66-98ea-4981-be99-fdfc45b571d1</DiscussionListGuid>
<DisplayMode>sample string 1</DisplayMode>
<DocLibListGuid>98b29db8-6a7b-4622-a50e-8f916e685685</DocLibListGuid>
<EOfficeDataSiteUrl>sample string 19</EOfficeDataSiteUrl>
<FormCode>sample string 20</FormCode>
<FormItem>
<ApprovalStatus>sample string 9</ApprovalStatus>
<CurrentApproverDueDate>2026-03-23T04:24:20.7077303+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>8c31c335-68bd-4d54-bd86-3d93601d0717</DiscussionListGuid>
<DocLibListGuid>82870d52-b4c3-4b87-80d4-68b24e5c63d8</DocLibListGuid>
<EffectiveDate>2026-03-23T04:24:20.7077303+07:00</EffectiveDate>
<FormCategory>sample string 10</FormCategory>
<FormCode>sample string 4</FormCode>
<FormNumber>sample string 7</FormNumber>
<FormPublishedDate>2026-03-23T04:24:20.7077303+07:00</FormPublishedDate>
<FormSetItemID>sample string 20</FormSetItemID>
<FormTemplate>sample string 6</FormTemplate>
<FormTemplateID>8</FormTemplateID>
<FormTemplateSiteGuid>131bc73a-afca-4697-96bb-1a63a13bf707</FormTemplateSiteGuid>
<FormTemplateWebGuid>f16cf0ee-baed-4959-99d3-114d48b33b6f</FormTemplateWebGuid>
<FormType>sample string 5</FormType>
<Group>sample string 18</Group>
<HasIsoNumber>sample string 17</HasIsoNumber>
<HasTemplate>sample string 16</HasTemplate>
<HistoryListGuid>bb4dd7f2-d590-40d9-b8e1-a6776b363cef</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>a09887c4-7ef5-4616-9439-9e99e20a4178</d4p1:ListGuid>
<d4p1:Ref>sample string 3</d4p1:Ref>
<d4p1:RefDisplayHTML>sample string 8</d4p1:RefDisplayHTML>
<d4p1:SiteGuid>ff2a92d5-7db3-4f65-9465-5caab4ab1afc</d4p1:SiteGuid>
<d4p1:Title>sample string 2</d4p1:Title>
<d4p1:WebGuid>ec1224d4-e1f9-4a36-8b75-abb346e961f1</d4p1:WebGuid>
<d4p1:WebUrl>sample string 10</d4p1:WebUrl>
</MFItem>
<PRItemDetailListGuid>24563dce-a25d-4dd4-a79b-6a49633f707d</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-03-23T04:24:20.7077303+07:00</SubmittedDate>
<Title>sample string 2</Title>
<UniqueId>9cfa35ee-1e93-4cc2-bc78-e8dbc4c36c5a</UniqueId>
<WFName>sample string 11</WFName>
</FormItem>
<FormType>sample string 21</FormType>
<HistoryListGuid>82b3faa5-9527-4b1b-9930-e94edcf783a9</HistoryListGuid>
<IsGenerateApprovalMatrix>true</IsGenerateApprovalMatrix>
<ItemId>5</ItemId>
<ItemUniqueId>383c9834-54e2-4875-bea0-991a85764c4f</ItemUniqueId>
<KeyValue>sample string 22</KeyValue>
<ListGuid>987b6025-5b24-4a1d-9b88-6b638bf7d06a</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>109653ee-3ec5-4f09-80ab-2ac58ad5040c</SiteGuid>
<SyncPermission>true</SyncPermission>
<WFName>sample string 18</WFName>
<WebGuid>9d84864e-7069-4f0f-b6f7-c7a111bd318b</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>e4d7db66-98ea-4981-be99-fdfc45b571d1</DiscussionListGuid>
<DisplayMode>sample string 1</DisplayMode>
<DocLibListGuid>98b29db8-6a7b-4622-a50e-8f916e685685</DocLibListGuid>
<EOfficeDataSiteUrl>sample string 19</EOfficeDataSiteUrl>
<FormCode>sample string 20</FormCode>
<FormItem>
<ApprovalStatus>sample string 9</ApprovalStatus>
<CurrentApproverDueDate>2026-03-23T04:24:20.7077303+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>8c31c335-68bd-4d54-bd86-3d93601d0717</DiscussionListGuid>
<DocLibListGuid>82870d52-b4c3-4b87-80d4-68b24e5c63d8</DocLibListGuid>
<EffectiveDate>2026-03-23T04:24:20.7077303+07:00</EffectiveDate>
<FormCategory>sample string 10</FormCategory>
<FormCode>sample string 4</FormCode>
<FormNumber>sample string 7</FormNumber>
<FormPublishedDate>2026-03-23T04:24:20.7077303+07:00</FormPublishedDate>
<FormSetItemID>sample string 20</FormSetItemID>
<FormTemplate>sample string 6</FormTemplate>
<FormTemplateID>8</FormTemplateID>
<FormTemplateSiteGuid>131bc73a-afca-4697-96bb-1a63a13bf707</FormTemplateSiteGuid>
<FormTemplateWebGuid>f16cf0ee-baed-4959-99d3-114d48b33b6f</FormTemplateWebGuid>
<FormType>sample string 5</FormType>
<Group>sample string 18</Group>
<HasIsoNumber>sample string 17</HasIsoNumber>
<HasTemplate>sample string 16</HasTemplate>
<HistoryListGuid>bb4dd7f2-d590-40d9-b8e1-a6776b363cef</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>a09887c4-7ef5-4616-9439-9e99e20a4178</d4p1:ListGuid>
<d4p1:Ref>sample string 3</d4p1:Ref>
<d4p1:RefDisplayHTML>sample string 8</d4p1:RefDisplayHTML>
<d4p1:SiteGuid>ff2a92d5-7db3-4f65-9465-5caab4ab1afc</d4p1:SiteGuid>
<d4p1:Title>sample string 2</d4p1:Title>
<d4p1:WebGuid>ec1224d4-e1f9-4a36-8b75-abb346e961f1</d4p1:WebGuid>
<d4p1:WebUrl>sample string 10</d4p1:WebUrl>
</MFItem>
<PRItemDetailListGuid>24563dce-a25d-4dd4-a79b-6a49633f707d</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-03-23T04:24:20.7077303+07:00</SubmittedDate>
<Title>sample string 2</Title>
<UniqueId>9cfa35ee-1e93-4cc2-bc78-e8dbc4c36c5a</UniqueId>
<WFName>sample string 11</WFName>
</FormItem>
<FormType>sample string 21</FormType>
<HistoryListGuid>82b3faa5-9527-4b1b-9930-e94edcf783a9</HistoryListGuid>
<IsGenerateApprovalMatrix>true</IsGenerateApprovalMatrix>
<ItemId>5</ItemId>
<ItemUniqueId>383c9834-54e2-4875-bea0-991a85764c4f</ItemUniqueId>
<KeyValue>sample string 22</KeyValue>
<ListGuid>987b6025-5b24-4a1d-9b88-6b638bf7d06a</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>109653ee-3ec5-4f09-80ab-2ac58ad5040c</SiteGuid>
<SyncPermission>true</SyncPermission>
<WFName>sample string 18</WFName>
<WebGuid>9d84864e-7069-4f0f-b6f7-c7a111bd318b</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.