How to build a JSON export.
All lines contained in the package have the below format:
-
The title should always appear in between quotation marks.
Example: “JSON export name"
-
The first open curly bracket '{' in the Title marks the start of the file.
The second open curly bracket comes after the title.
-
Each value in each line is also contained in between quotation marks. After the name of the value you want to show in your export and before the second quotation mark, place a colon. Example: ”Name visible on your export:”+“[keyword]”
*keyword: this is the actual value retrieved from the system
*each part of a line is contained in between quotation marks
Keywords can be used in different ways.
Example 1: keywords that are file uploads will show the name of the uploaded file
Example 2: keywords that contain multiple options will show the selection made by the user.
-
The end of a line is always marked by a comma
-
A file always ends with 2 closed curly brackets '}', so the file knows when to stop the reading process.
Here are some extra points that need to be taken into account:
-
It is not possible to export tables, such as the emergency contact table from the system.
-
Keywords need to be shared in order for information to show up.
-
Keywords can point to the form they are added on, if the element is used on multiple forms.
Meaning that, as you can see in the example below, you can use [form.xx] keywords as well as [element.xx].
-
JSON returns the latest version of information when it was exported last. This means that you have to manually run an export with this JSON file in order for it to show in the API.
This can be done in an automation too.
Example of a JSON request:
{
“JSON export name":{
"Initials:”[element.initials]",
“First name:”[employee.firstname]",
“Last name:”[employee.lastname]",
“Department (name)”:”[payroll.primary.department]",
"Department (custom id)”:”[payroll.primary.department.custom.id]",
“Resignation date:”[form.master_data.payroll_resignation_date]",
“End date system access:”[element.end_date_system_access]",
“Resignation from employee”:”[form.master_data.resignation_from_employee]",
“HR/processor mail":"[element.processor.email]",
“HR/processor name:”[element.processor.full_name]",
“Employee id":"[employee.id]"
}
}