Chat now with support
Chat with Support

Identity Manager 8.1 - REST API Reference Guide

Generate an event for an entity

This URL can be used to generate an event for an entity. Additional generation parameters can be provided.

NOTE: The authenticated user must be entitled to use the program function Allow to trigger any events from the frontend in order to call an event on an entity.

To generate an event for an entity, use the URL <baseURL>/api/entity/{table}/{uid}/event/{eventName}

Table 28: Generate event request

HTTP method

URI

Body

Put

<BaseURL>/api/entity/{table}/{uid}/event/{eventName}

{"parameters": {

"StringValue": "string",

"IntValue": 0,

"DateValue": "2016-05-19T11:21:33.579Z",

"BoolValue": true

}

Table 29: Generate event parameters

Parameter

Description

Parameter type

Data type

table

Table name (required)

path

String

uid

GUID of the entity (required)

path

String

eventName

Name of the event (required)

path

string

parameters

Parameter values

body

object

Body schema:

GenerationParameters {

parameters (SampleGenerationParameters, optional)

}

SampleGenerationParameters {

StringValue(string, optional),

IntValue(integer, optional),

DateValue(date - time, optional),

BoolValue (boolean, optional)

}

Example

Generate an event for an entity and specify some additional generation parameters.

https://<Hostname>/AppServer/api/entity/Person/6ecb123a-0c8c-4eec-bded-2c4909b886f5/event/DelegateAsync

Body:

{

"parameters": {

"ObjectkeysToDelegate": "<Key><T>HelperHeadOrg</T><P>1f020407-f677-4ef8-ae83-54fe3b11d71c</P><P>6ecb123a-0c8c-4eec-bded-2c4909b886f5</P></Key>",

"UID_PersonReceiver": "d4943ffc-d453-4611-8365-4ba394558b15",

"UID_PersonSender":"6ecb123a-0c8c-4eec-bded-2c4909b886f5",

"ValidFrom": "2016-05-31",

"ValidUntil": "2016-08-01",

"KeepMeInformed": false,

"IsDelegable": true,

"OrderReason": "Is on sick leave.",

"UID_ITShopOrg": "QER-ITSHOPORG-DELEGATION-PR",

"UID_PersonInserted": "6ecb123a-0c8c-4eec-bded-2c4909b886f5"

}

}

Response Code:

204

Assignments

The following APIs are used to handle assignments in member tables for the entities of One Identity Manager.

Get assignments for a specific entity

To get a list of assignments for a specific entity, use the URL <baseURL>/api/assignments/{table}/{column}/{uid}

Table 30: Get assignments request

HTTP method

URI

Body

Get

<BaseURL>/api/assignments/{table}/{column}/{uid}

None

Table 31: Get assignments parameters

Parameter

Description

Parameter type

Data type

table

Member table name (required)

path

string

column

Column pointing to the base entity (required)

path

string

uid

GUID of the base entity (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

loadType

Collection load type. Specify one of the values listed in the Values of parameter loadType table.

query

string

Table 32: 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:

array {

href(string),

title(string),

uid(string)

}

Related Documents