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:

{

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

"display": "Bodewell, Jeremia (JEREMIAB)",

"values": {

"ApprovalState": 0,

"AuthentifierLogins": "",

"BirthDate": "1993-05-14T00:00:00.0000000Z",

"Building": "",

"CanonicalName": "",

"CentralAccount": "JEREMIAB",

"CentralPassword": "",

"CentralSAPAccount": "BODEWELJ",

"City": "",

"CompanyMember": "",

"CustomProperty01": "",

"CustomProperty02": "",

"CustomProperty03": "",

"CustomProperty04": "",

"CustomProperty05": "",

"CustomProperty06": "",

"CustomProperty07": "",

"CustomProperty08": "",

"CustomProperty09": "",

"CustomProperty10": "",

"DateLastWorked": "1899-12-30T00:00:00.0000000Z",

"DeactivationEnd": "1899-12-30T00:00:00.0000000Z",

"DeactivationStart": "1899-12-30T00:00:00.0000000Z",

"DefaultEmailAddress": "",

"Description": "",

"DialogUserPassword": "",

"DialogUserSalt": "",

"DisplayTelephoneBook": false,

"DistinguishedName": "",

"EntryDate": "2016-05-20T00:00:00.0000000Z",

"ExitDate": "1899-12-30T00:00:00.0000000Z",

"Fax": "",

"FaxExtension": "",

"FirstName": "Jeremia",

"Floor": "",

"FormerName": "",

"Gender": 1,

"GenerationalQualifier": "",

"ImportSource": "",

"Initials": "JB",

"InternalName": "Bodewell, Jeremia",

"IsCar": false,

"IsDummyPerson": false,

"IsDuplicateName": false,

"IsExternal": true,

"IsInActive": false,

"IsNoInherite": false,

"IsNoteBookUser": false,

"IsRemoteAccessAllowed": false,

"IsSecurityIncident": false,

"IsSupporter": false,

"IsTemporaryDeactivated": false,

"IsTerminalServerAllowed": false,

"IsVIP": false,

"IsX500Dummy": false,

"JPegPhoto": "",

"LastName": "Bodewell",

"MiddleName": "",

"NameAddOn": "",

"PasswordAnswer": "",

"PasswordQuery": "",

"PersonalTitle": "",

"PersonnelNumber": "",

"Phone": "",

"PhoneExtension": "",

"PhoneMobile": "",

"PostalOfficeBox": "",

"PreferredName": "",

"Remarks": "",

"RiskIndexCalculated": 0,

"Room": "",

"Salutation": "Mr",

"SecurityIdent": "",

"Sponsor": "",

"Street": "",

"SubCompany": "",

"TechnicalEntryDate": "1899-12-30T00:00:00.0000000Z",

"Title": "",

"UID_Department": "",

"UID_DialogCountry": "",

"UID_DialogCulture": "",

"UID_DialogState": "",

"UID_DialogUser": "",

"UID_FirmPartner": "",

"UID_Locality": "",

"UID_Org": "",

"UID_Person": "83b10e84-c64e-4f9f-9ecb-2d0d7c94e8ec",

"UID_PersonHead": "",

"UID_PersonMasterIdentity": "",

"UID_ProfitCenter": "",

"UID_RealPerson": "",

"UID_WorkDesk": "",

"UID_X500Person": "",

"UserIDTSO": "",

"XDateInserted": "2016-05-20T09:12:25.7300000Z",

"XDateUpdated": "2016-05-20T09:12:25.7300000Z",

"XMarkedForDeletion": 0,

"XObjectKey": "<Key><T>Person</T><P>83b10e84-c64e-4f9f-9ecb-2d0d7c94e8ec</P></Key>",

"XTouched": "",

"XUserInserted": "<user name>",

"XUserUpdated": "<user name>",

"ZIPCode": ""

}

}

Change a single entity

To change a single entity, use the URL: <baseURL>/api/entity/{table}/{uid}

Table 22: Change single entity request

HTTP Method

URI

Body

Put

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

{"values": {

"StringColumn": "string",

"IntColumn": 0,

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

"BoolColumn": true

}

Table 23: Change single entity parameters

Parameter

Description

Parameter Type

Data Type

table

Table name (mandatory)

path

string

uid

Guid of the entity (mandatory)

path

string

values

Values to change

body

SampleValues

Body schema:

SingleChangeBody {

values(SampleValues, optional)

}

SampleValues {

StringColumn(string, optional),

IntColumn(integer, optional),

DateColumn(date - time, optional),

BoolColumn (boolean, optional)

}

Response schema:

{}

Example

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

Body:

{

"values": {

"LastName": "Garibaldi",

"IsExternal": false,

"UID_Locality": "83615878-7205-408d-a5fa-f260840c867c"

}

}

Response Code:

200

Response:

{}

Delete a single entity

To delete a single entity, use the URL: <baseURL>/api/entity/{table}/{uid}

Table 24: Delete single entity request

HTTP Method

URI

Body

Delete

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

None

Table 25: Delete single entity parameters

Parameter

Description

Parameter Type

Data Type

table

Table name (mandatory)

path

string

uid

Guid of the entity (mandatory)

path

string

Response schema:

{}

Related Documents