POST api/Forms/AddAdditionApprover
Request Information
URI Parameters
None.
Body Parameters
WFApproverName | Description | Type | Additional information |
---|---|---|---|
FormContext | FormContext |
None. |
|
FormItem | FormItem |
None. |
|
IsAdditional | boolean |
None. |
|
ButtonText | string |
None. |
|
DueDate | date |
None. |
|
Comment | string |
None. |
|
CompletedDate | date |
None. |
|
DelegatedUser | FormUser |
None. |
|
ItemId | integer |
None. |
|
ListId | globally unique identifier |
None. |
|
Outcome | string |
None. |
|
Parameters | string |
None. |
|
PostActions | string |
None. |
|
PreActions | string |
None. |
|
Group | string |
None. |
|
SortOrder | integer |
None. |
|
StartDate | date |
None. |
|
TaskId | integer |
None. |
|
Title | string |
None. |
|
User | FormUser |
None. |
|
WFId | globally unique identifier |
None. |
|
WFName | string |
None. |
|
ApprovalGroup | WFAprpovalGroup |
None. |
|
IsActive | boolean |
None. |
|
JobTitle | string |
None. |
|
ID | integer |
None. |
|
ShowInEmail | boolean |
None. |
|
ShowInPrintPreview | boolean |
None. |
Request Formats
application/json, text/json
Sample:
{ "FormContext": { "DisplayMode": "sample string 1", "ListName": "sample string 2", "ListGuid": "8e7af5b0-8a72-4110-808a-64251207d710", "HistoryListGuid": "7d681549-1de2-4fa3-8f92-dea1e28633eb", "ItemId": 5, "itemId": "sample string 6", "ItemUniqueId": "f7a9c6ff-2d87-4089-9f27-527897acc6ac", "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": "cd3eaa66-810c-4bc0-8b35-08edfbcd2909", "DocLibListGuid": "78ea6889-a9d6-4977-bb0a-303b69febf1d", "Settings": { "BackendApiUrl": "sample string 1", "EOfficeDataSiteUrl": "sample string 2", "HTTMSiteURL": "sample string 3" }, "FormItem": { "Id": 1, "UniqueId": "c61a83ae-8a3b-4cfe-b801-903fa151744a", "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": "6b237883-ddaa-419c-bfd4-62aa3a74836c", "FormTemplateSiteGuid": "752b462c-d67d-4568-ba23-5f14156f919a", "FormPublishedDate": "2025-07-17T10:34:47.0108311+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": "c076bf54-12e5-4822-9094-22c0af37a8ad", "DiscussionListGuid": "9d62d7fd-be85-4a9c-b979-05c55a42e3d8", "DocLibListGuid": "346e4f48-4280-43db-9578-63f613d005f0", "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:34:47.0108311+07:00", "SubmittedDate": "2025-07-17T10:34:47.0108311+07:00", "CurrentGroup": "sample string 12", "CurrentApproverJobTitle": "sample string 13", "SubmitCounter": 14, "EffectiveDate": "2025-07-17T10:34:47.0108311+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": "b280df7f-c576-4400-bcf0-86689ffe535e", "ListGuid": "f067c9fc-97f5-4a16-a619-ca3d9d232b7f", "WebGuid": "e9a2f7c3-e719-4abf-a858-57ff44871645", "ItemId": 7, "RefDisplayHTML": "sample string 8", "FormCode": "sample string 9", "WebUrl": "sample string 10", "FormType": "sample string 11" }, "PRItemDetailListGuid": "1cbc68a5-7b3a-45fa-83d7-7967569bfe02" }, "ClearAdditionalItemOnly": true, "ClearApprovalGroup": true, "SiteGuid": "fd1e4eac-1505-4e06-b334-bed0a39686a1", "WebGuid": "16fab3b9-20c3-4a67-b5f8-1f8936344d0d", "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 }, "FormItem": { "Id": 1, "UniqueId": "c61a83ae-8a3b-4cfe-b801-903fa151744a", "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": "6b237883-ddaa-419c-bfd4-62aa3a74836c", "FormTemplateSiteGuid": "752b462c-d67d-4568-ba23-5f14156f919a", "FormPublishedDate": "2025-07-17T10:34:47.0108311+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": "c076bf54-12e5-4822-9094-22c0af37a8ad", "DiscussionListGuid": "9d62d7fd-be85-4a9c-b979-05c55a42e3d8", "DocLibListGuid": "346e4f48-4280-43db-9578-63f613d005f0", "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:34:47.0108311+07:00", "SubmittedDate": "2025-07-17T10:34:47.0108311+07:00", "CurrentGroup": "sample string 12", "CurrentApproverJobTitle": "sample string 13", "SubmitCounter": 14, "EffectiveDate": "2025-07-17T10:34:47.0108311+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": "b280df7f-c576-4400-bcf0-86689ffe535e", "ListGuid": "f067c9fc-97f5-4a16-a619-ca3d9d232b7f", "WebGuid": "e9a2f7c3-e719-4abf-a858-57ff44871645", "ItemId": 7, "RefDisplayHTML": "sample string 8", "FormCode": "sample string 9", "WebUrl": "sample string 10", "FormType": "sample string 11" }, "PRItemDetailListGuid": "1cbc68a5-7b3a-45fa-83d7-7967569bfe02" }, "IsAdditional": true, "ButtonText": "sample string 2", "DueDate": "2025-07-17T10:34:47.0108311+07:00", "Comment": "sample string 3", "CompletedDate": "2025-07-17T10:34:47.0108311+07:00", "DelegatedUser": { "Id": 1, "Email": "sample string 2", "Username": "sample string 3", "DisplayName": "sample string 4", "PictureURL": "sample string 5" }, "ItemId": 4, "ListId": "18c48181-859f-4dc6-9beb-9db1fdaf2a9d", "Outcome": "sample string 6", "Parameters": "sample string 7", "PostActions": "sample string 8", "PreActions": "sample string 9", "Group": "sample string 10", "SortOrder": 11, "StartDate": "2025-07-17T10:34:47.0108311+07:00", "TaskId": 1, "Title": "sample string 12", "User": { "Id": 1, "Email": "sample string 2", "Username": "sample string 3", "DisplayName": "sample string 4", "PictureURL": "sample string 5" }, "WFId": "481c91bd-3c8d-4c8f-bb6b-e163311a8720", "WFName": "sample string 14", "ApprovalGroup": { "Id": 1, "ApprovalGroup": "sample string 2", "ApprovalGroupDisplayName": "sample string 3", "ApprovalGroupStatus": "sample string 4", "ApprovalType": "sample string 5", "ApprovalDialog": "sample string 6", "AutoApproveInMinutes": 7, "Behaviour": "sample string 8", "CanSendBack": true, "CompleteIfSameAccountApproved": true, "DueInDays": 11, "IsAllowAdditional": true, "IsAllowDelegation": true, "IsAllowLazyApproval": true, "IsAutoApprove": true, "IsNotifyRequester": true, "ListId": "sample string 17", "IsRequired": true, "ItemID": 19, "ItemStatusAfterApprove": "sample string 20", "ItemStatusAfterReject": "sample string 21", "ItemStatusAfterCompleted": "sample string 22", "MinutesBtwReminders": "sample string 23", "Notes": "sample string 24", "NotifyRequesterInMinutes": 25, "NumberOfReminders": 26, "RejectDialog": "sample string 27" }, "IsActive": true, "JobTitle": "sample string 16", "ID": 17, "ShowInEmail": true, "ShowInPrintPreview": true }
application/xml, text/xml
Sample:
<WFApprover xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Appvity.eOffice.Backend.Models"> <ApprovalGroup> <ApprovalDialog>sample string 6</ApprovalDialog> <ApprovalGroup>sample string 2</ApprovalGroup> <ApprovalGroupDisplayName>sample string 3</ApprovalGroupDisplayName> <ApprovalGroupStatus>sample string 4</ApprovalGroupStatus> <ApprovalType>sample string 5</ApprovalType> <AutoApproveInMinutes>7</AutoApproveInMinutes> <Behaviour>sample string 8</Behaviour> <CanSendBack>true</CanSendBack> <CompleteIfSameAccountApproved>true</CompleteIfSameAccountApproved> <DueInDays>11</DueInDays> <Id>1</Id> <IsAllowAdditional>true</IsAllowAdditional> <IsAllowDelegation>true</IsAllowDelegation> <IsAllowLazyApproval>true</IsAllowLazyApproval> <IsAutoApprove>true</IsAutoApprove> <IsNotifyRequester>true</IsNotifyRequester> <IsRequired>true</IsRequired> <ItemID>19</ItemID> <ItemStatusAfterApprove>sample string 20</ItemStatusAfterApprove> <ItemStatusAfterCompleted>sample string 22</ItemStatusAfterCompleted> <ItemStatusAfterReject>sample string 21</ItemStatusAfterReject> <ListId>sample string 17</ListId> <MinutesBtwReminders>sample string 23</MinutesBtwReminders> <Notes>sample string 24</Notes> <NotifyRequesterInMinutes>25</NotifyRequesterInMinutes> <NumberOfReminders>26</NumberOfReminders> <RejectDialog>sample string 27</RejectDialog> </ApprovalGroup> <ButtonText>sample string 2</ButtonText> <Comment>sample string 3</Comment> <CompletedDate>2025-07-17T10:34:47.0108311+07:00</CompletedDate> <DelegatedUser> <DisplayName>sample string 4</DisplayName> <Email>sample string 2</Email> <Id>1</Id> <PictureURL>sample string 5</PictureURL> <Username>sample string 3</Username> </DelegatedUser> <DueDate>2025-07-17T10:34:47.0108311+07:00</DueDate> <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>cd3eaa66-810c-4bc0-8b35-08edfbcd2909</DiscussionListGuid> <DisplayMode>sample string 1</DisplayMode> <DocLibListGuid>78ea6889-a9d6-4977-bb0a-303b69febf1d</DocLibListGuid> <EOfficeDataSiteUrl>sample string 19</EOfficeDataSiteUrl> <FormCode>sample string 20</FormCode> <FormItem> <ApprovalStatus>sample string 9</ApprovalStatus> <CurrentApproverDueDate>2025-07-17T10:34:47.0108311+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>9d62d7fd-be85-4a9c-b979-05c55a42e3d8</DiscussionListGuid> <DocLibListGuid>346e4f48-4280-43db-9578-63f613d005f0</DocLibListGuid> <EffectiveDate>2025-07-17T10:34:47.0108311+07:00</EffectiveDate> <FormCategory>sample string 10</FormCategory> <FormCode>sample string 4</FormCode> <FormNumber>sample string 7</FormNumber> <FormPublishedDate>2025-07-17T10:34:47.0108311+07:00</FormPublishedDate> <FormSetItemID>sample string 20</FormSetItemID> <FormTemplate>sample string 6</FormTemplate> <FormTemplateID>8</FormTemplateID> <FormTemplateSiteGuid>752b462c-d67d-4568-ba23-5f14156f919a</FormTemplateSiteGuid> <FormTemplateWebGuid>6b237883-ddaa-419c-bfd4-62aa3a74836c</FormTemplateWebGuid> <FormType>sample string 5</FormType> <Group>sample string 18</Group> <HasIsoNumber>sample string 17</HasIsoNumber> <HasTemplate>sample string 16</HasTemplate> <HistoryListGuid>c076bf54-12e5-4822-9094-22c0af37a8ad</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>f067c9fc-97f5-4a16-a619-ca3d9d232b7f</d4p1:ListGuid> <d4p1:Ref>sample string 3</d4p1:Ref> <d4p1:RefDisplayHTML>sample string 8</d4p1:RefDisplayHTML> <d4p1:SiteGuid>b280df7f-c576-4400-bcf0-86689ffe535e</d4p1:SiteGuid> <d4p1:Title>sample string 2</d4p1:Title> <d4p1:WebGuid>e9a2f7c3-e719-4abf-a858-57ff44871645</d4p1:WebGuid> <d4p1:WebUrl>sample string 10</d4p1:WebUrl> </MFItem> <PRItemDetailListGuid>1cbc68a5-7b3a-45fa-83d7-7967569bfe02</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:34:47.0108311+07:00</SubmittedDate> <Title>sample string 2</Title> <UniqueId>c61a83ae-8a3b-4cfe-b801-903fa151744a</UniqueId> <WFName>sample string 11</WFName> </FormItem> <FormType>sample string 21</FormType> <HistoryListGuid>7d681549-1de2-4fa3-8f92-dea1e28633eb</HistoryListGuid> <IsGenerateApprovalMatrix>true</IsGenerateApprovalMatrix> <ItemId>5</ItemId> <ItemUniqueId>f7a9c6ff-2d87-4089-9f27-527897acc6ac</ItemUniqueId> <KeyValue>sample string 22</KeyValue> <ListGuid>8e7af5b0-8a72-4110-808a-64251207d710</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>fd1e4eac-1505-4e06-b334-bed0a39686a1</SiteGuid> <SyncPermission>true</SyncPermission> <WFName>sample string 18</WFName> <WebGuid>16fab3b9-20c3-4a67-b5f8-1f8936344d0d</WebGuid> <WebRelativeUrl>sample string 8</WebRelativeUrl> <WebUrl>sample string 10</WebUrl> <itemId>sample string 6</itemId> </FormContext> <FormItem> <ApprovalStatus>sample string 9</ApprovalStatus> <CurrentApproverDueDate>2025-07-17T10:34:47.0108311+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:d3p1="http://schemas.datacontract.org/2004/07/Microsoft.SharePoint.Client.Taxonomy"> <d3p1:Label>sample string 1</d3p1:Label> <d3p1:TermGuid>sample string 2</d3p1:TermGuid> <d3p1:WssId>3</d3p1:WssId> </Department> <DiscussionListGuid>9d62d7fd-be85-4a9c-b979-05c55a42e3d8</DiscussionListGuid> <DocLibListGuid>346e4f48-4280-43db-9578-63f613d005f0</DocLibListGuid> <EffectiveDate>2025-07-17T10:34:47.0108311+07:00</EffectiveDate> <FormCategory>sample string 10</FormCategory> <FormCode>sample string 4</FormCode> <FormNumber>sample string 7</FormNumber> <FormPublishedDate>2025-07-17T10:34:47.0108311+07:00</FormPublishedDate> <FormSetItemID>sample string 20</FormSetItemID> <FormTemplate>sample string 6</FormTemplate> <FormTemplateID>8</FormTemplateID> <FormTemplateSiteGuid>752b462c-d67d-4568-ba23-5f14156f919a</FormTemplateSiteGuid> <FormTemplateWebGuid>6b237883-ddaa-419c-bfd4-62aa3a74836c</FormTemplateWebGuid> <FormType>sample string 5</FormType> <Group>sample string 18</Group> <HasIsoNumber>sample string 17</HasIsoNumber> <HasTemplate>sample string 16</HasTemplate> <HistoryListGuid>c076bf54-12e5-4822-9094-22c0af37a8ad</HistoryListGuid> <Id>1</Id> <IsoNumber>sample string 15</IsoNumber> <MFItem xmlns:d3p1="http://schemas.datacontract.org/2004/07/Appvity.eOffice.Backend.Services.MFService"> <d3p1:FormCode>sample string 9</d3p1:FormCode> <d3p1:FormType>sample string 11</d3p1:FormType> <d3p1:Id>1</d3p1:Id> <d3p1:ItemId>7</d3p1:ItemId> <d3p1:ListGuid>f067c9fc-97f5-4a16-a619-ca3d9d232b7f</d3p1:ListGuid> <d3p1:Ref>sample string 3</d3p1:Ref> <d3p1:RefDisplayHTML>sample string 8</d3p1:RefDisplayHTML> <d3p1:SiteGuid>b280df7f-c576-4400-bcf0-86689ffe535e</d3p1:SiteGuid> <d3p1:Title>sample string 2</d3p1:Title> <d3p1:WebGuid>e9a2f7c3-e719-4abf-a858-57ff44871645</d3p1:WebGuid> <d3p1:WebUrl>sample string 10</d3p1:WebUrl> </MFItem> <PRItemDetailListGuid>1cbc68a5-7b3a-45fa-83d7-7967569bfe02</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:34:47.0108311+07:00</SubmittedDate> <Title>sample string 2</Title> <UniqueId>c61a83ae-8a3b-4cfe-b801-903fa151744a</UniqueId> <WFName>sample string 11</WFName> </FormItem> <Group>sample string 10</Group> <ID>17</ID> <IsActive>true</IsActive> <IsAdditional>true</IsAdditional> <ItemId>4</ItemId> <JobTitle>sample string 16</JobTitle> <ListId>18c48181-859f-4dc6-9beb-9db1fdaf2a9d</ListId> <Outcome>sample string 6</Outcome> <Parameters>sample string 7</Parameters> <PostActions>sample string 8</PostActions> <PreActions>sample string 9</PreActions> <ShowInEmail>true</ShowInEmail> <ShowInPrintPreview>true</ShowInPrintPreview> <SortOrder>11</SortOrder> <StartDate>2025-07-17T10:34:47.0108311+07:00</StartDate> <TaskId>1</TaskId> <Title>sample string 12</Title> <User> <DisplayName>sample string 4</DisplayName> <Email>sample string 2</Email> <Id>1</Id> <PictureURL>sample string 5</PictureURL> <Username>sample string 3</Username> </User> <WFId>481c91bd-3c8d-4c8f-bb6b-e163311a8720</WFId> <WFName>sample string 14</WFName> </WFApprover>
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.