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}
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 } |
Parameter |
Description |
Parameter Type |
Data Type |
---|---|---|---|
table |
Table name (mandatory) |
path |
String |
uid |
Guid of the entity (mandatory) |
path |
String |
eventName |
Name of the event (mandatory) |
path |
string |
parameters |
Parameter values |
body |
object |
GenerationParameters {
parameters (SampleGenerationParameters, optional)
}
SampleGenerationParameters {
StringValue(string, optional),
IntValue(integer, optional),
DateValue(date - time, optional),
BoolValue (boolean, optional)
}
Execute an event for an entity and specify some additional generation parameters.
https://<Hostname>/AppServer/api/entity/Person/6ecb123a-0c8c-4eec-bded-2c4909b886f5/event/DelegateAsync
{
"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"
}
}
204
The following APIs are used to handle assignments in member tables for the entities of the One Identity Manager.
To get a list of assignments for a specific entity use the URL: <baseURL>/api/assignments/{table}/{column}/{uid}
HTTP Method |
URI |
Body |
---|---|---|
Get |
<BaseURL>/api/assignments/{table}/{column}/{uid} |
None |
Parameter |
Description |
Parameter Type |
Data Type |
---|---|---|---|
table |
Member table name (mandatory) |
path |
string |
column |
Column pointing to the base entity (mandatory) |
path |
string |
uid |
Guid of the base entity (mandatory) |
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 table Values of paramter loadType. |
query |
string |
array {
href(string),
title(string),
uid(string)
}
© 2021 One Identity LLC. ALL RIGHTS RESERVED. Feedback Terms of Use Privacy