Visit the official Paxata Documentation portal for all of your doc needs.

REST API Primer

What is the Paxata REST API?
Taken straight from our REST API documentation:
  
To provide programmatic access to the Paxata application, the Paxata application publishes a RESTful web service called the Paxata REST API. The Paxata REST API requires user-level authentication with a valid user account on the server. The Paxata REST API enforces permissions in the same way as the web application user interface. Additionally, for programmatic access the user account must have the AccessRestApi permission. By default, the RemoteAccess and SuperUser roles contain the AccessRestApi permission.
So basically, you can access all the functionalities of Paxata through code using Python, Java or any other modern language.
All access and requests are restricted and submitted to the same auditable and governable processes that our web interface goes through.

Hmm, ok but I don't need it to use Paxata, right?
 Correct, think of the REST API as being able to customize and integrate Paxata within your current workflow. However, you might be asked to provide a REST API token in order to authenticate, this token can only be generated by you and can only be seen once but can be re-generated and deleted at will, adding an extra layer of security.

What type of operations can be performed using the REST API?
  As mentioned earlier, the REST API provides access to Paxata programmatically, it does so by exposing URLs (called endpoints) to different types of actions, defined by different verbs. GET(), retrieves a list of something, POST(), creates one of those something, PUT(), updates it, DELETE() removes it.

  An endpoint can support any number of those verbs, and responses sent from Paxata will also change based on the information provided to the endpoint. For example, requesting a GET() on the library endpoint will return a list of all the library items that you have access to, while doing the same GET() and passing a library ID will return information about this specific dataset/answerset.

What is an example of integration?
  A lot of the organizations we work with utilize some type of enterprise scheduler, be it a CRON job, an Autosys or Control-M scripts. Paxata can be called as part of these tool processes and perform actions based on the scripts workflow, I.E. Import my sales data into Paxata to prep it for my projection model as soon as the previous process completed successfully, or, execute the data quality metrics project for the BI Dashboard.

  But since the REST API is accessible through code, Paxata can also be integrated with any in-house development efforts.

What is an example of a utility?
  The early utilities were built as tools to facilitate our work, such as documenting projects as artifacts for the customer,
other utilities have come from requests from our customers to have a tighter integration with their process.

Where can I get more information on the REST API?
  
Our documentation site has all that you need to interact with our REST API, if you have questions on how to get started then contact our Customer Services team.
Sign In or Register to comment.