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": "57db9671-e651-448d-89f8-0068f29778e7", "HistoryListGuid": "1af785a6-c406-4ebf-bdff-4a5eb4c65489", "ItemId": 5, "itemId": "sample string 6", "ItemUniqueId": "a6b897f9-0abe-4baa-b2c3-fe82687343d7", "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": "c82f0d8f-3df8-4c36-9367-12b0c771f2ec", "DocLibListGuid": "fd00be28-b9c6-4194-abb2-129e3aacd552", "Settings": { "BackendApiUrl": "sample string 1", "EOfficeDataSiteUrl": "sample string 2", "HTTMSiteURL": "sample string 3" }, "FormItem": { "Id": 1, "UniqueId": "a68d616f-09ee-4190-bbf5-91ec6432c17c", "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": "ecd1d8b6-49dd-460d-b273-3d278b8adec3", "FormTemplateSiteGuid": "91c82897-ea94-4430-acbc-68d983803794", "FormPublishedDate": "2025-07-17T10:27:48.9158754+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": "b8a9de6e-f2d4-4653-a389-0cdae0f1588d", "DiscussionListGuid": "535094d6-84c3-4856-84aa-0b7e5fd31a75", "DocLibListGuid": "785cefb7-31e7-496f-9ed7-eba5a03bff1a", "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-07-17T10:27:48.9158754+07:00", "SubmittedDate": "2025-07-17T10:27:48.9158754+07:00", "CurrentGroup": "sample string 12", "CurrentApproverJobTitle": "sample string 13", "SubmitCounter": 14, "EffectiveDate": "2025-07-17T10:27:48.9158754+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": "3ecee8dd-5f23-4f39-8e6a-fb33e3729a74", "ListGuid": "0da7d63c-0c36-4793-9ec4-d5234c545881", "WebGuid": "806d5314-685e-4c83-b4f7-4c38dde9e357", "ItemId": 7, "RefDisplayHTML": "sample string 8", "FormCode": "sample string 9", "WebUrl": "sample string 10", "FormType": "sample string 11" }, "PRItemDetailListGuid": "7e331205-1e85-4435-a68e-593847ae89ad" }, "ClearAdditionalItemOnly": true, "ClearApprovalGroup": true, "SiteGuid": "dd8e0b39-23de-4ae1-9512-1941a20dbcf1", "WebGuid": "96244059-5275-4ef7-af06-e78acda37051", "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": "57db9671-e651-448d-89f8-0068f29778e7", "HistoryListGuid": "1af785a6-c406-4ebf-bdff-4a5eb4c65489", "ItemId": 5, "itemId": "sample string 6", "ItemUniqueId": "a6b897f9-0abe-4baa-b2c3-fe82687343d7", "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": "c82f0d8f-3df8-4c36-9367-12b0c771f2ec", "DocLibListGuid": "fd00be28-b9c6-4194-abb2-129e3aacd552", "Settings": { "BackendApiUrl": "sample string 1", "EOfficeDataSiteUrl": "sample string 2", "HTTMSiteURL": "sample string 3" }, "FormItem": { "Id": 1, "UniqueId": "a68d616f-09ee-4190-bbf5-91ec6432c17c", "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": "ecd1d8b6-49dd-460d-b273-3d278b8adec3", "FormTemplateSiteGuid": "91c82897-ea94-4430-acbc-68d983803794", "FormPublishedDate": "2025-07-17T10:27:48.9158754+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": "b8a9de6e-f2d4-4653-a389-0cdae0f1588d", "DiscussionListGuid": "535094d6-84c3-4856-84aa-0b7e5fd31a75", "DocLibListGuid": "785cefb7-31e7-496f-9ed7-eba5a03bff1a", "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-07-17T10:27:48.9158754+07:00", "SubmittedDate": "2025-07-17T10:27:48.9158754+07:00", "CurrentGroup": "sample string 12", "CurrentApproverJobTitle": "sample string 13", "SubmitCounter": 14, "EffectiveDate": "2025-07-17T10:27:48.9158754+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": "3ecee8dd-5f23-4f39-8e6a-fb33e3729a74", "ListGuid": "0da7d63c-0c36-4793-9ec4-d5234c545881", "WebGuid": "806d5314-685e-4c83-b4f7-4c38dde9e357", "ItemId": 7, "RefDisplayHTML": "sample string 8", "FormCode": "sample string 9", "WebUrl": "sample string 10", "FormType": "sample string 11" }, "PRItemDetailListGuid": "7e331205-1e85-4435-a68e-593847ae89ad" }, "ClearAdditionalItemOnly": true, "ClearApprovalGroup": true, "SiteGuid": "dd8e0b39-23de-4ae1-9512-1941a20dbcf1", "WebGuid": "96244059-5275-4ef7-af06-e78acda37051", "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>c82f0d8f-3df8-4c36-9367-12b0c771f2ec</DiscussionListGuid> <DisplayMode>sample string 1</DisplayMode> <DocLibListGuid>fd00be28-b9c6-4194-abb2-129e3aacd552</DocLibListGuid> <EOfficeDataSiteUrl>sample string 19</EOfficeDataSiteUrl> <FormCode>sample string 20</FormCode> <FormItem> <ApprovalStatus>sample string 9</ApprovalStatus> <CurrentApproverDueDate>2025-07-17T10:27:48.9158754+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>535094d6-84c3-4856-84aa-0b7e5fd31a75</DiscussionListGuid> <DocLibListGuid>785cefb7-31e7-496f-9ed7-eba5a03bff1a</DocLibListGuid> <EffectiveDate>2025-07-17T10:27:48.9158754+07:00</EffectiveDate> <FormCategory>sample string 10</FormCategory> <FormCode>sample string 4</FormCode> <FormNumber>sample string 7</FormNumber> <FormPublishedDate>2025-07-17T10:27:48.9158754+07:00</FormPublishedDate> <FormSetItemID>sample string 20</FormSetItemID> <FormTemplate>sample string 6</FormTemplate> <FormTemplateID>8</FormTemplateID> <FormTemplateSiteGuid>91c82897-ea94-4430-acbc-68d983803794</FormTemplateSiteGuid> <FormTemplateWebGuid>ecd1d8b6-49dd-460d-b273-3d278b8adec3</FormTemplateWebGuid> <FormType>sample string 5</FormType> <Group>sample string 18</Group> <HasIsoNumber>sample string 17</HasIsoNumber> <HasTemplate>sample string 16</HasTemplate> <HistoryListGuid>b8a9de6e-f2d4-4653-a389-0cdae0f1588d</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>0da7d63c-0c36-4793-9ec4-d5234c545881</d4p1:ListGuid> <d4p1:Ref>sample string 3</d4p1:Ref> <d4p1:RefDisplayHTML>sample string 8</d4p1:RefDisplayHTML> <d4p1:SiteGuid>3ecee8dd-5f23-4f39-8e6a-fb33e3729a74</d4p1:SiteGuid> <d4p1:Title>sample string 2</d4p1:Title> <d4p1:WebGuid>806d5314-685e-4c83-b4f7-4c38dde9e357</d4p1:WebGuid> <d4p1:WebUrl>sample string 10</d4p1:WebUrl> </MFItem> <PRItemDetailListGuid>7e331205-1e85-4435-a68e-593847ae89ad</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-07-17T10:27:48.9158754+07:00</SubmittedDate> <Title>sample string 2</Title> <UniqueId>a68d616f-09ee-4190-bbf5-91ec6432c17c</UniqueId> <WFName>sample string 11</WFName> </FormItem> <FormType>sample string 21</FormType> <HistoryListGuid>1af785a6-c406-4ebf-bdff-4a5eb4c65489</HistoryListGuid> <IsGenerateApprovalMatrix>true</IsGenerateApprovalMatrix> <ItemId>5</ItemId> <ItemUniqueId>a6b897f9-0abe-4baa-b2c3-fe82687343d7</ItemUniqueId> <KeyValue>sample string 22</KeyValue> <ListGuid>57db9671-e651-448d-89f8-0068f29778e7</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>dd8e0b39-23de-4ae1-9512-1941a20dbcf1</SiteGuid> <SyncPermission>true</SyncPermission> <WFName>sample string 18</WFName> <WebGuid>96244059-5275-4ef7-af06-e78acda37051</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>c82f0d8f-3df8-4c36-9367-12b0c771f2ec</DiscussionListGuid> <DisplayMode>sample string 1</DisplayMode> <DocLibListGuid>fd00be28-b9c6-4194-abb2-129e3aacd552</DocLibListGuid> <EOfficeDataSiteUrl>sample string 19</EOfficeDataSiteUrl> <FormCode>sample string 20</FormCode> <FormItem> <ApprovalStatus>sample string 9</ApprovalStatus> <CurrentApproverDueDate>2025-07-17T10:27:48.9158754+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>535094d6-84c3-4856-84aa-0b7e5fd31a75</DiscussionListGuid> <DocLibListGuid>785cefb7-31e7-496f-9ed7-eba5a03bff1a</DocLibListGuid> <EffectiveDate>2025-07-17T10:27:48.9158754+07:00</EffectiveDate> <FormCategory>sample string 10</FormCategory> <FormCode>sample string 4</FormCode> <FormNumber>sample string 7</FormNumber> <FormPublishedDate>2025-07-17T10:27:48.9158754+07:00</FormPublishedDate> <FormSetItemID>sample string 20</FormSetItemID> <FormTemplate>sample string 6</FormTemplate> <FormTemplateID>8</FormTemplateID> <FormTemplateSiteGuid>91c82897-ea94-4430-acbc-68d983803794</FormTemplateSiteGuid> <FormTemplateWebGuid>ecd1d8b6-49dd-460d-b273-3d278b8adec3</FormTemplateWebGuid> <FormType>sample string 5</FormType> <Group>sample string 18</Group> <HasIsoNumber>sample string 17</HasIsoNumber> <HasTemplate>sample string 16</HasTemplate> <HistoryListGuid>b8a9de6e-f2d4-4653-a389-0cdae0f1588d</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>0da7d63c-0c36-4793-9ec4-d5234c545881</d4p1:ListGuid> <d4p1:Ref>sample string 3</d4p1:Ref> <d4p1:RefDisplayHTML>sample string 8</d4p1:RefDisplayHTML> <d4p1:SiteGuid>3ecee8dd-5f23-4f39-8e6a-fb33e3729a74</d4p1:SiteGuid> <d4p1:Title>sample string 2</d4p1:Title> <d4p1:WebGuid>806d5314-685e-4c83-b4f7-4c38dde9e357</d4p1:WebGuid> <d4p1:WebUrl>sample string 10</d4p1:WebUrl> </MFItem> <PRItemDetailListGuid>7e331205-1e85-4435-a68e-593847ae89ad</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-07-17T10:27:48.9158754+07:00</SubmittedDate> <Title>sample string 2</Title> <UniqueId>a68d616f-09ee-4190-bbf5-91ec6432c17c</UniqueId> <WFName>sample string 11</WFName> </FormItem> <FormType>sample string 21</FormType> <HistoryListGuid>1af785a6-c406-4ebf-bdff-4a5eb4c65489</HistoryListGuid> <IsGenerateApprovalMatrix>true</IsGenerateApprovalMatrix> <ItemId>5</ItemId> <ItemUniqueId>a6b897f9-0abe-4baa-b2c3-fe82687343d7</ItemUniqueId> <KeyValue>sample string 22</KeyValue> <ListGuid>57db9671-e651-448d-89f8-0068f29778e7</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>dd8e0b39-23de-4ae1-9512-1941a20dbcf1</SiteGuid> <SyncPermission>true</SyncPermission> <WFName>sample string 18</WFName> <WebGuid>96244059-5275-4ef7-af06-e78acda37051</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.