Robot Manager Rest Client API

Hi, I’m currently investigating how we could potentially make use of the Robot Manager REST Client but finding it difficult to get any kind of practical use from it, so I’m hoping to get a bit of direction please. I was only able to find one example on here when searching previous support posts but it’s limited, so anything and everything provided will be very helpful and much appreciated.

I’ve located the API section within Pega Platform/Dev Studio and have been testing the various resource paths/endpoints out but so far I’ve only been able to get info from one or two (like applications) but those don’t really provide much value/use. Also, despite authenticating ok, resource paths/endpoints like ‘cases’ and ‘users’ or ‘cases/{ID}’ and ‘users/{context}’ return with a response but don’t contain any results, even though I can separately find cases and users through Pega Platform/Dev Studio.

As a use case example, and from what I understood of the documentation, I’m thinking it should be possible to build an attended bot with a simple UI that queries the API in the background as needed to display useful info to the user:

  • whether a case is running in a particular workgroup/queue;
  • show details like the case ID, its current status, the name of the machine it’s running on;
  • what time a case started (and therefore how long it’s been running for);
  • maybe even provide options in the UI to create a new case or stop the current case (for occasions when there are timeouts/crashes, etc, either through design or to help recover from unhandled exceptions)
  • perhaps a list of currently-active bots and/or machines.

Thanks in advance for any specific guidance you can provide.

@KevQBE As you know, the RM REST Client is used to call Pega REST services that you create inside of your Robot Manager Pega Application (since you would be already authenticated to it and can therefore connect to them without additional authentication).

In the past, we have used the RM REST Client for the following use case. We created some decision trees within the Pega Application that we modified using a portal created within the platform. These could be queried using the RM REST Client and used within the logic of the bots. You can also call any of the specific Pega APIs that come OOTB. Essentially, as long as you expose an endpoint to whatever logic you want to build, you could potentially call it from the bot and use that information.

Hi @ThomasSasnett , thanks for this. If I’ve followed you correctly, you’re saying it is possible to achieve what I mentioned in my original post but I’ll probably need to create my own endpoint(s) to do so? If there are specific OOTB ones that I’ve missed or not utilised correctly/fully, it’d be great if you have more insight or an example, please. Sorry if I’ve misunderstood, I should have mentioned that I don’t have much experience with APIs, so may need to pester a little bit more before I get it :slight_smile:

@KevQBE I don’t have a lot of experience creating APIs in the Pega Platform, however there is lots of documentation and training available on that subject. I would start with the links below and expand as needed. It really requires some level of experience with the Pega Platform to create these as they rely on concepts you learn in the Pega SSA training materials.

https://docs.pega.com/bundle/platform/page/platform/data-integration/considerations-choosing-between-pega-api-custom-api.html

https://academy.pega.com/challenge/accessing-pega-application-using-pega-api/v6

@ThomasSasnett Thank you!