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

add notes for more polished editing of tutorial at some later period

parent be1d42e5
No related branches found
No related tags found
1 merge request!66Person API tutorial changes
......@@ -46,6 +46,8 @@ This tutorial demonstrates how to create a connection within Informatica Intelli
- Click the _Generate Access Token_ button next to the _Access Token_ field and it will auto-populate
- In the _Swagger File Path_ field, paste https<area>://git.doit.wisc.edu/interop/iics/external-iics-docs/-/raw/master/docs/tutorials/PersonAPI/swagger.json (this is a REST v2 OpenAPI specification file that may be different than the one you use in production later. IICS doesn't currently accept V3 and also frequently refers to this OpenAPI specification as a Swagger file.)
(REPLACE THE SWAGGER FILE WITH THE BASIC ONE FROM PERSONAPI)
![RESTv2 Settings](images/RESTv2settings.png "RESTv2 Settings")
9. Press the _Test Connection_ button in the upper right of the window to verify the connection is successful.
......@@ -53,6 +55,10 @@ This tutorial demonstrates how to create a connection within Informatica Intelli
### Usage as Source in Mappings
("SOURCE" IN MAPPINGS ISNT A COMMON SCHEMA, MOST COMMON SCHEMA IS WEB SERVICE (AT LEAST FOR NON-PERSON APIS) - SHOULD ADD SECTION WHICH COVERS THIS)
(FILTERS? CAN WE DO THAT?)
(ALSO WE MAY BE WELL SERVED UPDATING SCREENSHOTS)
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")
......@@ -75,6 +81,8 @@ This tutorial demonstrates how to create a connection within Informatica Intelli
### Creating Your Own Swagger Files
(NOT NECESSARY ANYMORE? WE CAN USE THE BASE SPEC... STILL USEFUL FOR NON-PERSON API... SHOULD WE HAVE A DIFFERENT EXAMPLE?IF SO, WHICH ONE>)
To perform different operations, you will need to create and host your own Swagger files in the OpenAPI 2.0 Format. IICS provides a tool for the creation of Swagger files, although these can only have one associated operation.
1. [Log into IICS](../../logging-in.md) with your NetID.
......@@ -104,5 +112,5 @@ Once this process is complete, you will be able to use the link to your Swagger
### Important Notes
- The RESTv2 Connector does not accept swagger files of the OpenAPI3.0 specification (which PersonAPI uses), so the Swagger files must be created using the IICS tool.
- PersonAPI has a strict limit on the amount of requests you can make per minute. Using operations besides Get People may not be feasible in the context of mass data load.
- The RESTv2 Connector does not accept swagger files of the OpenAPI3.0 specification (which PersonAPI uses), so the Swagger files must be created using the IICS tool. (NOT ANYMORE!!!)
- PersonAPI has a strict limit on the amount of requests you can make per minute. Using operations besides Get People may not be feasible in the context of mass data load. (POTENTIALLY STILL RELEVANT? LOOK INTO THIS)
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