Skip to main content
Solved

FME Server REST API : get automation tasks/items

nic_ran
Contributor
Forum|alt.badge.img+16

Is it possible to retrieve automation tasks/items using the FME Server REST API? Specifically, I’m trying to find all workspaces that are run by automations and I’d also need to determine the published parameters passed to each workspace.

The Schedules and Notifications (Subscriptions) REST API methods allow all “items” to be retrieved, which provides access to the workspace details but this does not seem to be exposed in the REST API for Automations…

I’m using FME Server 2019.2.2 Build 19817 - win64.

Best answer by hollyatsafe

Hi @nic_ran,

The FME Server Rest API endpoint for returning information about the components within a single Automation is unpublished, meaning it is subject to change without warning in new builds of FME Server so is not recommended for use.

I don't think this is something that we have seen requested before so please consider creating an Idea to request this endpoint is exposed with your detailed use case.

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

8 replies

H
Forum|alt.badge.img+2
  • hollyatsafe
  • Best Answer
  • April 14, 2020

Hi @nic_ran,

The FME Server Rest API endpoint for returning information about the components within a single Automation is unpublished, meaning it is subject to change without warning in new builds of FME Server so is not recommended for use.

I don't think this is something that we have seen requested before so please consider creating an Idea to request this endpoint is exposed with your detailed use case.

todd_davis
Supporter
Forum|alt.badge.img+21
  • todd_davisSupporter
  • Supporter
  • April 14, 2020
hollyatsafe wrote:

Hi @nic_ran,

The FME Server Rest API endpoint for returning information about the components within a single Automation is unpublished, meaning it is subject to change without warning in new builds of FME Server so is not recommended for use.

I don't think this is something that we have seen requested before so please consider creating an Idea to request this endpoint is exposed with your detailed use case.

Hi, there is the general request to have lots more of the api documented. https://knowledge.safe.com/content/idea/75119/more-fmerest-api-calls-documented.html

Cheers,

Todd

nic_ran
Contributor
Forum|alt.badge.img+16
  • nic_ranContributor
  • Author
  • Contributor
  • April 14, 2020
hollyatsafe wrote:

Hi @nic_ran,

The FME Server Rest API endpoint for returning information about the components within a single Automation is unpublished, meaning it is subject to change without warning in new builds of FME Server so is not recommended for use.

I don't think this is something that we have seen requested before so please consider creating an Idea to request this endpoint is exposed with your detailed use case.

Thanks Todd, I've up-voted that idea.

nic_ran
Contributor
Forum|alt.badge.img+16
  • nic_ranContributor
  • Author
  • Contributor
  • April 14, 2020
hollyatsafe wrote:

Hi @nic_ran,

The FME Server Rest API endpoint for returning information about the components within a single Automation is unpublished, meaning it is subject to change without warning in new builds of FME Server so is not recommended for use.

I don't think this is something that we have seen requested before so please consider creating an Idea to request this endpoint is exposed with your detailed use case.

Thanks Holly. I agree with Todd that it would be great to have more of this documented. I notice on the API reference page that there's a checkbox to "hide advanced calls". Perhaps there could be a similar checkbox to "show unsupported calls" or something along those lines, along with appropriate disclaimers for each call that is liable to change?

The reason that I would like to access the Automation components is that I'm trying to build a workspace to document current state of an FME Server environment. We're in the process of building a mirror PROD environment and I need to determine all workspace endpoints that will need to be updated for the new environment. (e.g. source/target datasets configured via published parameter in an Automation component, etc.)

As this is (hopefully) a one-time effort for me, it would be great if you could share the API calls that I will need. The workspace I'm building is not something that will continue to run after the migration is complete, so there's not much chance that an API call change in a future release of FME will impact it.

todd_davis
Supporter
Forum|alt.badge.img+21
  • todd_davisSupporter
  • Supporter
  • April 14, 2020
nic_ran wrote:

Thanks Holly. I agree with Todd that it would be great to have more of this documented. I notice on the API reference page that there's a checkbox to "hide advanced calls". Perhaps there could be a similar checkbox to "show unsupported calls" or something along those lines, along with appropriate disclaimers for each call that is liable to change?

The reason that I would like to access the Automation components is that I'm trying to build a workspace to document current state of an FME Server environment. We're in the process of building a mirror PROD environment and I need to determine all workspace endpoints that will need to be updated for the new environment. (e.g. source/target datasets configured via published parameter in an Automation component, etc.)

As this is (hopefully) a one-time effort for me, it would be great if you could share the API calls that I will need. The workspace I'm building is not something that will continue to run after the migration is complete, so there's not much chance that an API call change in a future release of FME will impact it.

How far are you along with this Nic? Because I have been building this capability on the side for a year and a bit, but have not started the automation side. Send me an email at and I can show you some of the things I have.

nic_ran
Contributor
Forum|alt.badge.img+16
  • nic_ranContributor
  • Author
  • Contributor
  • April 14, 2020
todd_davis wrote:

How far are you along with this Nic? Because I have been building this capability on the side for a year and a bit, but have not started the automation side. Send me an email at and I can show you some of the things I have.

Thanks @todd_davis, email sent.

nic_ran
Contributor
Forum|alt.badge.img+16
  • nic_ranContributor
  • Author
  • Contributor
  • April 15, 2020
hollyatsafe wrote:

Hi @nic_ran,

The FME Server Rest API endpoint for returning information about the components within a single Automation is unpublished, meaning it is subject to change without warning in new builds of FME Server so is not recommended for use.

I don't think this is something that we have seen requested before so please consider creating an Idea to request this endpoint is exposed with your detailed use case.

FYI, I added an "Idea": https://knowledge.safe.com/idea/111914/publish-fme-server-rest-api-endpoints-for-retrieva.html?

ebygomm
Influencer
Forum|alt.badge.img+31
  • ebygommInfluencer
  • Influencer
  • September 20, 2024

Is there still no way of doing this?

landersen
1 person upvoted this
  • landersen
    landersen

Reply


Helpful Members This Week

Community Stats

30,942
Posts
117,252
Replies
38,742
Members

Latest FME

Terms & ConditionsCookie settings

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
A product of
Safe Software respectfully acknowledges that we live, learn and work on the traditional and unceded territories of the Kwantlen, Katzie, and Semiahmoo First Nations.