Question on how to specify REST API URL

Hello:

I am trying to use this and in the Content Server REST API - Quick Start Guide, it says:

Each REST call is a URL, in the format:
http(s)://<machine name>/<CS service name>/<CS CGI>/api/v1/<resource name>The examples in this document will be a relative path to the Content Server CGI. Values in angle brackets (<>) are placeholders and not literal values.
This document will only describe a handful of calls, for more information see the documentation in Swagger.

But I looked everywhere for how to specify .../<CS service name>/<CS CGI>/ and could not find these two parameters. Could you please point me in a direction?

Thank you

Find more posts tagged with

API

AppWorks Gateway

Comments

Matthew_Pinkney

CS Service Name and CS CGI are something that are defined when you are setting up content server.
By default I believe your CS Service name would be OTCS and CS CGI would depend on your OS. Windows could be cs.exe or liveelink.exe or llisapi.dll or livelink. Solaris and Linux tend to be just livelink
ex.
http://myserver.mydomain.com/otcs/cs.exe/api/v1/nodes/2000

Kevin_Mark

CS Service Name is the part where you set the service name of your Content Server when the installer is running. It is one of the very first screens of the installer. As Matt has said, the default would be OTCS.

As for the CS CGI, you can look in your web server (IIS for example) for the web server mapping to your \cgi directory (ex. \Opentext\charlie\cgi). In IIS, you would find this under the 'Default Web Site'. If you don't see it there, you can manually add it by right-clicking 'Default Web Site' > Add Virtual Directory > name your alias/set the path > hit OK. There should also be a mapping for the \support directory.

The full URL would therefore look something like this (using a GET request as an example):

GET
http://myserver.com/charlie/livelink.exe/api/v1/nodes/2000/nodes