Hello, I need to use fme server rest api to make a web service application to convert cad to kml. The workspace uses ESRI Reprojector. Now the parameters I publish have no given input and output coordinate system. How do I pass parameter requests to this FMEserver through the web To complete the task
Question
fme server rest api
This post is closed to further activity.
It may be an old question, an answered question, an implemented idea, or a notification-only post.
Please check post dates before relying on any information in a question or answer.
For follow-up or related questions, please post a new question or idea.
If there is a genuine update to be made, please contact us and request that the post is reopened.
It may be an old question, an answered question, an implemented idea, or a notification-only post.
Please check post dates before relying on any information in a question or answer.
For follow-up or related questions, please post a new question or idea.
If there is a genuine update to be made, please contact us and request that the post is reopened.
+2- Contributor
Hi @jactry,
I believe what you are looking for may be covered in the Published Parameter Data Model section of the FME Server REST API V3 Documentation.
The Published Parameter Data Model is a generic data model that describes workspace published parameters and parameters in general in FME Server. This data model is used in the response body from endpoints such as "GET /repositories/< repository >/items/< item >/parameters" to retrieve the published parameters for a workspace.
There is an example workspace that includes a published parameter for coordinate systems that might be a good reference.
Hope that helps.
Is there any similar case you can refer to
Hi @jactry,
If you are looking for more information on how to initially create this published parameter I’d recommend running through Chapter 3 Exercise 4 of our FME Server Authoring Training Manual. In particular step 6 demonstrates how to set up a Coordinate System Published Parameter with Type = Choice with Alias. This requires the end user to select the value from a list of defined Coordinate Systems that are available to use with this conversion - rather than them having to type this in as plain text, by using Choice with Alias the options listed are also User Friendly rather than the values used by FME.
Once this workspace is published to FME Server if you are looking to run it via the Rest API then you must specify any published parameter values in the post upload body using the content type application/json. To see an example of how this is formatted you can review the Rest API documentation for this endpoint or alternatively the FME Server Rest API course Chapter 4 Exercise 1 covers this in more detail.
If you are creating a custom web app where the user will first select the Coordinate System to populate this request then you must first fetch the published parameter values and then submit the job (https://playground.fmeserver.com/using-the-rest-api/jobs/). I’d recommend taking a look at Chapter 9 Exercise 16 of the Rest API course which demonstrates a step by step example of this.
Lastly if you simply want to provide users who do not have access to FME Server to run this job then I’d recommend taking a look at FME Server Apps (only available in 2019.0+). This allows you to provide a URL with unauthenticated access to run a specific workspace without the need to use the Rest API. It will appear similar to the Run Workspace page where the user can set all published parameter values and then select Run. In 2019.1 we added the ability to customise the appearance of these apps to remove the references to FME. If you think this would be sufficient for your needs you can find more information on this here: https://knowledge.safe.com/articles/94277/fme-server-apps.html
Hi @jactry,
If you are looking for more information on how to initially create this published parameter I’d recommend running through Chapter 3 Exercise 4 of our FME Server Authoring Training Manual. In particular step 6 demonstrates how to set up a Coordinate System Published Parameter with Type = Choice with Alias. This requires the end user to select the value from a list of defined Coordinate Systems that are available to use with this conversion - rather than them having to type this in as plain text, by using Choice with Alias the options listed are also User Friendly rather than the values used by FME.
Once this workspace is published to FME Server if you are looking to run it via the Rest API then you must specify any published parameter values in the post upload body using the content type application/json. To see an example of how this is formatted you can review the Rest API documentation for this endpoint or alternatively the FME Server Rest API course Chapter 4 Exercise 1 covers this in more detail.
If you are creating a custom web app where the user will first select the Coordinate System to populate this request then you must first fetch the published parameter values and then submit the job (https://playground.fmeserver.com/using-the-rest-api/jobs/). I’d recommend taking a look at Chapter 9 Exercise 16 of the Rest API course which demonstrates a step by step example of this.
Lastly if you simply want to provide users who do not have access to FME Server to run this job then I’d recommend taking a look at FME Server Apps (only available in 2019.0+). This allows you to provide a URL with unauthenticated access to run a specific workspace without the need to use the Rest API. It will appear similar to the Run Workspace page where the user can set all published parameter values and then select Run. In 2019.1 we added the ability to customise the appearance of these apps to remove the references to FME. If you think this would be sufficient for your needs you can find more information on this here: https://knowledge.safe.com/articles/94277/fme-server-apps.html
My requirement is to create multiple file conversions, read in to support multi-source format kml \\ dwg \\ shp \\ tif \\ mdb, etc. Using an ESRI Reprojector, the output is also multi-source format kml \\ dwg \\ shp \\ tif \\ mdb, how When using the rest api to switch between different output formats, different parameter boxes need to be adjusted.