Setup API Integrations with Classic Kuali Research

Kuali rest APIs allows you to connect to external data sources including other Classic Kuali products like Kuali Research.  This article goes over how to set up these integrations with some examples to get you started.

• Kuali Research API Resources
• Some Examples of Kuali Research Integrations
• Pull a List of Units from Kuali Research
• Pull a List of Sponsors from Kuali Research
• Pull Award Details from Kuali Research

Kuali Research API Resources

Information on how to utilize the rest APIs in Classic Kuali Research is covered in our API Overview article. This gives you an overview of the API process (including getting an API key setup for authorization) and the documentation for the available rest APIs for each Kuali Research module.

Some Examples of Kuali Research Integrations

Below are some examples of commonly used APIs to pull information from Kuali Research to Kuali Platform.  This should get you started on how to utilize the APIs in general and expand on other integrations you may want to set up.  But if you'd like any other examples added just let us know!

Pull a List of Units from Kuali Research

If you want to pull a list of Units from Kuali Research into your Kuali form as a selectable dropdown field you can follow the below steps.

1. Create a new integration in Kuali pointing to this URL (replace the domain with your own):
   https://{{domain}}.kuali.co/res/research-common/api/v1/units/ 

   Documentation for this endpoint can be found here:
   https://{{domain}}.kuali.co/res/apidocs/common.html#research-common-units-get-1

Note: You can also point to the unit endpoint that allows filtering if you want to narrow down the Unit list by certain attributes.  We recommend filtering large lists by attributes to decrease results and improve performance of API call.  For example, filtering by only active units would be:
https://{{domain}}.kuali.co/res/research-common/api/v1/units/active=true

This filtered endpoint is documented here:
https://{{domain}}.kuali.co/res/apidocs/common.html#research-common-units-get-2

• When creating the GET integration (Get List of Data Items) in Kuali you would set it up the fields as outlined below.  Specifically the ID Key and Label Key of unitNumber; all else can be left blank (inputing your own unique domain url and API auth information):

  

  You can then click Run Test to see the results of the Unit dropdown and then click save.  

Note: if you want to display the Unit Number rather than Unit Name you can make the Label Key unitNumber instead.  Alternatively, you could add the Unit Number (or other information) as Outputs in the integration to then display in the form as desired via the 'Add linked auto-filled gadgets' option in the gadget; then drag into the form.

2. Add a new Advanced gadget of 'Data Lookup (List)' and for the Data Source point it to the newly created gadget:

   

   As mentioned above if you have Outputs in the integration you can then utilize them via the Add linked auto-filled gadgets by dragging them over into the form to the desired location.

   Once added, it will look like this as a selectable Unit dropdown populated by units pulled from Kuali Research:

   

Pull a List of Sponsors from Kuali Research

If you want to pull a list of Sponsors from Kuali Research into your Kuali form as a selectable dropdown field you can follow the below steps.

1. Create a new integration in Kuali pointing to the the below url which also filters results by active (replace the domain with your own):
   https://{{domain}}.kuali.co/res/research-common/api/v1/sponsors?active=true

   The documentation for this endpoint can be found here:
   https://{{domain}}.kuali.co/res/apidocs/common.html#research-common-sponsors-get-1

Note: You can also point to the sponsor endpoint that allows filtering if you want to narrow down the Sponsor list by certain attributes:
https://{{domain}}.kuali.co/res/apidocs/common.html#research-common-sponsors-get-2

• When creating the GET integration (Get List of Data Items) in Kuali you would set it up the fields as outlined below.  Specifically the ID Key and Label Key of sponsorName; all else can be left blank (inputing your own unique domain url and API auth information):

  

  You can then click Run Test to see the results of the Sponsor dropdown and then click save.  

Note: If you want to display the Sponsor Number rather than Sponsor Name you can make the Label Key sponsorNumber instead.  Alternatively, you could add the Sponsor Number (or other information) as Outputs in the integration to then display in the form as desired via the 'Add linked auto-filled gadgets' option in the gadget; then drag into the form.

2. Add a new Advanced gadget of 'Data Lookup (List)' and for the Data Source point it to the newly created gadget:

   

   As mentioned above if you have Outputs in the integration you can then utilize them via the Add linked auto-filled gadgets by dragging them over into the form to the desired location.

   Once added, it will look like this as a selectable Sponsor dropdown populated by units pulled from Kuali Research:

   

Pull Award Details from Kuali Research

There are multiple APIs available to pull Award information from Kuali Research depending on different criteria - below is just one example to pull a list of Awards as a dropdown list in a Kuali form (and display associated award info in the form).

1. Create a new integration in Kuali pointing to the the below url which also filters results by Sequence status (aka award version) being active and the Status code of active (replace the domain with your own):
   https://{{domain}}.kuali.co/res/award/api/v1/awards/?awardSequenceStatus=ACTIVE&statusCode=1

   The documentation for this endpoint can be found here:
   https://{{domain}}.co/res/apidocs/awards.html#research-awards-awards-get-2

Note: We recommend filtering large lists by attributes to decrease results and improve performance of API call.  

• When creating the GET integration (Get List of Data Items) in Kuali you would set it up the fields as outlined below.  Specifically the ID Key of awardId and Label Key of awardNumber and then the configured Outputs; all else can be left blank (inputing your own unique domain url and API auth information):

  

  You can then click Run Test to see the results of the Award dropdown and then click save.

Note: If you want to display a different value in dropdown (like Title) you can make the Label Key Title instead (or some other value).  You can also add whatever desired outputs available in the api.

2. Add a new Advanced gadget of 'Data Lookup (List)' and for the Data Source point it to the newly created gadget:

   

   As mentioned above if you have Outputs in the integration you can then utilize them via the Add linked auto-filled gadgets by dragging them over into the form to the desired location.

   Once added, it will look like this as a selectable Award dropdown and displaying linked info once an entry has been made: