Chat now with support
Chat with Support

Identity Manager 8.1.4 - REST API Reference Guide

Clear global variable

To clear a global variable, use the URL <baseURL>/appserver/variable/{name}

Table 10: Clear global variable request

HTTP method

URI

Body

Put

<baseURL>/appserver/variable/{name}

{"clear": true}

Table 11: Clear global variable parameters

Parameter

Description

Parameter type

Data type

name

Variable name (required)

path

string

Body schema:

{clear (boolean): True to clear a variable.}

Example

https://<Hostname>/AppServer/appserver/variable/FullSync

Body:

{"clear": true}

Collections

To get a list of entities, you have the option to use a GET or POST request against the REST API. Both methods support to query by example. Simply provide the columns to query in the form Name=Value in the URL.

Get collection using GET method

To get a list of entities using the GET method, use the URL <baseURL>/api/entities/{table}

Table 12: Get collection (GET) request

HTTP method

URI

Body

Get

<BaseURL>/api/entities/{table}

None

Table 13: Get collection (GET) parameters

Parameter

Description

Parameter type

Data type

table

Table name (required).

path

string

where

WHERE clause.

query

string

orderBy

ORDER BY clause.

query

string

offset

Offset of first item.

query

integer

limit

Maximum number of results.

query

integer

displayColumns

Additional display columns, semicolon separated.

query

string

loadType

Collection load type. Specify one of the values listed in Table 14.

query

string

Table 14: Values of parameter loadType

Value

Description

Default

Loads read-only entities according to the supplied query. Loaded columns include the primary key, display columns according to the display pattern, some special columns, and the columns defined in the select clause of the query. The entries are sorted by the defined display or the optional orderBy clause of the query. This load type is the default and be omitted.

Slim

Works mostly like Default but does not load display columns and does not build an orderBy clause per default. This type is useful when loading data not intended for display and can save much time by using database indexes.

BulkReadOnly

Loads read-only entities with all columns filled. The columns defined in the query are overridden.

ForeignDisplays

Loads display values for foreign keys contained in the display pattern. This allows showing displays instead of UIDs for foreign keys.

ForeignDisplaysForAllColumns

Like ForeignDisplays, but loads displays for all foreign keys contained in the select clauses of the query, not only columns referenced in the display pattern.

Response schema:

CollectionEntry {

uri(string),

display(string, optional),

longDisplay(string, optional),

values(SampleValues, optional)

}

SampleValues {

StringColumn(string, optional),

IntColumn(integer, optional),

DateColumn(date - time, optional),

BoolColumn (boolean, optional)

}

Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating