Query parameters are included in the URI path using a question mark or ampersand. For example, to receive a list of identities ordered by their surname, after specifying the table Person as a path parameter, you specify an orderBy as a query parameter. The following shows the URI format for this request:
<BaseURL>/api/entities/{table}
Example:
https://<Hostname>/AppServer/api/entities/person?orderBy=LastName
The first query parameter is preceded by a question mark, using the following format:
?parameterName=parameterValue
Subsequent query parameters are preceded by an ampersand, using the following format:
¶meterName=parameterValue
For example, to get all identities who are marked as external ordered by their company membership, use the following request:
https://<Hostname>/AppServer/api/entities/person?where=IsExternal%3D0&orderBy=CompanyMember
NOTE: If a parameter is not shown in a request’s URI format with a slash, it is a query parameter; the URI format for a request shows only the path parameters. The description that follows each URI format provides information on the query parameters, if any.
Query parameters to be used in WHERE clauses and predefined WHERE clauses can be provided in the form @paramname=value. Per default they have the type string. Additionally, it is possible to pass the type with the name: @otherParam[int]=3. Types originate from DbVal class.