Chat now with support
Chat with Support

Identity Manager 9.2.1 - API Development Guide

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

Filtering

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:

  • 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 identities 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

Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating