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

Update docs/tutorials/PersonAPI/PersonAPIwRESTv2.md

parent 90ceb34e
Branches master
No related tags found
1 merge request!45External Doc Reorganization
......@@ -88,14 +88,15 @@ To perform different operations, you will need to create and host your own Swagg
- Also set the _Verb_ to the one matching the operation. For operations which involve recieving data, this will usually be GET.
8. Obtain a response file from PersonAPI for the operation you have selected. This can easily be done using [Postman](https://www.postman.com/).
9. Upload this response file in the _Json Response File_ field.
10. Edit the _Headers_ and _Query Parameters_ fields as needed.
![Swagger File Creation](images/SwaggerCreation.png "Swagger File Creation")
10. Save your Swagger file. Once you have saved it you can no longer edit it, and must repeat the process from step 5 to make any changes.
11. Navigate back to _Swagger Files_ on the left pane.
12. Locate the Swagger File you just created in the list below.
13. Press the Download button to download the file to your personal computer.
14. Host the file somewhere that can be publically accessed, such as a public Gitlab repository.
11. Save your Swagger file. Once you have saved it you can no longer edit it, and must repeat the process from step 5 to make any changes.
12. Navigate back to _Swagger Files_ on the left pane.
13. Locate the Swagger File you just created in the list below.
14. Press the Download button to download the file to your personal computer.
15. Host the file somewhere that can be publically accessed, such as a public Gitlab repository.
Once this process is complete, you will be able to use the link to your Swagger file in the _Swagger File Path_ section of the RESTv2 Connector.
......@@ -104,4 +105,4 @@ 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. This API
- 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.
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