Skip to main content
Export Job Family Skill Profiles.
curl --request POST \
  --url https://{tenant_name}.{region}.techwolf.ai/job_architecture/export/job_families/skill_profiles \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "limit": 10,
  "starting_after": "4cbdbabe-5644-4423-8157-520f8a2f429a",
  "filters": [
    {
      "filter": "is_active",
      "is_active": true
    }
  ],
  "include": [
    "skill_validation_state",
    "proficiency_level",
    "proficiency_float",
    "critical"
  ],
  "output_skills_sorting": "alphabetical"
}'
{
  "has_next": true,
  "records": [
    {
      "external_id": "5cbdbdbe-5f44-4423-8157-520f8a2f429a",
      "skills": [
        {
          "skill_id": "8313fe8a-f39e-4a35-8c82-93b46c3de9bb",
          "skill": "Balance Sheet",
          "skill_types": [
            {
              "skill_type": "Family-Specific"
            }
          ],
          "domain_name": "Finance",
          "validation_state": "validated",
          "proficiency_level": 2,
          "proficiency_float": 0.4,
          "critical": false
        }
      ]
    },
    {
      "external_id": "61a6e076-d780-11ec-9d64-0242ac120002",
      "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.2,
          "critical": true
        },
        {
          "skill": "Python",
          "skill_id": "4b85469d-6729-4d70-9876-a0faa2a2f63b",
          "skill_types": [
            {
              "skill_type": "Family-Specific"
            }
          ],
          "domain_name": "Programming",
          "validation_state": "initially_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"

​
external_vendor
enum<string>

The external vendor vocabulary you want to see the Skills displayed in. This will only work for vendors that are activated on your tenant. When specified, the query parameter include=skill_validation_state will not work, as it is not supported on external vendor Skill Profiles.

Available options:
workday,
sap_attribute_library
Example:

"workday"

Body

application/json
​
limit
integer
required

The number of Job Families to show on a single page.

Required range: 1 <= x <= 100
Example:

10

​
starting_after
string

The external_id of the Job Family to continue looking from.

Maximum length: 100
Example:

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

​
filters
(is_active · object | last_updated · object)[]

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

  • is_active
  • last_updated
​
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.

Example:
[
  "skill_validation_state",
  "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

OK

  • List
  • Hierarchy
​
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.

Example:
[
  {
    "external_id": "5cbdbdbe-5f44-4423-8157-520f8a2f429a",
    "skills": [
      {
        "skill_id": "8313fe8a-f39e-4a35-8c82-93b46c3de9bb",
        "skill": "Balance Sheet",
        "skill_types": [{ "skill_type": "Family-Specific" }],
        "domain_name": "Finance",
        "validation_state": "validated",
        "proficiency_level": 2,
        "proficiency_float": 0.4,
        "critical": false
      }
    ]
  },
  {
    "external_id": "61a6e076-d780-11ec-9d64-0242ac120002",
    "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.2,
        "critical": true
      },
      {
        "skill": "Python",
        "skill_id": "4b85469d-6729-4d70-9876-a0faa2a2f63b",
        "skill_types": [{ "skill_type": "Family-Specific" }],
        "domain_name": "Programming",
        "validation_state": "initially_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"

⌘I