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": "b45a4bf2-8313-45d3-9ed1-106de883989e",
"HistoryListGuid": "00f71812-cdfb-4eb4-ad89-1b85a2f52a2d",
"ItemId": 5,
"itemId": "sample string 6",
"ItemUniqueId": "7f457a95-b73a-4764-8df7-deb904f5a252",
"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": "1478433c-d040-4463-8bd8-8375b2d62f21",
"DocLibListGuid": "8d3dc90d-d1e7-4273-857a-e5016b2152cb",
"Settings": {
"BackendApiUrl": "sample string 1",
"EOfficeDataSiteUrl": "sample string 2",
"HTTMSiteURL": "sample string 3"
},
"FormItem": {
"Id": 1,
"UniqueId": "b9ed9887-f18b-4727-ba00-9ddca0a7c34f",
"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": "0c8fb061-d9e5-4019-8469-92f9731d3cd5",
"FormTemplateSiteGuid": "74171813-1c25-4813-b041-3524394b3e52",
"FormPublishedDate": "2025-12-16T07:41:20.9690049+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": "7cc22764-75f8-480d-bccf-bafc8cbb31c8",
"DiscussionListGuid": "b6d6b85e-259a-430e-bea1-7538b96a1307",
"DocLibListGuid": "c4688d70-ef97-4203-aa89-57c1ba691b3e",
"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:20.9690049+07:00",
"SubmittedDate": "2025-12-16T07:41:20.9690049+07:00",
"CurrentGroup": "sample string 12",
"CurrentApproverJobTitle": "sample string 13",
"SubmitCounter": 14,
"EffectiveDate": "2025-12-16T07:41:20.9690049+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": "8b2ce43f-60b5-4b43-95ac-648973de9314",
"ListGuid": "7e022195-1bb7-4d58-824b-73797dbf33ef",
"WebGuid": "4193d5a0-0ba7-4d2f-93be-0cc12c3597c1",
"ItemId": 7,
"RefDisplayHTML": "sample string 8",
"FormCode": "sample string 9",
"WebUrl": "sample string 10",
"FormType": "sample string 11"
},
"PRItemDetailListGuid": "81e1fe76-f610-4c68-8e22-e7e8935e67ab"
},
"ClearAdditionalItemOnly": true,
"ClearApprovalGroup": true,
"SiteGuid": "1500822c-748d-4067-981a-c4567f28994a",
"WebGuid": "ff16fa3a-5285-46e2-a800-24f195ed2ad7",
"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": "b45a4bf2-8313-45d3-9ed1-106de883989e",
"HistoryListGuid": "00f71812-cdfb-4eb4-ad89-1b85a2f52a2d",
"ItemId": 5,
"itemId": "sample string 6",
"ItemUniqueId": "7f457a95-b73a-4764-8df7-deb904f5a252",
"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": "1478433c-d040-4463-8bd8-8375b2d62f21",
"DocLibListGuid": "8d3dc90d-d1e7-4273-857a-e5016b2152cb",
"Settings": {
"BackendApiUrl": "sample string 1",
"EOfficeDataSiteUrl": "sample string 2",
"HTTMSiteURL": "sample string 3"
},
"FormItem": {
"Id": 1,
"UniqueId": "b9ed9887-f18b-4727-ba00-9ddca0a7c34f",
"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": "0c8fb061-d9e5-4019-8469-92f9731d3cd5",
"FormTemplateSiteGuid": "74171813-1c25-4813-b041-3524394b3e52",
"FormPublishedDate": "2025-12-16T07:41:20.9690049+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": "7cc22764-75f8-480d-bccf-bafc8cbb31c8",
"DiscussionListGuid": "b6d6b85e-259a-430e-bea1-7538b96a1307",
"DocLibListGuid": "c4688d70-ef97-4203-aa89-57c1ba691b3e",
"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:20.9690049+07:00",
"SubmittedDate": "2025-12-16T07:41:20.9690049+07:00",
"CurrentGroup": "sample string 12",
"CurrentApproverJobTitle": "sample string 13",
"SubmitCounter": 14,
"EffectiveDate": "2025-12-16T07:41:20.9690049+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": "8b2ce43f-60b5-4b43-95ac-648973de9314",
"ListGuid": "7e022195-1bb7-4d58-824b-73797dbf33ef",
"WebGuid": "4193d5a0-0ba7-4d2f-93be-0cc12c3597c1",
"ItemId": 7,
"RefDisplayHTML": "sample string 8",
"FormCode": "sample string 9",
"WebUrl": "sample string 10",
"FormType": "sample string 11"
},
"PRItemDetailListGuid": "81e1fe76-f610-4c68-8e22-e7e8935e67ab"
},
"ClearAdditionalItemOnly": true,
"ClearApprovalGroup": true,
"SiteGuid": "1500822c-748d-4067-981a-c4567f28994a",
"WebGuid": "ff16fa3a-5285-46e2-a800-24f195ed2ad7",
"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>1478433c-d040-4463-8bd8-8375b2d62f21</DiscussionListGuid>
<DisplayMode>sample string 1</DisplayMode>
<DocLibListGuid>8d3dc90d-d1e7-4273-857a-e5016b2152cb</DocLibListGuid>
<EOfficeDataSiteUrl>sample string 19</EOfficeDataSiteUrl>
<FormCode>sample string 20</FormCode>
<FormItem>
<ApprovalStatus>sample string 9</ApprovalStatus>
<CurrentApproverDueDate>2025-12-16T07:41:20.9690049+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>b6d6b85e-259a-430e-bea1-7538b96a1307</DiscussionListGuid>
<DocLibListGuid>c4688d70-ef97-4203-aa89-57c1ba691b3e</DocLibListGuid>
<EffectiveDate>2025-12-16T07:41:20.9690049+07:00</EffectiveDate>
<FormCategory>sample string 10</FormCategory>
<FormCode>sample string 4</FormCode>
<FormNumber>sample string 7</FormNumber>
<FormPublishedDate>2025-12-16T07:41:20.9690049+07:00</FormPublishedDate>
<FormSetItemID>sample string 20</FormSetItemID>
<FormTemplate>sample string 6</FormTemplate>
<FormTemplateID>8</FormTemplateID>
<FormTemplateSiteGuid>74171813-1c25-4813-b041-3524394b3e52</FormTemplateSiteGuid>
<FormTemplateWebGuid>0c8fb061-d9e5-4019-8469-92f9731d3cd5</FormTemplateWebGuid>
<FormType>sample string 5</FormType>
<Group>sample string 18</Group>
<HasIsoNumber>sample string 17</HasIsoNumber>
<HasTemplate>sample string 16</HasTemplate>
<HistoryListGuid>7cc22764-75f8-480d-bccf-bafc8cbb31c8</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>7e022195-1bb7-4d58-824b-73797dbf33ef</d4p1:ListGuid>
<d4p1:Ref>sample string 3</d4p1:Ref>
<d4p1:RefDisplayHTML>sample string 8</d4p1:RefDisplayHTML>
<d4p1:SiteGuid>8b2ce43f-60b5-4b43-95ac-648973de9314</d4p1:SiteGuid>
<d4p1:Title>sample string 2</d4p1:Title>
<d4p1:WebGuid>4193d5a0-0ba7-4d2f-93be-0cc12c3597c1</d4p1:WebGuid>
<d4p1:WebUrl>sample string 10</d4p1:WebUrl>
</MFItem>
<PRItemDetailListGuid>81e1fe76-f610-4c68-8e22-e7e8935e67ab</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:20.9690049+07:00</SubmittedDate>
<Title>sample string 2</Title>
<UniqueId>b9ed9887-f18b-4727-ba00-9ddca0a7c34f</UniqueId>
<WFName>sample string 11</WFName>
</FormItem>
<FormType>sample string 21</FormType>
<HistoryListGuid>00f71812-cdfb-4eb4-ad89-1b85a2f52a2d</HistoryListGuid>
<IsGenerateApprovalMatrix>true</IsGenerateApprovalMatrix>
<ItemId>5</ItemId>
<ItemUniqueId>7f457a95-b73a-4764-8df7-deb904f5a252</ItemUniqueId>
<KeyValue>sample string 22</KeyValue>
<ListGuid>b45a4bf2-8313-45d3-9ed1-106de883989e</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>1500822c-748d-4067-981a-c4567f28994a</SiteGuid>
<SyncPermission>true</SyncPermission>
<WFName>sample string 18</WFName>
<WebGuid>ff16fa3a-5285-46e2-a800-24f195ed2ad7</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>1478433c-d040-4463-8bd8-8375b2d62f21</DiscussionListGuid>
<DisplayMode>sample string 1</DisplayMode>
<DocLibListGuid>8d3dc90d-d1e7-4273-857a-e5016b2152cb</DocLibListGuid>
<EOfficeDataSiteUrl>sample string 19</EOfficeDataSiteUrl>
<FormCode>sample string 20</FormCode>
<FormItem>
<ApprovalStatus>sample string 9</ApprovalStatus>
<CurrentApproverDueDate>2025-12-16T07:41:20.9690049+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>b6d6b85e-259a-430e-bea1-7538b96a1307</DiscussionListGuid>
<DocLibListGuid>c4688d70-ef97-4203-aa89-57c1ba691b3e</DocLibListGuid>
<EffectiveDate>2025-12-16T07:41:20.9690049+07:00</EffectiveDate>
<FormCategory>sample string 10</FormCategory>
<FormCode>sample string 4</FormCode>
<FormNumber>sample string 7</FormNumber>
<FormPublishedDate>2025-12-16T07:41:20.9690049+07:00</FormPublishedDate>
<FormSetItemID>sample string 20</FormSetItemID>
<FormTemplate>sample string 6</FormTemplate>
<FormTemplateID>8</FormTemplateID>
<FormTemplateSiteGuid>74171813-1c25-4813-b041-3524394b3e52</FormTemplateSiteGuid>
<FormTemplateWebGuid>0c8fb061-d9e5-4019-8469-92f9731d3cd5</FormTemplateWebGuid>
<FormType>sample string 5</FormType>
<Group>sample string 18</Group>
<HasIsoNumber>sample string 17</HasIsoNumber>
<HasTemplate>sample string 16</HasTemplate>
<HistoryListGuid>7cc22764-75f8-480d-bccf-bafc8cbb31c8</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>7e022195-1bb7-4d58-824b-73797dbf33ef</d4p1:ListGuid>
<d4p1:Ref>sample string 3</d4p1:Ref>
<d4p1:RefDisplayHTML>sample string 8</d4p1:RefDisplayHTML>
<d4p1:SiteGuid>8b2ce43f-60b5-4b43-95ac-648973de9314</d4p1:SiteGuid>
<d4p1:Title>sample string 2</d4p1:Title>
<d4p1:WebGuid>4193d5a0-0ba7-4d2f-93be-0cc12c3597c1</d4p1:WebGuid>
<d4p1:WebUrl>sample string 10</d4p1:WebUrl>
</MFItem>
<PRItemDetailListGuid>81e1fe76-f610-4c68-8e22-e7e8935e67ab</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:20.9690049+07:00</SubmittedDate>
<Title>sample string 2</Title>
<UniqueId>b9ed9887-f18b-4727-ba00-9ddca0a7c34f</UniqueId>
<WFName>sample string 11</WFName>
</FormItem>
<FormType>sample string 21</FormType>
<HistoryListGuid>00f71812-cdfb-4eb4-ad89-1b85a2f52a2d</HistoryListGuid>
<IsGenerateApprovalMatrix>true</IsGenerateApprovalMatrix>
<ItemId>5</ItemId>
<ItemUniqueId>7f457a95-b73a-4764-8df7-deb904f5a252</ItemUniqueId>
<KeyValue>sample string 22</KeyValue>
<ListGuid>b45a4bf2-8313-45d3-9ed1-106de883989e</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>1500822c-748d-4067-981a-c4567f28994a</SiteGuid>
<SyncPermission>true</SyncPermission>
<WFName>sample string 18</WFName>
<WebGuid>ff16fa3a-5285-46e2-a800-24f195ed2ad7</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.