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

Workspace Resource Skills

Workspace Resource Skills represent skills that have been assigned to a workspace resource.

Fetching a list of Workspace Resource Skills

Returns a list of Workspace Resource Skills that represent the skills associated with workspace resources visible to the logged in user.

This endpoint returns structured Workspace Resource 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 workspace_resource_skills top-level JSON key. Please see our Response Format section for more information.

Request
query Parameters
by_skill_id
integer <int32>

Only includes associated skill, by the skill ID.

by_skill_ids
string

Only includes associated skills. Input is a comma separated list of ids or an array.

by_skill_name
string

Only includes associated skills, by the name of the skill.

include
string

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

  • creator (User) - References the user who has created the skill association.
  • skill (Skill) - References the skill assigned to the object.
  • workspace_resource (WorkspaceResource) - References the workspace resource who has been assigned the skill.
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: "created_at:desc"

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

Valid values: created_at:asc, created_at:desc, skill_name:asc, and skill_name:desc.

page
integer <int32>
Default: 1
per_page
integer <int32> <= 200
Default: 20
workspace_resource_ids
Array of integers <int32>

Only includes workspace resource skills assigned to a workspace resource, by workspace resource ID.

Responses
200

A list of Workspace Resource Skills have been retrieved.

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

Bad Request

401

Unauthorized request

403

Forbidden request

404

Page Not Found

422

Unprocessable Entity

503

Service is unavailable

get/workspace_resource_skills
Request samples 
Response samples 
application/json
{
  • "count": 0,
  • "meta": {
    },
  • "results": [
    ],
  • "workspace_resource_skills": {
    },
  • "skills": {
    },
  • "users": {
    },
  • "workspace_resources": {
    }
}
Creating a new Workspace Resource Skill
This endpoint returns structured Workspace Resource 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 workspace_resource_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.


    

  • creator (User) - References the user who has created the skill association.
    • 

  • skill (Skill) - References the skill assigned to the object.
    • 

  • workspace_resource (WorkspaceResource) - References the workspace resource who has been assigned the skill.
    • 



 
Request Body schema: application/json
required
object
 
skill_id
required
integer <int32> 
The ID of the skill.


 
workspace_resource_id
required
integer <int32> 
The ID of the workspace resource.


 
level
integer <int32> 
The workspace resource's proficiency level in the skill (1-5). This defaults to 1 if it is not specified.
Note: Not all skills have levels.


 
Responses 
200
Workspace Resource Skill has been created.


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


401
Unauthorized request


403
Forbidden request


404
Page Not Found


422
Unprocessable Entity


503
Service is unavailable


post/workspace_resource_skills
Request samples 
application/json
{
  • "workspace_resource_skill": {
    }
}
Response samples 
application/json
{
  • "count": 0,
  • "meta": {
    },
  • "results": [
    ],
  • "workspace_resource_skills": {
    },
  • "skills": {
    },
  • "users": {
    },
  • "workspace_resources": {
    }
}
Fetching a single Workspace Resource Skill
This endpoint returns structured Workspace Resource 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 workspace_resource_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.


    

  • creator (User) - References the user who has created the skill association.
    • 

  • skill (Skill) - References the skill assigned to the object.
    • 

  • workspace_resource (WorkspaceResource) - References the workspace resource who has been assigned the skill.
    • 



 
Responses 
200
The Workspace Resource Skill has been retrieved.


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


401
Unauthorized request


403
Forbidden request


404
Page Not Found


422
Unprocessable Entity


503
Service is unavailable


get/workspace_resource_skills/{id}
Request samples 
Response samples 
application/json
{
  • "count": 0,
  • "meta": {
    },
  • "results": [
    ],
  • "workspace_resource_skills": {
    },
  • "skills": {
    },
  • "users": {
    },
  • "workspace_resources": {
    }
}
Updating an existing Workspace Resource Skill
This endpoint returns structured Workspace Resource 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 workspace_resource_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.


    

  • creator (User) - References the user who has created the skill association.
    • 

  • skill (Skill) - References the skill assigned to the object.
    • 

  • workspace_resource (WorkspaceResource) - References the workspace resource who has been assigned the skill.
    • 



 
Request Body schema: application/json
required
object
 
level
integer <int32> 
The workspace resource's proficiency level in the skill (1-5). This defaults to 0 if it is not specified.
Note: Not all skills have levels.


 
Responses 
200
Workspace Resource Skill has been updated.


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


401
Unauthorized request


403
Forbidden request


404
Page Not Found


422
Unprocessable Entity


503
Service is unavailable


put/workspace_resource_skills/{id}
Request samples 
application/json
{
  • "workspace_resource_skill": {
    }
}
Response samples 
application/json
{
  • "count": 0,
  • "meta": {
    },
  • "results": [
    ],
  • "workspace_resource_skills": {
    },
  • "skills": {
    },
  • "users": {
    },
  • "workspace_resources": {
    }
}
Deleting an existing Workspace Resource 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
Workspace Resource 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/workspace_resource_skills/{id}
Request samples 
Response samples 
application/json
{
  • "errors": [
    ]
}
➔ Next to Workspace Resources