In this section, Paradox Admins/System Implementors can create and manage API requests. 

Request list

This list includes the following columns:

• Request Name – The name of the request.
• Method – The integration method and corresponding color selected in the request. Options include:
  • GET
  • POST
  • PUT
  • PATCH
  • DELETE
• Used in – The names of the Workflows in which the request is used.
• Last Updated – The date and timestamp of the last update.

List actions

Create a request

You can create a request by clicking the + Create New Request button in the top right corner above the list. A new page will then open where you can enter in the details of the request. A new page will open where you can enter in the request's information.

Edit a request

You can edit a request by either clicking into it from the list or hovering over its row, clicking the ellipses icon that displays, and then selecting Edit from its drop-down menu. A new page will open where you can edit the details of the request.

View version history

You can view the version history of each request by hovering over its row, clicking the ellipses icon that displays, and then selecting View Version History from its drop-down menu. A slide-out drawer will open where you can view each version, the person who updated the version, and the details of the version when it is clicked from the lefthand panel.

You can also view the version history when editing a request by clicking the clock icon.

Export request

You can export requests individually and in bulk. 

Individually export

To export a request individually, simply hover over its row, click the ellipses icon that displays, and then select Export from its drop-down menu.

Export in bulk

To export requests in bulk, click the Export All icon button in the top right corner above the list.

Import request

You can easily import requests by clicking the Import icon button in the top right corner above the list. In the modal that opens, either drag and drop or click to browse to upload the preferred file. Select Import to upload the file to the preferred request list.

Duplicate request

You can easily duplicate a request by hovering over its row, clicking the ellipses icon that displays, and then selecting Duplicate from its drop-down menu. This is most effective when you have multiple requests to create that are very similar. Once a request is duplicated, you can open it and edit its details.

Run request

You can easily run a request by clicking the Run button within the request's row in its corresponding request list. When clicked, a slide-out drawer will open where you will need to enter in a Candidate ID.

This can be found by opening the Candidate Inbox to the preferred candidate's profile and copying the ID listed at the end of the URL. Paste this ID in the Paradox Candidate ID field within the Run Request drawer and select Preview. Once populated, click the Run button to run the request and view information regarding the response.