POST api/Forms/GrantPermissionDOE
Request Information
URI Parameters
None.
Body Parameters
FormContext| Name | Description | Type | Additional information |
|---|---|---|---|
| DisplayMode | string |
None. |
|
| ListName | string |
None. |
|
| ListGuid | globally unique identifier |
None. |
|
| HistoryListGuid | globally unique identifier |
None. |
|
| ItemId | integer |
None. |
|
| itemId | string |
None. |
|
| ItemUniqueId | globally unique identifier |
None. |
|
| CurrentUser | FormUser |
None. |
|
| WebRelativeUrl | string |
None. |
|
| RootSiteUrl | string |
None. |
|
| WebUrl | string |
None. |
|
| DiscussionListGuid | globally unique identifier |
None. |
|
| DocLibListGuid | globally unique identifier |
None. |
|
| Settings | EOfficeSettings |
None. |
|
| FormItem | FormItem |
None. |
|
| ClearAdditionalItemOnly | boolean |
None. |
|
| ClearApprovalGroup | boolean |
None. |
|
| SiteGuid | globally unique identifier |
None. |
|
| WebGuid | globally unique identifier |
None. |
|
| SyncPermission | boolean |
None. |
|
| ClearApprovalMatrix | boolean |
None. |
|
| WFName | string |
None. |
|
| EOfficeDataSiteUrl | string |
None. |
|
| FormCode | string |
None. |
|
| FormType | string |
None. |
|
| KeyValue | string |
None. |
|
| IsGenerateApprovalMatrix | boolean |
None. |
Request Formats
application/json, text/json
Sample:
{
"DisplayMode": "sample string 1",
"ListName": "sample string 2",
"ListGuid": "0fff507c-90e1-4ad9-ad7b-25df65b8a519",
"HistoryListGuid": "d6e2215e-0eeb-4b0b-90f9-c6307090fb61",
"ItemId": 5,
"itemId": "sample string 6",
"ItemUniqueId": "5bbf5964-41a3-499c-8319-8a9641578759",
"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": "cb026cff-f829-4015-b1e0-0b5af0a5ad90",
"DocLibListGuid": "91c9ed83-8530-424b-91f7-0a0f08e37d02",
"Settings": {
"BackendApiUrl": "sample string 1",
"EOfficeDataSiteUrl": "sample string 2",
"HTTMSiteURL": "sample string 3"
},
"FormItem": {
"Id": 1,
"UniqueId": "dd8f9ee5-fd3c-44cd-a0f5-34a7aad87988",
"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": "86b8c911-60d6-4c5b-932f-ddc57ecd2ad6",
"FormTemplateSiteGuid": "e566fde7-93d5-42cc-a4c0-d0bc7711f7b9",
"FormPublishedDate": "2025-12-16T07:47:48.5993665+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": "0b01f103-1db2-461c-9546-f7f840760cff",
"DiscussionListGuid": "d07d0315-60cf-49d1-9c29-0053c2a6df98",
"DocLibListGuid": "e02d48bc-05a8-4439-b55c-31919a1b35de",
"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:47:48.5993665+07:00",
"SubmittedDate": "2025-12-16T07:47:48.5993665+07:00",
"CurrentGroup": "sample string 12",
"CurrentApproverJobTitle": "sample string 13",
"SubmitCounter": 14,
"EffectiveDate": "2025-12-16T07:47:48.5993665+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": "8ee4f21b-4c2a-4f4a-9fea-917142754d8f",
"ListGuid": "57104431-856a-4658-846f-b9d8f360728c",
"WebGuid": "3fd6a60f-c4ab-419c-9809-ff0c597784af",
"ItemId": 7,
"RefDisplayHTML": "sample string 8",
"FormCode": "sample string 9",
"WebUrl": "sample string 10",
"FormType": "sample string 11"
},
"PRItemDetailListGuid": "eba1e9d4-4e00-4d2f-8541-7c9534cd20e1"
},
"ClearAdditionalItemOnly": true,
"ClearApprovalGroup": true,
"SiteGuid": "e2c7d4e7-4448-49a9-ac97-4cccaf26396d",
"WebGuid": "ee3fc262-4c45-407f-a3f0-f5bb2149302d",
"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:
<FormContext xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Appvity.eOffice.Backend.Models">
<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>cb026cff-f829-4015-b1e0-0b5af0a5ad90</DiscussionListGuid>
<DisplayMode>sample string 1</DisplayMode>
<DocLibListGuid>91c9ed83-8530-424b-91f7-0a0f08e37d02</DocLibListGuid>
<EOfficeDataSiteUrl>sample string 19</EOfficeDataSiteUrl>
<FormCode>sample string 20</FormCode>
<FormItem>
<ApprovalStatus>sample string 9</ApprovalStatus>
<CurrentApproverDueDate>2025-12-16T07:47:48.5993665+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>d07d0315-60cf-49d1-9c29-0053c2a6df98</DiscussionListGuid>
<DocLibListGuid>e02d48bc-05a8-4439-b55c-31919a1b35de</DocLibListGuid>
<EffectiveDate>2025-12-16T07:47:48.5993665+07:00</EffectiveDate>
<FormCategory>sample string 10</FormCategory>
<FormCode>sample string 4</FormCode>
<FormNumber>sample string 7</FormNumber>
<FormPublishedDate>2025-12-16T07:47:48.5993665+07:00</FormPublishedDate>
<FormSetItemID>sample string 20</FormSetItemID>
<FormTemplate>sample string 6</FormTemplate>
<FormTemplateID>8</FormTemplateID>
<FormTemplateSiteGuid>e566fde7-93d5-42cc-a4c0-d0bc7711f7b9</FormTemplateSiteGuid>
<FormTemplateWebGuid>86b8c911-60d6-4c5b-932f-ddc57ecd2ad6</FormTemplateWebGuid>
<FormType>sample string 5</FormType>
<Group>sample string 18</Group>
<HasIsoNumber>sample string 17</HasIsoNumber>
<HasTemplate>sample string 16</HasTemplate>
<HistoryListGuid>0b01f103-1db2-461c-9546-f7f840760cff</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>57104431-856a-4658-846f-b9d8f360728c</d3p1:ListGuid>
<d3p1:Ref>sample string 3</d3p1:Ref>
<d3p1:RefDisplayHTML>sample string 8</d3p1:RefDisplayHTML>
<d3p1:SiteGuid>8ee4f21b-4c2a-4f4a-9fea-917142754d8f</d3p1:SiteGuid>
<d3p1:Title>sample string 2</d3p1:Title>
<d3p1:WebGuid>3fd6a60f-c4ab-419c-9809-ff0c597784af</d3p1:WebGuid>
<d3p1:WebUrl>sample string 10</d3p1:WebUrl>
</MFItem>
<PRItemDetailListGuid>eba1e9d4-4e00-4d2f-8541-7c9534cd20e1</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:47:48.5993665+07:00</SubmittedDate>
<Title>sample string 2</Title>
<UniqueId>dd8f9ee5-fd3c-44cd-a0f5-34a7aad87988</UniqueId>
<WFName>sample string 11</WFName>
</FormItem>
<FormType>sample string 21</FormType>
<HistoryListGuid>d6e2215e-0eeb-4b0b-90f9-c6307090fb61</HistoryListGuid>
<IsGenerateApprovalMatrix>true</IsGenerateApprovalMatrix>
<ItemId>5</ItemId>
<ItemUniqueId>5bbf5964-41a3-499c-8319-8a9641578759</ItemUniqueId>
<KeyValue>sample string 22</KeyValue>
<ListGuid>0fff507c-90e1-4ad9-ad7b-25df65b8a519</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>e2c7d4e7-4448-49a9-ac97-4cccaf26396d</SiteGuid>
<SyncPermission>true</SyncPermission>
<WFName>sample string 18</WFName>
<WebGuid>ee3fc262-4c45-407f-a3f0-f5bb2149302d</WebGuid>
<WebRelativeUrl>sample string 8</WebRelativeUrl>
<WebUrl>sample string 10</WebUrl>
<itemId>sample string 6</itemId>
</FormContext>
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.