Where is the REST API reference documentation?

Permanently deleted user

27 Oktober 2017 17:08

I'd like to reference the project documents in a startup workflow.  The project documents are those in the data store, i.e. the projects listed as File Type 'gvh-project' in the Security & Data > Data Store > Documents tab, and referenced in Manager at https://GTX_HOST/Geocortex/Essentials/RestManager/DataStoreManage/Edit in Rest Manager.

 

If I try to browse to the REST API documentation at https://docs.geocortex.com/essentials/apis/rest/ it tells me that "The resource you are looking for has been removed, had its name changed, or is temporarily unavailable.".

 

Where can I find this documentation or otherwise find the REST endpoint URLs for project documents?

 

Thanks!

0

• 

  Permanently deleted user

  25 November 2017 00:05

  Hi Chris,

   

  I've checked in with the Essentials team and, while we used to have documentation for the REST API, I'm told there's no immediate plan to document the REST API again. As an aside, the "The resource you are looking for has been removed, had its name changed, or is temporarily unavailable" error is currently displayed for any URL that yields a Not Found (404) error; I've asked the Docs team to take a look at that, as that error is potentially a little misleading.

   

  Currently, the best way to determine how to use the REST API, whether for interacting with projects or using the printing endpoint, is to perform the action in the viewer while monitoring the requests it makes to Essentials via Fiddler. If you have a specific question about how something works -- or doesn't work (e.g., this works when the viewer does it, but when I call this endpoint, I get an error), I'm happy to corner one of our developers and get you an answer.

  0
• 

  Permanently deleted user

  28 Mars 2018 19:18

  Hi Jordan

   

  One thing that I would like to know is how to make a call to a secured service via the REST API. Just supplying credentials is not enough. I assume that we need to request a token and use that token.  Any help in this area would be appreciated.

  0
• 

  Permanently deleted user

  09 Maj 2018 19:55

  This is kind of a cop out and lazy product management practices. If you have an API, please document it. 

  0
• 

  Permanently deleted user

  28 Maj 2018 19:50

  Hi all, 

   

  We have a ticket open now (19017) to remove the broken link since it's definitely not helpful.  If you'd like to see a return of documentation for the REST api, please post an Idea for it here (https://support.geocortex.com/GSCIdeas?c=09a6000000008RsAAI&filter=1&categ=all&sub-nav=ideas&main-nav=essentials&page=1) .  I know there are no immediate plans for it right now, but if the demand is high enough it could be reprioritized.

   

  Clarrie, yes, you would want to include a token (eg. with a token= url parameter).  Where are you calling it from?  If it's a workflow, you can get an Essentials token by using the Get Request Info activity, and accessing the Token property on the resulting requestinfo variable.  Or if it's specifically for an Essentials-secured map service, you could use the GetMapServiceInfo activity.  If you're using a feature description or some other location on your site config that has access to replacement tokens, there's a {RestToken} one that can be used.

   

  -Amanda

  0

Du måste logga in om du vill lämna en kommentar.