POST api/Forms/ProcessKeywordSearch

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
FormContext	FormContext	None.
Keyword	string	None.
PageSize	integer	None.
SiteSearchFilter	string	None.
StartDate	string	None.
EndDate	string	None.
InText	string	None.
InTitle	string	None.
Engine	string	None.

Request Formats

application/json, text/json

Sample:

{
  "FormContext": {
    "DisplayMode": "sample string 1",
    "ListName": "sample string 2",
    "ListGuid": "67b7521d-2913-4dcd-8e28-84546f2370eb",
    "HistoryListGuid": "345bf924-2510-494a-a713-15e016848cf6",
    "ItemId": 5,
    "itemId": "sample string 6",
    "ItemUniqueId": "cbadfaa4-290e-4093-8169-320b5d18ff39",
    "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": "d1cd0c5f-9ee3-4098-b32c-cdee087854fa",
    "DocLibListGuid": "e868f7a5-4a09-4e5e-be3d-70ae5ebc5dd2",
    "Settings": {
      "BackendApiUrl": "sample string 1",
      "EOfficeDataSiteUrl": "sample string 2",
      "HTTMSiteURL": "sample string 3"
    },
    "FormItem": {
      "Id": 1,
      "UniqueId": "c7238820-f75d-4cd3-87d3-38656dadebdd",
      "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": "e7e2d523-0b08-433c-bd9d-4c7a1c0b4b97",
      "FormTemplateSiteGuid": "6c97b01a-9e82-4707-af04-1d80c90f3858",
      "FormPublishedDate": "2026-09-23T06:35:10.191912+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": "d7633e1a-cb8e-45c6-8e0b-088c7c52a0ef",
      "DiscussionListGuid": "dce692c9-6fe6-4dc1-a820-80fa432a9344",
      "DocLibListGuid": "13b31778-9131-40f8-84ac-97ebc302ef45",
      "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-09-23T06:35:10.191912+07:00",
      "SubmittedDate": "2026-09-23T06:35:10.191912+07:00",
      "CurrentGroup": "sample string 12",
      "CurrentApproverJobTitle": "sample string 13",
      "SubmitCounter": 14,
      "EffectiveDate": "2026-09-23T06:35:10.191912+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": "6157ff78-776c-4094-bc07-27cd0617c456",
        "ListGuid": "2ad5696d-d6d5-4cca-a223-3f31e0ef357d",
        "WebGuid": "a06054d4-7e1e-4d4c-8a93-98a3567609d1",
        "ItemId": 7,
        "RefDisplayHTML": "sample string 8",
        "FormCode": "sample string 9",
        "WebUrl": "sample string 10",
        "FormType": "sample string 11"
      },
      "PRItemDetailListGuid": "2317116a-fe83-4c96-851c-e721514fe3fd"
    },
    "ClearAdditionalItemOnly": true,
    "ClearApprovalGroup": true,
    "SiteGuid": "128a9be0-87f7-40cb-b5e7-f90706e3a62c",
    "WebGuid": "e56b3fa9-da12-4e71-98f3-2d213f91a924",
    "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
  },
  "Keyword": "sample string 1",
  "PageSize": 2,
  "SiteSearchFilter": "sample string 3",
  "StartDate": "sample string 4",
  "EndDate": "sample string 5",
  "InText": "sample string 6",
  "InTitle": "sample string 7",
  "Engine": "sample string 8"
}

application/xml, text/xml

Sample:

<CustomSearchData xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Appvity.eOffice.Backend.Models">
  <EndDate>sample string 5</EndDate>
  <Engine>sample string 8</Engine>
  <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>d1cd0c5f-9ee3-4098-b32c-cdee087854fa</DiscussionListGuid>
    <DisplayMode>sample string 1</DisplayMode>
    <DocLibListGuid>e868f7a5-4a09-4e5e-be3d-70ae5ebc5dd2</DocLibListGuid>
    <EOfficeDataSiteUrl>sample string 19</EOfficeDataSiteUrl>
    <FormCode>sample string 20</FormCode>
    <FormItem>
      <ApprovalStatus>sample string 9</ApprovalStatus>
      <CurrentApproverDueDate>2026-09-23T06:35:10.191912+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>dce692c9-6fe6-4dc1-a820-80fa432a9344</DiscussionListGuid>
      <DocLibListGuid>13b31778-9131-40f8-84ac-97ebc302ef45</DocLibListGuid>
      <EffectiveDate>2026-09-23T06:35:10.191912+07:00</EffectiveDate>
      <FormCategory>sample string 10</FormCategory>
      <FormCode>sample string 4</FormCode>
      <FormNumber>sample string 7</FormNumber>
      <FormPublishedDate>2026-09-23T06:35:10.191912+07:00</FormPublishedDate>
      <FormSetItemID>sample string 20</FormSetItemID>
      <FormTemplate>sample string 6</FormTemplate>
      <FormTemplateID>8</FormTemplateID>
      <FormTemplateSiteGuid>6c97b01a-9e82-4707-af04-1d80c90f3858</FormTemplateSiteGuid>
      <FormTemplateWebGuid>e7e2d523-0b08-433c-bd9d-4c7a1c0b4b97</FormTemplateWebGuid>
      <FormType>sample string 5</FormType>
      <Group>sample string 18</Group>
      <HasIsoNumber>sample string 17</HasIsoNumber>
      <HasTemplate>sample string 16</HasTemplate>
      <HistoryListGuid>d7633e1a-cb8e-45c6-8e0b-088c7c52a0ef</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>2ad5696d-d6d5-4cca-a223-3f31e0ef357d</d4p1:ListGuid>
        <d4p1:Ref>sample string 3</d4p1:Ref>
        <d4p1:RefDisplayHTML>sample string 8</d4p1:RefDisplayHTML>
        <d4p1:SiteGuid>6157ff78-776c-4094-bc07-27cd0617c456</d4p1:SiteGuid>
        <d4p1:Title>sample string 2</d4p1:Title>
        <d4p1:WebGuid>a06054d4-7e1e-4d4c-8a93-98a3567609d1</d4p1:WebGuid>
        <d4p1:WebUrl>sample string 10</d4p1:WebUrl>
      </MFItem>
      <PRItemDetailListGuid>2317116a-fe83-4c96-851c-e721514fe3fd</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-09-23T06:35:10.191912+07:00</SubmittedDate>
      <Title>sample string 2</Title>
      <UniqueId>c7238820-f75d-4cd3-87d3-38656dadebdd</UniqueId>
      <WFName>sample string 11</WFName>
    </FormItem>
    <FormType>sample string 21</FormType>
    <HistoryListGuid>345bf924-2510-494a-a713-15e016848cf6</HistoryListGuid>
    <IsGenerateApprovalMatrix>true</IsGenerateApprovalMatrix>
    <ItemId>5</ItemId>
    <ItemUniqueId>cbadfaa4-290e-4093-8169-320b5d18ff39</ItemUniqueId>
    <KeyValue>sample string 22</KeyValue>
    <ListGuid>67b7521d-2913-4dcd-8e28-84546f2370eb</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>128a9be0-87f7-40cb-b5e7-f90706e3a62c</SiteGuid>
    <SyncPermission>true</SyncPermission>
    <WFName>sample string 18</WFName>
    <WebGuid>e56b3fa9-da12-4e71-98f3-2d213f91a924</WebGuid>
    <WebRelativeUrl>sample string 8</WebRelativeUrl>
    <WebUrl>sample string 10</WebUrl>
    <itemId>sample string 6</itemId>
  </FormContext>
  <InText>sample string 6</InText>
  <InTitle>sample string 7</InTitle>
  <Keyword>sample string 1</Keyword>
  <PageSize>2</PageSize>
  <SiteSearchFilter>sample string 3</SiteSearchFilter>
  <StartDate>sample string 4</StartDate>
</CustomSearchData>

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

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

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

Sample:

Sample not available.