Processes
System resource#
The system resource provides you with convenient information and functions. The system resource can be found at /api/system.
Generate identifiers#
To generate valid, random HRHIS4 identifiers you can do a GET request to this resource:
The limit query parameter is optional and indicates how many identifiers you want to be returned with the response. The default is to return one identifier. The response will contain a JSON object with an array named codes, similar to this:
The HRHIS4 UID format has these requirements:
11 characters long.
Alphanumeric characters only, ie. alphabetic or numeric characters (A-Za-z0-9).
Start with an alphabetic character (A-Za-z).
View system information#
To get information about the current system you can do a GET request to this URL:
JSON and JSONP response formats are supported. The system info response currently includes the below properties.
Note
If the user who is requesting this resource does not have full authority in the system then only the first seven properties will be included, as this information is security sensitive.
To get information about the system context only, i.e. contextPath and
userAgent, you can make a GET request to the below URL. JSON and
JSONP response formats are supported:
Check if username and password combination is correct#
To check if some user credentials (a username and password combination) is correct you can make a GET request to the following resource using basic authentication:
You can detect the outcome of the authentication by inspecting the HTTP status code of the response header. The meanings of the possible status codes are listed below. Note that this applies to Web API requests in general.
View asynchronous task status#
Tasks which often take a long time to complete can be performed
asynchronously. After initiating an async task you can poll the status
through the system/tasks resource by supplying the task category and
the task identifier of interest.
When polling for the task status you need to authenticate as the same user which initiated the task. The following task categories are supported:
Each asynchronous task is automatically assigned an identifier which can be used to monitor the status of the task. This task identifier is returned by the API when you initiate an async task through the various async-enabled endpoints.
Monitoring a task#
You can poll the task status through a GET request to the system tasks resource like this:
An example request may look like this:
The response will provide information about the status, such as the notification level, category, time and status. The completed property indicates whether the process is considered to be complete.
Monitoring all tasks for a category#
You can poll all tasks for a specific category through a GET request to the system tasks resource:
An example request to poll for the status of data value import tasks looks like this:
Monitor all tasks#
You can request a list of all currently running tasks in the system with a GET request to the system tasks resource:
The response will look similar to this:
View asynchronous task summaries#
The task summaries resource allows you to retrieve a summary of an asynchronous task invocation. You need to specify the category and optionally the identifier of the task. The task identifier can be retrieved from the response of the API request which initiated the asynchronous task.
To retrieve the summary of a specific task you can issue a request to:
An example request might look like this:
The response will look similar to this:
You might also retrieve import summaries for multiple tasks of a specific category with a request like this:
Get appearance information#
You can retrieve the available flag icons in JSON format with a GET request:
You can retrieve the available UI styles in JSON format with a GET request:
Scheduling#
HRHIS4 allows for scheduling of jobs of various types. Each type of job has different properties for configuration, giving you finer control over how jobs are run. In addition, you can configure the same job to run with different configurations and at different intervals if required.
Get available job types#
To get a list of all available job types you can use the following endpoint:
The response contains information about each job type including name, job type, key, scheduling type and available parameters. The scheduling type can either be CRON, meaning jobs can be scheduled using a cron expression with the cronExpression field, or FIXED_DELAY, meaning jobs can be scheduled to run with a fixed delay in between with the delay field. The field delay is given in seconds.
A response will look similar to this:
Create job#
To configure jobs you can do a POST request to the following resource:
A job without parameters in JSON format looks like this :
An example of an analytics table job with parameters in JSON format:
As example of a push analysis job with parameters in JSON format:
An example of a job with scheduling type FIXED_DELAY and 120 seconds delay:
Get jobs#
List all job configurations:
Retrieve a job:
The response payload looks like this:
Update job#
Update a job with parameters using the following endpoint and JSON payload format:
Delete job#
Delete a job using:
Note that some jobs with custom configuration parameters may not be added if the required system settings are not configured. An example of this is data synchronization, which requires remote server configuration.