The API Explorer is an interactive application used for making calls to Kepler service endpoints directly in Relativity. It includes modules used to perform CRUDQ operations on a Relativity resource. Each module contains the URLs for service endpoints, the ability to view fields used in the payload request, and information about fields returned in a response.
The API Explorer consumes an OpenAPI file generated using Open API 3.0 specification, which is a common standard for REST APIs. After you install the API Explorer, it searches for an OpenAPI file in each application RAP file installed in your Relativity instance. It then reads the file and populates a web interface, so that you can interact with the APIs supported by that specific application. For more information, see What Is OpenAPI? on the Swagger website.
This page contains the following information:
Complete the following tasks to set up the API Explorer:
The quick-start steps include high-level information about how to navigate through the API Explorer and make REST calls. You may want to use these instructions if you are already familiar with using OpenAPI documentation. For additional information about available services and requirements for making REST calls, see HTTP APIs.
If you would like detailed navigation instructions and conceptual information, see the API Explorer tutorial.
(Click to expand)
(Click to expand)
Note: If you execute a REST call, your instance database may be modified. You can change, delete, or corrupt data using the API Explorer interface.
(Click to expand)
The API Explorer tutorial provides detailed information for each step used in the process for inspecting a REST API. It uses the Object Manager service to step through the features of the API Explorer, while also explaining key concepts underlying REST calls. For example, it describes the parameters and fields that you need set for a specific endpoint on the Object Manager service. If you need only minimal instructions for navigating in the API Explorer, see Quick-start steps.
This tutorial includes the following sections:
In the API Explorer, you can interact with an API by selecting it, and then choosing the version that you want to use for REST calls. Complete the following steps to select the API and its respective version:
The left navigation pane lists applications that have OpenAPI files describing the API for an application.
The center pane may display the available versions of the API used for the application. In this example, the center pane displays only one version of the Object Manager API.
(Click to expand)
The center pane now displays a list of available endpoints that you can use to make REST calls for this versioned service. The HTTP method and route for each endpoint is displayed. This example uses Object Manager v1, but you can easily switch to Object Manager v2.
(Click to expand)
A REST request includes header information, and may include key-value pairs in a JSON payload in the body. To view the header parameters and the request body, click on an endpoint. For example, click on the read endpoint for the Object Manager API as shown in the following screen shot:
(Click to expand)
The request page contains the following information:
(Click to expand)
The read endpoint on the Object Manager service requires these parameters:
The Request body section contains the following tabs:
(Click to expand)
In the Object Manager service, a read endpoint requires the following fields displayed on the Example Value and Model tabs:
For more information about field values, see Object Manager (REST).
Before making a REST call, you must set the values for the required parameters and fields in the request body. Click Try it out to set the values that you want to use.
(Click to expand)
The Parameters section now displays a form listing the required values that you need to add. For the read endpoint on the Object Manager service, enter the following value in this form:
(Click to expand)
To set the fields in the request body, scroll to the Request body section of the form. For the read endpoint on the Object Manager service, enter the following field values:
(Click to expand)
For more information about field values, see Object Manager (REST).
After you have set the parameters and field values, you are ready to make a request to the service. Click Execute.
Note: If you execute a REST call, your instance database may be modified. You can change, delete, or corrupt data using the API Explorer interface.
A response is returned after a REST call finishes executing. It includes a status code indicating whether the call was successful, HTTP headers with general information about the response, and possibly a response body with any requested data. For more information, see Describing Responses on the Swagger website.
Review the following response:
(Click to expand)
In the API Explorer, the Responses section includes the following subsections:
Response body - the content returned by the service, which contains is key-value pairs formatted as JSON.
For the Object Manager service, the response body includes the following fields:
Community Updates |
|||
Aero Developer FAQ | Evolving the Platform | Most recent release notes | |
Learn more | Learn more | Learn more |
Additional Resources |
|||
![]() |
![]() |
||
Access Third-Party Tools with GitHub | Create .NET Apps Faster with NuGet | ||
Visit github | visit nuget |