This URL can be used to call a method on an entity. The entity will be saved automatically if required.
NOTE: This request type is able to run customizer or dialog methods for an entity. Note that currently only those methods are supported that do not return a value. The method name matching is processed for customizer methods first. If none are found, the system continues the matching using the dialog methods.
To call a method on an entity, use the URL <baseURL>/api/entity/{table}/{uid}/method/{methodName}
Table 40: Call method request
|
Put |
<BaseURL>/api/entity/{table}/{uid}/method/{methodName} |
{
"parameters": [
"Parameter value"]
} |
Table 41: Call method parameters
|
table |
Table name (required) |
path |
string |
|
uid |
GUID of the entity (required) |
path |
string |
|
methodName |
Name of the method (required) |
path |
string |
|
parameters |
Parameter values |
body |
object[] |
Body schema:
parameters {
parameters (object, optional)
}
Example 1:
Run a customizer method on an entity.
https://<Hostname>/AppServer/api/entity/Person/7f6bcca9-05dc-4857-9dc5-eff915590752/method/ExecuteTemplates
Response Code:
204
Example 2:
Run a customizer method on an entity that takes some input parameters.
https://<Hostname>/AppServer/api/entity/Person/9ec76ebd-2024-4a10-a079-948414c8b2c0/method/DelegateElement
Body:
{
"parameters": [
"f79c30fd-87bb-4958-a812-0683ddcac7c9",
"<Key><T>HelperHeadPerson</T><P>d4943ffc-d453-4611-8365-4ba394558b15</P><P>9ec76ebd-2024-4a10-a079-948414c8b2c0</P></Key>",
"2016-05-31",
"2016-08-01",
true,
false,
"",
"Is on sick leave."
]
}
Response Code:
204
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 42: Generate event request
|
Put |
<BaseURL>/api/entity/{table}/{uid}/event/{eventName} |
{"parameters": {
"StringValue": "string",
"IntValue": 0,
"DateValue": "2016-05-19T11:21:33.579Z",
"BoolValue": true
} |
Table 43: Generate event parameters
|
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
The following APIs are used to handle assignments in member tables for the entities of One Identity Manager.
Detailed information about this topic
To get a list of assignments for a specific entity, use the URL <baseURL>/api/assignments/{table}/{column}/{uid}
Table 44: Get assignments request
|
Get |
<BaseURL>/api/assignments/{table}/{column}/{uid} |
None |
Table 45: Get assignments parameters
|
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 following table. |
query |
string |
Table 46: Values of parameter loadType
|
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)
}
Example:
https://<Hostname>/AppServer/api/assignments/PersonInOrg/UID_Org/007b7087-6881-44e7-8954-82374340718f?limit=2
Response:
[
{
"href": "https://<Hostname>/AppServer/api/entity/Person/a9c6bc62-3f77-453f-b774-3afd9d4d19e0",
"title": "Abbey, Jenna (JENNAA) - KAGU Org",
"uid": "a9c6bc62-3f77-453f-b774-3afd9d4d19e0"
},
{
"href": "https://<Hostname>/AppServer/api/entity/Person/be514f69-fc8f-49c0-a791-2b79b8f5cbdf",
"title": "Abbott, James (JAMESA) - KAGU Org",
"uid": "be514f69-fc8f-49c0-a791-2b79b8f5cbdf"
}
]
