REST - Managing personnel and organization chart via API
FollowThrough the Altamira REST API, external systems can manage employee personal data and the whole organization chart (positions and employee-position assignments). The operations are run by the customer systems and the updated data is visible in the platform to end users, who work in read-only mode on the standard interface.
This article is an overview: the endpoints, payloads and entity-specific rules are described in the linked sub-articles at the bottom.
Approach
The Altamira API is based on views: for each operation the customer creates a SceltaCampi view on the relevant entity, assigns it a TagName, exposes it as an API and calls it in read (GET) or write (POST/DELETE) mode, authenticating with a JWT token. The general mechanisms are described in the Introduction, Authentication and How to expose a view in the API articles.
Data model
Personnel data and the organization chart are modelled on three entities (Employees, Positions, Assignments) linked to each other through the primary ids of the respective entities. The structure, the relationships and the key concepts (direct boss, reports, vacant position, the role of ids in references, history) are explained in the dedicated article:
- REST - Personnel and organization data model — recommended preliminary reading.
Endpoints to prepare
To cover the full management of personnel and organization chart, the following endpoints must be prepared, each corresponding to a view exposed as an API:
Personnel
- Endpoint to read employee personal data.
- Endpoint to write employee personal data.
Organization chart — lookup tables
- Endpoint to read the Organization charts lookup.
- Endpoint to read the Roles lookup.
- Endpoint to read the Locations lookup.
Organization chart — positions
- Endpoint to read positions.
- Endpoint to read the full organization chart.
- Endpoint to write and delete positions.
Organization chart — employee assignment
- Endpoint to write and close employee-position assignments.
Rules common to all endpoints
-
Date format:
"2026-04-02T00:00:00Z"(ISO 8601, UTC). -
The
idfield: always mandatory in the write payload. Pass0to create a new record, or the record identifier to update an existing one. -
Payload structure: JSON object with a
dataproperty containing an array of objects. Each object represents a record to create or update. - Field names: they correspond to the TagNames of the view fields. The names shown in the examples of the sub-articles are the minimum set required for writes to work correctly and must be respected. You can however add additional fields to the views to meet customer needs.
Permissions
The user authenticating the integration must have on their account the read and/or write permissions on the involved entities. Permissions are detailed in each of the sub-articles. We recommend creating a dedicated user for the integration, with only the set of permissions strictly required by the planned operations.
Sub-articles
- REST - Personnel and organization data model
- REST - Employee personal data via API
- REST - Organization chart and positions via API
- REST - Employee-position assignments via API
- REST - Common operational scenarios for the organization chart via API
Related articles
- Introduction to Altamira APIs
- Authentication — generating and refreshing JWT tokens
- How to expose a view in the API
- REST - Write call example
- REST - Read call example
Comments
0 comments
Please sign in to leave a comment.