Chat now with support
Chat with Support

Identity Manager 9.1.3 - REST API Reference Guide

Get count of collection using POST method

To get only the count for a list of entities using the POST method, use the URL <baseURL>/api/entities/{table}/count.

Table 22: Get count of collection (POST) request

HTTP method

URI

Body

Get <BaseURL>/api/entities/{table}/count {"where": ""}
Table 23: Get count of collection (POST) parameters
Parameter Description Parameter type Data type
table Table name (required). path string
where WHERE clause. body string
whereKey

Predefined WHERE clause from QBMLimitedSQL (Key [UID] or ID [Ident_QBMLimitedSQL]).

body

string

queryParameters

Parameters to be used in where or whereKey clause.

body

string

queryByExample

Sample values to filter the entries.

body

string

Body schema:

CollectionQueryCountParms{

where string

WHERE clause.

whereKey string

Predefined WHERE clause from QBMLimitedSQL.

queryParameters {

Parameters to be used in where or whereKey clause.

}

queryByExample {

Sample values to filter the entries.

}

}

Response schema:

Count(integer)

Example: Body

{

"where": "string",

"whereKey": "string",

"queryParameters": {

"lastname": "Miller",

"age": 42

},

"queryByExample": {

"lastname": "Einstein",

"firstname": "Albert"

}

}

Example:

https://<Hostname>/AppServer/api/entities/Person/count

Body:

{"where": "LastName=adams"}

Response:

2

Single entities

The following APIs are used to handle entities of One Identity Manager. You can create, read, update, and delete single entities as well as call methods of an entity and generate events.

Detailed information about this topic

Create a single entity

To create a single entity, use the URL <baseURL>/api/entity/{table}.

Table 24: Create single entity request

HTTP method

URI

Body

Post

<BaseURL>/api/entity/{table}

{"values": {

"StringColumn": "string",

"IntColumn": 0,

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

"BoolColumn":  True

}

Table 25: Create single entity parameters

Parameter

Description

Parameter type

Data type

table

Table name (required).

path

string

values

Values to set.

body

SampleValues

Body schema:

SingleChangeBody {

values(SampleValues, optional)

}

SampleValues {

StringColumn(string, optional),

IntColumn(integer, optional),

DateColumn(date - time, optional),

BoolColumn (boolean, optional)

}

Response schema:

CreateSingleResult {

uid (string, optional),

uri (string, optional)

}

Example:

https://<Hostname>/AppServer/api/entity/Person

Body:

{

"values": {

"FirstName": "Jeremia",

"LastName": "Bodewell",

"IsExternal": True,

"BirthDate": "1993-05-14",

"Gender": 1

}

}

Response:

{

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

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

}

Create a batch of single entities

To create a batch single entity, use the URL <baseURL>/api/entities.

Table 26: Create a batch of single entities request

HTTP method

URI

Body

Post

<BaseURL>/api/entities

{

"entities": [

{

"table": "string",

"values": {

"StringColumn": "string",

"IntColumn": 0,

"DateColumn": "2016-0519T11:21:33.579Z",

"DoubleColumn": 3.14,

"BoolColumn": true

}

}

]

}

Table 27: Create a batch of single entities parameters
Parameter Description Parameter type Data type
entities List of entities to create (required). Body array[InsertEntity]
Body schema:

BulkChangeBodyInsert {

entities(array[InsertEntity])

}

InsertEntity {

table(string),

values(SampleValues, optional)

}

SampleValues {

StringColumn(string, optional),

IntColumn(integer, optional),

DateColumn(date - time, optional),

BoolColumn (boolean, optional)

}

Response schema:

CreateBulkResult {

entities(Array[UidAndUri])

UidAndUri {

uid (string, optional),

uri (string, optional)

}

Example:

https://<Hostname>/AppServer/api/entities

Body:

{

"entities": [

{

"table": "Person",

"values": {

"FirstName": "Jeremia",

"LastName": "Bodewell",

"IsExternal": True,

"BirthDate": "1993-05-14",

"Gender": 1

}

},

{

"table": "Person",

"values": {

"FirstName": "Rose",

"LastName": "Gladstone",

"IsExternal": False,

"BirthDate": "1991-03-21",

"Gender": 2

}

}

]

}

Response:

{

"entities": [

{

"uid": "8a2eee88-0615-4595-a903-8388ca74d877",

"uri": "/AppServer/api/entity/Person/8a2eee88-0615-4595-a903-8388ca74d877"

},

{

"uid": "df563a8c-203a-4132-8fcb-bc4adaee35b6",

"uri": "/AppServer/api/entity/Person/df563a8c-203a-4132-8fcb-bc4adaee35b6"

}

]

}

Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating