How to use the Search API in SDL LiveContent Reach?

Hi,

I want to use XQuery (Search API) provided by SDL reach.

Following is the URL that I found from the documentation.

http://<host>:<port>/<context>/web/search.xql?action=search&min=<value>&chunk=<value>&max=<value>&sort=<value>&scope=<value>&query=<value>&searchId=<value>&format=<value>&lang=<value>&pub=<value>&filter=<value>

I want to know the proper way to access this API from C#

I tried using HttpClient, and tried to read the response using ReadAsStringAsync () method, but this gives me an error.

Please could you assist me with this, as I want to format the search result I get from the API.

Regards,

Puneet Singh Marwaha

Translate

Parents

0 Fredrik Geers over 7 years ago

You mention getting an error, what is the exact error you are seeing?
Cancel
Vote Up 0 Vote Down

Sign in to reply

Verify Answer

Cancel

Share
Documentation Survey: help us offer you better documentation! Translate
0 Puneet Marwaha over 7 years ago in reply to Fredrik Geers

Hey Fredrik,

Please see error below.

Also, could you please advise proper way for implementing consumption of search api.

<html>
   <head>
      <title>Working...</title>
   </head>
   <body>
      <form method="POST" name="hiddenform" action="qa-sdl-reach-delivery.bentley.com/.../">
         <input type="hidden" name="wa" value="wsignin1.0" /><input type="hidden" name="wresult" value="<trust:RequestSecurityTokenResponseCollection xmlns:trust="docs.oasis-open.org/.../200512"><trust:RequestSecurityTokenResponse><trust:Lifetime><wsu:Created xmlns:wsu="docs.oasis-open.org/.../wsu:Created><wsu:Expires xmlns:wsu="docs.oasis-open.org/.../trust:Lifetime><wsp:AppliesTo xmlns:wsp="schemas.xmlsoap.org/.../policy"><EndpointReference xmlns="www.w3.org/.../wsp:AppliesTo><trust:RequestedSecurityToken><saml:Assertion MajorVersion="1" MinorVersion="1" AssertionID="_e9bfebe1-05d5-427a-a889-1516706251f2" Issuer="qa-ims.bentley.com/" IssueInstant="2016-09-01T14:11:25.303Z" xmlns:saml="urn:oasis:names:tc:SAML:1.0:assertion"><saml:Conditions NotBefore="2016-09-01T14:11:25.272Z" NotOnOrAfter="2016-09-01T15:11:25.272Z"><saml:AudienceRestrictionCondition><saml:Audience>qa-sdl-reach-delivery.bentley.com/.../saml:Subject><saml:Attribute AttributeName="name" AttributeNamespace="schemas.xmlsoap.org/.../saml:Attribute><saml:Attribute AttributeName="givenname" AttributeNamespace="schemas.xmlsoap.org/.../saml:Attribute><saml:Attribute AttributeName="surname" AttributeNamespace="schemas.xmlsoap.org/.../saml:Attribute><saml:Attribute AttributeName="emailaddress" AttributeNamespace="schemas.xmlsoap.org/.../saml:Attribute><saml:Attribute AttributeName="role" AttributeNamespace="schemas.microsoft.com/.../saml:Attribute><saml:Attribute AttributeName="sapbupa" AttributeNamespace="schemas.bentley.com/.../saml:Attribute><saml:Attribute AttributeName="site" AttributeNamespace="schemas.bentley.com/.../saml:Attribute><saml:Attribute AttributeName="ultimatesite" AttributeNamespace="schemas.bentley.com/.../saml:Attribute><saml:Attribute AttributeName="sapentitlement" AttributeNamespace="schemas.bentley.com/.../saml:Attribute><saml:Attribute AttributeName="entitlement" AttributeNamespace="schemas.bentley.com/.../saml:Attribute><saml:Attribute AttributeName="countryiso" AttributeNamespace="schemas.bentley.com/.../saml:Attribute><saml:Attribute AttributeName="languageiso" AttributeNamespace="schemas.bentley.com/.../saml:Attribute><saml:Attribute AttributeName="ismarketingprospect" AttributeNamespace="schemas.bentley.com/.../saml:Attribute><saml:Attribute AttributeName="isbentleyemployee" AttributeNamespace="schemas.bentley.com/.../saml:Attribute><saml:Attribute AttributeName="becommunitiesusername" AttributeNamespace="schemas.bentley.com/.../saml:Attribute><saml:Attribute AttributeName="becommunitiesemailaddress" AttributeNamespace="schemas.bentley.com/.../saml:Attribute><saml:Attribute AttributeName="userid" AttributeNamespace="schemas.bentley.com/.../saml:Attribute><saml:Attribute AttributeName="organization" AttributeNamespace="schemas.bentley.com/.../claims"><saml:AttributeValue>Bentley Systems Inc</saml:AttributeValue></saml:Attribute><saml:Attribute AttributeName="has_select" AttributeNamespace="schemas.bentley.com/.../saml:Attribute><saml:Attribute AttributeName="organizationid" AttributeNamespace="schemas.bentley.com/.../saml:Attribute><saml:Attribute AttributeName="organizationname" AttributeNamespace="schemas.bentley.com/.../claims"><saml:AttributeValue>Bentley Systems Inc</saml:AttributeValue></saml:Attribute><saml:Attribute AttributeName="ultimateid" AttributeNamespace="schemas.bentley.com/.../saml:Attribute><saml:Attribute AttributeName="ultimatename" AttributeNamespace="schemas.bentley.com/.../claims"><saml:AttributeValue>Bentley Systems Inc</saml:AttributeValue></saml:Attribute><saml:Attribute AttributeName="ultimatereferenceid" AttributeNamespace="schemas.bentley.com/.../saml:Attribute><saml:Attribute AttributeName="usagecountryiso" AttributeNamespace="schemas.bentley.com/.../saml:AttributeStatement><ds:Signature xmlns:ds="www.w3.org/.../xmldsig Algorithm="www.w3.org/.../xml-exc-c14n /><ds:SignatureMethod Algorithm="www.w3.org/.../xmldsig-more /><ds:Reference URI="#_e9bfebe1-05d5-427a-a889-1516706251f2"><ds:Transforms><ds:Transform Algorithm="www.w3.org/.../xmldsig /><ds:Transform Algorithm="www.w3.org/.../xml-exc-c14n /></ds:Transforms><ds:DigestMethod Algorithm="www.w3.org/.../xmlenc /><ds:DigestValue>R82IgxNngUGLYlsGRy0w1dvMI7fH/LBL9XXdR5lqPCY=</ds:DigestValue></ds:Reference></ds:SignedInfo><ds:SignatureValue>HJfmY/Jmiytk7/lCklmn3gMwJcNCy6j+iNrqO1sPebjpUZynHcNR/ptw8m83nnwkAJgvcJ6yzVTOUevNDFrejD5TcX6riylwAibEVBbsTH//XBR6IYFCr6wHlIXQuk3sHskxH8CB8yUsjvuXSfVt+psCv904/NnBh+nKvg+BKdk=</ds:SignatureValue><KeyInfo xmlns="www.w3.org/.../xmldsigL5y19xiBvByHX3NRAgSE3++A2rdNsJcW6ZyEd9EmAz4/zIk1dt6XibcxmsXbowEcD+8=</X509Certificate></X509Data></KeyInfo></ds:Signature></saml:Assertion></trust:RequestedSecurityToken><trust:RequestedAttachedReference><o:SecurityTokenReference k:TokenType="docs.oasis-open.org/.../oasis-wss-saml-token-profile-1.1 xmlns:k="docs.oasis-open.org/.../oasis-wss-wssecurity-secext-1.1.xsd" xmlns:o="docs.oasis-open.org/.../oasis-200401-wss-wssecurity-secext-1.0.xsd"><o:KeyIdentifier ValueType="docs.oasis-open.org/.../oasis-wss-saml-token-profile-1.0 k:TokenType="docs.oasis-open.org/.../oasis-wss-saml-token-profile-1.1 xmlns:k="docs.oasis-open.org/.../oasis-wss-wssecurity-secext-1.1.xsd" xmlns:o="docs.oasis-open.org/.../oasis-200401-wss-wssecurity-secext-1.0.xsd"><o:KeyIdentifier ValueType="docs.oasis-open.org/.../oasis-wss-saml-token-profile-1.0 />
         <noscript>
            <p>Script is disabled. Click Submit to continue.</p>
            <input type="submit" value="Submit" />
         </noscript>
      </form>
      <script language="javascript">window.setTimeout('document.forms[0].submit()', 0);</script>
   </body>
</html>
Cancel
Vote Up 0 Vote Down

Sign in to reply

Verify Answer

Cancel

Share
Documentation Survey: help us offer you better documentation! Translate
0 Alex Sarafian over 7 years ago in reply to Puneet Marwaha

Hi Puneet,

Consuming the Rest API of Content Deliver (Reach) when integrated with an STS is not an easy task. The tricky part is getting a cookie for the JSESSIONID.

Before I provide a more detailed explanation let me ask first what is the scope? By whom, why and when is the program intended to run?
Cancel
Vote Up 0 Vote Down

Sign in to reply

Verify Answer

Cancel

Share
Documentation Survey: help us offer you better documentation! Translate
0 Puneet Marwaha over 7 years ago in reply to Alex Sarafian

Hey Alex,

We have a WPF client app, where we have to provide a search functionality. This search is to be implemented using SDL LiveContent Reach (XQuery Search API) because we have our product documentation being created by SDL Create.
So we wanted to know how to get the data from SDL Search API and display it in our dialog using our own formatting (massaging the search result for styling).
Please advise.
Cancel
Vote Up 0 Vote Down

Sign in to reply

Verify Answer

Cancel

Share
Documentation Survey: help us offer you better documentation! Translate
0 Alex Sarafian over 7 years ago in reply to Puneet Marwaha
Hi Puneet,

That means that you need indeed C#. I had almost something for PowerShell but I'll explain what you need to do to authenticate yourself to the API. That means capturing a set of cookies (JSESSIONID) that grants you access to the api.

The following is assuming your target Reach is deployed and configured for Review and Collaboration and that means it is using the same STS as Content Manager. As I don't know your STS I'll be generic

You have a couple of options:

From the C# play browser and where necessary fill in the credentials if necessary. You can use WebClient class or more low level classes such as HttpClient or WebRequest. An excellent guide is looking at Fiddler while you do the same from your browser

From the C# launch a browser, let it authenticate and somehow capture the cookies after it gets authenticated to Reach

From the C# get a token using WCF and WSTrust from the configured STS and then submit the token to Reach and capture the cookies. Again Fiddler is an excellent guide. If you chose this path then let me share a small but important detail. Before you issue the token, you need make a request to Reach and capture an initial JSESSIONID cookie. Then when submitting the token you need to pass this original JSESSIONID and then capture the replacement. This is all in Fiddler captures but its a small detail and you need to be aware to notice.

The code for each case is not easy and it is beyond the scope of this thread. Please take notice that working with the protocols for federated authentication is an advanced subject. But as reference WS-Federation and WS-Trust are in play.

An alternative that is to discuss with the owner of the Reach deployment to open up a potential alternative root for your application and only your application. This is a security violation and therefore not my preference and certainly not the path I would chose.

Good luck and let me know if I can help further within the scope of this thread.
Cancel
Vote Up 0 Vote Down

Sign in to reply

Verify Answer

Reject Answer

Cancel

Share
Documentation Survey: help us offer you better documentation! Translate
0 Puneet Marwaha over 7 years ago in reply to Alex Sarafian

Hey Alex,

Thank you so much for this info and your time.
However this knowledge isn't sufficient for us to implement. It would be better if we could have a little snippet of what you explained above.
But I understand the scope of this thread does not ask for it.
Could you also please specify posts which could help me implementing it.
Any help will be appreciated.
Cancel
Vote Up 0 Vote Down

Sign in to reply

Verify Answer

Cancel

Share
Documentation Survey: help us offer you better documentation! Translate
0 Alex Sarafian over 7 years ago in reply to Puneet Marwaha

Hi Puneet,
As I already mentioned, providing the solution is beyond the scope of this thread. From my explanation it should be already clear that this is not simple and therefore it cannot be provided as part of some snippets. In other words, it simply doesn't fit plus I don't a have a clean code base to share.

My advice is to look online for what I mentioned. Search for the terms provided but keep in mind that you need relatively good understanding of SOAP and WCF. I'm a person that likes to see what is going on on the network layer and if you share my preference, then while using Publication Manager, capture a session with Fiddler and analyze it.

I've also shared a PowerShell module WcfPS that addresses only part of what you need. It can issue bearer tokens for web sites but the rest becomes your responsibility.

Good luck
Alex
Cancel
Vote Up 0 Vote Down

Sign in to reply

Verify Answer

Reject Answer

Cancel

Share
Documentation Survey: help us offer you better documentation! Translate

Reply

0 Alex Sarafian over 7 years ago in reply to Puneet Marwaha

Hi Puneet,
As I already mentioned, providing the solution is beyond the scope of this thread. From my explanation it should be already clear that this is not simple and therefore it cannot be provided as part of some snippets. In other words, it simply doesn't fit plus I don't a have a clean code base to share.

My advice is to look online for what I mentioned. Search for the terms provided but keep in mind that you need relatively good understanding of SOAP and WCF. I'm a person that likes to see what is going on on the network layer and if you share my preference, then while using Publication Manager, capture a session with Fiddler and analyze it.

I've also shared a PowerShell module WcfPS that addresses only part of what you need. It can issue bearer tokens for web sites but the rest becomes your responsibility.

Good luck
Alex
Cancel
Vote Up 0 Vote Down

Sign in to reply

Verify Answer

Reject Answer

Cancel

Share
Documentation Survey: help us offer you better documentation! Translate

Children

0 Puneet Marwaha over 7 years ago in reply to Alex Sarafian

Hi Alex,

Thanks again for replying.
Will try to find to some solution from the details you have provided.

Also, I am not able to open the link you have shared for Power Shell.
When I click the url, it says page not found.

Regards
Puneet
Cancel
Vote Up 0 Vote Down

Sign in to reply

Verify Answer

Cancel

Share
Documentation Survey: help us offer you better documentation! Translate
0 Alex Sarafian over 7 years ago in reply to Puneet Marwaha

Sorry. Probably something went wrong with the formatting

www.powershellgallery.com/.../
Cancel
Vote Up 0 Vote Down

Sign in to reply

Verify Answer

Cancel

Share
Documentation Survey: help us offer you better documentation! Translate

Tridion Docs Developers > 03 - Developer Forum

How to use the Search API in SDL LiveContent Reach?