E9.2 API Rest Call ending in No Response

[aostdiek]

I am starting to schedule some of my first Orchestrations and am attempting to start our Orchestrator Scheduler via API's, but am getting 'No Response' when trying to setup any initial API calls (done via Talend API Tester). Is there a resource available someone can direct me to, or does anyone have some gotchas and advice for a new wannabe Orchestrator aficionado on how to setup the API testing tools?

 

[DaveWagoner]

Fun stuff!

External API tools like postman and Talend (I've never used but I'm guessing it's similar) require connectivity to the AIS server. So if you're running your API tool as a glorified web browser, and can web browse to your orch web frontend then you should be able to at least call your discover endpoint and get a response without a timeout.

IF however your AIS server is locked down via networking magic, and your API tester tool is using some sort of central proxy (such as if you're running postman web without the helper proxy) then the request might be coming from a blocked source, and you're just seeing the result of that.

So there are lots of potential variables at play depending on which tool you're using, which endpoint you're calling, how you're calling it, etc etc etc

My best advice is to make sure, assuming the networking and tool are compatible, that you're sending the right METHOD of request. Some endpoints expect GET, some expect POST, etc.

If you're trying a specific endpoint, post that here and maybe we could work thru it.

 

[lfurino]

You have to make sure the scheduler is started first and then you can start the scheduler for the Orchestration. To do this, first send a post request to: https://<ais_server>:<ais_port>/jderest/v2/scheduler/startScheduler
then to start it for an Orchestration send another post request to https://<ais_server>:<ais_port>/jderest/v2/scheduler/startjob/<orchName>

Don't forget to set the Method as Post, Content-Type as application/json, the Authorization string and an empty body. Here is an example in talend:


You can reference the complete API documentation here: https://docs.oracle.com/en/applicat...oduct/9.2/rest-api/api-scheduler-service.html

 

[KeerthiKiran]

I am starting to schedule some of my first Orchestrations and am attempting to start our Orchestrator Scheduler via API's, but am getting 'No Response' when trying to setup any initial API calls (done via Talend API Tester). Is there a resource available someone can direct me to, or does anyone have some gotchas and advice for a new wannabe Orchestrator aficionado on how to setup the API testing tools?

Can you check your USERID that you are using to start Scheduler have sufficient rights to the console.

 

[aostdiek]

Fun stuff!

External API tools like postman and Talend (I've never used but I'm guessing it's similar) require connectivity to the AIS server. So if you're running your API tool as a glorified web browser, and can web browse to your orch web frontend then you should be able to at least call your discover endpoint and get a response without a timeout.

IF however your AIS server is locked down via networking magic, and your API tester tool is using some sort of central proxy (such as if you're running postman web without the helper proxy) then the request might be coming from a blocked source, and you're just seeing the result of that.

So there are lots of potential variables at play depending on which tool you're using, which endpoint you're calling, how you're calling it, etc etc etc

My best advice is to make sure, assuming the networking and tool are compatible, that you're sending the right METHOD of request. Some endpoints expect GET, some expect POST, etc.

If you're trying a specific endpoint, post that here and maybe we could work thru it.

Thank you so much for the reply Dave! It looks like my initial problem is that AIS server endpoint may not be correct, as I cannot browse to it.

From the Oracle documentation, we should be able to can access those via AIS Server endpoints using this URL format: http://<server>:<port>/jderest/<URI>, and my CNC provided the server/port information, but I still get no response. I tried to call the Discovery Service REST Endpoints and got no response, so I'm assuming my AIS server endpoint is correct, or it's locked down.

Can you provide greater context regarding the ability to "web browse to your orch web frontend" statement? Are you saying that if you just put in http://<server>:<port>, that should take you somewhere? Orch Studio... somewhere else?

I appreciate the assistance and advice!

 

[aostdiek]

You have to make sure the scheduler is started first and then you can start the scheduler for the Orchestration. To do this, first send a post request to: https://<ais_server>:<ais_port>/jderest/v2/scheduler/startScheduler
then to start it for an Orchestration send another post request to https://<ais_server>:<ais_port>/jderest/v2/scheduler/startjob/<orchName>

Don't forget to set the Method as Post, Content-Type as application/json, the Authorization string and an empty body. Here is an example in talend:
View attachment 19727

You can reference the complete API documentation here: https://docs.oracle.com/en/applicat...oduct/9.2/rest-api/api-scheduler-service.html

Thanks for the notes Larry, I believe I have a problem further upstream, as I can't even get a response right now.

I appreciate the detail for starting the scheduler, as it aligned to what I was trying to use. So assuming I get my connectivity correctly established, my post request should get the scheduler started.

I appreciate the reply and hope you're doing well!

 

[DaveWagoner]

Thank you so much for the reply Dave! It looks like my initial problem is that AIS server endpoint may not be correct, as I cannot browse to it.

From the Oracle documentation, we should be able to can access those via AIS Server endpoints using this URL format: http://<server>:<port>/jderest/<URI>, and my CNC provided the server/port information, but I still get no response. I tried to call the Discovery Service REST Endpoints and got no response, so I'm assuming my AIS server endpoint is correct, or it's locked down.

Can you provide greater context regarding the ability to "web browse to your orch web frontend" statement? Are you saying that if you just put in http://<server>:<port>, that should take you somewhere? Orch Studio... somewhere else?

I appreciate the assistance and advice!

When you say "no response" are you saying that you're getting a timeout? Or something more informative like a specific error? It sounds like you're timing out perhaps.

For me at least, the studio frontend is at http://<url>:<port>/studio/login.html, and the API endpoint for orch discover is http://<url>:<port>/jderest/discover

The Discover endpoint is a GET method, and in the header I'm adding
'Content-Type: application/json'
and Postman translates my plaintext username and password into a header field called "Authorization: Basic <encodedUserPass>".

The http method (GET/POST/etc), auth header, and content type are required to successfully call the discover endpoint.

One other thing occurred to me-- if your CNC doesn't want to deal with certs, and your AIS server is behind firewall, they might have left it without HTTPS. So make sure you're specifying the correct protocol at the very beginning too

 

[aostdiek]

Wrapping up this thread with our resolution path. Our AIS settings in Server Manager were not configured correctly to enable what we were trying to do, and once we had that properly configured, our Scheduler is working and scheduled orchestrations/notifications are working as expected/designed. If anyone is doing this for the first time, I would suggest making sure your AIS Server has the Health Check properly setup and working via Server Manager.

Thank you @lfurino and @DaveWagoner for your feedback here.

 

[JohnDanter2]

I always use this guy in postman

https://myaisserver.com.theportnum/jderest/v3/open-api-catalog

It brings back a list of all the orchestrations the role and password you give it, in the auth tab using basic auth, is allowed to see.
So it's very useful for checking the connection, what you can use and also quickly building your API collection (save the file and import it)

 

[DaveWagoner]

I always use this guy in postman

https://myaisserver.com.theportnum/jderest/v3/open-api-catalog

It brings back a list of all the orchestrations the role and password you give it, in the auth tab using basic auth, is allowed to see.
So it's very useful for checking the connection, what you can use and also quickly building your API collection (save the file and import it)

Nice! I only knew about the menu option from within studio Tools > Definitions > openAPI, downloading that, and installing it each time. It makes a copy of my collection each time so it's a little annoying, your method should work better for me