Introduction
Manual responses are Data Virtualization API endpoints that always return the same, predefined output — no matter what request comes in. They’re configured entirely within FME Flow, lightweight to set up, and perfect for consistent information like fixed metadata, service status updates, or reference details.
Because they don’t connect to workspaces or external data, manual responses stay simple and predictable. If you ever need results that change based on request input or live data, that’s when you’d move to a workspace response instead.
Note that documentation may change rapidly and not reflect the current build. This article was written with FME 2025.1.2 b25630.
Learning Objectives
After completing this lesson, you’ll be able to:
- Create and apply tags to organize API endpoints.
- Configure a manual endpoint in FME Flow
Step-by-Step Instructions
In this exercise, you’ll create a manual endpoint: GET /about. It returns general information about the EnvironData API and the department that manages it.
The /about endpoint acts as a simple entry point, giving users context about the API’s purpose and how it can be used. Because it’s a manual response, the output is static and doesn’t rely on external data sources.
1. Create a Tag
From the Environmental Impact and Response API page in FME Flow, click the Endpoints tab. Here you can create, update, organize, or delete endpoints.
Over time you’ll have many endpoints here. Use tags to group related ones (by topic, data source, parameters, or schema). Tags also help end-users quickly find what they need in the documentation.
Click the Manage Tags.
Click Create and enter:
- Tag Name: general
- Description: Department and service information.
Click Create.
The new general tag is now listed.
Click Close to return to the Endpoints tab. The new general tag is now listed, and endpoints can be added to it.
2. Create a Manual Endpoint
Click Create to open the Create Endpoint dialog.
Enter the following values:
| Path | about |
| Operation | GET |
| Summary | Retrieve EnvironData Coordination Office details |
| Description | Returns contact info, hours, focus areas, and other details about the EnvironData Coordination Office. Helps users understand who manages the API. |
| Endpoint Tags | general |
| Inherit API Setting* | Enabled |
*Endpoints can have individual security settings, or adopt the security configurations (such as authentication, users, and roles) from the parent API.
Next, go to the Response tab. Set Response Type to Manual.
Fill in:
| HTTP Status Code | 200 - OK |
| Description | Successful |
| Content Type | application/json |
| Response Message |
{ "name": "EnvironData Coordination Office (EDCO)", "website": "https://environdatagov.example", "email": "support@environdatagov.org", "departmentFocus": [ "Environmental Monitoring", "Disaster Impact Coordination", "Data Sharing and Integration" ], "operatingHours": "Mon–Fri 8:30 AM to 5:30 PM", "location": "456 Greenway Ave, Capital Region, CR 67890", "contactNumber": "+1-800-321-0456" } |
Click Create to finish. The new GET /about endpoint now appears under the general tag.
Now that the GET /about endpoint is configured, we can make a request.
3. Make a Request from the Documentation
In FME Flow, open the API Details tab and launch Swagger (View Documentation).
Click the GET /about endpoint to expand the request details. Click the Try it Out button to test a request.
Click Execute to make the request.
NOTE: Since the EnvironData API requires authentication, a login window may appear. Enter your FME Flow credentials to create a temporary session token for testing requests in Swagger.
Once submitted, the request runs and the response appears under Server Response. You should see a 200 OK with the JSON body.
If credentials are wrong, you’ll see 401 Unauthorized.
Swagger is a powerful way to test endpoints in real time. You can try different parameters, credentials, and error conditions—all without writing code. Swagger also shows an example Curl request and the Request URL, which you can copy for use in other apps.
3. Copy Request URL
For the next tutorial, you’ll need the Request URL. Copy the Request URL and continue to Secure Data Virtualization Endpoints with Authentication. Also, leave the Swagger documentation open for quick reference.
Lesson Summary
By creating a manual endpoint, you’ve learned how to define an API directly within FME Flow — including its path, methods, and response structure — without relying on a workspace template.
Manual endpoints give you full control over how data is exposed, making them ideal for lightweight APIs, testing, or integrating with existing systems.
In the next lesson, you’ll learn to authenticate your API requests from different clients.
Next Lesson: Secure Data Virtualization Endpoints with Authentication.