Chat now with support
Chat with Support

Identity Manager 8.0 - REST API Reference Guide

Example

https://<Hostname>/AppServer/api/entity/Person/83b10e84-c64e-4f9f-9ecb-2d0d7c94e8ec

Response Code:

200

Response:

{}

Call a method on an entity

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 execute customizer or dialog methods for an entity. Please be aware that currently only those methods are supported that do not return a value. The method name matching will be processed for customizer methods first. If none is 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 26: Call method request

HTTP Method

URI

Body

Put

<BaseURL>/api/entity/{table}/{uid}/method/{methodName}

{

"parameters": [

"Parameter value"]

}

Table 27: Call method parameters

Parameter

Description

Parameter Type

Data Type

table

Table name (mandatory)

path

string

uid

Guid of the entity (mandatory)

path

string

methodName

Name of the method (mandatory)

path

string

parameters

Parameter values

body

object[]

Body schema:

parameters {

parameters (object, optional)

}

Example 1

Execute a customizer method on an entity.

https://<Hostname>/AppServer/api/entity/Person/7f6bcca9-05dc-4857-9dc5-eff915590752/method/ExecuteTemplates

Response Code:

204

Example 2

Execute 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

Related Documents