We've updated some of our product names. Nintex Promapp is now called Process Manager.

Extending the Nintex Process Manager OpenSearch endpoint

The SharePoint search endpoint which is available for your Nintex Process Manager site at Admin >Configuration > Intranet/Extranet Resources > SharePoint Search adheres to the OpenSearch A collection of simple formats for the sharing of search results. standard.

You can make HTTP GET requests to this endpoint with the parameters described in the table below to retrieve process, document, and group content from a Nintex Process Manager site. The content returned will be in the format specified by the OpenSearch Protocol. For more information, see the OpenSearch website.

Note:

The OpenSearch endpoint is secured with a URL token which is unique for each Nintex Process Manager site.
This token can be revoked by the Nintex support team at any time. The minimode A permalink to a Nintex Process Manager process or document which allows anonymous users to access processes, documents or process groups. links retrieved in the results using the altUrl parameter are governed separately.
Returning minimode links in the results is not recommended and instead the full URL should be returned to ensure users have to authenticate to gain access to the content.

OpenSearch endpoint parameters

Parameter	Type	Description
terms	Text	The criteria to search on. A blank term will result in an error being returned in the response. See Search ranking and syntax reference for the supported syntax. If no search terms are added and the group parameter is included, then all content within the group is returned in the results. This includes any processes, groups, or documents. Content in any sub-groups is not included.
startItem	Number	Indicates the item number that is the first item returned in the search results shown for the page. This is used to indicate which page of items to show. This means if the startItem is 0, pageSize is 10, and 20 total results, then 0 is provided to get the first page, and 10 for the second page. The page parameter can be used as an alternative.
page	Number	Indicates the current page of items to display. For example: If 1 is used, displays the first page if 2 is used, displays the second page.
pageSize	Number	Indicates the number of items to show per page.
base	0 or 1	Indicates where index for either the page or startItem starts at either 1 or 0. This means, if the base is 0, then the page parameter must be 0 to show the first page of results, 1 for the second page and so forth.
group	GUID	The unique id for the group that should be filtered on. Only results within this group or sub-groups will be returned.
altUrls	True or False	Indicates whether to include the minimode link for a process as an additional URL in the results returned. Caution: This parameter is not recommended as it returns minimode links in the results and content is displayed to unauthenticated users. Instead the full URL should be returned to ensure users have to authenticate to gain access to the content.

Example: Full Search

Sample URL: https://au.promapp.com/acme/SharePoint?token=ABC123&terms=recruit%20starter&startItem=1&pageSize=20&base=0

Sample Results:


<?xml version="1.0" encoding="UTF-8"?>
<rss xmlns:atom="http://www.w3.org/2005/Atom" xmlns:opensearch="http://a9.com/-/spec/opensearch/1.1/" version="2.0">
   <channel>
      <title>Promapp Search : recruit,starter</title>
      <description>Search results for "recruit,starter" from https://demo.promapp.com/shaun/</description>
      <copyright>Promapp Solutions Ltd.</copyright>
      <opensearch:totalResults>3</opensearch:totalResults>
      <opensearch:startIndex>1</opensearch:startIndex>
      <opensearch:itemsPerPage>20</opensearch:itemsPerPage>
      <opensearch:Query xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" role="request" searchTerms="recruit starter" startPage="1" />
      <item>
         <guid isPermaLink="true">https://au.promapp.com/acme/Process/123482f7-a7a6-4855-97cd-c65a701dabcd</guid>
         <link>https://au.promapp.com/acme/Process/123482f7-a7a6-4855-97cd-c65a701dabcd</link>
         <category>Process</category>
         <title>Obtain approval to recruit</title>
         <description>To obtain approval to recruit before proceeding with recruitment.</description>
         <atom:updated>2019-02-05T08:25:36Z</atom:updated>
         <group id="1234a31b-ce7d-4a7f-8eef-8d21d4674567">Human Resources</group>
      </item>
      <item>
         <guid isPermaLink="true">https://au.promapp.com/acme/Documents/View/Open?displayType=document&amp;documentId=12ab8ff1-afcb-467a-8cae-bce3006fabcd</guid>
         <link>https://au.promapp.com/acme/Documents/View/Open?displayType=document&amp;documentId=12ab8ff1-afcb-467a-8cae-bce3006fabcd</link>
         <category>Form</category>
         <title>Starters Checklist.doc.pdf</title>
         <atom:updated>2013-06-24T22:59:51Z</atom:updated>
         <group id="123ecb42-7ecb-42ad-9830-fb7f5201abcd">Process Library</group>
      </item>
      <item>
         <guid isPermaLink="true">https://au.promapp.com/acme/Process/Group/1234a31b-ce7d-4a7f-8eef-8d21d4670000</guid>
         <link>https://au.promapp.com/acme/Process/Group/1234a31b-ce7d-4a7f-8eef-8d21d4670000</link>
         <category>Group</category>
         <title>Recruitment</title>
         <description />
         <atom:updated>2017-02-12T23:42:56Z</atom:updated>
         <group id="12ab6363-7805-481f-8fa8-e6d3d916xy34">Human Resources</group>
      </item>
   </channel>
</rss>

Example: Full Search with Alternate Links

Sample URL: https://au.promapp.com/acme/SharePoint?token=ABC123&terms=recruit%20starter&startItem=1&pageSize=20&base=0&altUrls=true

Sample Results:


<?xml version="1.0" encoding="UTF-8"?>
<rss xmlns:atom="http://www.w3.org/2005/Atom" xmlns:opensearch="http://a9.com/-/spec/opensearch/1.1/" version="2.0">
   <channel>
      <title>Promapp Search : recruit,starter</title>
      <description>Search results for "recruit,starter" from https://demo.promapp.com/shaun/</description>
      <copyright>Promapp Solutions Ltd.</copyright>
      <opensearch:totalResults>3</opensearch:totalResults>
      <opensearch:startIndex>1</opensearch:startIndex>
      <opensearch:itemsPerPage>20</opensearch:itemsPerPage>
      <opensearch:Query xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" role="request" searchTerms="recruit starter" startPage="1" />
      <item>
         <guid isPermaLink="true">https://au.promapp.com/acme/Process/123482f7-a7a6-4855-97cd-c65a701dabcd</guid>
         <link>https://au.promapp.com/acme/Process/123482f7-a7a6-4855-97cd-c65a701dabcd</link>
         <category>Process</category>
         <title>Obtain approval to recruit</title>
         <description>To obtain approval to recruit before proceeding with recruitment.</description>
         <atom:link rel="alternate" type="text/html" title="Prepare for new starter" href="https://demo.promapp.com/shaun/Process/Minimode/Permalink/D2dM7BTryEEPMVwJbIKeJD" />
         <atom:updated>2019-02-05T08:25:36Z</atom:updated>
         <group id="1234a31b-ce7d-4a7f-8eef-8d21d4670000">Human Resources</group>
      </item>
      <item>
         <guid isPermaLink="true">https://au.promapp.com/acme/Documents/View/Open?displayType=document&amp;documentId=34ea8ff1-afcb-467a-8cae-bce3006fa8c2</guid>
         <link>https://au.promapp.com/acme/Documents/View/Open?displayType=document&amp;documentId=12ab8ff1-afcb-467a-8cae-bce3006fabcd</link>
         <category>Form</category>
         <title>Starters Checklist.doc.pdf</title>
         <atom:updated>2013-06-24T22:59:51Z</atom:updated>
         <group id="1234cb42-7ecb-42ad-9830-fb7f520100ab">Process Library</group>
      </item>
      <item>
         <guid isPermaLink="true">https://au.promapp.com/acme/Process/Group/1760a31b-ce7d-4a7f-8eef-8d21d4673937</guid>
         <link>https://au.promapp.com/acme/Process/Group/1760a31b-ce7d-4a7f-8eef-8d21d4673937</link>
         <category>Group</category>
         <title>Recruitment</title>
         <description />
         <atom:updated>2017-02-12T23:42:56Z</atom:updated>
         <group id="12346363-7805-481f-8fa8-e6d3d9160000">Human Resources</group>
      </item>
   </channel>
</rss>

Example: Group Restricted Search

Sample URL:

https://au.promapp.com/acme/SharePoint?token=ABC123&terms=recruit%20starter&startItem=1&pageSize=20&base=0&group=1760a31b-ce7d-4a7f-8eef-8d21d4673937

Sample Results:


<?xml version="1.0" encoding="UTF-8"?>
<rss xmlns:atom="http://www.w3.org/2005/Atom" xmlns:opensearch="http://a9.com/-/spec/opensearch/1.1/" version="2.0">
   <channel>
      <title>Promapp Search : recruit,starter</title>
      <description>Search results for "recruit,starter" from https://demo.promapp.com/shaun/</description>
      <copyright>Promapp Solutions Ltd.</copyright>
      <opensearch:totalResults>4</opensearch:totalResults>
      <opensearch:startIndex>1</opensearch:startIndex>
      <opensearch:itemsPerPage>20</opensearch:itemsPerPage>
      <opensearch:Query xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" role="request" searchTerms="recruit starter" startPage="1" />
      <item>
         <guid isPermaLink="true">https://au.promapp.com/acme/Process/123482f7-a7a6-4855-97cd-c65a701dabcd</guid>
         <link>https://au.promapp.com/acme/Process/123482f7-a7a6-4855-97cd-c65a701dabcd</link>
         <category>Process</category>
         <title>Obtain approval to recruit</title>
         <description>To obtain approval to recruit before proceeding with recruitment.</description>
         <atom:updated>2019-02-05T08:25:36Z</atom:updated>
         <group id="1234a31b-ce7d-4a7f-8eef-8d21d4670000">Recruitment</group>
      </item>
      <item>
         <guid isPermaLink="true">https://au.promapp.com/acme/Process/Group/1234a31b-ce7d-4a7f-8eef-8d21d4670000</guid>
         <link>https://au.promapp.com/acme/Process/Group/1234a31b-ce7d-4a7f-8eef-8d21d4670000</link>
         <category>Group</category>
         <title>Recruitment</title>
         <description />
         <atom:updated>2017-02-12T23:42:56Z</atom:updated>
         <group id="12346363-7805-481f-8fa8-e6d3d91612ab">Human Resources</group>
      </item>
   </channel>
</rss>

Example: Group Content Search

Sample URL:https://au.promapp.com/acme/SharePoint?token=ABC123&terms=&startItem=1&pageSize=20&base=0&group=5c296363-7805-481f-8fa8-e6d3d916dc69

Sample Results:


<?xml version="1.0" encoding="UTF-8"?>
<rss xmlns:atom="http://www.w3.org/2005/Atom" xmlns:opensearch="http://a9.com/-/spec/opensearch/1.1/" version="2.0">
   <channel>
      <title>Promapp Search :</title>
      <description>Search results for "" from https://demo.promapp.com/shaun/</description>
      <copyright>Promapp Solutions Ltd.</copyright>
      <opensearch:totalResults>12</opensearch:totalResults>
      <opensearch:startIndex>1</opensearch:startIndex>
      <opensearch:itemsPerPage>20</opensearch:itemsPerPage>
      <item>
         <guid isPermaLink="true">https://au.promapp.com/acme/Process/Group/12ab44d1-24ef-4bed-a3b8-a2f16ced0000</guid>
         <link>https://au.promapp.com/acme/Process/Group/12ab44d1-24ef-4bed-a3b8-a2f16ced0000</link>
         <category>Group</category>
         <title>Induct New Employees</title>
         <description />
         <atom:updated>2016-07-07T05:49:57Z</atom:updated>
         <group id="12346363-7805-481f-8fa8-e6d3d91612ab">Human Resources</group>
      </item>
      <item>
         <guid isPermaLink="true">https://au.promapp.com/acme/Process/Group/12abd7fd-2c33-40fd-a9da-ea04e9d60000</guid>
         <link>https://au.promapp.com/acme/Process/Group/12abd7fd-2c33-40fd-a9da-ea04e9d60000</link>
         <category>Group</category>
         <title>Manage Employee Leave</title>
         <description />
         <atom:updated>2017-01-22T22:42:24Z</atom:updated>
         <group id="12346363-7805-481f-8fa8-e6d3d91612ab">Human Resources</group>
      </item>
      <item>
         <guid isPermaLink="true">https://au.promapp.com/acme/Process/Group/1abc19f3-5f9e-43e5-b182-4230506d0000</guid>
         <link>https://au.promapp.com/acme/Process/Group/1abc19f3-5f9e-43e5-b182-4230506d0000</link>
         <category>Group</category>
         <title>Manage Performance and Discipline</title>
         <description>From https://demo.promapp.com/walker</description>
         <atom:updated>2013-06-24T22:33:36Z</atom:updated>
         <group id="12346363-7805-481f-8fa8-e6d3d9160000">Human Resources</group>
      </item>
      <item>
         <guid isPermaLink="true">https://au.promapp.com/acme/Process/Group/1234a31b-ce7d-4a7f-8eef-8d21d4670000</guid>
         <link>https://au.promapp.com/acme/Process/Group/1234a31b-ce7d-4a7f-8eef-8d21d4670000</link>
         <category>Group</category>
         <title>Recruitment</title>
         <description />
         <atom:updated>2017-02-12T23:42:56Z</atom:updated>
         <group id="12346363-7805-481f-8fa8-e6d3d9160000">Human Resources</group>
      </item>
   </channel>
</rss>