Changes to Orch API spec

Help Orchestrator
,
1

Just wondering where I can find release notes for Orchestrator API spec updates/changes. One of my automations started failing from 23 Sep 2024 because now the API request needs an extra query param to get the desired result. It worked ok up until 22 Sep. Are changes to API published somewhere? Thanks

2

@sudster

Generally in these release notes only you would find few updates

Cheers

3

You can check Orchestrator’s Swagger for detailed documentation of current APIs, including changes to query requirements and new parameters. Swagger often contains information about API methods

4

Thanks guys. I am after a list where it says x has been changed to y or query param z was added etc.

5

What API call exactly does not work anymore?

6

Thank you very much for the follow up on this topic!

We use a third party tool (we use 2 automation platforms in parallel) to monitor Queue items with status “New”, which alerts us if a queue is stuck for more than 30 minutes. We make an API request to get a count of new queue items every half an hour. This was working ok up until the 21 Sept. Sometime on 22 Sep, the API response stopped giving us the count, but the request itself did not fail. However parsing the response failed because the count element was no longer present.

Please note we did not make any changes to the API request. We didn’t notice the issue for a week and a bit I think. Once I added the $count to the query parameter, it started working again. This is why I was asking if there is a document that shows changes to the API spec, like a change log.

7

Sure, the change is highlighted in the release notes: Orchestrator - September 2024
It was previously announced as deprecated in April: Overview - Deprecation timeline

8

Thanks @CosminV , would it be outside the realm of possibilities to notify enterprise customers of any breaking changes? Or may be list all breaking changes under a separate section, so we can develop an automation to grab them. If you can list API changes in Swagger itself, right next to the entity that changed/changing, that would be even better; at least when something doesn’t work, we can easily identify what has changed.

Since my original question has been answered, I’ll mark your answer as the solution. Thank you again for the response!