LOV Hierarchy
This webservice allows to create and manage LOV hierarchy.
Users can create nested LOVs and define dependancies.
deleteHierarchyMember
This method deletes the hierarchy (relations) between LOVs. Opration is based on hierarchy ID or UUID parameter.
This method must be called with Talentlink backoffice user credentials.
The user name must be set to the following format: CompanyName:saif:BO.
The password must be the user password for example: "Saif123!"
This method must be called with Talentlink backoffice user credentials.
The user name must be set to the following format: CompanyName:saif:BO.
The password must be the user password for example: "Saif123!"
Post Parameter
| Parameter | Data Type | Description |
|---|---|---|
| id |
Long
|
Internal TLK lov hierarchy ID |
| uuid |
String
|
Lov Hierarchy UUID |
Request Parameter
Response Parameter
| Parameter | Data Type | Description |
|---|---|---|
| deleteHierarchyMember |
OperationResultDto
|
Provides status (success/failure) and comments regarding the execution of some operation performed in TalentLink. |
| success |
Boolean
|
Is operation successful |
| details |
String
|
Details if operation fails |
getLovHierarchyMemberById
This method returns the details of specified hierarchy member (one node in LOV hierarchy graph).
This method must be called with Talentlink backoffice user credentials.
The user name must be set to the following format: CompanyName:saif:BO.
The password must be the user password for example: "Saif123!"
This method must be called with Talentlink backoffice user credentials.
The user name must be set to the following format: CompanyName:saif:BO.
The password must be the user password for example: "Saif123!"
Post Parameter
| Parameter | Data Type | Description |
|---|---|---|
| hierarchyMemberId |
Long
|
Id of hierarchy member (LovHierarchyMember class) |
Request Parameter
Response Parameter
| Parameter | Data Type | Description |
|---|---|---|
| getLovHierarchyMemberById |
LovHierarchyMemberDto
|
DTO representing one node in LOV hierarchy graph. |
| uuid |
String
|
Unique identifier for hierarchy member in the form of name/value (where name should be "ConfLOV"). This is a required attribute. |
| id |
Long
|
Unique id in table "LOV", used for local purposes (not for use in external update via webservice) |
| name |
String
|
Optional name of hierarchy member |
| translation |
String
|
Translated value of LOV, used for displaying in TalentLink GUI (not for use in external update via webservice) |
| hierMemberId |
Long
|
Unique id in table "LOV_HIER_MEMBER", used for local purposes (not for use in external update via webservice) |
| labels |
LovLabelsDto
|
Labels of this hierarchy member |
| name |
String
|
Name of the LOV entry this list of labels belongs to (optional). |
| value |
String
|
Value of the LOV entry this list of labels belongs to (optional). |
| type |
String
|
Type of the LOV entry this list of labels belongs to (optional). |
| overwrite |
Boolean
|
Indicates whether this list of labels should overwrite completely the one that already exists for the corresponding LOV entry (true) or just the values included in this list (false). Default value is false. |
| label |
LabelDto
|
Lov label |
| language |
String
|
Label language |
| value |
String
|
Label translation value |
| order |
Long
|
Order in which hierarchy members within same tree and same level should be organized |
| dataType |
DataType
|
Data type of hierarchy member. Possible values: INTEGER, TEXT, POSITIVE_INTEGER, NUMERICAL, BOOLEAN |
| searchable |
Boolean
|
Describes if LOV Hierarchy is searchable |
| hparents |
List
|
Parents of this hierarchy member |
| hlov |
LovHierarchyMemberDto
|
Parent of this hierarchy member |
| vlovs |
List
|
LOV values of this hierarchy member |
| vlov |
GenericLovForHierarchingDto
|
LOV value |
| translation |
String
|
Translated value of LOV, used for displaying in TalentLink GUI (not for use in external update via webservice) |
| name |
String
|
Optional name of LOV value |
| id |
Long
|
Unique id in table "LOV", used for local purposes (not for use in external update via webservice) |
| uuid |
String
|
Unique identifier for LOV value in the form of name/value (where name should equal to parent's hierarchy member value). This is a required attribute. |
| order |
Integer
|
Order in which LOV values belonging to one parent should be organized |
| labels |
LovLabelsDto
|
Labels of this hierarchy member |
| dataValue |
BigDecimal
|
Numeric value for LOV. |
| activators |
Activators
|
LOV uuids (or ids if it's for local TalentLink purposes) that activate this LOV value in hierarchy tree. |
| vlov |
UuidIdPairDto
|
Represents mapping of LOV UUID to LOV ID |
| id |
Long
|
Represents ID to by mapped by UUID |
| uuid |
String
|
UUID that is assigned to ID |
| departments |
List
|
Departments that this hierarchy member should belong to. If null, then the hierarchy member can be accessed globally. |
| dep |
Long
|
Internal TLK Organization ID |
| delete |
Boolean
|
If true the annotated LOV value should be deleted |
| importSessionId |
Long
|
Used to denote one importing session |
| rootOrphan |
Boolean
|
Is root without children ? |
getLovsAvilableForHierarching
Returns LOVs available for hierarching (narrowing based on current user department, and if LOV has been already used somewhere) narrowing result:
- if lovType = 0 then returns all hierarchy members, either global or local,
- if lovType = 1, returns only Global LOVs,
- if lovType = 2, returns only Local LOVs (and if departmentId is not null, then local LOVs for specified department, and if lovId is not null, then returns only for departments available for this LOV).
This method must be called with Talentlink backoffice user credentials.
The user name must be set to the following format: CompanyName:saif:BO.
The password must be the user password for example: "Saif123!"
- if lovType = 0 then returns all hierarchy members, either global or local,
- if lovType = 1, returns only Global LOVs,
- if lovType = 2, returns only Local LOVs (and if departmentId is not null, then local LOVs for specified department, and if lovId is not null, then returns only for departments available for this LOV).
This method must be called with Talentlink backoffice user credentials.
The user name must be set to the following format: CompanyName:saif:BO.
The password must be the user password for example: "Saif123!"
Post Parameter
| Parameter | Data Type | Description |
|---|---|---|
| lovType |
Integer
|
Internal TLK Lov Type ID |
| departmentId |
Long
|
Internal TLK organization ID |
| lovId |
Long
|
Internal TLK Lov ID |
Request Parameter
Response Parameter
| Parameter | Data Type | Description |
|---|---|---|
| getLovsAvilableForHierarching |
List
|
DTOs representing one node in LOV hierarchy graph. |
| translation |
String
|
Translated value of LOV, used for displaying in TalentLink GUI (not for use in external update via webservice) |
| name |
String
|
Optional name of LOV value |
| id |
Long
|
Unique id in table "LOV", used for local purposes (not for use in external update via webservice) |
| uuid |
String
|
Unique identifier for LOV value in the form of name/value (where name should equal to parent's hierarchy member value). This is a required attribute. |
| order |
Integer
|
Order in which LOV values belonging to one parent should be organized |
| labels |
LovLabelsDto
|
Labels of this hierarchy member |
| name |
String
|
Name of the LOV entry this list of labels belongs to (optional). |
| value |
String
|
Value of the LOV entry this list of labels belongs to (optional). |
| type |
String
|
Type of the LOV entry this list of labels belongs to (optional). |
| overwrite |
Boolean
|
Indicates whether this list of labels should overwrite completely the one that already exists for the corresponding LOV entry (true) or just the values included in this list (false). Default value is false. |
| label |
LabelDto
|
Lov label |
| language |
String
|
Label language |
| value |
String
|
Label translation value |
| dataValue |
BigDecimal
|
Numeric value for LOV. |
| activators |
Activators
|
LOV uuids (or ids if it's for local TalentLink purposes) that activate this LOV value in hierarchy tree. |
| vlov |
UuidIdPairDto
|
Represents mapping of LOV UUID to LOV ID |
| id |
Long
|
Represents ID to by mapped by UUID |
| uuid |
String
|
UUID that is assigned to ID |
getLovsByUnlockers
This method returns the list of LOV's which are activated by the parent LOV. Results are displayed in the context of a parent LOV.
This method must be called with Talentlink backoffice user credentials.
The user name must be set to the following format: CompanyName:saif:BO.
The password must be the user password for example: "Saif123!"
This method must be called with Talentlink backoffice user credentials.
The user name must be set to the following format: CompanyName:saif:BO.
The password must be the user password for example: "Saif123!"
Post Parameter
| Parameter | Data Type | Description |
|---|---|---|
| destinationLovId |
Long
|
Internal TLK LOV ID |
| parentLovs |
List
|
Internal TLK LOV ID representing parents |
| language |
String
|
Language code Click to see possible values |
Request Parameter
Response Parameter
| Parameter | Data Type | Description |
|---|---|---|
| getLovsByUnlockers |
List
|
DTOs representing one node in LOV hierarchy graph. |
| translation |
String
|
Translated value of LOV, used for displaying in TalentLink GUI (not for use in external update via webservice) |
| name |
String
|
Optional name of LOV value |
| id |
Long
|
Unique id in table "LOV", used for local purposes (not for use in external update via webservice) |
| uuid |
String
|
Unique identifier for LOV value in the form of name/value (where name should equal to parent's hierarchy member value). This is a required attribute. |
| order |
Integer
|
Order in which LOV values belonging to one parent should be organized |
| labels |
LovLabelsDto
|
Labels of this hierarchy member |
| name |
String
|
Name of the LOV entry this list of labels belongs to (optional). |
| value |
String
|
Value of the LOV entry this list of labels belongs to (optional). |
| type |
String
|
Type of the LOV entry this list of labels belongs to (optional). |
| overwrite |
Boolean
|
Indicates whether this list of labels should overwrite completely the one that already exists for the corresponding LOV entry (true) or just the values included in this list (false). Default value is false. |
| label |
LabelDto
|
Lov label |
| language |
String
|
Label language |
| value |
String
|
Label translation value |
| dataValue |
BigDecimal
|
Numeric value for LOV. |
| activators |
Activators
|
LOV uuids (or ids if it's for local TalentLink purposes) that activate this LOV value in hierarchy tree. |
| vlov |
UuidIdPairDto
|
Represents mapping of LOV UUID to LOV ID |
| id |
Long
|
Represents ID to by mapped by UUID |
| uuid |
String
|
UUID that is assigned to ID |
getLovsByUnlockersWithFilter
This method returns the list of LOV's which are activated by the parent LOV. Results are displayed in the context of a parent LOV with added filtering (for specified recruitment type and department).
This method must be called with Talentlink backoffice user credentials.
The user name must be set to the following format: CompanyName:saif:BO.
The password must be the user password for example: "Saif123!"
This method must be called with Talentlink backoffice user credentials.
The user name must be set to the following format: CompanyName:saif:BO.
The password must be the user password for example: "Saif123!"
Post Parameter
| Parameter | Data Type | Description |
|---|---|---|
| destinationLovId |
Long
|
Internal TLK LOV ID |
| parentLovs |
List
|
Internal TLK LOV ID representing parents |
| language |
String
|
Language code Click to see possible values |
| filterDptId |
Long
|
Internal TLK Organization ID to filter LOVs |
| filterRecType |
RecruitmentType
|
Filter by Recruitment Type. Possible values: JOBP, JOBC, CONP, CONC |
Request Parameter
Response Parameter
| Parameter | Data Type | Description |
|---|---|---|
| getLovsByUnlockers |
List
|
DTOs representing one node in LOV hierarchy graph. |
| translation |
String
|
Translated value of LOV, used for displaying in TalentLink GUI (not for use in external update via webservice) |
| name |
String
|
Optional name of LOV value |
| id |
Long
|
Unique id in table "LOV", used for local purposes (not for use in external update via webservice) |
| uuid |
String
|
Unique identifier for LOV value in the form of name/value (where name should equal to parent's hierarchy member value). This is a required attribute. |
| order |
Integer
|
Order in which LOV values belonging to one parent should be organized |
| labels |
LovLabelsDto
|
Labels of this hierarchy member |
| name |
String
|
Name of the LOV entry this list of labels belongs to (optional). |
| value |
String
|
Value of the LOV entry this list of labels belongs to (optional). |
| type |
String
|
Type of the LOV entry this list of labels belongs to (optional). |
| overwrite |
Boolean
|
Indicates whether this list of labels should overwrite completely the one that already exists for the corresponding LOV entry (true) or just the values included in this list (false). Default value is false. |
| label |
LabelDto
|
Lov label |
| language |
String
|
Label language |
| value |
String
|
Label translation value |
| dataValue |
BigDecimal
|
Numeric value for LOV. |
| activators |
Activators
|
LOV uuids (or ids if it's for local TalentLink purposes) that activate this LOV value in hierarchy tree. |
| vlov |
UuidIdPairDto
|
Represents mapping of LOV UUID to LOV ID |
| id |
Long
|
Represents ID to by mapped by UUID |
| uuid |
String
|
UUID that is assigned to ID |
getWholeHierarchy
Returns the whole LOV hierarchy without details (only hierarchy members with information about parents). Results can be narrowed as follows:
- if lovType = 0 then returns all hierarchy members, either global or local,
- if lovType = 1, returns only Global LOVs,
- if lovType = 2, returns only Local LOVs (and if departmentId is not null, then local LOVs for specified department).
This method must be called with Talentlink backoffice user credentials.
The user name must be set to the following format: CompanyName:saif:BO.
The password must be the user password for example: "Saif123!"
- if lovType = 0 then returns all hierarchy members, either global or local,
- if lovType = 1, returns only Global LOVs,
- if lovType = 2, returns only Local LOVs (and if departmentId is not null, then local LOVs for specified department).
This method must be called with Talentlink backoffice user credentials.
The user name must be set to the following format: CompanyName:saif:BO.
The password must be the user password for example: "Saif123!"
Post Parameter
| Parameter | Data Type | Description |
|---|---|---|
| lovType |
Integer
|
Internal TLK Lov Type ID |
| departmentId |
Long
|
Internal TLK organization ID |
Request Parameter
Response Parameter
| Parameter | Data Type | Description |
|---|---|---|
| getWholeHierarchy |
List
|
DTO representing one node in LOV hierarchy graph. |
| uuid |
String
|
Unique identifier for hierarchy member in the form of name/value (where name should be "ConfLOV"). This is a required attribute. |
| id |
Long
|
Unique id in table "LOV", used for local purposes (not for use in external update via webservice) |
| name |
String
|
Optional name of hierarchy member |
| translation |
String
|
Translated value of LOV, used for displaying in TalentLink GUI (not for use in external update via webservice) |
| hierMemberId |
Long
|
Unique id in table "LOV_HIER_MEMBER", used for local purposes (not for use in external update via webservice) |
| labels |
LovLabelsDto
|
Labels of this hierarchy member |
| name |
String
|
Name of the LOV entry this list of labels belongs to (optional). |
| value |
String
|
Value of the LOV entry this list of labels belongs to (optional). |
| type |
String
|
Type of the LOV entry this list of labels belongs to (optional). |
| overwrite |
Boolean
|
Indicates whether this list of labels should overwrite completely the one that already exists for the corresponding LOV entry (true) or just the values included in this list (false). Default value is false. |
| label |
LabelDto
|
Lov label |
| language |
String
|
Label language |
| value |
String
|
Label translation value |
| order |
Long
|
Order in which hierarchy members within same tree and same level should be organized |
| dataType |
DataType
|
Data type of hierarchy member. Possible values: INTEGER, TEXT, POSITIVE_INTEGER, NUMERICAL, BOOLEAN |
| searchable |
Boolean
|
Describes if LOV Hierarchy is searchable |
| hparents |
List
|
Parents of this hierarchy member |
| hlov |
LovHierarchyMemberDto
|
Parent of this hierarchy member |
| vlovs |
List
|
LOV values of this hierarchy member |
| vlov |
GenericLovForHierarchingDto
|
LOV value |
| translation |
String
|
Translated value of LOV, used for displaying in TalentLink GUI (not for use in external update via webservice) |
| name |
String
|
Optional name of LOV value |
| id |
Long
|
Unique id in table "LOV", used for local purposes (not for use in external update via webservice) |
| uuid |
String
|
Unique identifier for LOV value in the form of name/value (where name should equal to parent's hierarchy member value). This is a required attribute. |
| order |
Integer
|
Order in which LOV values belonging to one parent should be organized |
| labels |
LovLabelsDto
|
Labels of this hierarchy member |
| dataValue |
BigDecimal
|
Numeric value for LOV. |
| activators |
Activators
|
LOV uuids (or ids if it's for local TalentLink purposes) that activate this LOV value in hierarchy tree. |
| vlov |
UuidIdPairDto
|
Represents mapping of LOV UUID to LOV ID |
| id |
Long
|
Represents ID to by mapped by UUID |
| uuid |
String
|
UUID that is assigned to ID |
| departments |
List
|
Departments that this hierarchy member should belong to. If null, then the hierarchy member can be accessed globally. |
| dep |
Long
|
Internal TLK Organization ID |
| delete |
Boolean
|
If true the annotated LOV value should be deleted |
| importSessionId |
Long
|
Used to denote one importing session |
| rootOrphan |
Boolean
|
Is root without children ? |
linkHierarchyMembers
Connects two LOVs into hierarchy members
This method must be called with Talentlink backoffice user credentials.
The user name must be set to the following format: CompanyName:saif:BO.
The password must be the user password for example: "Saif123!"
This method must be called with Talentlink backoffice user credentials.
The user name must be set to the following format: CompanyName:saif:BO.
The password must be the user password for example: "Saif123!"
Post Parameter
| Parameter | Data Type | Description |
|---|---|---|
| parentId |
Long
|
Internal TLK ID of LOV that will become a parent |
| childId |
Long
|
Internal TLK ID of LOV that will become a child |
Request Parameter
Response Parameter
| Parameter | Data Type | Description |
|---|---|---|
| linkHierarchyMembers |
LovHierarchyMemberDto
|
DTO representing one node in LOV hierarchy graph. |
| uuid |
String
|
Unique identifier for hierarchy member in the form of name/value (where name should be "ConfLOV"). This is a required attribute. |
| id |
Long
|
Unique id in table "LOV", used for local purposes (not for use in external update via webservice) |
| name |
String
|
Optional name of hierarchy member |
| translation |
String
|
Translated value of LOV, used for displaying in TalentLink GUI (not for use in external update via webservice) |
| hierMemberId |
Long
|
Unique id in table "LOV_HIER_MEMBER", used for local purposes (not for use in external update via webservice) |
| labels |
LovLabelsDto
|
Labels of this hierarchy member |
| name |
String
|
Name of the LOV entry this list of labels belongs to (optional). |
| value |
String
|
Value of the LOV entry this list of labels belongs to (optional). |
| type |
String
|
Type of the LOV entry this list of labels belongs to (optional). |
| overwrite |
Boolean
|
Indicates whether this list of labels should overwrite completely the one that already exists for the corresponding LOV entry (true) or just the values included in this list (false). Default value is false. |
| label |
LabelDto
|
Lov label |
| language |
String
|
Label language |
| value |
String
|
Label translation value |
| order |
Long
|
Order in which hierarchy members within same tree and same level should be organized |
| dataType |
DataType
|
Data type of hierarchy member. Possible values: INTEGER, TEXT, POSITIVE_INTEGER, NUMERICAL, BOOLEAN |
| searchable |
Boolean
|
Describes if LOV Hierarchy is searchable |
| hparents |
List
|
Parents of this hierarchy member |
| hlov |
LovHierarchyMemberDto
|
Parent of this hierarchy member |
| vlovs |
List
|
LOV values of this hierarchy member |
| vlov |
GenericLovForHierarchingDto
|
LOV value |
| translation |
String
|
Translated value of LOV, used for displaying in TalentLink GUI (not for use in external update via webservice) |
| name |
String
|
Optional name of LOV value |
| id |
Long
|
Unique id in table "LOV", used for local purposes (not for use in external update via webservice) |
| uuid |
String
|
Unique identifier for LOV value in the form of name/value (where name should equal to parent's hierarchy member value). This is a required attribute. |
| order |
Integer
|
Order in which LOV values belonging to one parent should be organized |
| labels |
LovLabelsDto
|
Labels of this hierarchy member |
| dataValue |
BigDecimal
|
Numeric value for LOV. |
| activators |
Activators
|
LOV uuids (or ids if it's for local TalentLink purposes) that activate this LOV value in hierarchy tree. |
| vlov |
UuidIdPairDto
|
Represents mapping of LOV UUID to LOV ID |
| id |
Long
|
Represents ID to by mapped by UUID |
| uuid |
String
|
UUID that is assigned to ID |
| departments |
List
|
Departments that this hierarchy member should belong to. If null, then the hierarchy member can be accessed globally. |
| dep |
Long
|
Internal TLK Organization ID |
| delete |
Boolean
|
If true the annotated LOV value should be deleted |
| importSessionId |
Long
|
Used to denote one importing session |
| rootOrphan |
Boolean
|
Is root without children ? |
makeLovHierarchyMemberFromLov
Creates LOV hierarchy member entity from provided LOV, making it available for linking with another LOV.
This method must be called with Talentlink backoffice user credentials.
The user name must be set to the following format: CompanyName:saif:BO.
The password must be the user password for example: "Saif123!"
This method must be called with Talentlink backoffice user credentials.
The user name must be set to the following format: CompanyName:saif:BO.
The password must be the user password for example: "Saif123!"
Post Parameter
| Parameter | Data Type | Description |
|---|---|---|
| lovId |
Long
|
Internal TLK Lov ID |
Request Parameter
Response Parameter
| Parameter | Data Type | Description |
|---|---|---|
| makeLovHierarchyMemberFromLov |
LovHierarchyMemberDto
|
DTO representing one node in LOV hierarchy graph. |
| uuid |
String
|
Unique identifier for hierarchy member in the form of name/value (where name should be "ConfLOV"). This is a required attribute. |
| id |
Long
|
Unique id in table "LOV", used for local purposes (not for use in external update via webservice) |
| name |
String
|
Optional name of hierarchy member |
| translation |
String
|
Translated value of LOV, used for displaying in TalentLink GUI (not for use in external update via webservice) |
| hierMemberId |
Long
|
Unique id in table "LOV_HIER_MEMBER", used for local purposes (not for use in external update via webservice) |
| labels |
LovLabelsDto
|
Labels of this hierarchy member |
| name |
String
|
Name of the LOV entry this list of labels belongs to (optional). |
| value |
String
|
Value of the LOV entry this list of labels belongs to (optional). |
| type |
String
|
Type of the LOV entry this list of labels belongs to (optional). |
| overwrite |
Boolean
|
Indicates whether this list of labels should overwrite completely the one that already exists for the corresponding LOV entry (true) or just the values included in this list (false). Default value is false. |
| label |
LabelDto
|
Lov label |
| language |
String
|
Label language |
| value |
String
|
Label translation value |
| order |
Long
|
Order in which hierarchy members within same tree and same level should be organized |
| dataType |
DataType
|
Data type of hierarchy member. Possible values: INTEGER, TEXT, POSITIVE_INTEGER, NUMERICAL, BOOLEAN |
| searchable |
Boolean
|
Describes if LOV Hierarchy is searchable |
| hparents |
List
|
Parents of this hierarchy member |
| hlov |
LovHierarchyMemberDto
|
Parent of this hierarchy member |
| vlovs |
List
|
LOV values of this hierarchy member |
| vlov |
GenericLovForHierarchingDto
|
LOV value |
| translation |
String
|
Translated value of LOV, used for displaying in TalentLink GUI (not for use in external update via webservice) |
| name |
String
|
Optional name of LOV value |
| id |
Long
|
Unique id in table "LOV", used for local purposes (not for use in external update via webservice) |
| uuid |
String
|
Unique identifier for LOV value in the form of name/value (where name should equal to parent's hierarchy member value). This is a required attribute. |
| order |
Integer
|
Order in which LOV values belonging to one parent should be organized |
| labels |
LovLabelsDto
|
Labels of this hierarchy member |
| dataValue |
BigDecimal
|
Numeric value for LOV. |
| activators |
Activators
|
LOV uuids (or ids if it's for local TalentLink purposes) that activate this LOV value in hierarchy tree. |
| vlov |
UuidIdPairDto
|
Represents mapping of LOV UUID to LOV ID |
| id |
Long
|
Represents ID to by mapped by UUID |
| uuid |
String
|
UUID that is assigned to ID |
| departments |
List
|
Departments that this hierarchy member should belong to. If null, then the hierarchy member can be accessed globally. |
| dep |
Long
|
Internal TLK Organization ID |
| delete |
Boolean
|
If true the annotated LOV value should be deleted |
| importSessionId |
Long
|
Used to denote one importing session |
| rootOrphan |
Boolean
|
Is root without children ? |
unLinkHierarchyMembers
Unlinks connection between parent and child hierarchy members
This method must be called with Talentlink backoffice user credentials.
The user name must be set to the following format: CompanyName:saif:BO.
The password must be the user password for example: "Saif123!"
This method must be called with Talentlink backoffice user credentials.
The user name must be set to the following format: CompanyName:saif:BO.
The password must be the user password for example: "Saif123!"
Post Parameter
| Parameter | Data Type | Description |
|---|---|---|
| parentId |
Long
|
Internal TLK ID of LOV that will become a parent |
| childId |
Long
|
Internal TLK ID of LOV that will become a child |
Request Parameter
Response Parameter
| Parameter | Data Type | Description |
|---|---|---|
| unLinkHierarchyMembers |
OperationResultDto
|
Provides status (success/failure) and comments regarding the execution of some operation performed in TalentLink. |
| success |
Boolean
|
Is operation successful |
| details |
String
|
Details if operation fails |
updateHierarchy
Updates hierarchy with information provided in DTOs. Should be used only via import functionality
This method must be called with Talentlink backoffice user credentials.
The user name must be set to the following format: CompanyName:saif:BO.
The password must be the user password for example: "Saif123!"
This method must be called with Talentlink backoffice user credentials.
The user name must be set to the following format: CompanyName:saif:BO.
The password must be the user password for example: "Saif123!"
Post Parameter
| Parameter | Data Type | Description |
|---|---|---|
| hlov |
List
|
Represents Lov Hierarchies to be updated |
| uuid |
String
|
Unique identifier for hierarchy member in the form of name/value (where name should be "ConfLOV"). This is a required attribute. |
| id |
Long
|
Unique id in table "LOV", used for local purposes (not for use in external update via webservice) |
| name |
String
|
Optional name of hierarchy member |
| translation |
String
|
Translated value of LOV, used for displaying in TalentLink GUI (not for use in external update via webservice) |
| hierMemberId |
Long
|
Unique id in table "LOV_HIER_MEMBER", used for local purposes (not for use in external update via webservice) |
| labels |
LovLabelsDto
|
Labels of this hierarchy member |
| name |
String
|
Name of the LOV entry this list of labels belongs to (optional). |
| value |
String
|
Value of the LOV entry this list of labels belongs to (optional). |
| type |
String
|
Type of the LOV entry this list of labels belongs to (optional). |
| overwrite |
Boolean
|
Indicates whether this list of labels should overwrite completely the one that already exists for the corresponding LOV entry (true) or just the values included in this list (false). Default value is false. |
| label |
LabelDto
|
Lov label |
| language |
String
|
Label language |
| value |
String
|
Label translation value |
| order |
Long
|
Order in which hierarchy members within same tree and same level should be organized |
| dataType |
DataType
|
Data type of hierarchy member. Possible values: INTEGER, TEXT, POSITIVE_INTEGER, NUMERICAL, BOOLEAN |
| searchable |
Boolean
|
Describes if LOV Hierarchy is searchable |
| hparents |
List
|
Parents of this hierarchy member |
| hlov |
LovHierarchyMemberDto
|
Parent of this hierarchy member |
| vlovs |
List
|
LOV values of this hierarchy member |
| vlov |
GenericLovForHierarchingDto
|
LOV value |
| translation |
String
|
Translated value of LOV, used for displaying in TalentLink GUI (not for use in external update via webservice) |
| name |
String
|
Optional name of LOV value |
| id |
Long
|
Unique id in table "LOV", used for local purposes (not for use in external update via webservice) |
| uuid |
String
|
Unique identifier for LOV value in the form of name/value (where name should equal to parent's hierarchy member value). This is a required attribute. |
| order |
Integer
|
Order in which LOV values belonging to one parent should be organized |
| labels |
LovLabelsDto
|
Labels of this hierarchy member |
| dataValue |
BigDecimal
|
Numeric value for LOV. |
| activators |
Activators
|
LOV uuids (or ids if it's for local TalentLink purposes) that activate this LOV value in hierarchy tree. |
| vlov |
UuidIdPairDto
|
Represents mapping of LOV UUID to LOV ID |
| id |
Long
|
Represents ID to by mapped by UUID |
| uuid |
String
|
UUID that is assigned to ID |
| departments |
List
|
Departments that this hierarchy member should belong to. If null, then the hierarchy member can be accessed globally. |
| dep |
Long
|
Internal TLK Organization ID |
| delete |
Boolean
|
If true the annotated LOV value should be deleted |
| importSessionId |
Long
|
Used to denote one importing session |
| rootOrphan |
Boolean
|
Is root without children ? |
Request Parameter
Response Parameter
| Parameter | Data Type | Description |
|---|---|---|
| updateHierarchy |
OperationResultDto
|
Provides status (success/failure) and comments regarding the execution of some operation performed in TalentLink. |
| success |
Boolean
|
Is operation successful |
| details |
String
|
Details if operation fails |
updateHierarchyMemberUnlockers
Updates LovHierarchyMember's LOVs unlockers with information provided in DTO
This method must be called with Talentlink backoffice user credentials.
The user name must be set to the following format: CompanyName:saif:BO.
The password must be the user password for example: "Saif123!"
This method must be called with Talentlink backoffice user credentials.
The user name must be set to the following format: CompanyName:saif:BO.
The password must be the user password for example: "Saif123!"
Post Parameter
| Parameter | Data Type | Description |
|---|---|---|
| lhmDto |
LovHierarchyMemberDto
|
Represents Lov Hierarchy to be updated |
| uuid |
String
|
Unique identifier for hierarchy member in the form of name/value (where name should be "ConfLOV"). This is a required attribute. |
| id |
Long
|
Unique id in table "LOV", used for local purposes (not for use in external update via webservice) |
| name |
String
|
Optional name of hierarchy member |
| translation |
String
|
Translated value of LOV, used for displaying in TalentLink GUI (not for use in external update via webservice) |
| hierMemberId |
Long
|
Unique id in table "LOV_HIER_MEMBER", used for local purposes (not for use in external update via webservice) |
| labels |
LovLabelsDto
|
Labels of this hierarchy member |
| name |
String
|
Name of the LOV entry this list of labels belongs to (optional). |
| value |
String
|
Value of the LOV entry this list of labels belongs to (optional). |
| type |
String
|
Type of the LOV entry this list of labels belongs to (optional). |
| overwrite |
Boolean
|
Indicates whether this list of labels should overwrite completely the one that already exists for the corresponding LOV entry (true) or just the values included in this list (false). Default value is false. |
| label |
LabelDto
|
Lov label |
| language |
String
|
Label language |
| value |
String
|
Label translation value |
| order |
Long
|
Order in which hierarchy members within same tree and same level should be organized |
| dataType |
DataType
|
Data type of hierarchy member. Possible values: INTEGER, TEXT, POSITIVE_INTEGER, NUMERICAL, BOOLEAN |
| searchable |
Boolean
|
Describes if LOV Hierarchy is searchable |
| hparents |
List
|
Parents of this hierarchy member |
| hlov |
LovHierarchyMemberDto
|
Parent of this hierarchy member |
| vlovs |
List
|
LOV values of this hierarchy member |
| vlov |
GenericLovForHierarchingDto
|
LOV value |
| translation |
String
|
Translated value of LOV, used for displaying in TalentLink GUI (not for use in external update via webservice) |
| name |
String
|
Optional name of LOV value |
| id |
Long
|
Unique id in table "LOV", used for local purposes (not for use in external update via webservice) |
| uuid |
String
|
Unique identifier for LOV value in the form of name/value (where name should equal to parent's hierarchy member value). This is a required attribute. |
| order |
Integer
|
Order in which LOV values belonging to one parent should be organized |
| labels |
LovLabelsDto
|
Labels of this hierarchy member |
| dataValue |
BigDecimal
|
Numeric value for LOV. |
| activators |
Activators
|
LOV uuids (or ids if it's for local TalentLink purposes) that activate this LOV value in hierarchy tree. |
| vlov |
UuidIdPairDto
|
Represents mapping of LOV UUID to LOV ID |
| id |
Long
|
Represents ID to by mapped by UUID |
| uuid |
String
|
UUID that is assigned to ID |
| departments |
List
|
Departments that this hierarchy member should belong to. If null, then the hierarchy member can be accessed globally. |
| dep |
Long
|
Internal TLK Organization ID |
| delete |
Boolean
|
If true the annotated LOV value should be deleted |
| importSessionId |
Long
|
Used to denote one importing session |
| rootOrphan |
Boolean
|
Is root without children ? |
Request Parameter
Response Parameter
| Parameter | Data Type | Description |
|---|---|---|
| updateHierarchyMemberUnlockers |
OperationResultDto
|
Provides status (success/failure) and comments regarding the execution of some operation performed in TalentLink. |
| success |
Boolean
|
Is operation successful |
| details |
String
|
Details if operation fails |
updateSingleHierarchyMember
Updates hierarchy of a single hierarchy member with information provided in DTO.
This method must be called with Talentlink backoffice user credentials.
The user name must be set to the following format: CompanyName:saif:BO.
The password must be the user password for example: "Saif123!"
This method must be called with Talentlink backoffice user credentials.
The user name must be set to the following format: CompanyName:saif:BO.
The password must be the user password for example: "Saif123!"
Post Parameter
| Parameter | Data Type | Description |
|---|---|---|
| hlov |
LovHierarchyMemberDto
|
Represents Lov Hierarchy to be updated |
| uuid |
String
|
Unique identifier for hierarchy member in the form of name/value (where name should be "ConfLOV"). This is a required attribute. |
| id |
Long
|
Unique id in table "LOV", used for local purposes (not for use in external update via webservice) |
| name |
String
|
Optional name of hierarchy member |
| translation |
String
|
Translated value of LOV, used for displaying in TalentLink GUI (not for use in external update via webservice) |
| hierMemberId |
Long
|
Unique id in table "LOV_HIER_MEMBER", used for local purposes (not for use in external update via webservice) |
| labels |
LovLabelsDto
|
Labels of this hierarchy member |
| name |
String
|
Name of the LOV entry this list of labels belongs to (optional). |
| value |
String
|
Value of the LOV entry this list of labels belongs to (optional). |
| type |
String
|
Type of the LOV entry this list of labels belongs to (optional). |
| overwrite |
Boolean
|
Indicates whether this list of labels should overwrite completely the one that already exists for the corresponding LOV entry (true) or just the values included in this list (false). Default value is false. |
| label |
LabelDto
|
Lov label |
| language |
String
|
Label language |
| value |
String
|
Label translation value |
| order |
Long
|
Order in which hierarchy members within same tree and same level should be organized |
| dataType |
DataType
|
Data type of hierarchy member. Possible values: INTEGER, TEXT, POSITIVE_INTEGER, NUMERICAL, BOOLEAN |
| searchable |
Boolean
|
Describes if LOV Hierarchy is searchable |
| hparents |
List
|
Parents of this hierarchy member |
| hlov |
LovHierarchyMemberDto
|
Parent of this hierarchy member |
| vlovs |
List
|
LOV values of this hierarchy member |
| vlov |
GenericLovForHierarchingDto
|
LOV value |
| translation |
String
|
Translated value of LOV, used for displaying in TalentLink GUI (not for use in external update via webservice) |
| name |
String
|
Optional name of LOV value |
| id |
Long
|
Unique id in table "LOV", used for local purposes (not for use in external update via webservice) |
| uuid |
String
|
Unique identifier for LOV value in the form of name/value (where name should equal to parent's hierarchy member value). This is a required attribute. |
| order |
Integer
|
Order in which LOV values belonging to one parent should be organized |
| labels |
LovLabelsDto
|
Labels of this hierarchy member |
| dataValue |
BigDecimal
|
Numeric value for LOV. |
| activators |
Activators
|
LOV uuids (or ids if it's for local TalentLink purposes) that activate this LOV value in hierarchy tree. |
| vlov |
UuidIdPairDto
|
Represents mapping of LOV UUID to LOV ID |
| id |
Long
|
Represents ID to by mapped by UUID |
| uuid |
String
|
UUID that is assigned to ID |
| departments |
List
|
Departments that this hierarchy member should belong to. If null, then the hierarchy member can be accessed globally. |
| dep |
Long
|
Internal TLK Organization ID |
| delete |
Boolean
|
If true the annotated LOV value should be deleted |
| importSessionId |
Long
|
Used to denote one importing session |
| rootOrphan |
Boolean
|
Is root without children ? |
Request Parameter
Response Parameter
| Parameter | Data Type | Description |
|---|---|---|
| updateSingleHierarchyMember |
OperationResultDto
|
Provides status (success/failure) and comments regarding the execution of some operation performed in TalentLink. |
| success |
Boolean
|
Is operation successful |
| details |
String
|
Details if operation fails |