Use Cases
Step through a typical use case using the IRT REST API, as summarized in the following table.
Task | More Information |
---|---|
Create or update a single user | Call the user API with one record in the payload. The application determines the id of the user in your system based on the external id to either create or update the user. If the record with the external id exists, it is updated. Otherwise, a new user is created. |
Bulk create or update users | Call the user API with more than one record in the payload. For each record, if the application can find a record with a corresponding external id, it updates it. Otherwise, create a new record. |
Create or update a single site | Call the site API with one record in the payload. The application determines the id of the site in your system based on the external id to either create or update the site. If the record with the external id exists, it is updated. Otherwise, a new site is created. |
Bulk create or update sites | Call the site API with more than one record in the payload. For each record, if the application can find a record with the corresponding external id, it updates it. Otherwise, create a new record. |