The UserProperties API can be used to retrieve information on the structure of all the properties that can be attached to a user. This API is read-only: only the HTTP GET
request method is therefore available on this API.
The UserProperties
API can be used to retrieve information on the structure of all the properties that can be attached to a user. This API is read-only: only the HTTP GET
request method is therefore available on this API.
The type
property of a UserProperty is an enumeration allowing to know the type of data that it is possible to store within a user property.
0
: Boolean ;1
: Integer or list of values ;2
: Numerical ;3
: Date ;4
: Texte ;5
: Objet. Identifies UserProperties containing a value that is not simple, such as another user, an image, or a file. The format
property described in the section below provides additional information on the type of data.The format
property of a UserProperty designates an object containing various information about how to display and edit a user property.
Boolean type properties always have the following format:
Integer value type properties always have the following format:
Properties of type integer can also designate properties of type list of values, to which their format has the key select
, or radio
in the case of lists containing only two possible values. The following formats are possible in this case:
Numeric value type properties can have one of the following formats:
Date type properties always have the following format:
Text type properties can have one of the following formats:
Some properties contain a value retrieved via another Lucca API, in this case their format is as follows:
File and image type user properties contain a GUID that identifies a file stored on the Lucca server. Example of value:
The properties identifying an image or a file have the following formats respectively:
There are different types of UserProperties
. The category
property of each UserProperties
object lets you know to which category a UserProperties
belongs.
0
: Native property ;1
: Attribute property ;2
: Applicative property ;3
: Extension property (extendedData) ;4
: Analytical axes property ;5
: Password property.These properties are static and necessary for the proper functioning of Lucca applications. Some of these properties are only reported by the UserProperties
API if specific Lucca applications are instantiated.
(~ config)
: depends on application configuration
Name | Availability |
---|---|
address | if Lucca Core HR (~ config) |
allowsElectronicPayslip | if Lucca Payslips |
bankName | always |
bic | if Lucca Expenses |
birthDate | always |
calendar | always |
civilTitle | always |
corporateCard | if Lucca Expenses |
csp | if Lucca Absences |
culture | always |
department | always |
directLine | always |
dtContractEnd | always |
dtContractStart | always |
employeeNumber | always |
firstName | always |
frenchCarTaxHorsePower | if Lucca Expenses |
frenchMotocyclesTaxHorsePower | if Lucca Expenses |
gender | always |
habilitedRoles | always |
iban | if Lucca Expenses |
insuranceNumber | if Lucca Payslips or if Lucca Absences (~ config) |
jobTitle | always |
lastName | always |
legalEntity | always |
login | always |
mail | always |
manager | if Lucca Absences and/or Lucca Expenses (~ config) |
nationality | always |
personalAccount | if Lucca Expenses (~ config) |
personalEmail | always |
personalMobile | always |
picture | always |
professionalMobile | always |
quote | always |
rolePrincipal | always |
seniorityDate | if Lucca Absences |
site | if Lucca Absences |
unitSellPrice | if Lucca Absences and/or Lucca Compensation |
userWorkCycles | if Lucca Timesheets and/or if Lucca Absences |
Attribute category properties are custom properties that were created through the custom fields admin (xxx.ilucca.net/admin/extended-datas
). All of these properties are of type text and have a maximum length of 255 characters.
Application properties are specific to a specific Lucca application. The UserProperties
API will only report these properties if the applications that use them are instantiated. In some cases, certain properties are only available if the relevant application has been configured to use them.
profile_figgo
; manager2
.profile_cleemy
.Properties in the extension category, called ExtendedData, are custom properties that were created through the extensions admin (xxx.ilucca.net/directory/settings#/hrfile/properties
) . These properties are basically similar to attribute type properties, but are more comprehensive and can have different types. These properties are only available if the HR Folder is instantiated. More information on the ExtendedData documentation page.
Properties in the Analytical Axes category are properties that have been created through the Analytical Axes admin (xxx.ilucca.net/admin/axes
). These properties behave similarly to properties containing a value retrieved via another Lucca API. See the Formats of object type properties section.
This category of properties is only reserved for the password
property.