Kantata Kantata OX Knowledge Base Release Notes Status Page
Kantata OX API Documentation

Skills

Skills are used in Kantata OX to describe capabilities of users for the purposes of resource planning. They can be associated with a user through a Skill Membership. A user can be associated with up to 200 skills. This model includes categories such as 'Skill', 'Language', 'Certification' and 'Other'.

Fetching a list of Skills

The Skills endpoint provides a list of every Skill that belongs to the Account of the User making the request. The response will contain an array of Skill objects, sorted alphabetically by the name attribute.

NOTE: You cannot create more than 3000 skills per account.

This endpoint returns structured Skill objects. As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results array and will be indexed by ID in the skills top-level JSON key. Please see our Response Format section for more information.

Request
query Parameters
created_after
string

Filter for records created after a specified datetime.

created_before
string

Filter for records created before a specified datetime.

except
string

Includes the skills that are not in the passed in set of skill ids. For example, '10,15'.

external_reference_external_message
string

Filter the objects based on the external message of their associated external references. This is an exact match.

external_reference_external_status
string

Filter by the status of the external object in the external system.

external_reference_service_model
string

Filter by the type of the external object this external reference belongs to.

external_reference_service_model_ref
integer <int32>

Filter by the id of the external object this external reference belongs to.

external_reference_service_name
string

Filter by the name of the provider for integration.

external_reference_status
string

Filter by the status of the integration, this can be successful or fail.

for_users
string

Includes skills that are not already associated with these users. For example, '10,15'.

has_external_references
boolean

Filter by whether or not the object has external references.

include
string

Any of the below associations can be included in your request by providing the include param, e.g. include=association1,association2.

  • external_references (ExternalReference) - Includes references to external integrations for this object.
  • skill_category (SkillCategory) - The Skill Category under which the Skill is grouped.
matching
string

Includes skills with a name that matches the search string.

only
string

Allows you to request one or more resources directly by ID. Multiple IDs can be supplied in a comma separated list, like GET /api/v1/workspaces.json?only=5,6,7.

order
string
Default: "alphabetical:asc"

Supply order with the name of a valid sort field for the endpoint and a direction.

Valid values: alphabetical:asc and alphabetical:desc.

page
integer <int32>
Default: 1
per_page
integer <int32> <= 200
Default: 20
skill_category_ids
string

Includes skills that are associated with these skill categories. For example, '2,25'.

unassigned_skills_for_estimate_scenario_resource
integer <int32>

Includes the skills that an estimate scenario resource has not been assigned.

unassigned_skills_for_project_template_assignment
integer <int32>

Includes the skills that a project template assignment has not been assigned.

unassigned_skills_for_user
integer <int32>

Includes the skills that a user has not been assigned.

unassigned_skills_for_workspace_resource
integer <int32>

Includes the skills that a workspace resource has not been assigned.

updated_after
string

Filter for records updated after a specified datetime.

updated_before
string

Filter for records updated before a specified datetime.

without_external_reference_service_name
string

Exclude by the existence of an external reference with the specified service name.

Responses
200

A list of Skills have been retrieved.

Response Schema: application/json
count
integer <int32>
object
Array of objects
object
object
object
400

Bad Request

401

Unauthorized request

403

Forbidden request

404

Page Not Found

422

Unprocessable Entity

503

Service is unavailable

get/skills
Request samples 
Response samples 
application/json
{
  • "count": 0,
  • "meta": {
    },
  • "results": [
    ],
  • "skills": {
    },
  • "external_references": {
    },
  • "skill_categories": {
    }
}
Creating a new Skill
NOTE: You cannot create more than 3000 skills per account.


This endpoint returns structured Skill objects.
As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results array
and will be indexed by ID in the skills top-level JSON key.
Please see our Response Format section for more information.


Request 
query Parameters
include
string
Any of the below associations can be included in your request by providing the include param, e.g. include=association1,association2.


    

  • external_references (ExternalReference) - Includes references to external integrations for this object.
    • 

  • skill_category (SkillCategory) - The Skill Category under which the Skill is grouped.
    • 



 
Request Body schema: application/json
object
 
name
required
string
The name of the skill to be created.


 
max_level
required
string
The max number of levels allowed for the skill and must be either 1 or 5.


 
skill_category_id
required
integer <int32> 
The id of the skill category associated with this skill.


 
description
string
The description of the skill.


 
object
Typically populated programmatically by a third party system via an integration, this is an optional
object that holds data from an external system. It connects objects in an external system with objects in
Kantata OX (for example, to connect a HubSpot Deal to a Kantata OX Project).


 
Responses 
200
Skill has been created.


Response Schema: application/json
count
integer <int32> 
 
object
 
Array of objects
 
object
 
object
 
object
 
400
Bad Request


401
Unauthorized request


403
Forbidden request


404
Page Not Found


422
Unprocessable Entity


503
Service is unavailable


post/skills
Request samples 
application/json
{
  • "skill": {
    }
}
Response samples 
application/json
{
  • "count": 0,
  • "meta": {
    },
  • "results": [
    ],
  • "skills": {
    },
  • "external_references": {
    },
  • "skill_categories": {
    }
}
Fetching a single Skill
This endpoint returns structured Skill objects.
As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results array
and will be indexed by ID in the skills top-level JSON key.
Please see our Response Format section for more information.


Request 
path Parameters
id
required
integer
The ID of the Model.


 
query Parameters
include
string
Any of the below associations can be included in your request by providing the include param, e.g. include=association1,association2.


    

  • external_references (ExternalReference) - Includes references to external integrations for this object.
    • 

  • skill_category (SkillCategory) - The Skill Category under which the Skill is grouped.
    • 



 
Responses 
200
The Skill has been retrieved.


Response Schema: application/json
count
integer <int32> 
 
object
 
Array of objects
 
object
 
object
 
object
 
400
Bad Request


401
Unauthorized request


403
Forbidden request


404
Page Not Found


422
Unprocessable Entity


503
Service is unavailable


get/skills/{id}
Request samples 
Response samples 
application/json
{
  • "count": 0,
  • "meta": {
    },
  • "results": [
    ],
  • "skills": {
    },
  • "external_references": {
    },
  • "skill_categories": {
    }
}
Updating an existing Skill
This endpoint returns structured Skill objects.
As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results array
and will be indexed by ID in the skills top-level JSON key.
Please see our Response Format section for more information.


Request 
path Parameters
id
required
integer
The ID of the Model.


 
query Parameters
include
string
Any of the below associations can be included in your request by providing the include param, e.g. include=association1,association2.


    

  • external_references (ExternalReference) - Includes references to external integrations for this object.
    • 

  • skill_category (SkillCategory) - The Skill Category under which the Skill is grouped.
    • 



 
Request Body schema: application/json
object
 
name
string
The name of the skill to be created.


 
max_level
string
The max number of levels allowed for the skill and must be either 1 or 5.


 
skill_category_id
integer <int32> 
The id of the skill category associated with this skill.


 
description
string
The description of the skill.


 
object
Typically populated programmatically by a third party system via an integration, this is an optional
object that holds data from an external system. It connects objects in an external system with objects in
Kantata OX (for example, to connect a HubSpot Deal to a Kantata OX Project).


 
Responses 
200
Skill has been updated.


Response Schema: application/json
count
integer <int32> 
 
object
 
Array of objects
 
object
 
object
 
object
 
400
Bad Request


401
Unauthorized request


403
Forbidden request


404
Page Not Found


422
Unprocessable Entity


503
Service is unavailable


put/skills/{id}
Request samples 
application/json
{
  • "skill": {
    }
}
Response samples 
application/json
{
  • "count": 0,
  • "meta": {
    },
  • "results": [
    ],
  • "skills": {
    },
  • "external_references": {
    },
  • "skill_categories": {
    }
}
Deleting an existing Skill
The response will contain no content and an HTTP 204 status code if the request was
successful, or a standard Kantata OX error message explaining why the object could not be deleted.


Request 
path Parameters
id
required
integer
The ID of the Model.


 
Responses 
204
Skill has been deleted.


400
Bad Request


401
Unauthorized request


403
Forbidden request


404
Page Not Found


422
Unprocessable Entity


503
Service is unavailable


delete/skills/{id}
Request samples 
Response samples 
application/json
{
  • "errors": [
    ]
}
➔ Next to Users