To delete a single entity, use the URL <baseURL>/api/entities.
Table 36: Delete a batch of single entities request
| Delete |
<BaseURL>/api/entities |
None |
Table 37: Delete a batch of single entities parameters
| entities |
List of entities to delete. |
body |
DeleteEntity |
Body schema:
BulkChangeBodyDelete {
entities(array[DeleteEntity])
}
DeleteEntity {
table(string),
uid(string)
}
Response code:
204
Example:
https://<Hostname>/AppServer/api/entities
Body:
{
"entities": [
{
"table": "Person",
"uid": "8a2eee88-0615-4595-a903-8388ca74d877"
},
{
"table": "Person",
"uid": "df563a8c-203a-4132-8fcb-bc4adaee35b6"
}
]
}
Response Code:
204
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 38: Call method request
|
Put |
<BaseURL>/api/entity/{table}/{uid}/method/{methodName} |
{
"parameters": [
"Parameter value"]
} |
Table 39: 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 40: 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 41: 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
