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

Project Template Assignment Skills

Project Template Assignment Skills represent skills that have been assigned to a Project Template Assignment.

Fetching a list of Project Template Assignment Skills

Returns a list of project template assignment skills that represent the skills associated with project template assignments visible to the logged in user.

This endpoint returns structured Project Template Assignment 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 project_template_assignment_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.
  • project_template_assignment (ProjectTemplateAssignment) - References the project template assignment that has been assigned to the skill.
  • skill (Skill) - References the skill assigned to the object.
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
project_template_assignment_ids
string

Only includes project template assignment skills assigned to a project template assignment. Project template assignment ids can be passed in as an array or comma separated string.

Responses
200

A list of Project Template Assignment 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/project_template_assignment_skills
Request samples 
Response samples 
application/json
{
  • "count": 0,
  • "meta": {
    },
  • "results": [
    ],
  • "project_template_assignment_skills": {
    },
  • "skills": {
    },
  • "users": {
    },
  • "project_template_assignments": {
    }
}
Creating a new Project Template Assignment Skill
This endpoint returns structured Project Template Assignment 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 project_template_assignment_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.
    • 

  • project_template_assignment (ProjectTemplateAssignment) - References the project template assignment that has been assigned to the skill.
    • 

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



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


 
project_template_assignment_id
required
integer <int32> 
The ID of the project template assignment.


 
level
integer <int32> 
The project template assignment'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
Project Template Assignment 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/project_template_assignment_skills
Request samples 
application/json
{
  • "project_template_assignment_skill": {
    }
}
Response samples 
application/json
{
  • "count": 0,
  • "meta": {
    },
  • "results": [
    ],
  • "project_template_assignment_skills": {
    },
  • "skills": {
    },
  • "users": {
    },
  • "project_template_assignments": {
    }
}
Fetching a single Project Template Assignment Skill
This endpoint returns structured Project Template Assignment 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 project_template_assignment_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.
    • 

  • project_template_assignment (ProjectTemplateAssignment) - References the project template assignment that has been assigned to the skill.
    • 

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



 
Responses 
200
The Project Template Assignment 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/project_template_assignment_skills/{id}
Request samples 
Response samples 
application/json
{
  • "count": 0,
  • "meta": {
    },
  • "results": [
    ],
  • "project_template_assignment_skills": {
    },
  • "skills": {
    },
  • "users": {
    },
  • "project_template_assignments": {
    }
}
Updating an existing Project Template Assignment Skill
This endpoint returns structured Project Template Assignment 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 project_template_assignment_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.
    • 

  • project_template_assignment (ProjectTemplateAssignment) - References the project template assignment that has been assigned to the skill.
    • 

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



 
Request Body schema: application/json
required
object
 
level
integer <int32> 
The project template assignment'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
Project Template Assignment 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/project_template_assignment_skills/{id}
Request samples 
application/json
{
  • "project_template_assignment_skill": {
    }
}
Response samples 
application/json
{
  • "count": 0,
  • "meta": {
    },
  • "results": [
    ],
  • "project_template_assignment_skills": {
    },
  • "skills": {
    },
  • "users": {
    },
  • "project_template_assignments": {
    }
}
Deleting an existing Project Template Assignment 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
Project Template Assignment 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/project_template_assignment_skills/{id}
Request samples 
Response samples 
application/json
{
  • "errors": [
    ]
}
➔ Next to Project Template Additional Tabs