OrgPerson

Manage org persons, which represent the assignment of a person to an organizational unit (OrgUnit) and optionally a role (OrgRole).
You can create, update, delete, and search for org persons with advanced filtering and pagination.

Version

2.0.0

OpenAPI version

3.0.0

Operations

index

POST

/v2/org-person/index

Returns a paginated and filterable list of org persons.
Use POST to allow complex filters via JSON payload.

Request Body

Parameters for searching org persons

object

filter

object

org_person_id

string format: uuid

person_id

string format: uuid

org_unit_id

string format: uuid

org_role_id

string format: uuid

per-page

integer

default: 100 >= 1

page

integer

default: 1 >= 1

sort

string

Allowed values: org_person_id person_id org_unit_id org_role_id

history

boolean

Example

{
  "filter": {
    "org_unit_id": "123e4567-e89b-12d3-a456-426655440000"
  },
  "per-page": 20,
  "page": 1,
  "sort": "person_id"
}

Responses

200

List of org persons

Array<object>

object

org_person_id

required

string

person_id

required

string

org_unit_id

required

string

org_role_id

string

{
  "org_person_id": "122b7448dce72057574d59f93d456e54",
  "person_id": "db7d0826-e572-4f7b-b4a7-69e7534b1634",
  "org_unit_id": "123e4567-e89b-12d3-a456-426655440000",
  "org_role_id": "223e4567-e89b-12d3-a456-426655440000"
}

Example

{
  "org_person_id": "122b7448dce72057574d59f93d456e54",
  "person_id": "db7d0826-e572-4f7b-b4a7-69e7534b1634",
  "org_unit_id": "123e4567-e89b-12d3-a456-426655440000",
  "org_role_id": "223e4567-e89b-12d3-a456-426655440000"
}

Headers

X-Pagination-Current-Page

integer

Current page

X-Pagination-Page-Count

integer

Total number of pages

X-Pagination-Per-Page

integer

Number of items per page

X-Pagination-Total-Count

integer

Total number of items

view

GET

/v2/org-person/view/{id}

Retrieve an org person by its unique ID.

Path Parameters

id

required

string format: uuid

ID of the org person to retrieve

Responses

200

Org person found

object

org_person_id

required

string

person_id

required

string

org_unit_id

required

string

org_role_id

string

Example

{
  "org_person_id": "122b7448dce72057574d59f93d456e54",
  "person_id": "db7d0826-e572-4f7b-b4a7-69e7534b1634",
  "org_unit_id": "123e4567-e89b-12d3-a456-426655440000",
  "org_role_id": "223e4567-e89b-12d3-a456-426655440000"
}

404

Org person not found

create

POST

/v2/org-person/create

Create a new org person by providing the required details.

Request Body ^required

Org person object to be created

object

org_person_id

required

string

person_id

required

string

org_unit_id

required

string

org_role_id

string

Example

{
  "person_id": "db7d0826-e572-4f7b-b4a7-69e7534b1634",
  "org_unit_id": "123e4567-e89b-12d3-a456-426655440000",
  "org_role_id": "223e4567-e89b-12d3-a456-426655440000"
}

Responses

201

Org person created successfully

object

org_person_id

required

string

person_id

required

string

org_unit_id

required

string

org_role_id

string

Example

{
  "org_person_id": "122b7448dce72057574d59f93d456e54",
  "person_id": "db7d0826-e572-4f7b-b4a7-69e7534b1634",
  "org_unit_id": "123e4567-e89b-12d3-a456-426655440000",
  "org_role_id": "223e4567-e89b-12d3-a456-426655440000"
}

update

PUT

/v2/org-person/update/{id}

Update an existing org person by its unique ID.

Path Parameters

id

required

string format: uuid

ID of the org person to update

Request Body ^required

Org person object with updated data

object

org_person_id

required

string

person_id

required

string

org_unit_id

required

string

org_role_id

string

Example

{
  "org_role_id": "new-role-id"
}

Responses

200

Org person updated successfully

object

org_person_id

required

string

person_id

required

string

org_unit_id

required

string

org_role_id

string

Example

{
  "org_person_id": "122b7448dce72057574d59f93d456e54",
  "org_role_id": "new-role-id"
}

404

Org person not found

delete

DELETE

/v2/org-person/delete/{id}

Delete an org person by its unique ID.
If force=true, all related entities will also be deleted.

Path Parameters

id

required

string format: uuid

ID of the org person to delete

Query Parameters

force

boolean

Force the deletion of the entity and all related entities

Responses

204

Org person deleted successfully

400

If force=false, the operation is interrupted and the list of connected entities that will be deleted in case of confirmation (force=true) is returned