Skip to content
4HSE Developers DEV

OrgPerson

An OrgPerson represents the assignment of a person to an organization unit, optionally with a role in the organization chart.

Use this API to:

  • Assign a person to an organization unit with an optional role
  • Find all people in an organization unit (filter by org_unit_id)
  • Find all organization units a person belongs to (filter by person_id)
  • Find all people with a specific organizational role (filter by org_role_id)

Supports historicization.

Version
2.0.0
OpenAPI version
3.0.0

Authentication

Section titled “ Authentication ”

OAuth2

Section titled “OAuth2 ”

Security scheme type: oauth2

Flow type: password

Token URL: https://auth.4hse.com/realms/4hse/protocol/openid-connect/token

AccessToken

Section titled “AccessToken ”

Security scheme type: apiKey

Query parameter name: access-token

Operations

Section titled “Operations”

index

Section titled “index”
POST
/v2/org-person/index

Returns a paginated list of person-unit assignments.

Most useful filters:

  • org_unit_id: all people in a specific organization unit
  • person_id: all units a person belongs to
  • org_role_id: all people with a specific organizational role

Authorizations

Section titled “Authorizations ”

Request Body

Section titled “Request Body ”

Parameters for searching

object
filter
object
org_person_id
string format: uuid
org_unit_id
string format: uuid
person_id
string format: uuid
org_role_id
string format: uuid
nullable
org_unit_code

Code of the organization unit.

string
org_unit_name

Name of the organization unit.

string
org_role_code

Code of the organizational role.

string
nullable
org_role_name

Name of the organizational role.

string
nullable
person_first_name
string
person_last_name
string
person_code
string
person_is_employee
boolean
project_name

Name of the project.

string
owned_active

Whether this assignment is currently active.

boolean
nullable
parent_active

Whether the parent entities are currently active.

boolean
nullable
per-page
integer
default: 100 >= 1
page
integer
default: 1 >= 1
sort
string
Allowed values: person_first_name person_last_name person_code org_unit_name org_role_name
history

If true, includes historicized entries.

boolean
Example
{
  "filter": {
    "org_unit_id": "6d7e8f90-1234-5678-abcd-ef6789012345"
  },
  "per-page": 20,
  "page": 1,
  "sort": "person_last_name"
}

Responses

Section titled “ Responses ”
200
Section titled “200 ”

List of person-unit assignments

Array<object>
object
org_person_id
string format: uuid
org_unit_id
string format: uuid
person_id
string format: uuid
org_role_id
string format: uuid
nullable
org_unit_code

Code of the organization unit.

string
org_unit_name

Name of the organization unit.

string
org_role_code

Code of the organizational role.

string
nullable
org_role_name

Name of the organizational role.

string
nullable
person_first_name
string
person_last_name
string
person_code
string
person_is_employee
boolean
project_name

Name of the project.

string
owned_active

Whether this assignment is currently active.

boolean
nullable
parent_active

Whether the parent entities are currently active.

boolean
nullable

Headers

Section titled “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

create

Section titled “create”
POST
/v2/org-person/create

Assigns a person to an organization unit.

Requires person_id and org_unit_id. The org_person_id is auto-generated if not provided.

Optionally pass org_role_id to assign a specific organizational role. If omitted, the person is assigned to the unit without a specific role.

Authorizations

Section titled “Authorizations ”

Request Body required

Section titled “Request Body required ”

Assignment to create

object
org_person_id

Unique identifier. Auto-generated if not provided.

string format: uuid
org_unit_id
required

The organization unit. Pass the org_unit_id from the OrgUnit API.

string format: uuid
person_id
required

The person. Pass the person_id from the Person API.

string format: uuid
org_role_id

The organizational role (optional). Pass the org_role_id from the OrgRole API. If omitted, the person is assigned without a specific role.

string format: uuid
nullable

Responses

Section titled “ Responses ”
201
Section titled “201 ”

Person assigned successfully

object
org_person_id

Unique identifier. Auto-generated if not provided.

string format: uuid
org_unit_id
required

The organization unit. Pass the org_unit_id from the OrgUnit API.

string format: uuid
person_id
required

The person. Pass the person_id from the Person API.

string format: uuid
org_role_id

The organizational role (optional). Pass the org_role_id from the OrgRole API. If omitted, the person is assigned without a specific role.

string format: uuid
nullable

view

Section titled “view”
GET
/v2/org-person/view/{id}

Retrieves a single assignment by its ID.

Authorizations

Section titled “Authorizations ”

Path Parameters

Section titled “Path Parameters ”
id
required
string format: uuid

The org_person_id to retrieve.

Responses

Section titled “ Responses ”
200
Section titled “200 ”

Assignment found

object
org_person_id
string format: uuid
org_unit_id
string format: uuid
person_id
string format: uuid
org_role_id
string format: uuid
nullable
org_unit_code

Code of the organization unit.

string
org_unit_name

Name of the organization unit.

string
org_role_code

Code of the organizational role.

string
nullable
org_role_name

Name of the organizational role.

string
nullable
person_first_name
string
person_last_name
string
person_code
string
person_is_employee
boolean
project_name

Name of the project.

string
owned_active

Whether this assignment is currently active.

boolean
nullable
parent_active

Whether the parent entities are currently active.

boolean
nullable
404
Section titled “404 ”

Not found

update

Section titled “update”
PUT
/v2/org-person/update/{id}

Updates an existing assignment.

Authorizations

Section titled “Authorizations ”

Path Parameters

Section titled “Path Parameters ”
id
required
string format: uuid

The org_person_id to update.

Request Body required

Section titled “Request Body required ”

Fields to update

object
org_person_id

Unique identifier. Auto-generated if not provided.

string format: uuid
org_unit_id
required

The organization unit. Pass the org_unit_id from the OrgUnit API.

string format: uuid
person_id
required

The person. Pass the person_id from the Person API.

string format: uuid
org_role_id

The organizational role (optional). Pass the org_role_id from the OrgRole API. If omitted, the person is assigned without a specific role.

string format: uuid
nullable

Responses

Section titled “ Responses ”
200
Section titled “200 ”

Updated successfully

object
org_person_id

Unique identifier. Auto-generated if not provided.

string format: uuid
org_unit_id
required

The organization unit. Pass the org_unit_id from the OrgUnit API.

string format: uuid
person_id
required

The person. Pass the person_id from the Person API.

string format: uuid
org_role_id

The organizational role (optional). Pass the org_role_id from the OrgRole API. If omitted, the person is assigned without a specific role.

string format: uuid
nullable
404
Section titled “404 ”

Not found

delete

Section titled “delete”
DELETE
/v2/org-person/delete/{id}

Deletes a person-unit assignment.

Authorizations

Section titled “Authorizations ”

Path Parameters

Section titled “Path Parameters ”
id
required
string format: uuid

The org_person_id to delete.

Query Parameters

Section titled “Query Parameters ”
force
boolean

If true, deletes the assignment.

Responses

Section titled “ Responses ”
204
Section titled “204 ”

Deleted successfully

400
Section titled “400 ”

Preview of affected entities (returned when force=false)