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.
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
Use the Orderby query parameter to sort the results returned in an response. This parameter allows you to sort the column names of the underlying database table.
Examples
The following query returns identities sorted by first name in ascending order:
https://<Host-Name>/ApiServer/portal/person?OrderBy=FirstName
The following query returns identities sorted by first name in descending order
:https://<host name>/ApiServer/portal/person?OrderBy=FirstName%20DESC
Use the filter query parameter to filter the results returned in an response. A filter like this consists of a JSON formatted string that must contain the following:
CompareOp: The operator for comparing the contents of the selected column with the expected value
The following comparison operators are permitted:
Equal: The results only include data sets with column data that matches the comparison value.
NotEqual: The results only include data sets with column data that does NOT match the comparison value.
LowerThan: The results only include data sets with column data less than the comparison value.
LowerOrEqual: The results only include data sets with column data less than or equal to the comparison value.
GreaterOrEqual: The results only include data sets with column data greater than or equal to the comparison value.
Like: Requires the use of a percent sign (%) as a placeholder. You can enter up to two percent signs in this value. The results only include data sets with column data that matches the comparison value pattern.
NotLike: Requires the use of a percent sign (%) as a placeholder. You can enter up to two percent signs in this value. The results only include data sets with column data that does NOT match the comparison value pattern.
BitsSet: The value is compared to the comparison value using the AND (&) logical operator. The result must not be equal to 0.
BitsNotSet: The value is compared to the comparison value using the AND (&) logical operator. The result must be equal to 0.
Value1: Comparison value for comparing the contents of the column
Value 2: If this second comparison value is passed down, the value of CompareOp is ignored and all the values that are greater or equal to Value1 and less or equal to Value2 are determined.
Example
The following query returns all identities with the last name "User1":
https://<Host-Name>/ApiServer/portal/person/all?filter=[{ColumnName: 'LastName', CompareOp: 'Equal', Value1: 'User1'}]
© 2024 One Identity LLC. ALL RIGHTS RESERVED. Nutzungsbedingungen Datenschutz Cookie Preference Center
