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'.
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.
created_after | string <date-time> Filter for records created after a specified datetime. The datetime must be in ISO 8601 format. |
created_before | string <date-time> Filter for records created before a specified datetime. The datetime must be in ISO 8601 format. |
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_model_refs | string Filter for objects that correlate to the specified external object IDs. Provide a comma-separated list of up to 200 external IDs. |
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
|
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 |
order | string Default: "alphabetical:asc" Supply Valid values: |
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 <date-time> Filter for records updated after a specified datetime. The datetime must be in ISO 8601 format. |
updated_before | string <date-time> Filter for records updated before a specified datetime. The datetime must be in ISO 8601 format. |
without_external_reference_service_name | string Exclude by the existence of an external reference with the specified service name. |
{- "count": 0,
- "meta": {
- "count": 0,
- "page_count": 0,
- "page_number": 0,
- "page_size": 0
}, - "results": [
- {
- "key": "string",
- "id": "string"
}
], - "skills": {
- "property1": {
- "created_at": "2019-08-24T14:15:22Z",
- "description": "string",
- "external_reference_ids": [
- "string"
], - "max_level": "string",
- "name": "string",
- "skill_category_id": "string",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "property2": {
- "created_at": "2019-08-24T14:15:22Z",
- "description": "string",
- "external_reference_ids": [
- "string"
], - "max_level": "string",
- "name": "string",
- "skill_category_id": "string",
- "updated_at": "2019-08-24T14:15:22Z"
}
}, - "external_references": {
- "property1": {
- "created_at": "2019-08-24T14:15:22Z",
- "external_link": "string",
- "external_message": "string",
- "external_status": "string",
- "last_synced_at": "2019-08-24T14:15:22Z",
- "locked": true,
- "service_model": "string",
- "service_model_ref": "string",
- "service_name": "string",
- "status": "string",
- "subject_id": 0,
- "subject_ref": {
- "key": "string",
- "id": "string"
}, - "subject_type": "string",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "property2": {
- "created_at": "2019-08-24T14:15:22Z",
- "external_link": "string",
- "external_message": "string",
- "external_status": "string",
- "last_synced_at": "2019-08-24T14:15:22Z",
- "locked": true,
- "service_model": "string",
- "service_model_ref": "string",
- "service_name": "string",
- "status": "string",
- "subject_id": 0,
- "subject_ref": {
- "key": "string",
- "id": "string"
}, - "subject_type": "string",
- "updated_at": "2019-08-24T14:15:22Z"
}
}, - "skill_categories": {
- "property1": {
- "name": "string",
- "skill_ids": [
- "string"
]
}, - "property2": {
- "name": "string",
- "skill_ids": [
- "string"
]
}
}
}
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.
{- "skill": {
- "name": "string",
- "max_level": "string",
- "skill_category_id": 0,
- "description": "string",
- "external_reference": {
- "service_name": "string",
- "service_model": "string",
- "service_model_ref": "string",
- "status": "string",
- "external_message": "string",
- "external_link": "string",
- "external_status": "string",
- "locked": true
}
}
}
{- "count": 0,
- "meta": {
- "count": 0,
- "page_count": 0,
- "page_number": 0,
- "page_size": 0
}, - "results": [
- {
- "key": "string",
- "id": "string"
}
], - "skills": {
- "property1": {
- "created_at": "2019-08-24T14:15:22Z",
- "description": "string",
- "external_reference_ids": [
- "string"
], - "max_level": "string",
- "name": "string",
- "skill_category_id": "string",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "property2": {
- "created_at": "2019-08-24T14:15:22Z",
- "description": "string",
- "external_reference_ids": [
- "string"
], - "max_level": "string",
- "name": "string",
- "skill_category_id": "string",
- "updated_at": "2019-08-24T14:15:22Z"
}
}, - "external_references": {
- "property1": {
- "created_at": "2019-08-24T14:15:22Z",
- "external_link": "string",
- "external_message": "string",
- "external_status": "string",
- "last_synced_at": "2019-08-24T14:15:22Z",
- "locked": true,
- "service_model": "string",
- "service_model_ref": "string",
- "service_name": "string",
- "status": "string",
- "subject_id": 0,
- "subject_ref": {
- "key": "string",
- "id": "string"
}, - "subject_type": "string",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "property2": {
- "created_at": "2019-08-24T14:15:22Z",
- "external_link": "string",
- "external_message": "string",
- "external_status": "string",
- "last_synced_at": "2019-08-24T14:15:22Z",
- "locked": true,
- "service_model": "string",
- "service_model_ref": "string",
- "service_name": "string",
- "status": "string",
- "subject_id": 0,
- "subject_ref": {
- "key": "string",
- "id": "string"
}, - "subject_type": "string",
- "updated_at": "2019-08-24T14:15:22Z"
}
}, - "skill_categories": {
- "property1": {
- "name": "string",
- "skill_ids": [
- "string"
]
}, - "property2": {
- "name": "string",
- "skill_ids": [
- "string"
]
}
}
}
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.
include | string Any of the below associations can be included in your request by providing the
|
{- "count": 0,
- "meta": {
- "count": 0,
- "page_count": 0,
- "page_number": 0,
- "page_size": 0
}, - "results": [
- {
- "key": "string",
- "id": "string"
}
], - "skills": {
- "property1": {
- "created_at": "2019-08-24T14:15:22Z",
- "description": "string",
- "external_reference_ids": [
- "string"
], - "max_level": "string",
- "name": "string",
- "skill_category_id": "string",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "property2": {
- "created_at": "2019-08-24T14:15:22Z",
- "description": "string",
- "external_reference_ids": [
- "string"
], - "max_level": "string",
- "name": "string",
- "skill_category_id": "string",
- "updated_at": "2019-08-24T14:15:22Z"
}
}, - "external_references": {
- "property1": {
- "created_at": "2019-08-24T14:15:22Z",
- "external_link": "string",
- "external_message": "string",
- "external_status": "string",
- "last_synced_at": "2019-08-24T14:15:22Z",
- "locked": true,
- "service_model": "string",
- "service_model_ref": "string",
- "service_name": "string",
- "status": "string",
- "subject_id": 0,
- "subject_ref": {
- "key": "string",
- "id": "string"
}, - "subject_type": "string",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "property2": {
- "created_at": "2019-08-24T14:15:22Z",
- "external_link": "string",
- "external_message": "string",
- "external_status": "string",
- "last_synced_at": "2019-08-24T14:15:22Z",
- "locked": true,
- "service_model": "string",
- "service_model_ref": "string",
- "service_name": "string",
- "status": "string",
- "subject_id": 0,
- "subject_ref": {
- "key": "string",
- "id": "string"
}, - "subject_type": "string",
- "updated_at": "2019-08-24T14:15:22Z"
}
}, - "skill_categories": {
- "property1": {
- "name": "string",
- "skill_ids": [
- "string"
]
}, - "property2": {
- "name": "string",
- "skill_ids": [
- "string"
]
}
}
}
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.
include | string Any of the below associations can be included in your request by providing the
|
object | |||||||||||
|
{- "skill": {
- "name": "string",
- "max_level": "string",
- "skill_category_id": 0,
- "description": "string",
- "external_reference": {
- "service_name": "string",
- "service_model": "string",
- "service_model_ref": "string",
- "status": "string",
- "external_message": "string",
- "external_link": "string",
- "external_status": "string",
- "locked": true
}
}
}
{- "count": 0,
- "meta": {
- "count": 0,
- "page_count": 0,
- "page_number": 0,
- "page_size": 0
}, - "results": [
- {
- "key": "string",
- "id": "string"
}
], - "skills": {
- "property1": {
- "created_at": "2019-08-24T14:15:22Z",
- "description": "string",
- "external_reference_ids": [
- "string"
], - "max_level": "string",
- "name": "string",
- "skill_category_id": "string",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "property2": {
- "created_at": "2019-08-24T14:15:22Z",
- "description": "string",
- "external_reference_ids": [
- "string"
], - "max_level": "string",
- "name": "string",
- "skill_category_id": "string",
- "updated_at": "2019-08-24T14:15:22Z"
}
}, - "external_references": {
- "property1": {
- "created_at": "2019-08-24T14:15:22Z",
- "external_link": "string",
- "external_message": "string",
- "external_status": "string",
- "last_synced_at": "2019-08-24T14:15:22Z",
- "locked": true,
- "service_model": "string",
- "service_model_ref": "string",
- "service_name": "string",
- "status": "string",
- "subject_id": 0,
- "subject_ref": {
- "key": "string",
- "id": "string"
}, - "subject_type": "string",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "property2": {
- "created_at": "2019-08-24T14:15:22Z",
- "external_link": "string",
- "external_message": "string",
- "external_status": "string",
- "last_synced_at": "2019-08-24T14:15:22Z",
- "locked": true,
- "service_model": "string",
- "service_model_ref": "string",
- "service_name": "string",
- "status": "string",
- "subject_id": 0,
- "subject_ref": {
- "key": "string",
- "id": "string"
}, - "subject_type": "string",
- "updated_at": "2019-08-24T14:15:22Z"
}
}, - "skill_categories": {
- "property1": {
- "name": "string",
- "skill_ids": [
- "string"
]
}, - "property2": {
- "name": "string",
- "skill_ids": [
- "string"
]
}
}
}
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.
Skill has been deleted.
Bad Request
Unauthorized request
Forbidden request
Page Not Found
Unprocessable Entity
Service is unavailable
{- "errors": [
- {
- "type": "string",
- "message": "string"
}
]
}