POST api/Forms/GenerateESign

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
FormContext	FormContext	None.
SPOSiteUrl	string	None.
SPODocLib	string	None.

Request Formats

application/json, text/json

Sample:

{
  "FormContext": {
    "DisplayMode": "sample string 1",
    "ListName": "sample string 2",
    "ListGuid": "65d492a0-065e-4386-8880-5db913fc724e",
    "HistoryListGuid": "b622ca0a-df0f-490c-a3a5-d730057a538a",
    "ItemId": 5,
    "itemId": "sample string 6",
    "ItemUniqueId": "4c8d6fdd-fac8-4f10-a7d5-2eee3a3b6d43",
    "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": "5ab600fa-a59f-49dd-a068-24ffb0ceab4c",
    "DocLibListGuid": "3dc8fada-ce03-4f34-b652-0eb536e62cf5",
    "Settings": {
      "BackendApiUrl": "sample string 1",
      "EOfficeDataSiteUrl": "sample string 2",
      "HTTMSiteURL": "sample string 3"
    },
    "FormItem": {
      "Id": 1,
      "UniqueId": "baea36da-4e0e-42bf-9cd0-53ed0b715f46",
      "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": "bf3a962c-0ca8-4df2-b49c-a0a3a1f9f4c1",
      "FormTemplateSiteGuid": "3d686633-dae1-499e-be24-c2647e63d66b",
      "FormPublishedDate": "2026-03-23T04:19:27.4881437+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": "66b3db71-7c40-4c08-b1ad-4082649f9dc5",
      "DiscussionListGuid": "01e692e8-3365-4bc4-a68e-ec7167301eee",
      "DocLibListGuid": "27413407-3558-4d25-bc7b-a7c705a771f2",
      "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-03-23T04:19:27.4881437+07:00",
      "SubmittedDate": "2026-03-23T04:19:27.4881437+07:00",
      "CurrentGroup": "sample string 12",
      "CurrentApproverJobTitle": "sample string 13",
      "SubmitCounter": 14,
      "EffectiveDate": "2026-03-23T04:19:27.4881437+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": "04e7bdfa-b3d0-4a80-aa0e-b35d603be1bb",
        "ListGuid": "dffd9463-c132-47e9-a48d-14828ebe7de7",
        "WebGuid": "d214a964-d3a7-4e6a-b5f7-bed205ada504",
        "ItemId": 7,
        "RefDisplayHTML": "sample string 8",
        "FormCode": "sample string 9",
        "WebUrl": "sample string 10",
        "FormType": "sample string 11"
      },
      "PRItemDetailListGuid": "410f9870-de9b-4ee5-b1c7-2a36a7f00b05"
    },
    "ClearAdditionalItemOnly": true,
    "ClearApprovalGroup": true,
    "SiteGuid": "4412b5ca-a4d0-47b0-9f1f-35e76e48201e",
    "WebGuid": "34d08ad8-972b-4dcc-9912-0fd05a233529",
    "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
  },
  "SPOSiteUrl": "sample string 1",
  "SPODocLib": "sample string 2"
}

application/xml, text/xml

Sample:

<FormeSign xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Appvity.eOffice.Backend.Services.eSignService">
  <FormContext xmlns:d2p1="http://schemas.datacontract.org/2004/07/Appvity.eOffice.Backend.Models">
    <d2p1:ClearAdditionalItemOnly>true</d2p1:ClearAdditionalItemOnly>
    <d2p1:ClearApprovalGroup>true</d2p1:ClearApprovalGroup>
    <d2p1:ClearApprovalMatrix>true</d2p1:ClearApprovalMatrix>
    <d2p1:CurrentUser>
      <d2p1:DisplayName>sample string 4</d2p1:DisplayName>
      <d2p1:Email>sample string 2</d2p1:Email>
      <d2p1:Id>1</d2p1:Id>
      <d2p1:PictureURL>sample string 5</d2p1:PictureURL>
      <d2p1:Username>sample string 3</d2p1:Username>
    </d2p1:CurrentUser>
    <d2p1:DiscussionListGuid>5ab600fa-a59f-49dd-a068-24ffb0ceab4c</d2p1:DiscussionListGuid>
    <d2p1:DisplayMode>sample string 1</d2p1:DisplayMode>
    <d2p1:DocLibListGuid>3dc8fada-ce03-4f34-b652-0eb536e62cf5</d2p1:DocLibListGuid>
    <d2p1:EOfficeDataSiteUrl>sample string 19</d2p1:EOfficeDataSiteUrl>
    <d2p1:FormCode>sample string 20</d2p1:FormCode>
    <d2p1:FormItem>
      <d2p1:ApprovalStatus>sample string 9</d2p1:ApprovalStatus>
      <d2p1:CurrentApproverDueDate>2026-03-23T04:19:27.4881437+07:00</d2p1:CurrentApproverDueDate>
      <d2p1:CurrentApproverJobTitle>sample string 13</d2p1:CurrentApproverJobTitle>
      <d2p1:CurrentApprovers>
        <d2p1:FormUser>
          <d2p1:DisplayName>sample string 4</d2p1:DisplayName>
          <d2p1:Email>sample string 2</d2p1:Email>
          <d2p1:Id>1</d2p1:Id>
          <d2p1:PictureURL>sample string 5</d2p1:PictureURL>
          <d2p1:Username>sample string 3</d2p1:Username>
        </d2p1:FormUser>
        <d2p1:FormUser>
          <d2p1:DisplayName>sample string 4</d2p1:DisplayName>
          <d2p1:Email>sample string 2</d2p1:Email>
          <d2p1:Id>1</d2p1:Id>
          <d2p1:PictureURL>sample string 5</d2p1:PictureURL>
          <d2p1:Username>sample string 3</d2p1:Username>
        </d2p1:FormUser>
      </d2p1:CurrentApprovers>
      <d2p1:CurrentGroup>sample string 12</d2p1:CurrentGroup>
      <d2p1: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>
      </d2p1:Department>
      <d2p1:DiscussionListGuid>01e692e8-3365-4bc4-a68e-ec7167301eee</d2p1:DiscussionListGuid>
      <d2p1:DocLibListGuid>27413407-3558-4d25-bc7b-a7c705a771f2</d2p1:DocLibListGuid>
      <d2p1:EffectiveDate>2026-03-23T04:19:27.4881437+07:00</d2p1:EffectiveDate>
      <d2p1:FormCategory>sample string 10</d2p1:FormCategory>
      <d2p1:FormCode>sample string 4</d2p1:FormCode>
      <d2p1:FormNumber>sample string 7</d2p1:FormNumber>
      <d2p1:FormPublishedDate>2026-03-23T04:19:27.4881437+07:00</d2p1:FormPublishedDate>
      <d2p1:FormSetItemID>sample string 20</d2p1:FormSetItemID>
      <d2p1:FormTemplate>sample string 6</d2p1:FormTemplate>
      <d2p1:FormTemplateID>8</d2p1:FormTemplateID>
      <d2p1:FormTemplateSiteGuid>3d686633-dae1-499e-be24-c2647e63d66b</d2p1:FormTemplateSiteGuid>
      <d2p1:FormTemplateWebGuid>bf3a962c-0ca8-4df2-b49c-a0a3a1f9f4c1</d2p1:FormTemplateWebGuid>
      <d2p1:FormType>sample string 5</d2p1:FormType>
      <d2p1:Group>sample string 18</d2p1:Group>
      <d2p1:HasIsoNumber>sample string 17</d2p1:HasIsoNumber>
      <d2p1:HasTemplate>sample string 16</d2p1:HasTemplate>
      <d2p1:HistoryListGuid>66b3db71-7c40-4c08-b1ad-4082649f9dc5</d2p1:HistoryListGuid>
      <d2p1:Id>1</d2p1:Id>
      <d2p1:IsoNumber>sample string 15</d2p1:IsoNumber>
      <d2p1: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>dffd9463-c132-47e9-a48d-14828ebe7de7</d4p1:ListGuid>
        <d4p1:Ref>sample string 3</d4p1:Ref>
        <d4p1:RefDisplayHTML>sample string 8</d4p1:RefDisplayHTML>
        <d4p1:SiteGuid>04e7bdfa-b3d0-4a80-aa0e-b35d603be1bb</d4p1:SiteGuid>
        <d4p1:Title>sample string 2</d4p1:Title>
        <d4p1:WebGuid>d214a964-d3a7-4e6a-b5f7-bed205ada504</d4p1:WebGuid>
        <d4p1:WebUrl>sample string 10</d4p1:WebUrl>
      </d2p1:MFItem>
      <d2p1:PRItemDetailListGuid>410f9870-de9b-4ee5-b1c7-2a36a7f00b05</d2p1:PRItemDetailListGuid>
      <d2p1:Ref>sample string 3</d2p1:Ref>
      <d2p1:RefDisplayHTML>sample string 21</d2p1:RefDisplayHTML>
      <d2p1:Requester>
        <d2p1:DisplayName>sample string 4</d2p1:DisplayName>
        <d2p1:Email>sample string 2</d2p1:Email>
        <d2p1:Id>1</d2p1:Id>
        <d2p1:PictureURL>sample string 5</d2p1:PictureURL>
        <d2p1:Username>sample string 3</d2p1:Username>
      </d2p1:Requester>
      <d2p1:SubmitCounter>14</d2p1:SubmitCounter>
      <d2p1:SubmittedDate>2026-03-23T04:19:27.4881437+07:00</d2p1:SubmittedDate>
      <d2p1:Title>sample string 2</d2p1:Title>
      <d2p1:UniqueId>baea36da-4e0e-42bf-9cd0-53ed0b715f46</d2p1:UniqueId>
      <d2p1:WFName>sample string 11</d2p1:WFName>
    </d2p1:FormItem>
    <d2p1:FormType>sample string 21</d2p1:FormType>
    <d2p1:HistoryListGuid>b622ca0a-df0f-490c-a3a5-d730057a538a</d2p1:HistoryListGuid>
    <d2p1:IsGenerateApprovalMatrix>true</d2p1:IsGenerateApprovalMatrix>
    <d2p1:ItemId>5</d2p1:ItemId>
    <d2p1:ItemUniqueId>4c8d6fdd-fac8-4f10-a7d5-2eee3a3b6d43</d2p1:ItemUniqueId>
    <d2p1:KeyValue>sample string 22</d2p1:KeyValue>
    <d2p1:ListGuid>65d492a0-065e-4386-8880-5db913fc724e</d2p1:ListGuid>
    <d2p1:ListName>sample string 2</d2p1:ListName>
    <d2p1:RootSiteUrl>sample string 9</d2p1:RootSiteUrl>
    <d2p1:Settings>
      <d2p1:BackendApiUrl>sample string 1</d2p1:BackendApiUrl>
      <d2p1:EOfficeDataSiteUrl>sample string 2</d2p1:EOfficeDataSiteUrl>
      <d2p1:HTTMSiteURL>sample string 3</d2p1:HTTMSiteURL>
    </d2p1:Settings>
    <d2p1:SiteGuid>4412b5ca-a4d0-47b0-9f1f-35e76e48201e</d2p1:SiteGuid>
    <d2p1:SyncPermission>true</d2p1:SyncPermission>
    <d2p1:WFName>sample string 18</d2p1:WFName>
    <d2p1:WebGuid>34d08ad8-972b-4dcc-9912-0fd05a233529</d2p1:WebGuid>
    <d2p1:WebRelativeUrl>sample string 8</d2p1:WebRelativeUrl>
    <d2p1:WebUrl>sample string 10</d2p1:WebUrl>
    <d2p1:itemId>sample string 6</d2p1:itemId>
  </FormContext>
  <SPODocLib>sample string 2</SPODocLib>
  <SPOSiteUrl>sample string 1</SPOSiteUrl>
</FormeSign>

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 'FormeSign'.

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

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

Sample:

Sample not available.