Skip to main content

Step 3.3: Add a Response to Your Operation

Responses define what your API returns after performing an operation. In Data Equity Studio, responses are currently supported in the JSON format.

How to Add a Response​

  1. Select the Operation:

    • Navigate to the operation you’ve just created (e.g., GET /users, POST /products).

  2. Add a New Response:

    • Click on the Add Response button.

  3. Choose a Status Code:

    • Select the relevant HTTP status code for the operation:
      • 200 OK: Successful response for GET, PUT, or DELETE operations.
      • 201 Created: Successful response for POST operations.
      • 400 Bad Request: Error response for invalid client requests.
      • 500 Internal Server Error: Error response for server issues. Docs Version Dropdown

  4. Provide a Description:

    • Add a brief description of the response to clarify its purpose (e.g., "List of users", "User successfully created", "Invalid request format").