Export Job Skill market alignment. - TechWolf Developer Portal

API Documentation

API Versioning

Taxonomy

Domains
Subdomains
Skill Clusters
Skills
Taxonomy operations

Employees

CRUD
Skill Profile
Metrics
Search
Skill Events
Interactions
Suggestions

Job Families

CRUD
Skill Profile
Job Family Profile Data

Jobs

CRUD
Skill Profile
Job Profile Data
Metrics

Peer Groups

Peer Groups

Vacancies

CRUD
Skill Profile
Metrics
Search

Courses

CRUD
Skill Profile
Metrics

Skill Clusters

CRUD
Skill Profile
Metrics

External Companies

CRUD
Search

Skills

Skill Search
Skill Gaps
Skill Lookup

Organisational Structure

Organisational Units

Custom Properties

Definitions
Properties

Matchmaking

Vacancy Matching
Course Recommendations
External Company Matching
Job Matching
Job Family Matching
Match Feedback

Matching Configuration

Filters

Export

Reports

General Reports
Employee Reports
Vacancy Reports
Job Reports
Data Maturity Scan

Version

Version

curl --request POST \
  --url https://{tenant_name}.{region}.techwolf.ai/job_architecture/export/jobs/market_alignment \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "limit": 10,
  "starting_after": "4cbdbabe-5644-4423-8157-520f8a2f429a",
  "filters": [
    {
      "filter": "last_updated",
      "value": "2022-01-01",
      "operator": "lt"
    },
    {
      "filter": "job_family_id_is_in_list",
      "job_family_ids": [
        "5cbdbdbe-5f44-4423-8157-520f8a2f429a",
        "62d2c013-ab77-410e-b5fb-2f96eed9c1db"
      ]
    }
  ]
}'

{
  "has_next": true,
  "records": [
    {
      "job_id": "b003505-eb84-42dc-a79f-5e7b1fe897b7",
      "alignment_scores": [
        {
          "peer_group": "B2B",
          "job_to_peer_score": 0.85,
          "peer_to_job_score": 0.9
        },
        {
          "peer_group": "B2C",
          "job_to_peer_score": 0.95,
          "peer_to_job_score": 0.8
        }
      ]
    }
  ],
  "next_starting_after": "61a6e076-d780-11ec-9d64-0242ac120002"
}

Authorizations

Authorization

string

header

required

The access token received from the authorization server in the OAuth 2.0 flow.

Query Parameters

response_format

enum<string>

default:simple

If set to explained, the response will include an explanation of the match.

Available options:

simple,

explained

Example:

"explained"

Body

application/json

limit

integer

required

The number of Jobs to show on a single page.

Required range: 1 <= x <= 100

Example:

10

starting_after

string

The external_id of the Job to continue looking from.

Maximum length: 100

Example:

"4cbdbabe-5644-4423-8157-520f8a2f429a"

filters

object[]

A set of filters used to apply on the exported Job Skill Profiles.

Example:

[
  {
    "filter": "last_updated",
    "value": "2022-01-01",
    "operator": "lt"
  },
  {
    "filter": "job_family_id_is_in_list",
    "job_family_ids": [
      "5cbdbdbe-5f44-4423-8157-520f8a2f429a",
      "62d2c013-ab77-410e-b5fb-2f96eed9c1db"
    ]
  }
]

Response

200

application/json

has_next

boolean

required

True when there is more data after this page.

Example:

true

records

object[]

required

A list containing the requested data for each entity, limited by the limit parameter.

A match result between a Job and its market Skill Profiles.

records.job_id

string

required

The unique ID in your system, consisting of alphanumeric characters, hyphens and underscores.

Required string length: 1 - 100

Example:

"b003505-eb84-42dc-a79f-5e7b1fe897b7"

records.alignment_scores

object[]

required

The market alignment scores for the Job, for every peer Skill Profile.

Example:

[
  {
    "peer_group": "B2B",
    "job_to_peer_score": 0.85,
    "peer_to_job_score": 0.9
  },
  {
    "peer_group": "B2C",
    "job_to_peer_score": 0.95,
    "peer_to_job_score": 0.8
  }
]

next_starting_after

string

The next starting_after value for pagination.

Maximum length: 100

Example:

"61a6e076-d780-11ec-9d64-0242ac120002"

has_next

boolean

required

True when there is more data after this page.

Example:

true

records

object[]

required

A list containing the requested data for each entity, limited by the limit parameter.

A match result between a Job and its market Skill Profiles.

records.job_id

string

required

The unique ID in your system, consisting of alphanumeric characters, hyphens and underscores.

Required string length: 1 - 100

Example:

"b003505-eb84-42dc-a79f-5e7b1fe897b7"

records.alignment_scores

object[]

required

The market alignment scores for the Job, for every peer Skill Profile.

Example:

[
  {
    "peer_group": "B2B",
    "job_to_peer_score": 0.85,
    "peer_to_job_score": 0.9
  },
  {
    "peer_group": "B2C",
    "job_to_peer_score": 0.95,
    "peer_to_job_score": 0.8
  }
]

next_starting_after

string

The next starting_after value for pagination.

Maximum length: 100

Example:

"61a6e076-d780-11ec-9d64-0242ac120002"

has_next

boolean

required

True when there is more data after this page.

Example:

true

records

object[]

required

A list containing the requested data for each entity, limited by the limit parameter.

A match result between a Job and its market Skill Profiles.

records.job_id

string

required

The unique ID in your system, consisting of alphanumeric characters, hyphens and underscores.

Required string length: 1 - 100

Example:

"b003505-eb84-42dc-a79f-5e7b1fe897b7"

records.alignment_scores

object[]

required

The market alignment scores for the Job, for every peer Skill Profile.

records.alignment_scores.peer_group

string

required

Name of the peer group.

Required string length: 1 - 255

Example:

"B2B"

records.alignment_scores.job_to_peer_score

number

required

The matching score between the Job and the peer Skill Profile, expressed as a number between 0 and 1. This indicates how well the Job Skill Profile covers the Skill requirements of the peer Skill Profile.

Required range: 0 <= x <= 1

records.alignment_scores.peer_to_job_score

number

required

The matching score between the peer Skill Profile and the Job, expressed as a number between 0 and 1. This indicates how well a peer Skill Profile covers the Skill requirements of the Job Skill Profile.

Required range: 0 <= x <= 1

records.alignment_scores.job_missing_skills

object[]

required

The list of Skills that are required by the peer Skill Profile but are missing from the Job Skill Profile.

Default structure for an individual Skill.

records.alignment_scores.peer_missing_skills

object[]

required

The list of Skills that are required by the Job Skill Profile but are missing from the peer Skill Profile.

Default structure for an individual Skill.

records.alignment_scores.overlapping_skills

object[]

required

The list of Skills that are either directly present or are sufficiently adjacent to present Skills in both the Job Skill Profile and the peer Skill Profile.

records.alignment_scores.overlapping_skills.skill_name

string

required

The name of the Skill.

Minimum length: 1

Example:

"Machine Learning"

records.alignment_scores.overlapping_skills.skill_id

string

required

The universal unique ID of the Skill, consisting of alphanumeric characters, hyphens and underscores. The Skill name connected to this id can be identified by either using the Skill Search endpoint or in any response body that contains that Skill.

Required string length: 1 - 100

Example:

"a3903505-eb84-42dc-a79f-5e7b1fe897b7"

records.alignment_scores.overlapping_skills.job_adjacent_skill_name

string

required

The name of the adjacent Skill in the Job Skill Profile.

Minimum length: 1

records.alignment_scores.overlapping_skills.job_adjacent_skill_id

string

required

The universally unique ID of the adjacent Skill in the Job Skill Profile, consisting of alphanumeric characters, hyphens and underscores. The Skill name connected to this ID can be identified by either using the Skill Search endpoint or in any response body that contains that Skill.

Required string length: 1 - 100

records.alignment_scores.overlapping_skills.job_adjacency_score

number

required

The adjacency score between the Skill and the adjacent Skill in the Job Skill Profile.

Required range: 0 <= x <= 1

records.alignment_scores.overlapping_skills.peer_adjacent_skill_name

string

required

The name of the adjacent Skill in the peer Skill Profile.

Minimum length: 1

records.alignment_scores.overlapping_skills.peer_adjacent_skill_id

string

required

The universally unique ID of the adjacent Skill in the peer Skill Profile, consisting of alphanumeric characters, hyphens and underscores. The Skill name connected to this ID can be identified by either using the Skill Search endpoint or in any response body that contains that Skill.

Required string length: 1 - 100

records.alignment_scores.overlapping_skills.peer_adjacency_score

number

required

The adjacency score between the Skill and the adjacent Skill in the peer Skill Profile.

Required range: 0 <= x <= 1

Example:

[
  {
    "peer_group": "B2B",
    "job_to_peer_score": 0.85,
    "peer_to_job_score": 0.9,
    "job_missing_skills": [
      {
        "skill_name": "Python",
        "skill_id": "4dba81ae-9a4d-4863-8157-520f8a2f4c59"
      }
    ],
    "peer_missing_skills": [
      {
        "skill_name": "Machine Learning",
        "skill_id": "a3903505-eb84-42dc-a79f-5e7b1fe897b7"
      }
    ],
    "overlapping_skills": [
      {
        "skill_name": "SQL",
        "skill_id": "c8c4b3a1-2d55-4dde-a71c-d7129c675a77",
        "job_adjacent_skill_name": "PostgreSQL",
        "job_adjacent_skill_id": "6d9fcb6e-7dfb-4d5f-9743-6e2c0c58c232",
        "job_adjacency_score": 0.7,
        "peer_adjacent_skill_name": "SQL",
        "peer_adjacent_skill_id": "c8c4b3a1-2d55-4dde-a71c-d7129c675a77",
        "peer_adjacency_score": 1
      }
    ]
  },
  {
    "peer_group": "B2C",
    "job_to_peer_score": 0.95,
    "peer_to_job_score": 0.8,
    "job_missing_skills": [
      {
        "skill_name": "Java",
        "skill_id": "15aa59ae-9a4d-4863-8157-520f8a2f4e64"
      }
    ],
    "peer_missing_skills": [
      {
        "skill_name": "C#",
        "skill_id": "72adf84b-24a8-41d6-a4b4-e6f53c473cb3"
      }
    ],
    "overlapping_skills": [
      {
        "skill_name": "JavaScript",
        "skill_id": "b2f1b6d0-983f-4f6e-a6a2-2b44806307b6",
        "job_adjacent_skill_name": "JavaScript",
        "job_adjacent_skill_id": "b2f1b6d0-983f-4f6e-a6a2-2b44806307b6",
        "job_adjacency_score": 1,
        "peer_adjacent_skill_name": "TypeScript",
        "peer_adjacent_skill_id": "6d9fcb6e-7dfb-4d5f-9743-6e2c0c58c232",
        "peer_adjacency_score": 0.7
      }
    ]
  }
]

next_starting_after

string

The next starting_after value for pagination.

Maximum length: 100

Example:

"61a6e076-d780-11ec-9d64-0242ac120002"

Was this page helpful?

Export Job external market Skill Profiles.Export Job Family Skill Profiles.

curl --request POST \
  --url https://{tenant_name}.{region}.techwolf.ai/job_architecture/export/jobs/market_alignment \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "limit": 10,
  "starting_after": "4cbdbabe-5644-4423-8157-520f8a2f429a",
  "filters": [
    {
      "filter": "last_updated",
      "value": "2022-01-01",
      "operator": "lt"
    },
    {
      "filter": "job_family_id_is_in_list",
      "job_family_ids": [
        "5cbdbdbe-5f44-4423-8157-520f8a2f429a",
        "62d2c013-ab77-410e-b5fb-2f96eed9c1db"
      ]
    }
  ]
}'

{
  "has_next": true,
  "records": [
    {
      "job_id": "b003505-eb84-42dc-a79f-5e7b1fe897b7",
      "alignment_scores": [
        {
          "peer_group": "B2B",
          "job_to_peer_score": 0.85,
          "peer_to_job_score": 0.9
        },
        {
          "peer_group": "B2C",
          "job_to_peer_score": 0.95,
          "peer_to_job_score": 0.8
        }
      ]
    }
  ],
  "next_starting_after": "61a6e076-d780-11ec-9d64-0242ac120002"
}