Responses that are sent from the REST API use the following codes. If queries fail, an explanatory error message is displayed.
|
200 |
Query successful. |
|
204 |
Query successful. Response has no content. |
|
401 |
Access not authorized. The session must be authorized first. |
|
404 |
The given resource could not be found. |
|
405 |
The HTTP method used is not allowed for this query. |
|
500 |
A server error occurred. The error message is sent with the response. On the ground of security, a detailed error message is not included in the response. For more information, see the application log file on the server. |
Related topics
In this section, you will find advice and information for creating and implementing entity methods.
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:
| 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 employees and starts with the 101st employee:
https://<host name>/ApiServer/portal/person?PageSize=50&StartIndex=100
Sort order
You can use the Orderby query parameter to sort the results returned in a response. This parameter allows you to sort the column names of the underlying database table.
Examples
The following query returns employees sorted by first name in ascending order:
https://<host name>/ApiServer/portal/person?OrderBy=FirstName
Employees sorted in descending order by first name:
https://<host name>/ApiServer/portal/person?OrderBy=FirstName%20DESC
Filtering
You can use the filter query parameter to filter the results returned in a response. A filter like this consists of a JSON formatted string that must contain the following:
- ColumnName: Name of the column used to filter
-
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 employees with the last name "User1":
https://<host name>/ApiServer/portal/person/all?filter=[{ColumnName: 'LastName', CompareOp: 'Equal', Value1: 'User1'}]
Grouping
You can use the group path parameter to group the results returned in a response. You can use the by query parameter to specify which attribute to use for grouping. Furthermore, you can use the withcount query parameter to specify (values: true or false) whether to calculate the number of objects for each group. This may increase the runtime.
NOTE: The API method must support grouping (by using the EnableGrouping parameter).
The result of the query contains a filter condition that you can pass to the URL parameter as filter.
Example
The following queries determine the number of identities grouped by primary location:
https://<host name>/ApiServer/portal/person/all/group?by=UID_Locality&withcount=true
Response:
{
{
"Display": "(No value: Primary location)",
"Filters": [
{
"ColumnName": "UID_Locality",
"CompareOp": 0
}
],
"Count": 42
},
{
"Display": "Berlin",
"Filters": [
{
"ColumnName": "UID_Locality",
"CompareOp": 0,
"Value1": "c644f672-566b-4ab0-bac0-2ad07b6cf457"
}
],
"Count": 12
}
}
Hierarchical data structure
Some data model tables are defined as hierarchical structures (Department for example). Data from such tables is loaded from a specific hierarchy level.
You can use the parentKey query parameter of the parent object to specify the hierarchy level.
Example
The following query determines the service categories directly below the Access Lifecycle service category:
https://<host name>/ApiServer/portal/servicecategories?parentKey=QER-f33d9f6ec3e744a3ab69a474c10f6ff4
The following query determines the service categories that do not have a parent service category:
https://<Host-Name>/ApiServer/portal/servicecategories?parentKey=
The following query determines all service categories regardless of their hierarchy:
https://<Host-Name>/ApiServer/portal/servicecategories
You can use the noRecursive path parameter to specify whether the data is queried as a flat list (values: true or false).
Example
https://<host name>/ApiServer/portal/servicecategories?noRecursive=true
Additional query parameters
You can use the withProperties query parameter to specify whether additional information from specific tables columns are returned in the response.
NOTE: To enable table columns for these queries, set the Show in wizards option in the column properties of the relevant columns in the Designer.
TIP: You can delimit the names of multiple columns with commas.
Example
The following query determines the number of all identities and also returns their preferred name and title:
https://<host name>/ApiServer/portal/person/all?withProperties=PreferredName,Title
Response:
{
"TotalCount": 105950,
"TableName": "Person",
"Entities": [
{
"Display": "100, User (USER1)",
"LongDisplay": "100, User (USER1)",
"Keys": [
"bbf3f8e6-b719-4ec7-be35-cbd6383ef370"
],
"Columns": {
"DefaultEmailAddress": {
"Value": "USER1@qs.ber",
"IsReadOnly": true
},
"IdentityType": {
"Value": "Primary",
"IsReadOnly": true,
"DisplayValue": "Primary identity"
},
"PreferredName": {
"Value": "User1",
"IsReadOnly": true
},
"Title": {
"Value": "Dr.",
"IsReadOnly": true
},
"XObjectKey": {
"Value": "<Key><T>Person</T><P>bbf3f8e6-b719-4ec7-be35-cbd6383ef370</P></Key>",
"IsReadOnly": true
}
}
}
Related topics
API development includes a lot of asynchronous code with async/await constructs. To avoid deadlocks, use the ConfigureAwait(false) method for every await keyword.
For more information, see https://blog.stephencleary.com/2012/07/dont-block-on-async-code.html and https://devblogs.microsoft.com/dotnet/configureawait-faq/.
Examples and help – Software Development Kit
To make it easier for you to start developing your API with the API Designer, One Identity provides a Software Development Kit (SDK) with lots of commented code example.
The SDK can be found on the installation medium in the directory QBM\dvd\AddOn\ApiSamples.
