Chatee ahora con Soporte
Chat con el soporte

Identity Manager 9.2.1 - API Development Guide

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": "Johnny",
                    "IsReadOnly": true
                },
                "Title": {
                    "Value": "Dr.",
                    "IsReadOnly": true
                },
                "XObjectKey": {
                    "Value": "<Key><T>Person</T><P>bbf3f8e6-b719-4ec7-be35-cbd6383ef370</P></Key>",
                    "IsReadOnly": true
                }
            }
}

Type-safe classes

Type-safe classes allow you to use the database model in a type-safe way. This gives you the following advantages:

  • Compiling scripts checks whether the classes used are correct. This allows you to detect spelling mistakes in table and column names early on.

  • The development environment can offer auto-completion.

  • The column's data type is detected, which prevents type conversion errors.

To use type-safe classes

  1. Edit the corresponding API plug-in (see Editing API plug-ins) and proceed as follows:

    • Add a reference to the type-safe class library of the corresponding database module (AOB.TypedWrappers.dll for example).

      This makes the classes for this module available in the <module name>.TypedWrappers namespace (AOB.TypedWrappers for example).

User-defined methods

User-defined methods are methods for which you fully define the processing, input, and output data in code. This type therefore offers the greatest flexibility.

For examples for the user-defined methods, see the SDK under Sdk01_Basics\03-CustomMethod.cs.

SQL methods

SQL methods are methods that provide data from a predefined SQL query through the API. Create the parameters of a query as SQL parameters.

For examples for the definition of SQL methods, see the SDK under Sdk01_Basics\02-BasicSqlMethod.cs.

Documentos relacionados

The document was helpful.

Seleccionar calificación

I easily found the information I needed.

Seleccionar calificación