Export Job Skill Profiles. - 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/skill_profiles \
  --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"
      ]
    }
  ],
  "include": [
    "low_data_availability_flag",
    "proficiency_level",
    "proficiency_float",
    "critical"
  ],
  "output_skills_sorting": "alphabetical"
}'

{
  "has_next": true,
  "records": [
    {
      "external_id": "5cbdbdbe-5f44-4423-8157-520f8a2f429a",
      "low_data_availability": false,
      "skills": [
        {
          "skill_id": "8313fe8a-f39e-4a35-8c82-93b46c3de9bb",
          "skill": "Balance Sheet",
          "skill_types": [
            {
              "skill_type": "Job-Specific",
              "is_common": true
            }
          ],
          "domain_name": "Finance",
          "validation_state": "validated",
          "proficiency_level": 2,
          "proficiency_float": 0.66,
          "critical": false
        },
        {
          "skill_id": "bdb5ee3f-8ba0-4c40-92b2-0277431ae069",
          "skill": "IFRS",
          "skill_types": [
            {
              "skill_type": "Job-Specific"
            }
          ],
          "domain_name": "Finance",
          "validation_state": "initially_validated",
          "proficiency_level": 2,
          "proficiency_float": 0.66,
          "critical": null
        }
      ]
    },
    {
      "external_id": "61a6e076-d780-11ec-9d64-0242ac120002",
      "low_data_availability": false,
      "skills": [
        {
          "skill": "Machine Learning",
          "skill_id": "ac3a733e-b258-438d-8d39-9a2837a10e11",
          "skill_types": [
            {
              "skill_type": "Family-Specific"
            }
          ],
          "domain_name": "Data Science",
          "validation_state": "validated",
          "proficiency_level": 1,
          "proficiency_float": 0.33,
          "critical": true
        },
        {
          "skill": "Python",
          "skill_id": "4b85469d-6729-4d70-9876-a0faa2a2f63b",
          "skill_types": [
            {
              "skill_type": "Job-Specific"
            }
          ],
          "domain_name": "Programming",
          "validation_state": "validated",
          "proficiency_level": null,
          "proficiency_float": null,
          "critical": true
        }
      ]
    }
  ],
  "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

domain_namespace

enum<string>

default:techwolf

The Domain namespace determines the Domains the Skills will be mapped to. Using techwolf will map them to the default TechWolf domains. Using taxonomy will map them to the custom Domains defined in your Taxonomy. Using adaptive will map the Skills to the Domains in the custom Taxonomy if there is one present, otherwise it will fall back to the default Techwolf Domains.

Available options:

techwolf,

taxonomy,

adaptive

response_format

enum<string>

default:list

Defines the format of the returned Skill Profile.

Available options:

list,

hierarchy

Example:

"list"

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"
    ]
  }
]

include

enum<string>[]

Additional attributes that will be included in the response body. This query parameter can be added multiple times to include more attributes.

Available options:

low_data_availability_flag,

skill_validation_state,

proficiency_level,

proficiency_float,

critical

Example:

[
  "low_data_availability_flag",
  "proficiency_level",
  "proficiency_float",
  "critical"
]

output_skills_sorting

enum<string>

default:alphabetical

Sort the Skills in the results alphabetically or by decreasing confidence.

Available options:

alphabetical,

confidence

Example:

"alphabetical"

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.

The default Skill Profile result is returned. The profile consists of a list of Skills with their Domain names and Skill types.

records.external_id

string

required

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

Required string length: 1 - 100

Example:

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

records.skills

object[]

required

The Skills contained in this profile.

Default structure for an individual Skill.

records.skills.skill

string

required

The name of the Skill.

Minimum length: 1

Example:

"Machine Learning"

records.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.skills.skill_types

object[]

required

A list of skill types.

A Skill type.

records.skills.domain_name

string

required

The Domain name of the Skill.

Minimum length: 1

Example:

"Data Science"

records.skills.validation_state

enum<string>

The validation state of the Skill. "initially_validated" indicates that the Skill was accepted from the suggested skill profile during the initial Job creation. "validated" indicates that the Skill was explicitly validated using Job feedback.

Available options:

initially_validated,

validated

Example:

"initially_validated"

records.skills.proficiency_level

number | null

The required proficiency level for this Skill that is associated with the entity. It cannot be greater than the maximum proficiency level (default levels are 1-2-3). <br/> If the proficiency level is not set, the default proficiency level is returned. If the proficiency level is explicitly set to null, null is returned.

Required range: x >= 1

Example:

3

records.skills.proficiency_float

number | null

The required proficiency level for this Skill that is associated with the entity. If the proficiency level is explicitly set to null, null is returned.

Required range: 0 < x <= 1

Example:

0.5

records.skills.critical

boolean | null

Indicates whether the Skill is critical for the entity. If there is no information about the criticality of the Skill, null is returned.

Example:

true

records.low_data_availability

boolean

Flag indicating whether sufficient data is available for qualitative skill inference for a given entity.

Example:

false

Example:

[
  {
    "external_id": "5cbdbdbe-5f44-4423-8157-520f8a2f429a",
    "low_data_availability": false,
    "skills": [
      {
        "skill_id": "8313fe8a-f39e-4a35-8c82-93b46c3de9bb",
        "skill": "Balance Sheet",
        "skill_types": [
          {
            "skill_type": "Job-Specific",
            "is_common": true
          }
        ],
        "domain_name": "Finance",
        "validation_state": "validated",
        "proficiency_level": 2,
        "proficiency_float": 0.66,
        "critical": false
      },
      {
        "skill_id": "bdb5ee3f-8ba0-4c40-92b2-0277431ae069",
        "skill": "IFRS",
        "skill_types": [{ "skill_type": "Job-Specific" }],
        "domain_name": "Finance",
        "validation_state": "initially_validated",
        "proficiency_level": 2,
        "proficiency_float": 0.66,
        "critical": null
      }
    ]
  },
  {
    "external_id": "61a6e076-d780-11ec-9d64-0242ac120002",
    "low_data_availability": false,
    "skills": [
      {
        "skill": "Machine Learning",
        "skill_id": "ac3a733e-b258-438d-8d39-9a2837a10e11",
        "skill_types": [{ "skill_type": "Family-Specific" }],
        "domain_name": "Data Science",
        "validation_state": "validated",
        "proficiency_level": 1,
        "proficiency_float": 0.33,
        "critical": true
      },
      {
        "skill": "Python",
        "skill_id": "4b85469d-6729-4d70-9876-a0faa2a2f63b",
        "skill_types": [{ "skill_type": "Job-Specific" }],
        "domain_name": "Programming",
        "validation_state": "validated",
        "proficiency_level": null,
        "proficiency_float": null,
        "critical": true
      }
    ]
  }
]

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.

The default Skill Profile result is returned. The profile consists of a list of Skills with their Domain names and Skill types.

records.external_id

string

required

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

Required string length: 1 - 100

Example:

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

records.skills

object[]

required

The Skills contained in this profile.

Default structure for an individual Skill.

records.skills.skill

string

required

The name of the Skill.

Minimum length: 1

Example:

"Machine Learning"

records.skills.skill_id

string

required

Required string length: 1 - 100

Example:

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

records.skills.skill_types

object[]

required

A list of skill types.

A Skill type.

records.skills.domain_name

string

required

The Domain name of the Skill.

Minimum length: 1

Example:

"Data Science"

records.skills.validation_state

enum<string>

Available options:

initially_validated,

validated

Example:

"initially_validated"

records.skills.proficiency_level

number | null

Required range: x >= 1

Example:

3

records.skills.proficiency_float

number | null

The required proficiency level for this Skill that is associated with the entity. If the proficiency level is explicitly set to null, null is returned.

Required range: 0 < x <= 1

Example:

0.5

records.skills.critical

boolean | null

Indicates whether the Skill is critical for the entity. If there is no information about the criticality of the Skill, null is returned.

Example:

true

records.low_data_availability

boolean

Flag indicating whether sufficient data is available for qualitative skill inference for a given entity.

Example:

false

Example:

[
  {
    "external_id": "5cbdbdbe-5f44-4423-8157-520f8a2f429a",
    "low_data_availability": false,
    "skills": [
      {
        "skill_id": "8313fe8a-f39e-4a35-8c82-93b46c3de9bb",
        "skill": "Balance Sheet",
        "skill_types": [
          {
            "skill_type": "Job-Specific",
            "is_common": true
          }
        ],
        "domain_name": "Finance",
        "validation_state": "validated",
        "proficiency_level": 2,
        "proficiency_float": 0.66,
        "critical": false
      },
      {
        "skill_id": "bdb5ee3f-8ba0-4c40-92b2-0277431ae069",
        "skill": "IFRS",
        "skill_types": [{ "skill_type": "Job-Specific" }],
        "domain_name": "Finance",
        "validation_state": "initially_validated",
        "proficiency_level": 2,
        "proficiency_float": 0.66,
        "critical": null
      }
    ]
  },
  {
    "external_id": "61a6e076-d780-11ec-9d64-0242ac120002",
    "low_data_availability": false,
    "skills": [
      {
        "skill": "Machine Learning",
        "skill_id": "ac3a733e-b258-438d-8d39-9a2837a10e11",
        "skill_types": [{ "skill_type": "Family-Specific" }],
        "domain_name": "Data Science",
        "validation_state": "validated",
        "proficiency_level": 1,
        "proficiency_float": 0.33,
        "critical": true
      },
      {
        "skill": "Python",
        "skill_id": "4b85469d-6729-4d70-9876-a0faa2a2f63b",
        "skill_types": [{ "skill_type": "Job-Specific" }],
        "domain_name": "Programming",
        "validation_state": "validated",
        "proficiency_level": null,
        "proficiency_float": null,
        "critical": true
      }
    ]
  }
]

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.

The response format formats the Skills in a hierarchical structure. When a Taxonomy is availabe it contains Domains, Skill Clusters and Skills. If it is a 4-level Taxonomy, there is a Subdomain layer between Domains and Skill Clusters. If no Taxonomy is available, the Skills are grouped under their default Techwolf Domain.

records.domains

object[]

required

Domains of the Skills in the Skill Profile. If no Taxonomy is avaiable, these are the Techwolf Domains.

records.external_id

string

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

Required string length: 1 - 100

Example:

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

records.low_data_availability

boolean

Flag indicating whether sufficient data is available for qualitative skill inference for a given entity.

Example:

false

records.skills_outside_taxonomy

object[]

List of Skills that are outside of the Taxonomy. This field is only present when a Taxonomy is available.

Default structure for an individual Skill.

Example:

[
  {
    "external_id": "5cbdbdbe-5f44-4423-8157-520f8a2f429a",
    "low_data_availability": false,
    "domains": [
      {
        "domain_name": "Computer Science",
        "external_id": "d8b6e1a3-3b0f-4a0f-bec9-52f8452d4e6c",
        "subdomains": [
          {
            "subdomain_name": "Software Engineering",
            "external_id": "cb62f1b7-d6e2-4f8c-b55b-3a25d4861d32",
            "skill_clusters": [
              {
                "skill_cluster_name": "Programming Languages",
                "external_id": "f074ea9e-5431-4e8d-992e-2abe21868b45",
                "skills": [
                  {
                    "skill": "Python",
                    "skill_id": "4dba81ae-9a4d-4863-8157-520f8a2f4c59",
                    "validation_state": "suggested"
                  },
                  {
                    "skill": "Java",
                    "skill_id": "15aa59ae-9a4d-4863-8157-520f8a2f4e64",
                    "validation_state": "suggested"
                  }
                ]
              }
            ]
          }
        ]
      }
    ],
    "skills_outside_taxonomy": [
      {
        "skill": "C++",
        "skill_id": "8a7a4f7b-b8ef-4f82-bb8e-7469f876cf5c",
        "validation_state": "suggested"
      },
      {
        "skill": "C#",
        "skill_id": "72adf84b-24a8-41d6-a4b4-e6f53c473cb3",
        "validation_state": "suggested"
      }
    ]
  }
]

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 Skill Clusters data.Export Job Suggested Skill Profiles.

curl --request POST \
  --url https://{tenant_name}.{region}.techwolf.ai/job_architecture/export/jobs/skill_profiles \
  --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"
      ]
    }
  ],
  "include": [
    "low_data_availability_flag",
    "proficiency_level",
    "proficiency_float",
    "critical"
  ],
  "output_skills_sorting": "alphabetical"
}'

{
  "has_next": true,
  "records": [
    {
      "external_id": "5cbdbdbe-5f44-4423-8157-520f8a2f429a",
      "low_data_availability": false,
      "skills": [
        {
          "skill_id": "8313fe8a-f39e-4a35-8c82-93b46c3de9bb",
          "skill": "Balance Sheet",
          "skill_types": [
            {
              "skill_type": "Job-Specific",
              "is_common": true
            }
          ],
          "domain_name": "Finance",
          "validation_state": "validated",
          "proficiency_level": 2,
          "proficiency_float": 0.66,
          "critical": false
        },
        {
          "skill_id": "bdb5ee3f-8ba0-4c40-92b2-0277431ae069",
          "skill": "IFRS",
          "skill_types": [
            {
              "skill_type": "Job-Specific"
            }
          ],
          "domain_name": "Finance",
          "validation_state": "initially_validated",
          "proficiency_level": 2,
          "proficiency_float": 0.66,
          "critical": null
        }
      ]
    },
    {
      "external_id": "61a6e076-d780-11ec-9d64-0242ac120002",
      "low_data_availability": false,
      "skills": [
        {
          "skill": "Machine Learning",
          "skill_id": "ac3a733e-b258-438d-8d39-9a2837a10e11",
          "skill_types": [
            {
              "skill_type": "Family-Specific"
            }
          ],
          "domain_name": "Data Science",
          "validation_state": "validated",
          "proficiency_level": 1,
          "proficiency_float": 0.33,
          "critical": true
        },
        {
          "skill": "Python",
          "skill_id": "4b85469d-6729-4d70-9876-a0faa2a2f63b",
          "skill_types": [
            {
              "skill_type": "Job-Specific"
            }
          ],
          "domain_name": "Programming",
          "validation_state": "validated",
          "proficiency_level": null,
          "proficiency_float": null,
          "critical": true
        }
      ]
    }
  ],
  "next_starting_after": "61a6e076-d780-11ec-9d64-0242ac120002"
}