{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-products/fno-api/sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":["img"]},"type":"markdown"},"seo":{"title":"Test APIs with Try It","description":"API documentation for Revenera products","siteUrl":"https://developer.revenera.com","llmstxt":{"hide":false,"sections":[{"title":"Table of contents","includeFiles":["**/*"],"excludeFiles":[]}],"excludeFiles":[]}},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"test-apis-with-try-it","__idx":0},"children":["Test APIs with Try It"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Try It"]}," feature allows you to send API requests directly from this API reference documentation, to explore and validate API endpoints."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["With Try It, you can:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Modify any field in example requests"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Save requests and review previous calls in the request history"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Configure multiple environments with customizable variables"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Send requests to live servers"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Use realistic mock responses during API integration"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"accessing-try-it","__idx":1},"children":["Accessing Try It"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["You can open Try It from the API reference by selecting ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Try it"]}," on an endpoint."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["When Try It opens, it appears as an overlay on top of the documentation page you were viewing. The interface is divided into two main sections:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Request"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["History"]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"working-with-environments","__idx":2},"children":["Working with Environments"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Environments combine a server URL with predefined inputs, allowing you to make API calls using a consistent configuration."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"adding-a-new-environment","__idx":3},"children":["Adding a New Environment"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Create a new environment where you replace the variable ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":["siteID"]}," with your FlexNet Operations instance."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":5,"id":"to-create-a-new-environment","__idx":4},"children":["To create a new environment:"]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Click the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Environments"]}," icon ",{"$$mdtype":"Tag","name":"Image","attributes":{"src":"/assets/selectenvironment.181cea824cd59e932a9f3212ee1d10e298db051af23ced3360e7e9582585c154.9c1bb791.png","alt":"selectenvironment.png","framed":false,"withLightbox":false,"width":"","height":""},"children":[]}," in the top‑right corner of Try It."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["In the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Environments"]}," window, click ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["New environment"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Enter a name and confirm."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["In the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Server"]}," field, open ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["More options"]}," (three dots) and select ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Edit"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Enter the server URL and save your changes."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Optional configuration: In the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Inputs"]}," table, you can:",{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Add new inputs and assign values"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Update existing input values"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Mark inputs as secret"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Remove inputs you added"]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"editing-environment-settings","__idx":5},"children":["Editing Environment Settings"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["You can update any environment you create to better match your needs:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Rename the environment using the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Edit"]}," icon"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Change the server URL from the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Server"]}," field"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Define or update server variable values"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Manage inputs by adding, editing, hiding, or removing them"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"setting-an-active-environment","__idx":6},"children":["Setting an Active Environment"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["One environment can be marked as active. By default, all requests are sent to the active environment."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":5,"id":"to-set-an-environment-as-active","__idx":7},"children":["To set an environment as active:"]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Click the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Environments"]}," icon ",{"$$mdtype":"Tag","name":"Image","attributes":{"src":"/assets/selectenvironment.181cea824cd59e932a9f3212ee1d10e298db051af23ced3360e7e9582585c154.9c1bb791.png","alt":"selectenvironment.png","framed":false,"withLightbox":false,"width":"","height":""},"children":[]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["In the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Environments"]}," window, hover over the environment's ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["More options"]}," menu."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Select ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Set as active"]},"."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"switching-environments","__idx":8},"children":["Switching environments"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":5,"id":"to-test-requests-against-a-different-environment","__idx":9},"children":["To test requests against a different environment:"]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Open the environment selector in the top-right corner of Try It."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Choose the environment you want to use."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"deleting-an-environment","__idx":10},"children":["Deleting an Environment"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["You can permanently delete environments that you created."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":5,"id":"to-delete-an-environment","__idx":11},"children":["To delete an environment:"]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Click the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Environments"]}," icon ",{"$$mdtype":"Tag","name":"Image","attributes":{"src":"/assets/selectenvironment.181cea824cd59e932a9f3212ee1d10e298db051af23ced3360e7e9582585c154.9c1bb791.png","alt":"selectenvironment.png","framed":false,"withLightbox":false,"width":"","height":""},"children":[]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["In the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Environments"]}," window, locate the environment you want to remove."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Open ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["More options"]}," and select ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Remove environment"]},"."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"using-the-request-panel","__idx":12},"children":["Using the Request Panel"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The Request panel is displayed on the left side of the Try It interface. It contains all the controls needed to configure and send a request for a selected endpoint."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"sending-a-request","__idx":13},"children":["Sending a Request"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":5,"id":"to-send-a-request","__idx":14},"children":["To send a request:"]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Provide values for the required parameters."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Select ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Send"]},"."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"viewing-responses","__idx":15},"children":["Viewing Responses"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["After sending a request, a response preview appears at the bottom of the Request panel."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The response preview may include:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["HTTP status code, response time, and payload size"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Response body in JSON, plain text, HTML, or XML format"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Response headers and their values"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Response cookies"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["You can copy the response by selecting the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Copy"]}," icon on the right side of the response area."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"adding-requests","__idx":16},"children":["Adding Requests"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["You can add requests to the Request panel to access frequently used requests. All requests are displayed as tabs."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":5,"id":"to-add-a-request","__idx":17},"children":["To add a request:"]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["At the top of the Request panel, click the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["+"]}," icon and click ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["New Request"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["With the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["New Request"]}," tab selected, click the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["+"]}," icon again and select an endpoint from the list."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"using-the-history-panel","__idx":18},"children":["Using the History panel"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Try It keeps a record of the requests you send, making it easy to revisit earlier API calls."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["History"]}," panel shows:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Requests listed from newest to oldest"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Requests grouped by date"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["The response status code for each request"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"searching-the-request-history","__idx":19},"children":["Searching the Request History"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["You can search the request history using the search field at the top of the History panel. Searches can match:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["HTTP methods (for example, ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET"]}," or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST"]},")"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Text from the request payload"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"clearing-the-request-history","__idx":20},"children":["Clearing the Request History"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["You can remove individual requests or clear the entire history:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["To delete a single request, hover over it and select the trash icon"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["To clear all history, select the broom icon next to the search field"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"collapsing-the-history-panel","__idx":21},"children":["Collapsing the History Panel"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["To improve usability on smaller screens, you can hide the History panel."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Select the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Collapse panel"]}," button in the bottom-left corner of the Try It interface."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"returning-to-the-api-reference","__idx":22},"children":["Returning to the API Reference"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Close Try It using the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["X"]}," icon in the top-left corner of the Request panel to return to the documentation."]}]},"headings":[{"value":"Test APIs with Try It","id":"test-apis-with-try-it","depth":1},{"value":"Accessing Try It","id":"accessing-try-it","depth":2},{"value":"Working with Environments","id":"working-with-environments","depth":2},{"value":"Adding a New Environment","id":"adding-a-new-environment","depth":3},{"value":"To create a new environment:","id":"to-create-a-new-environment","depth":5},{"value":"Editing Environment Settings","id":"editing-environment-settings","depth":3},{"value":"Setting an Active Environment","id":"setting-an-active-environment","depth":3},{"value":"To set an environment as active:","id":"to-set-an-environment-as-active","depth":5},{"value":"Switching environments","id":"switching-environments","depth":3},{"value":"To test requests against a different environment:","id":"to-test-requests-against-a-different-environment","depth":5},{"value":"Deleting an Environment","id":"deleting-an-environment","depth":3},{"value":"To delete an environment:","id":"to-delete-an-environment","depth":5},{"value":"Using the Request Panel","id":"using-the-request-panel","depth":2},{"value":"Sending a Request","id":"sending-a-request","depth":3},{"value":"To send a request:","id":"to-send-a-request","depth":5},{"value":"Viewing Responses","id":"viewing-responses","depth":3},{"value":"Adding Requests","id":"adding-requests","depth":3},{"value":"To add a request:","id":"to-add-a-request","depth":5},{"value":"Using the History panel","id":"using-the-history-panel","depth":2},{"value":"Searching the Request History","id":"searching-the-request-history","depth":3},{"value":"Clearing the Request History","id":"clearing-the-request-history","depth":3},{"value":"Collapsing the History Panel","id":"collapsing-the-history-panel","depth":3},{"value":"Returning to the API Reference","id":"returning-to-the-api-reference","depth":2}],"frontmatter":{"markdown":{"toc":{"depth":3}},"seo":{"title":"Test APIs with Try It"}},"lastModified":"2026-06-03T10:48:25.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/products/fno-api/apis/rest/using-tryit","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}