Use Cases
Last updated
Was this helpful?
Last updated
Was this helpful?
This page describes how the API can achieve a goal or objective and outlines the steps involved in a scenario, the tasks or actions to be performed, and the expected results or outcomes.
The use cases are set to a specific objective and outcome and intended as a template to leverage for all API needs.
The use cases are separated into three categories:
Introductory Use Cases: Objectives common for all PlexTrac users when getting started. These use cases are relatively straightforward.
Intermediate Use Cases: Objectives that are easy to achieve within the platform but contain non-intuitive steps when done via API. Some platform interactions send multiple API requests, which can be confusing to replicate when manually calling API endpoints.
Advanced Use Cases: Objectives are not available within the platform but are doable via API. Since certain platform functionality consists of making requests to multiple API endpoints, new functionality can be created by combining various API requests and data transformation. An example of an advanced use case is with data import/export. While Plextrac doesn't have the functionality to import/export all stored data, POST requests to create and GET requests exist in the database. Combining a GET request with saving the response to a JSON can make the functionality to export the data. Data can be imported by combining some data transformation to remove IDs and a POST request to create a new data object.
Add the key "repositoryId" and the value "" to the finding JSON (i.e., "repositoryId": "clgn7pad8046c28n27tbg8ue3").