using Search Query (subtype=258) with search API

Is it possible to use the Search API to retrieve the results of a search that has been saved as a Search Query object (subtype=258)?

To elaborate the larger problem, I have been asked to create an export to Excel utility for searches. We do not want to recreate the advanced search, modify files, or use OScript. So I need a way to execute a Saved Search and get the results as XML (which I know the Search API can do) so I can use XSLT to convert the XML to CVS so the user can open the results in excel. If LAPI or the Content Services are needed, that is acceptable; but use of the search API is preferred as it would allow me to complete this task using only HTML, CSS and JavaScript (JQuery).

Find more posts tagged with

Comments

Steve Brezina

Hi Ross,

You presently cannot execute a Search Query with the Search API to receive XML output. I will enter a feature request for this.

However, you can achieve the same result with a Search Template. Try ?func=search&templateID=xxxx&outputformat=xml, where xxxx is the DataId of the template.

Regards,

Steve

Jean-Philippe_Martin

Hi,
Here is a little trick for the transformation of your xml output using xsl.

Put a xsl file named something.xsl in your support directory, ex: livelink_home/support/xsl/something.xsl which would look something like this :

<? xml version = " 1.0 " encoding = " utf-16 " standalone = " yes " ?>
< xsl:stylesheet xmlns:xsl = " http://www.w3.org/1999/XSL/Transform " version = " 1.0 " >
< xsl:import href = " /livelink/livelink.exe?func=doc.fetch & nodeId=52610034 " />
< xsl:template match = " / " >
< xsl:apply-imports />
</ xsl:template >
</ xsl:stylesheet >

where the href reference point to an xsl file you added to Livelink. This way you can update your code easily with the Livelink interface instead of having to deploy a new xsl file each time your code is updated.

So to make the whole thing work, your url would look like :

livelink_server/livelink/livelink.exe?func=search&slice=<sliceid>&outputformat=xml&where1=<some words>&stylesheet=xsl/something.xsl&templateid=<templateid>

Ross_Lanes

First, that is a greate idea about using a XSLT file that loads an XSLT file from inside the system.

Second, I realize that this is possibly outside the scope of this forum; however, is there any programmatic way to execute a Search Query and get back results in any format or get back the search criteria that is stored in the Search Query?

Steve Brezina

Hi Ross,

What version of Content Server are you using? CS 10.0 has $WebSBroker.SearchAPIUtil.RunQuery() which does exactly that. See the _TESTRunQuery() method on that object for an example usage.

Programmatic execution of a Search Query object in 9.7.x will take additional coding.

Regards,

Steve

Ross_Lanes

We do use CS 9.7.1 and I am assuming that this code is OScript? I should point out that I in no way know OScript and was hopping not to need to learn it; however, if that is what is needed then so be it. However, so I can go back and let the client know is OScript the only way to execute a saved search programmatically?

Steve Brezina

Hi Ross,

Yes, custom OScript would be needed. There is no Web Services or LAPI interface for executing a saved Search Query object. The closest thing is the Search API URL previously discussed that can search with a specific template (same as a search query but with different rules around user access), returning the results in XML ready for transform. I suggest exploring this option.

Regards,

Steve

Eric_Savard

Sorry for the late post but I'm now trying to search a templateID through the API, so i'm doing a ?func=search&templateID=xxxxx and I'm getting an error Your are not allowed to use templateID?

Steve Brezina

Hi Eric,

templateId=**** works as long as the DataId specified is one of your templates or the Admin's. What is the error you're seeing? Please state the Content Server version and update level as well.

Regards,

Steve

Eric_Savard

Thanks Steve,

I am using base 10.5 with no updates and the error is:

You're not allowed to use 'templateID'?

Eric

Eric_Savard

Also to add to my last reply, I am using an admin Template.

Eric

Steve Brezina

Hi Eric,

I can't find that error. Please post a screenshot of the error or open a ticket with Customer Support if you prefer a more formal investigation. &templateId=**** is a long standing Search API parameter.

Regards,

Steve