Skip to main content
Solved

FME API Automation topic trigger and external action query

  • January 15, 2025
  • 4 replies
  • 36 views

vn1
Contributor
Forum|alt.badge.img+4
  • Contributor

If an automation is triggered by a schedule, you can obtain the schedule properties via the Schedules list.  https://docs.safe.com/fme/html/FME_REST/apidoc/v3/index.html#!/schedules/list

 

If an automation is triggered by a topic, how do you obtain the name(s) of the topic(s) that trigger that automation?

If an automation posts to a topic, how do you obtain the name(s) of the topic(s) that automation posts to?

Best answer by hkingsbury

I’ve attached an example workspace that makes used of the /fmerest/v3/automations/workflows/@Value(id)/components api - which is undocumented.

It returns a json object that contains all the components in an automation. You can then break this down and find what topics are called.

View original
Did this help you find an answer to your question?

4 replies

hkingsbury
Celebrity
Forum|alt.badge.img+50
  • Celebrity
  • Best Answer
  • January 15, 2025

I’ve attached an example workspace that makes used of the /fmerest/v3/automations/workflows/@Value(id)/components api - which is undocumented.

It returns a json object that contains all the components in an automation. You can then break this down and find what topics are called.


vn1
Contributor
Forum|alt.badge.img+4
  • Author
  • Contributor
  • January 16, 2025

Thank you.  This appears to achieve the result.  Is there any known reason why the components api is undocumented?


hkingsbury
Celebrity
Forum|alt.badge.img+50
  • Celebrity
  • January 17, 2025

 

vn1 wrote:

Thank you.  This appears to achieve the result.  Is there any known reason why the components api is undocumented?


Great question, at a guess it’s because it’s viewed more as an internal API and not something Safe is expecting people to interact with. There are quite a few instances like this.

@rylanatsafe are you able to give some insight into why some APIs are documented and some aren’t?


rylanatsafe
Safer
Forum|alt.badge.img+13
  • Safer
  • January 18, 2025

@hkingsbury that’s a great question!

We focus on documenting API endpoints with strong external use cases. Endpoints primarily used by internal processes, like the Flow UI, are less likely to be documented to allow for more flexibility in making improvements or breaking changes.

Some undocumented endpoints might not be optimized for general use and encouraging their widespread use (through API documentation) could impact application performance, though that is generally an uncommon case.

The /components part of the Automations API remains undocumented in the V4 Flow REST API. I recognize the need for better insights into object connectivity and dependencies in FME Flow. The scenario described aligns with feedback we’ve seen, and we’re exploring options to address in the future.

Thank you for the tag! Your suggestion is a clever approach to obtaining the topic information.


Reply


Cookie policy

We use cookies to enhance and personalize your experience. If you accept you agree to our full cookie policy. Learn more about our cookies.

 
Cookie settings