You can define the following types of API methods.
-
Entity methods
-
User-defined methods
-
SQL methods
You can define the following types of API methods.
Entity methods
User-defined methods
SQL methods
Entity methods work with small parts of the object model in order to read data from the database or write data to the database. When you create an entity method, you only need to enter the table and column name and, if required, a filter condition (WHERE clause). Internal processing is handled by the API Server. The data schema for the input and output also has a specific format.
For examples for the definition of entity methods, see the SDK under Sdk01_Basics\01-BasicQueryMethod.cs.
Do not declare path parameters in the URL of entity methods that support operations of type Update or Create.
NOTE: Entity-based methods normally work with a limit to avoid unintentionally loading extremely large amounts of data.
The following query parameters help you to limit the amount of data that is returned by obtaining multiple data sets from sequential responses:
| Query parameter | Default value | Description |
|---|---|---|
| PageSize | 20 |
Specifies the maximum number of data sets that can be contained in the response. If you only determine the total number and do not want to obtains single data sets, use the value -1. |
| StartIndex | 0 |
Specifies as from which data sets the results are returned in the response. This parameter is null-based (the first element is addressed with the value 0). |
Example
The following query returns 50 identities and starts with the 101st identity:
https://<Host-Name>/ApiServer/portal/person?PageSize=50&StartIndex=100
© 2024 One Identity LLC. ALL RIGHTS RESERVED. Terms of Use Privacy Cookie Preference Center