Skip to content

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'.

Operations

Fetching a list of Skills

Request

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 5000 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.

Query
created_afterstring, (date-time)

Filter for records created after a specified datetime. The datetime must be in ISO 8601 format.

created_beforestring, (date-time)

Filter for records created before a specified datetime. The datetime must be in ISO 8601 format.

exceptstring

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

external_reference_external_messagestring

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

external_reference_external_statusstring

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

external_reference_service_modelstring

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

external_reference_service_model_refinteger, (int32)

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

external_reference_service_model_refsstring

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_namestring

Filter by the name of the provider for integration.

external_reference_statusstring

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

for_usersstring

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

has_external_referencesboolean

Filter by whether or not the object has external references.

includestring

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.
matchingstring

Includes skills with a name that matches the search string.

onlystring

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.

orderstring

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

Valid values: alphabetical:asc and alphabetical:desc.

Default:"alphabetical:asc"
pageinteger, (int32)
Default:1
per_pageinteger, (int32), <= 200
Default:20
skill_category_idsstring

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

unassigned_skills_for_estimate_scenario_resourceinteger, (int32)

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

unassigned_skills_for_project_template_assignmentinteger, (int32)

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

unassigned_skills_for_userinteger, (int32)

Includes the skills that a user has not been assigned.

unassigned_skills_for_workspace_resourceinteger, (int32)

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

updated_afterstring, (date-time)

Filter for records updated after a specified datetime. The datetime must be in ISO 8601 format.

updated_beforestring, (date-time)

Filter for records updated before a specified datetime. The datetime must be in ISO 8601 format.

without_external_reference_service_namestring

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

GET
/skills
curl -i -X GET \
  'https://api.mavenlink.com/api/v1/skills?created_after=2019-08-24T14%3A15%3A22Z&created_before=2019-08-24T14%3A15%3A22Z&except=string&external_reference_external_message=string&external_reference_external_status=string&external_reference_service_model=string&external_reference_service_model_ref=0&external_reference_service_model_refs=string&external_reference_service_name=string&external_reference_status=string&for_users=string&has_external_references=true&include=string&matching=string&only=string&order=alphabetical%3Aasc&page=1&per_page=20&skill_category_ids=string&unassigned_skills_for_estimate_scenario_resource=0&unassigned_skills_for_project_template_assignment=0&unassigned_skills_for_user=0&unassigned_skills_for_workspace_resource=0&updated_after=2019-08-24T14%3A15%3A22Z&updated_before=2019-08-24T14%3A15%3A22Z&without_external_reference_service_name=string'

Responses

A list of Skills have been retrieved.

Bodyapplication/json
countinteger, (int32)
metaobject
resultsArray of objects
skillsobject
external_referencesobject
skill_categoriesobject
Response
{
  "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"
      ]
    }
  }
}