Get the top matching Jobs for an Employee
curl --request POST \
--url https://{tenant_name}.{region}.techwolf.ai/employees/{external_id}/matching_jobs \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"filters": [
{
"filter": "last_updated",
"value": "2022-01-01",
"operator": "lt"
},
{
"filter": "custom_property_equal",
"from_entity_property": "desired_wage",
"to_entity_property": "wage"
},
{
"filter": "custom_property",
"property_name": "direct_manager",
"property_value": "John Doe"
},
{
"filter": "custom_property_is_in",
"from_entity_property": "required_drivers_license",
"to_entity_property": "drivers_licenses"
},
{
"filter": "custom_property_is_in_list",
"property_name": "drivers_license",
"possible_values": [
"C",
"CE"
]
},
{
"filter": "custom_property_contains",
"from_entity_property": "shift_regime_codes",
"to_entity_property": "desired_regime"
},
{
"filter": "custom_property_list_overlap",
"from_entity_property": "desired_industries",
"to_entity_property": "industries"
},
{
"filter": "custom_property_contains_element",
"property_name": "industries",
"property_value": "electronics"
},
{
"filter": "external_id_is_in_list",
"external_ids": [
"c350500-eb84-42dc-a79f-5e7b1fe897b7",
"b450500-eb84-42dc-a79f-5e7b1fe897c8"
]
},
{
"filter": "low_data_availability",
"exclude_low_data_availability": true
}
],
"weights": [
{
"weight": "skills_match",
"value": 1
}
]
}
'import requests
url = "https://{tenant_name}.{region}.techwolf.ai/employees/{external_id}/matching_jobs"
payload = {
"filters": [
{
"filter": "last_updated",
"value": "2022-01-01",
"operator": "lt"
},
{
"filter": "custom_property_equal",
"from_entity_property": "desired_wage",
"to_entity_property": "wage"
},
{
"filter": "custom_property",
"property_name": "direct_manager",
"property_value": "John Doe"
},
{
"filter": "custom_property_is_in",
"from_entity_property": "required_drivers_license",
"to_entity_property": "drivers_licenses"
},
{
"filter": "custom_property_is_in_list",
"property_name": "drivers_license",
"possible_values": ["C", "CE"]
},
{
"filter": "custom_property_contains",
"from_entity_property": "shift_regime_codes",
"to_entity_property": "desired_regime"
},
{
"filter": "custom_property_list_overlap",
"from_entity_property": "desired_industries",
"to_entity_property": "industries"
},
{
"filter": "custom_property_contains_element",
"property_name": "industries",
"property_value": "electronics"
},
{
"filter": "external_id_is_in_list",
"external_ids": ["c350500-eb84-42dc-a79f-5e7b1fe897b7", "b450500-eb84-42dc-a79f-5e7b1fe897c8"]
},
{
"filter": "low_data_availability",
"exclude_low_data_availability": True
}
],
"weights": [
{
"weight": "skills_match",
"value": 1
}
]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
filters: [
{filter: 'last_updated', value: '2022-01-01', operator: 'lt'},
{
filter: 'custom_property_equal',
from_entity_property: 'desired_wage',
to_entity_property: 'wage'
},
{
filter: 'custom_property',
property_name: 'direct_manager',
property_value: 'John Doe'
},
{
filter: 'custom_property_is_in',
from_entity_property: 'required_drivers_license',
to_entity_property: 'drivers_licenses'
},
{
filter: 'custom_property_is_in_list',
property_name: 'drivers_license',
possible_values: ['C', 'CE']
},
{
filter: 'custom_property_contains',
from_entity_property: 'shift_regime_codes',
to_entity_property: 'desired_regime'
},
{
filter: 'custom_property_list_overlap',
from_entity_property: 'desired_industries',
to_entity_property: 'industries'
},
{
filter: 'custom_property_contains_element',
property_name: 'industries',
property_value: 'electronics'
},
{
filter: 'external_id_is_in_list',
external_ids: ['c350500-eb84-42dc-a79f-5e7b1fe897b7', 'b450500-eb84-42dc-a79f-5e7b1fe897c8']
},
{filter: 'low_data_availability', exclude_low_data_availability: true}
],
weights: [{weight: 'skills_match', value: 1}]
})
};
fetch('https://{tenant_name}.{region}.techwolf.ai/employees/{external_id}/matching_jobs', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://{tenant_name}.{region}.techwolf.ai/employees/{external_id}/matching_jobs",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'filters' => [
[
'filter' => 'last_updated',
'value' => '2022-01-01',
'operator' => 'lt'
],
[
'filter' => 'custom_property_equal',
'from_entity_property' => 'desired_wage',
'to_entity_property' => 'wage'
],
[
'filter' => 'custom_property',
'property_name' => 'direct_manager',
'property_value' => 'John Doe'
],
[
'filter' => 'custom_property_is_in',
'from_entity_property' => 'required_drivers_license',
'to_entity_property' => 'drivers_licenses'
],
[
'filter' => 'custom_property_is_in_list',
'property_name' => 'drivers_license',
'possible_values' => [
'C',
'CE'
]
],
[
'filter' => 'custom_property_contains',
'from_entity_property' => 'shift_regime_codes',
'to_entity_property' => 'desired_regime'
],
[
'filter' => 'custom_property_list_overlap',
'from_entity_property' => 'desired_industries',
'to_entity_property' => 'industries'
],
[
'filter' => 'custom_property_contains_element',
'property_name' => 'industries',
'property_value' => 'electronics'
],
[
'filter' => 'external_id_is_in_list',
'external_ids' => [
'c350500-eb84-42dc-a79f-5e7b1fe897b7',
'b450500-eb84-42dc-a79f-5e7b1fe897c8'
]
],
[
'filter' => 'low_data_availability',
'exclude_low_data_availability' => true
]
],
'weights' => [
[
'weight' => 'skills_match',
'value' => 1
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://{tenant_name}.{region}.techwolf.ai/employees/{external_id}/matching_jobs"
payload := strings.NewReader("{\n \"filters\": [\n {\n \"filter\": \"last_updated\",\n \"value\": \"2022-01-01\",\n \"operator\": \"lt\"\n },\n {\n \"filter\": \"custom_property_equal\",\n \"from_entity_property\": \"desired_wage\",\n \"to_entity_property\": \"wage\"\n },\n {\n \"filter\": \"custom_property\",\n \"property_name\": \"direct_manager\",\n \"property_value\": \"John Doe\"\n },\n {\n \"filter\": \"custom_property_is_in\",\n \"from_entity_property\": \"required_drivers_license\",\n \"to_entity_property\": \"drivers_licenses\"\n },\n {\n \"filter\": \"custom_property_is_in_list\",\n \"property_name\": \"drivers_license\",\n \"possible_values\": [\n \"C\",\n \"CE\"\n ]\n },\n {\n \"filter\": \"custom_property_contains\",\n \"from_entity_property\": \"shift_regime_codes\",\n \"to_entity_property\": \"desired_regime\"\n },\n {\n \"filter\": \"custom_property_list_overlap\",\n \"from_entity_property\": \"desired_industries\",\n \"to_entity_property\": \"industries\"\n },\n {\n \"filter\": \"custom_property_contains_element\",\n \"property_name\": \"industries\",\n \"property_value\": \"electronics\"\n },\n {\n \"filter\": \"external_id_is_in_list\",\n \"external_ids\": [\n \"c350500-eb84-42dc-a79f-5e7b1fe897b7\",\n \"b450500-eb84-42dc-a79f-5e7b1fe897c8\"\n ]\n },\n {\n \"filter\": \"low_data_availability\",\n \"exclude_low_data_availability\": true\n }\n ],\n \"weights\": [\n {\n \"weight\": \"skills_match\",\n \"value\": 1\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://{tenant_name}.{region}.techwolf.ai/employees/{external_id}/matching_jobs")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"filters\": [\n {\n \"filter\": \"last_updated\",\n \"value\": \"2022-01-01\",\n \"operator\": \"lt\"\n },\n {\n \"filter\": \"custom_property_equal\",\n \"from_entity_property\": \"desired_wage\",\n \"to_entity_property\": \"wage\"\n },\n {\n \"filter\": \"custom_property\",\n \"property_name\": \"direct_manager\",\n \"property_value\": \"John Doe\"\n },\n {\n \"filter\": \"custom_property_is_in\",\n \"from_entity_property\": \"required_drivers_license\",\n \"to_entity_property\": \"drivers_licenses\"\n },\n {\n \"filter\": \"custom_property_is_in_list\",\n \"property_name\": \"drivers_license\",\n \"possible_values\": [\n \"C\",\n \"CE\"\n ]\n },\n {\n \"filter\": \"custom_property_contains\",\n \"from_entity_property\": \"shift_regime_codes\",\n \"to_entity_property\": \"desired_regime\"\n },\n {\n \"filter\": \"custom_property_list_overlap\",\n \"from_entity_property\": \"desired_industries\",\n \"to_entity_property\": \"industries\"\n },\n {\n \"filter\": \"custom_property_contains_element\",\n \"property_name\": \"industries\",\n \"property_value\": \"electronics\"\n },\n {\n \"filter\": \"external_id_is_in_list\",\n \"external_ids\": [\n \"c350500-eb84-42dc-a79f-5e7b1fe897b7\",\n \"b450500-eb84-42dc-a79f-5e7b1fe897c8\"\n ]\n },\n {\n \"filter\": \"low_data_availability\",\n \"exclude_low_data_availability\": true\n }\n ],\n \"weights\": [\n {\n \"weight\": \"skills_match\",\n \"value\": 1\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{tenant_name}.{region}.techwolf.ai/employees/{external_id}/matching_jobs")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"filters\": [\n {\n \"filter\": \"last_updated\",\n \"value\": \"2022-01-01\",\n \"operator\": \"lt\"\n },\n {\n \"filter\": \"custom_property_equal\",\n \"from_entity_property\": \"desired_wage\",\n \"to_entity_property\": \"wage\"\n },\n {\n \"filter\": \"custom_property\",\n \"property_name\": \"direct_manager\",\n \"property_value\": \"John Doe\"\n },\n {\n \"filter\": \"custom_property_is_in\",\n \"from_entity_property\": \"required_drivers_license\",\n \"to_entity_property\": \"drivers_licenses\"\n },\n {\n \"filter\": \"custom_property_is_in_list\",\n \"property_name\": \"drivers_license\",\n \"possible_values\": [\n \"C\",\n \"CE\"\n ]\n },\n {\n \"filter\": \"custom_property_contains\",\n \"from_entity_property\": \"shift_regime_codes\",\n \"to_entity_property\": \"desired_regime\"\n },\n {\n \"filter\": \"custom_property_list_overlap\",\n \"from_entity_property\": \"desired_industries\",\n \"to_entity_property\": \"industries\"\n },\n {\n \"filter\": \"custom_property_contains_element\",\n \"property_name\": \"industries\",\n \"property_value\": \"electronics\"\n },\n {\n \"filter\": \"external_id_is_in_list\",\n \"external_ids\": [\n \"c350500-eb84-42dc-a79f-5e7b1fe897b7\",\n \"b450500-eb84-42dc-a79f-5e7b1fe897c8\"\n ]\n },\n {\n \"filter\": \"low_data_availability\",\n \"exclude_low_data_availability\": true\n }\n ],\n \"weights\": [\n {\n \"weight\": \"skills_match\",\n \"value\": 1\n }\n ]\n}"
response = http.request(request)
puts response.read_body[
{
"job_id": "b003505-eb84-42dc-a79f-5e7b1fe897b7",
"employee_id": "a3903505-eb84-42dc-a79f-5e7b1fe897b7",
"score": 0.87657
}
]
Job Matching
Get the top matching Jobs for an Employee
Get an export of the best matching Jobs for an Employee. Only active Jobs are included in the export. The Employee’s current Job is excluded from the results.
Get the top matching Jobs for an Employee
curl --request POST \
--url https://{tenant_name}.{region}.techwolf.ai/employees/{external_id}/matching_jobs \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"filters": [
{
"filter": "last_updated",
"value": "2022-01-01",
"operator": "lt"
},
{
"filter": "custom_property_equal",
"from_entity_property": "desired_wage",
"to_entity_property": "wage"
},
{
"filter": "custom_property",
"property_name": "direct_manager",
"property_value": "John Doe"
},
{
"filter": "custom_property_is_in",
"from_entity_property": "required_drivers_license",
"to_entity_property": "drivers_licenses"
},
{
"filter": "custom_property_is_in_list",
"property_name": "drivers_license",
"possible_values": [
"C",
"CE"
]
},
{
"filter": "custom_property_contains",
"from_entity_property": "shift_regime_codes",
"to_entity_property": "desired_regime"
},
{
"filter": "custom_property_list_overlap",
"from_entity_property": "desired_industries",
"to_entity_property": "industries"
},
{
"filter": "custom_property_contains_element",
"property_name": "industries",
"property_value": "electronics"
},
{
"filter": "external_id_is_in_list",
"external_ids": [
"c350500-eb84-42dc-a79f-5e7b1fe897b7",
"b450500-eb84-42dc-a79f-5e7b1fe897c8"
]
},
{
"filter": "low_data_availability",
"exclude_low_data_availability": true
}
],
"weights": [
{
"weight": "skills_match",
"value": 1
}
]
}
'import requests
url = "https://{tenant_name}.{region}.techwolf.ai/employees/{external_id}/matching_jobs"
payload = {
"filters": [
{
"filter": "last_updated",
"value": "2022-01-01",
"operator": "lt"
},
{
"filter": "custom_property_equal",
"from_entity_property": "desired_wage",
"to_entity_property": "wage"
},
{
"filter": "custom_property",
"property_name": "direct_manager",
"property_value": "John Doe"
},
{
"filter": "custom_property_is_in",
"from_entity_property": "required_drivers_license",
"to_entity_property": "drivers_licenses"
},
{
"filter": "custom_property_is_in_list",
"property_name": "drivers_license",
"possible_values": ["C", "CE"]
},
{
"filter": "custom_property_contains",
"from_entity_property": "shift_regime_codes",
"to_entity_property": "desired_regime"
},
{
"filter": "custom_property_list_overlap",
"from_entity_property": "desired_industries",
"to_entity_property": "industries"
},
{
"filter": "custom_property_contains_element",
"property_name": "industries",
"property_value": "electronics"
},
{
"filter": "external_id_is_in_list",
"external_ids": ["c350500-eb84-42dc-a79f-5e7b1fe897b7", "b450500-eb84-42dc-a79f-5e7b1fe897c8"]
},
{
"filter": "low_data_availability",
"exclude_low_data_availability": True
}
],
"weights": [
{
"weight": "skills_match",
"value": 1
}
]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
filters: [
{filter: 'last_updated', value: '2022-01-01', operator: 'lt'},
{
filter: 'custom_property_equal',
from_entity_property: 'desired_wage',
to_entity_property: 'wage'
},
{
filter: 'custom_property',
property_name: 'direct_manager',
property_value: 'John Doe'
},
{
filter: 'custom_property_is_in',
from_entity_property: 'required_drivers_license',
to_entity_property: 'drivers_licenses'
},
{
filter: 'custom_property_is_in_list',
property_name: 'drivers_license',
possible_values: ['C', 'CE']
},
{
filter: 'custom_property_contains',
from_entity_property: 'shift_regime_codes',
to_entity_property: 'desired_regime'
},
{
filter: 'custom_property_list_overlap',
from_entity_property: 'desired_industries',
to_entity_property: 'industries'
},
{
filter: 'custom_property_contains_element',
property_name: 'industries',
property_value: 'electronics'
},
{
filter: 'external_id_is_in_list',
external_ids: ['c350500-eb84-42dc-a79f-5e7b1fe897b7', 'b450500-eb84-42dc-a79f-5e7b1fe897c8']
},
{filter: 'low_data_availability', exclude_low_data_availability: true}
],
weights: [{weight: 'skills_match', value: 1}]
})
};
fetch('https://{tenant_name}.{region}.techwolf.ai/employees/{external_id}/matching_jobs', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://{tenant_name}.{region}.techwolf.ai/employees/{external_id}/matching_jobs",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'filters' => [
[
'filter' => 'last_updated',
'value' => '2022-01-01',
'operator' => 'lt'
],
[
'filter' => 'custom_property_equal',
'from_entity_property' => 'desired_wage',
'to_entity_property' => 'wage'
],
[
'filter' => 'custom_property',
'property_name' => 'direct_manager',
'property_value' => 'John Doe'
],
[
'filter' => 'custom_property_is_in',
'from_entity_property' => 'required_drivers_license',
'to_entity_property' => 'drivers_licenses'
],
[
'filter' => 'custom_property_is_in_list',
'property_name' => 'drivers_license',
'possible_values' => [
'C',
'CE'
]
],
[
'filter' => 'custom_property_contains',
'from_entity_property' => 'shift_regime_codes',
'to_entity_property' => 'desired_regime'
],
[
'filter' => 'custom_property_list_overlap',
'from_entity_property' => 'desired_industries',
'to_entity_property' => 'industries'
],
[
'filter' => 'custom_property_contains_element',
'property_name' => 'industries',
'property_value' => 'electronics'
],
[
'filter' => 'external_id_is_in_list',
'external_ids' => [
'c350500-eb84-42dc-a79f-5e7b1fe897b7',
'b450500-eb84-42dc-a79f-5e7b1fe897c8'
]
],
[
'filter' => 'low_data_availability',
'exclude_low_data_availability' => true
]
],
'weights' => [
[
'weight' => 'skills_match',
'value' => 1
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://{tenant_name}.{region}.techwolf.ai/employees/{external_id}/matching_jobs"
payload := strings.NewReader("{\n \"filters\": [\n {\n \"filter\": \"last_updated\",\n \"value\": \"2022-01-01\",\n \"operator\": \"lt\"\n },\n {\n \"filter\": \"custom_property_equal\",\n \"from_entity_property\": \"desired_wage\",\n \"to_entity_property\": \"wage\"\n },\n {\n \"filter\": \"custom_property\",\n \"property_name\": \"direct_manager\",\n \"property_value\": \"John Doe\"\n },\n {\n \"filter\": \"custom_property_is_in\",\n \"from_entity_property\": \"required_drivers_license\",\n \"to_entity_property\": \"drivers_licenses\"\n },\n {\n \"filter\": \"custom_property_is_in_list\",\n \"property_name\": \"drivers_license\",\n \"possible_values\": [\n \"C\",\n \"CE\"\n ]\n },\n {\n \"filter\": \"custom_property_contains\",\n \"from_entity_property\": \"shift_regime_codes\",\n \"to_entity_property\": \"desired_regime\"\n },\n {\n \"filter\": \"custom_property_list_overlap\",\n \"from_entity_property\": \"desired_industries\",\n \"to_entity_property\": \"industries\"\n },\n {\n \"filter\": \"custom_property_contains_element\",\n \"property_name\": \"industries\",\n \"property_value\": \"electronics\"\n },\n {\n \"filter\": \"external_id_is_in_list\",\n \"external_ids\": [\n \"c350500-eb84-42dc-a79f-5e7b1fe897b7\",\n \"b450500-eb84-42dc-a79f-5e7b1fe897c8\"\n ]\n },\n {\n \"filter\": \"low_data_availability\",\n \"exclude_low_data_availability\": true\n }\n ],\n \"weights\": [\n {\n \"weight\": \"skills_match\",\n \"value\": 1\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://{tenant_name}.{region}.techwolf.ai/employees/{external_id}/matching_jobs")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"filters\": [\n {\n \"filter\": \"last_updated\",\n \"value\": \"2022-01-01\",\n \"operator\": \"lt\"\n },\n {\n \"filter\": \"custom_property_equal\",\n \"from_entity_property\": \"desired_wage\",\n \"to_entity_property\": \"wage\"\n },\n {\n \"filter\": \"custom_property\",\n \"property_name\": \"direct_manager\",\n \"property_value\": \"John Doe\"\n },\n {\n \"filter\": \"custom_property_is_in\",\n \"from_entity_property\": \"required_drivers_license\",\n \"to_entity_property\": \"drivers_licenses\"\n },\n {\n \"filter\": \"custom_property_is_in_list\",\n \"property_name\": \"drivers_license\",\n \"possible_values\": [\n \"C\",\n \"CE\"\n ]\n },\n {\n \"filter\": \"custom_property_contains\",\n \"from_entity_property\": \"shift_regime_codes\",\n \"to_entity_property\": \"desired_regime\"\n },\n {\n \"filter\": \"custom_property_list_overlap\",\n \"from_entity_property\": \"desired_industries\",\n \"to_entity_property\": \"industries\"\n },\n {\n \"filter\": \"custom_property_contains_element\",\n \"property_name\": \"industries\",\n \"property_value\": \"electronics\"\n },\n {\n \"filter\": \"external_id_is_in_list\",\n \"external_ids\": [\n \"c350500-eb84-42dc-a79f-5e7b1fe897b7\",\n \"b450500-eb84-42dc-a79f-5e7b1fe897c8\"\n ]\n },\n {\n \"filter\": \"low_data_availability\",\n \"exclude_low_data_availability\": true\n }\n ],\n \"weights\": [\n {\n \"weight\": \"skills_match\",\n \"value\": 1\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{tenant_name}.{region}.techwolf.ai/employees/{external_id}/matching_jobs")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"filters\": [\n {\n \"filter\": \"last_updated\",\n \"value\": \"2022-01-01\",\n \"operator\": \"lt\"\n },\n {\n \"filter\": \"custom_property_equal\",\n \"from_entity_property\": \"desired_wage\",\n \"to_entity_property\": \"wage\"\n },\n {\n \"filter\": \"custom_property\",\n \"property_name\": \"direct_manager\",\n \"property_value\": \"John Doe\"\n },\n {\n \"filter\": \"custom_property_is_in\",\n \"from_entity_property\": \"required_drivers_license\",\n \"to_entity_property\": \"drivers_licenses\"\n },\n {\n \"filter\": \"custom_property_is_in_list\",\n \"property_name\": \"drivers_license\",\n \"possible_values\": [\n \"C\",\n \"CE\"\n ]\n },\n {\n \"filter\": \"custom_property_contains\",\n \"from_entity_property\": \"shift_regime_codes\",\n \"to_entity_property\": \"desired_regime\"\n },\n {\n \"filter\": \"custom_property_list_overlap\",\n \"from_entity_property\": \"desired_industries\",\n \"to_entity_property\": \"industries\"\n },\n {\n \"filter\": \"custom_property_contains_element\",\n \"property_name\": \"industries\",\n \"property_value\": \"electronics\"\n },\n {\n \"filter\": \"external_id_is_in_list\",\n \"external_ids\": [\n \"c350500-eb84-42dc-a79f-5e7b1fe897b7\",\n \"b450500-eb84-42dc-a79f-5e7b1fe897c8\"\n ]\n },\n {\n \"filter\": \"low_data_availability\",\n \"exclude_low_data_availability\": true\n }\n ],\n \"weights\": [\n {\n \"weight\": \"skills_match\",\n \"value\": 1\n }\n ]\n}"
response = http.request(request)
puts response.read_body[
{
"job_id": "b003505-eb84-42dc-a79f-5e7b1fe897b7",
"employee_id": "a3903505-eb84-42dc-a79f-5e7b1fe897b7",
"score": 0.87657
}
]
Authorizations
The access token received from the authorization server in the OAuth 2.0 flow.
Path Parameters
The unique ID in your system, consisting of alphanumeric characters, hyphens and underscores.
Required string length:
1 - 100Pattern:
[a-zA-Z0-9_-]+Example:
"a3903505-eb84-42dc-a79f-5e7b1fe897b7"
Query Parameters
The minimum score of the results. Due to approximations for fast result-delivery, there might be records with a score slightly lower than the minimum.
Required range:
0 <= x <= 1Example:
0.7
The maximal number of results returned.
Required range:
1 <= x <= 100Example:
10
The rank offset for returned matches, return matches starting from rank offset up to rank offset+limit.
Required range:
x >= 0If set to explained, the response will include an explanation of the match.
Available options:
simple, explained Example:
"explained"
When set to true, includes matches where the Employee is overqualified for the Job. Overqualified matches are those where the Employee's skill level significantly exceeds the requirements. This filter will only work if proficiency matching is enabled on the tenant.
Example:
true
The minimum ratio of critical skills that must be matched. Only matches meeting or exceeding this ratio will be returned. When not provided, no critical skills ratio filtering is applied. This filter will only work if the "use_criticalities" feature flag is enabled.
Required range:
0 <= x <= 1Example:
0.8
The external vendor vocabulary you want to see the Skills displayed in. This will only work for vendors that are activated on your tenant.
Available options:
techwolf, workday, sap_attribute_library Example:
"workday"
The display language used for Skill names. Altering the vocabulary language does not change the Skill Profile; it solely changes the way it is displayed. If not specified, the default language (en_uk) will be used. The en language is an alias for en_uk. IETF BCP 47 language tags (e.g. fr-FR, zh-CN) are also accepted and mapped to their internal equivalents.
Vendor-specific availability: Only the following languages are available for the default TechWolf vocabulary: en, en_uk, en_us, de, fr, nl. The additional languages (es, fr_ca, it, ja, ko, pt_br, zh_cn, zh_tw, sv, fi, da, no) are only available when the request is scoped to the workday vendor (via external_vendor=workday) and the tenant's Workday vocabulary includes them. Use GET /taxonomy/skills/languages to discover the exact set of languages available for a given vendor in your tenant.
Available options:
en, en_uk, en_us, de, fr, nl, es, fr_ca, it, ja, ko, pt_br, zh_cn, zh_tw, sv, fi, da, no Additional entity attributes that will be included in the response body. This query parameter can be added multiple times to include more attributes. When include entity is used, the response will include the name of the Job and the external ID of the corresponding Job Family.
Available options:
custom_properties, entity Example:
["custom_properties", "entity"]
Body
application/json
List of filters to be applied on the entities before matching
filters
(last_updated · object | custom_property_equal · object | custom_property · object | custom_property_is_in · object | custom_property_is_in_list · object | custom_property_contains · object | custom_property_contains_element · object | custom_property_list_overlap · object | external_id_is_in_list · object | low_data_availability · object)[]
required
- last_updated
- custom_property_equal
- custom_property
- custom_property_is_in
- custom_property_is_in_list
- custom_property_contains
- custom_property_contains_element
- custom_property_list_overlap
- external_id_is_in_list
- low_data_availability
Show child attributes
Show child attributes
Example:
[ { "filter": "last_updated", "value": "2022-01-01", "operator": "lt" }, { "filter": "custom_property_equal", "from_entity_property": "desired_wage", "to_entity_property": "wage" }, { "filter": "custom_property", "property_name": "direct_manager", "property_value": "John Doe" }, { "filter": "custom_property_is_in", "from_entity_property": "required_drivers_license", "to_entity_property": "drivers_licenses" }, { "filter": "custom_property_is_in_list", "property_name": "drivers_license", "possible_values": ["C", "CE"] }, { "filter": "custom_property_contains", "from_entity_property": "shift_regime_codes", "to_entity_property": "desired_regime" }, { "filter": "custom_property_list_overlap", "from_entity_property": "desired_industries", "to_entity_property": "industries" }, { "filter": "custom_property_contains_element", "property_name": "industries", "property_value": "electronics" }, { "filter": "external_id_is_in_list", "external_ids": [ "c350500-eb84-42dc-a79f-5e7b1fe897b7", "b450500-eb84-42dc-a79f-5e7b1fe897c8" ] }, { "filter": "low_data_availability", "exclude_low_data_availability": true } ]
List of weights to be applied during matching. Currently, Skills match weight is the only supported weight for Job matching and is set to 1.0 by default.
Show child attributes
Show child attributes
Example:
[{ "weight": "skills_match", "value": 1 }]
Response
OK
Note: When proficiency matching or criticality matching is enabled on the tenant, additional fields will be included in the response. See the PropertiesSimple and PropertiesExplained schemas for details on which fields are included.
- Simple
- Custom Properties
- Entity
- Explained
- PropertiesSimple
- PropertiesExplained
List of match results.
Show child attributes
Show child attributes
Was this page helpful?