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