POST api/Forms/GenerateApprovalMatrix

Request Information

URI Parameters

None.

Body Parameters

Name	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": "39017009-da6e-464c-8b30-8fa5727575a5",
  "HistoryListGuid": "5ab87134-253c-4010-8df8-ac743f30d7e0",
  "ItemId": 5,
  "itemId": "sample string 6",
  "ItemUniqueId": "cc0cb6c0-8feb-4206-a493-9bb8e1c02d87",
  "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": "e965100f-2ac3-4c9c-8eef-a6d3431a44b8",
  "DocLibListGuid": "799193a6-e0b1-4176-902d-ebc27aa22000",
  "Settings": {
    "BackendApiUrl": "sample string 1",
    "EOfficeDataSiteUrl": "sample string 2",
    "HTTMSiteURL": "sample string 3"
  },
  "FormItem": {
    "Id": 1,
    "UniqueId": "2f8636fc-0b00-4d84-82ee-b746e8a02ad4",
    "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": "4a8c4a3e-8340-4d03-a782-3cf091df4ce6",
    "FormTemplateSiteGuid": "8c7b0ac1-da65-4b9e-98d3-5dff2457d5b7",
    "FormPublishedDate": "2025-12-16T07:42:13.7053637+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": "ed134114-c8b8-4161-bcd1-43ca9b0bc1a7",
    "DiscussionListGuid": "8fa857bd-a5ba-4dea-b7f2-8e691bf4171c",
    "DocLibListGuid": "c5a542e6-95af-4d52-8652-51651735d79b",
    "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:42:13.7053637+07:00",
    "SubmittedDate": "2025-12-16T07:42:13.7053637+07:00",
    "CurrentGroup": "sample string 12",
    "CurrentApproverJobTitle": "sample string 13",
    "SubmitCounter": 14,
    "EffectiveDate": "2025-12-16T07:42:13.7053637+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": "8f6c1d4c-4bd8-42b8-ad74-3c06080a1f39",
      "ListGuid": "777bc662-1a1a-4947-8c67-6a048e564c87",
      "WebGuid": "facff054-e62d-4f00-a983-6239aa7a8806",
      "ItemId": 7,
      "RefDisplayHTML": "sample string 8",
      "FormCode": "sample string 9",
      "WebUrl": "sample string 10",
      "FormType": "sample string 11"
    },
    "PRItemDetailListGuid": "2c1386de-f9f4-441c-b882-8a88217254d9"
  },
  "ClearAdditionalItemOnly": true,
  "ClearApprovalGroup": true,
  "SiteGuid": "89e856ad-2b18-46b5-b5dc-43d6bbe2a3d0",
  "WebGuid": "d9dc9697-973f-428f-8c37-fd1caaceae96",
  "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>e965100f-2ac3-4c9c-8eef-a6d3431a44b8</DiscussionListGuid>
  <DisplayMode>sample string 1</DisplayMode>
  <DocLibListGuid>799193a6-e0b1-4176-902d-ebc27aa22000</DocLibListGuid>
  <EOfficeDataSiteUrl>sample string 19</EOfficeDataSiteUrl>
  <FormCode>sample string 20</FormCode>
  <FormItem>
    <ApprovalStatus>sample string 9</ApprovalStatus>
    <CurrentApproverDueDate>2025-12-16T07:42:13.7053637+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>8fa857bd-a5ba-4dea-b7f2-8e691bf4171c</DiscussionListGuid>
    <DocLibListGuid>c5a542e6-95af-4d52-8652-51651735d79b</DocLibListGuid>
    <EffectiveDate>2025-12-16T07:42:13.7053637+07:00</EffectiveDate>
    <FormCategory>sample string 10</FormCategory>
    <FormCode>sample string 4</FormCode>
    <FormNumber>sample string 7</FormNumber>
    <FormPublishedDate>2025-12-16T07:42:13.7053637+07:00</FormPublishedDate>
    <FormSetItemID>sample string 20</FormSetItemID>
    <FormTemplate>sample string 6</FormTemplate>
    <FormTemplateID>8</FormTemplateID>
    <FormTemplateSiteGuid>8c7b0ac1-da65-4b9e-98d3-5dff2457d5b7</FormTemplateSiteGuid>
    <FormTemplateWebGuid>4a8c4a3e-8340-4d03-a782-3cf091df4ce6</FormTemplateWebGuid>
    <FormType>sample string 5</FormType>
    <Group>sample string 18</Group>
    <HasIsoNumber>sample string 17</HasIsoNumber>
    <HasTemplate>sample string 16</HasTemplate>
    <HistoryListGuid>ed134114-c8b8-4161-bcd1-43ca9b0bc1a7</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>777bc662-1a1a-4947-8c67-6a048e564c87</d3p1:ListGuid>
      <d3p1:Ref>sample string 3</d3p1:Ref>
      <d3p1:RefDisplayHTML>sample string 8</d3p1:RefDisplayHTML>
      <d3p1:SiteGuid>8f6c1d4c-4bd8-42b8-ad74-3c06080a1f39</d3p1:SiteGuid>
      <d3p1:Title>sample string 2</d3p1:Title>
      <d3p1:WebGuid>facff054-e62d-4f00-a983-6239aa7a8806</d3p1:WebGuid>
      <d3p1:WebUrl>sample string 10</d3p1:WebUrl>
    </MFItem>
    <PRItemDetailListGuid>2c1386de-f9f4-441c-b882-8a88217254d9</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:42:13.7053637+07:00</SubmittedDate>
    <Title>sample string 2</Title>
    <UniqueId>2f8636fc-0b00-4d84-82ee-b746e8a02ad4</UniqueId>
    <WFName>sample string 11</WFName>
  </FormItem>
  <FormType>sample string 21</FormType>
  <HistoryListGuid>5ab87134-253c-4010-8df8-ac743f30d7e0</HistoryListGuid>
  <IsGenerateApprovalMatrix>true</IsGenerateApprovalMatrix>
  <ItemId>5</ItemId>
  <ItemUniqueId>cc0cb6c0-8feb-4206-a493-9bb8e1c02d87</ItemUniqueId>
  <KeyValue>sample string 22</KeyValue>
  <ListGuid>39017009-da6e-464c-8b30-8fa5727575a5</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>89e856ad-2b18-46b5-b5dc-43d6bbe2a3d0</SiteGuid>
  <SyncPermission>true</SyncPermission>
  <WFName>sample string 18</WFName>
  <WebGuid>d9dc9697-973f-428f-8c37-fd1caaceae96</WebGuid>
  <WebRelativeUrl>sample string 8</WebRelativeUrl>
  <WebUrl>sample string 10</WebUrl>
  <itemId>sample string 6</itemId>
</FormContext>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'FormContext'.

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json, application/xml, text/xml

Sample:

Sample not available.