Status: Open
Status: Answered
Status: Closed
Status: Duplicate

Looking for the Swagger docs for Content Server REST API

0
Posted Jun 22 by Jeff Wogan.

The Content Server REST API - Quick Start Guide states that
>This document will only describe a handful of calls, for more information see the documentation in Swagger.

The only mention of Swagger, that I can find, is in a Knowledge Center document for OTMM, OpenText Media Management, not Content Server (OTCS), that states
> 1.3 – REST API documentation

> On a deployed version of OTMM, you can access the REST API documentation through the URL /swagger-ui. The REST API documentation contains information on how to make calls to the REST API to achieve functions within OTMM such as retrieving and saving assets, performing searches, starting workflows, and so forth.

I've successfully logged in through a browser at http://<server>/livelink/llisapi.dll/ and also through an AJAX REST call at http://<server>/livelink/llisapi.dll/api/v1/auth/ (ie I've gotten a ticket number in response). However I get the following message when I go to http://<server>/livelink/llisapi.dll/api/v1/swagger-ui/ through either an AJAX REST call or directly in the browser URL.

>401 - Unauthorized: Access is denied due to invalid credentials.

>You do not have permission to view this directory or page using the credentials that you supplied.

I've verified that my login has been granted every possible privilege in the CS Admin and still I'm getting the 401.

Can someone please point me in the right direction to find/get the Content Server REST API Swagger documentation?

Thank you.

7 Answers

0
BEST ANSWER: As chosen by the author.

Hi Jeff,

Please see the API References here..

https://developer.opentext.com/webaccess/#url=%2Fawd%2Fresources%2Fapis&tab=501

Best Regards
Chris


0
BEST ANSWER: As chosen by the author.

Hi Chris,

Having the swagger documentation on line is great in most instances, but when you want it locally for when you develop offline - my scenario most of the time, it would be great to have a copy locally to your instance of content server.

Is there a clear rationale why OT won't publish the API in this way? This would be really really useful for many people I am sure.

Thanks,

Anthony


0
BEST ANSWER: As chosen by the author.

Hi Anthony,

There is nothing to hide, the swagger documentation can be auto generated with certain languages but not all our products are able to support that hence we publish them all in a common format here on the developer site.

I will pass on your feedback to the Product Managers concerned and update you if there are any plans to publish the APIs in the way you suggest.

Best Regards
Chris


0
BEST ANSWER: As chosen by the author.

Hi Chris,

Thanks for coming back to me. So as an interim method is it possible just to bundle the common format you have produced currently. E.g. bundle the entire set that we see here as a downloadable item: https://developer.opentext.com/webaccess/#url=%2Fawd%2Fresources%2Fapis&tab=501

Be grateful if you could keep me updated on this.

Kindest,

Anthony


0
BEST ANSWER: As chosen by the author.

hi Anthony,

I've just published a local Swagger API viewer with the Content Server API on the Blog:
https://developer.opentext.com/awd/blogs/13328447/content+server+local+api+viewer

I'm no longer on the project but hope it helps.


0
BEST ANSWER: As chosen by the author.

This is of interest to me. I just built some documentation for my REST API. I did a couple of attempts at swagger but had no real luck with it, and found trying to write a static document too tedious. So, over the course of an afternoon, I extended the REST orphan objects that make up a REST API extension, then added a new Documentation method to my ospace root to autogenerate documentation for REST. I can see benefits of doing this for everyone in that it is far easier to have a static web page that is portable with all the documentation on it. Here is an example of what my API Documentation looks like, you'll see that it is a bit swagger like.
http://www.hferguson.ca/corpweb/apidocs/apidocs.html
<br/>
-Hugh


0
BEST ANSWER: As chosen by the author.

Marcin,

That's really excellent. Massively helpful.

Thanks,

Anthony


 You have subscribed and will receive email notifications of updates to this topic. To unsubscribe, uncheck the checkbox.

Statistics

Related categories

Related tags

Your answer

To leave an answer, please sign in.