Skip to content
Snippets Groups Projects
Commit 0db79dba authored by SAM CARPENTER's avatar SAM CARPENTER
Browse files

Update PersonAPIwRESTv2.md

parent 0f0ad3e9
No related branches found
No related tags found
1 merge request!42Person api with rest v2
This tutorial demonstrates how to create a connection within Informatica Intelligent Cloud Services (IICS) using the RESTv2 type to connect to the [Mock Person API](https://developer.wisc.edu/docs/mock-person-api/1/overview). In production, you will want to use the non-Mock [Person API](https://developer.wisc.edu/docs/person-api/1/overview) and you can request access to it via [this link](https://it.wisc.edu/services/identity-access-management-work-request/) if you don't have access already. This tutorial will assume you already have a working IICS account with a secure agent installed as well as an API app set up in the Wisc Developer portal. This tutorial demonstrates how to create a connection within Informatica Intelligent Cloud Services (IICS) using the RESTv2 type to connect to the [Mock Person API](https://developer.wisc.edu/docs/mock-person-api/1/overview). In production, you will want to use the non-Mock [Person API](https://developer.wisc.edu/docs/person-api/1/overview) and you can request access to it via [this link](https://it.wisc.edu/services/identity-access-management-work-request/) if you don't have access already. This tutorial will assume you already have a working IICS account with a secure agent installed as well as an API app set up in the Wisc Developer portal.
Note: *It looks like we may need to also include how to get an App into a user's API login* Note: *It looks like we may need to also include how to get an App into a user's API login*
...@@ -39,3 +38,30 @@ Note: *It looks like we may need to also include how to get an App into a user's ...@@ -39,3 +38,30 @@ Note: *It looks like we may need to also include how to get an App into a user's
9. Press the _Test Connection_ button in the upper right of the window to verify the connection is successful. 9. Press the _Test Connection_ button in the upper right of the window to verify the connection is successful.
10. If the connection is successful, press the _Save_ button. 10. If the connection is successful, press the _Save_ button.
###Usage as a Source in a Mapping
1. To use PersonAPI as a source in a mapping, select the connection you just created as the source. To get a list of all people, select "get people" as the operation.
![Selection of Mapping Source](images/mapping1.png "Output Group")
2. In order for the source to be used, you must go to the Request Options of the source and Configure the Request Message
![Request Options](images/mapping2.png "Request Options")
3. No request message is required for this specific API function to work, although IICS requires one. Simply add '{}'. This will throw an error message while validating, but will still result in successful access to the data once the mapping is run.
![Request Message](images/mapping3.png "Request Message")
4. Go to the Field Mapping tab within the source, and click the boxes on the left for each item you would like to map. Different dropdowns will show up on the right, containing the values you have mapped. These are groups that will be used in the next step.
![Field Mapping](images/mapping4.png "Field Mapping")
5. Once you have done Field Mapping, attempt to connect your source to any transformation. This will create a selection menu of several values, each corresponding to the groups seen in the Field Mapping. In this specific case, "data" contains all of the relevant data related to a Student.
![Output Group](images/mapping5.png "Output Group")
###Important Notes
- Web Service connectors enabled by Business Service options do not currently operate with this API. This issue is being researched.
- The RESTv2 Connector does not accept swagger files of the OpenAPI3.0 specification (which PersonAPI uses), so the Swagger file must be converted to 2.0 through tools or by hand. There is a link to a converted swagger file provided in this tutorial.
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment