Converse agora com nosso suporte
Chat com o suporte

Identity Manager 9.2 - API Development Guide

Entity 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.

Detailed information about this topic

Notes

  • Do not declare path parameters in the URL of entity methods that support operations of type Update or Create.

Limiting results

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

Sort order

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

Documentos relacionados

The document was helpful.

Selecione a classificação

I easily found the information I needed.

Selecione a classificação