If you wish to retrieve the result dataset from a workspace through the REST API, the best method is to write it to a shared resource location that is accessible to the client. In this example we will make a workspace, then run a call while changing the output to the Temporary Repository. We will use a very basic workspace to test this out.

Create the Workspace

1) Open FME Workbench and start a blank workspace.

2) Add a Microsoft Excel reader, with the BusinessLicenses File.

There are many ways to add a Reader to a workspace. We can add the Reader by clicking on the canvas and typing Excel.

Once we have selected the Excel Reader, we click the ... button to navigate to the Dataset.

The Dataset is located here:

C:\FMEData2018\Data\Planning\BusinessLicenses.xlsx

3) Then add CSV writer to the workspace.

Next, we can add the CSV Writer. The CSV Writer can be added in the same way. Click the canvas and start to type CSV. Select the CSV writer.

Accepting the default parameters is okay.

Then, connect the Excel file to the CSV file.

4) Set the Destination Folder.

The next step is to identify the Published parameter of the destination dataset. Published Parameters are located in the Navigator panel of FME Workbench. It should be called DestDataset_CSV2. Right click on DestDataset_CSV2 and select Edit Value. Then using the drop-down arrow, expand the FME Server Parameter menu and select $(FME_SHAREDRESOURCE_TEMP).

When using calls through the REST API it is important to have the file being written to an area that your FME Server has access to. The temporary folder is a great place to write files to for testing because the files will be cleaned.

5) Set the Source Dataset

We will upload the data using the API later. For now change the source dataset folder to:

$(FME_SHAREDRESOURCE_DATA)/SharedResourceTest/BusinessLicenses.xlsx

The source dataset also has to be in a location that the FME Server has access to. We are specifying a folder here that will be created through the REST API.

6) Set the Source Dataset to a Private Parameter

The next step is to set the Source Dataset to a private parameter. This can be accomplished by going to the navigator panel and then right-clicking on the parameter. Then select "Convert to Private Parameter."

Converting Public Parameters to Private Parameters ensures that the call is easy to use. Since, the source of the dataset will not change it is a best practice to convert it to a private parameter.

7) Publish to FME Server

If you have not set up the Server Connection the instructions can be found here

First, click the publish to FME Server button. Then, select the FME Server Connection created previously and click Next. Now, set the Repository name to RESTTraining. Set the Workspace name to Chapter6Exercise11.fmw and click Next. Finally, select the Job Submitter Service and publish the Workspace.

Upload the Data Using the Resources call

8) Enter the following URL and Headers into Postman

Headers:

• Content-Type: application/octet-stream

• Accept: application/json

• Content-Disposition: attachment; filename= "BusinessLicenses.xlsx"

• Authorization: fmetoken token=<yourToken>

9) Add the Body of the call in Postman

First, click on the body tab in Postman. Then, select Binary and click Choose Files.
Find C:\FMEData2018\Data\Planning\BusinessLicenses.xlsx as the file to upload!

10) Click Send! Then, review the response

Run the Job

11) Enter the following URL and Headers into Postman

Headers:

• Accept: application/json

• Content-Type: application/json

• Authorization: fmetoken token=

12) Add the Body of the call in Postman

First, click on the body tab in Postman. Then, click the raw button. Then, paste the following information.

{
"publishedParameters": [
{
  "name": "DestDataset_CSV2",
  "value": "$(FME_SHAREDRESOURCE_TEMP)"
}
]
}

13) Review the Response from the FME Server

{

"id": 29

}

Please Note. The Job ID pictured may be different to what your machine returns.

Test the Job was Successful

14) Enter the Following call into Postman. Then, Click Send!

This call will run asynchronously so in return you will receive an id. To check that your call has been completed, use this call.

Headers

• Accept: application/json

• Authorization: fmetoken token= <yourToken>

15) Review the Response to ensure the job was completed successfully

Download the Resulting File

16) Enter in the Request URL and Headers into Postman

Then you can download the file using the call below.

Headers:

• Accept: application/octet-stream

• Authorization: fmetoken token= <yourToken>

• Content-Type: application/x-www-form-urlendcoded

17) Enter in the Body in Postman

Click the body tab in Postman. Then select raw. Then, paste the following information. Click Send!

accept=contents&disposition=inline

18) Review the Response in Postman!

While Postman can process the call, the CSV file cannot be downloaded. If you wanted to download a copy of the file you can do so through FME JavaScript API. We will walk through this process later in the course.