POST api/Forms/DeleteItemDraft
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": "67380501-0c37-4fcc-8079-041324937192",
"HistoryListGuid": "282fdbfb-9021-4b32-84f7-81cfb4668acd",
"ItemId": 5,
"itemId": "sample string 6",
"ItemUniqueId": "ee4cb50a-c70c-4c77-a244-4791c160b158",
"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": "209a0903-e4fe-43d2-b33c-b9e6e69e4ada",
"DocLibListGuid": "588d0b90-6ca7-4b38-8ee5-f8f483c3814a",
"Settings": {
"BackendApiUrl": "sample string 1",
"EOfficeDataSiteUrl": "sample string 2",
"HTTMSiteURL": "sample string 3"
},
"FormItem": {
"Id": 1,
"UniqueId": "d941d56d-42ce-4865-916d-9641603cdff6",
"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": "729d9ff5-8c45-4732-ba24-f7080f0c36f4",
"FormTemplateSiteGuid": "bbdab62d-a77f-477c-91ca-3f1394d812d9",
"FormPublishedDate": "2026-08-08T13:13:53.2496373+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": "29b85886-06c3-4de9-a02b-c25502278f48",
"DiscussionListGuid": "b67b5fb1-f582-46d0-9be4-2e826dbce804",
"DocLibListGuid": "bc1875e0-b357-4b93-84eb-e8a9c86e20ab",
"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-08-08T13:13:53.2496373+07:00",
"SubmittedDate": "2026-08-08T13:13:53.2496373+07:00",
"CurrentGroup": "sample string 12",
"CurrentApproverJobTitle": "sample string 13",
"SubmitCounter": 14,
"EffectiveDate": "2026-08-08T13:13:53.2496373+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": "33338042-c765-4987-9c08-53b17d9d79ab",
"ListGuid": "40ad74c5-2135-4ee2-a9bc-e20587caf4dc",
"WebGuid": "942c4877-fe32-40e9-a494-127fb78f696a",
"ItemId": 7,
"RefDisplayHTML": "sample string 8",
"FormCode": "sample string 9",
"WebUrl": "sample string 10",
"FormType": "sample string 11"
},
"PRItemDetailListGuid": "9892942d-9c53-4141-88e2-a2157a3ccd25"
},
"ClearAdditionalItemOnly": true,
"ClearApprovalGroup": true,
"SiteGuid": "b521d95d-2524-4f7b-aae1-918d8b8c626f",
"WebGuid": "43c75546-4cc3-4835-bcaa-0e217d04fab0",
"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>209a0903-e4fe-43d2-b33c-b9e6e69e4ada</DiscussionListGuid>
<DisplayMode>sample string 1</DisplayMode>
<DocLibListGuid>588d0b90-6ca7-4b38-8ee5-f8f483c3814a</DocLibListGuid>
<EOfficeDataSiteUrl>sample string 19</EOfficeDataSiteUrl>
<FormCode>sample string 20</FormCode>
<FormItem>
<ApprovalStatus>sample string 9</ApprovalStatus>
<CurrentApproverDueDate>2026-08-08T13:13:53.2496373+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>b67b5fb1-f582-46d0-9be4-2e826dbce804</DiscussionListGuid>
<DocLibListGuid>bc1875e0-b357-4b93-84eb-e8a9c86e20ab</DocLibListGuid>
<EffectiveDate>2026-08-08T13:13:53.2496373+07:00</EffectiveDate>
<FormCategory>sample string 10</FormCategory>
<FormCode>sample string 4</FormCode>
<FormNumber>sample string 7</FormNumber>
<FormPublishedDate>2026-08-08T13:13:53.2496373+07:00</FormPublishedDate>
<FormSetItemID>sample string 20</FormSetItemID>
<FormTemplate>sample string 6</FormTemplate>
<FormTemplateID>8</FormTemplateID>
<FormTemplateSiteGuid>bbdab62d-a77f-477c-91ca-3f1394d812d9</FormTemplateSiteGuid>
<FormTemplateWebGuid>729d9ff5-8c45-4732-ba24-f7080f0c36f4</FormTemplateWebGuid>
<FormType>sample string 5</FormType>
<Group>sample string 18</Group>
<HasIsoNumber>sample string 17</HasIsoNumber>
<HasTemplate>sample string 16</HasTemplate>
<HistoryListGuid>29b85886-06c3-4de9-a02b-c25502278f48</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>40ad74c5-2135-4ee2-a9bc-e20587caf4dc</d3p1:ListGuid>
<d3p1:Ref>sample string 3</d3p1:Ref>
<d3p1:RefDisplayHTML>sample string 8</d3p1:RefDisplayHTML>
<d3p1:SiteGuid>33338042-c765-4987-9c08-53b17d9d79ab</d3p1:SiteGuid>
<d3p1:Title>sample string 2</d3p1:Title>
<d3p1:WebGuid>942c4877-fe32-40e9-a494-127fb78f696a</d3p1:WebGuid>
<d3p1:WebUrl>sample string 10</d3p1:WebUrl>
</MFItem>
<PRItemDetailListGuid>9892942d-9c53-4141-88e2-a2157a3ccd25</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-08-08T13:13:53.2496373+07:00</SubmittedDate>
<Title>sample string 2</Title>
<UniqueId>d941d56d-42ce-4865-916d-9641603cdff6</UniqueId>
<WFName>sample string 11</WFName>
</FormItem>
<FormType>sample string 21</FormType>
<HistoryListGuid>282fdbfb-9021-4b32-84f7-81cfb4668acd</HistoryListGuid>
<IsGenerateApprovalMatrix>true</IsGenerateApprovalMatrix>
<ItemId>5</ItemId>
<ItemUniqueId>ee4cb50a-c70c-4c77-a244-4791c160b158</ItemUniqueId>
<KeyValue>sample string 22</KeyValue>
<ListGuid>67380501-0c37-4fcc-8079-041324937192</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>b521d95d-2524-4f7b-aae1-918d8b8c626f</SiteGuid>
<SyncPermission>true</SyncPermission>
<WFName>sample string 18</WFName>
<WebGuid>43c75546-4cc3-4835-bcaa-0e217d04fab0</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.