Skip to main content
Question

Import endpoint schema into workbench

  • August 13, 2025
  • 3 replies
  • 57 views

redgeographics
Celebrity
Forum|alt.badge.img+60

Is there a way to import the schema you’ve set up for an endpoint into your workspace? As I understand it, right now (build 25572) the schema that you define in Flow is only used to generate the documentation and you can copy and paste from there of course, but that still feels a bit unpolished.

3 replies

alexbiz
Influencer
Forum|alt.badge.img+28
  • Influencer
  • 161 replies
  • August 13, 2025

Hey Hans,

Usually, OpenAPI/Swagger provides a route to a JSON description document that could be used for this. Something like : 
/swagger.json
/openapi.json
/openapi/v1.json
/api-docs
/api-docs.json

Unfortunately, FME Flow DV APIs doesn’t seem to have one.

Ideally, you should be able to use the OpenAPICaller with your FME Flow API, but that doesn’t seem possible at the moment.


redgeographics
Celebrity
Forum|alt.badge.img+60
  • Author
  • Celebrity
  • 3704 replies
  • August 14, 2025

Yeah, I saw there was an option to download the OpenAPI description but that makes a call to v4 of the FME Flow API and that’s not implemented yet.

And to be honest, even with that I’m not sure it would be of use. Unless I’m mistaken, you still have to construct the API response yourself, so either JSONTemplater or AttributeManager. That’s where I’d like to see an easy way of importing the structure in to.

Just throwing an idea out there… Could it be added automatically, in an annotation, to the workspace that’s being generated by Flow?


redgeographics
Celebrity
Forum|alt.badge.img+60
  • Author
  • Celebrity
  • 3704 replies
  • August 14, 2025

Oh hang on, it turns out that it does actually save the OpenAPI spec for a specific endpoint:

C:\Users\<username>\Documents\FME\Data Virtualization APIs\<Flow name>\<API name>\<Workspace name>\OpenAPISpec\

Flow name is the name of the web connection used to connect to it.