Chat now with support
Chat with Support

Identity Manager 8.1 - REST API Reference Guide

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"

}

]

Add assignments

To add a list of assignments for a specific entity, use the URL <baseURL>/api/assignments/{table}/{column}/{uid}

Table 33: Add assignments request

HTTP method

URI

Body

Post

<BaseURL>/api/assignments/{table}/{column}/{uid}

{"members": ["string"]}

Table 34: Add assignments parameters

Parameter

Description

Parameter type

Data type

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

members

GUIDs of the members to add (required)

body

string[]

Response schema:

AssignmentResult {

assigned (int, optional),

removed (int, optional)

}

Example

https://<Hostname>/AppServer/api/assignments/PersonInOrg/UID_Org/007b7087-6881-44e7-8954-82374340718f

Body:

{"members": [

"31d99791-d658-40d7-b5e5-58eecf998797",

"40e43904-4958-4bce-915b-f77bab675f06",

"7c21b251-d774-4616-bc3a-b91506ddb23b"]

}

Response:

{

"assigned": 3,

"removed": 0

}

Remove assignments

To remove a list of assignments for a specific entity, use the URL <baseURL>/api/assignments/{table}/{column}/{uid}

Table 35: Remove assignments request

HTTP method

URI

Body

Delete

<BaseURL>/api/assignments/{table}/{column}/{uid}

{"members": ["string"]}

Table 36: Remove assignments parameters

Parameter

Description

Parameter type

Data type

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

members

GUIDs of the members to remove (required)

body

string[]

Response schema:

AssignmentResult {

assigned (int, optional),

removed (int, optional)

}

Related Documents