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

Project Template Assignments

Project Template Assignments(Project Template Resources) represent placeholders for task assignees in project templates. These assignments are mapped to project template stories and are assigned to real users when the template is applied.

Fetching a list of Project Template Assignments

This endpoint returns structured Project Template Assignment 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_assignments 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.

  • project_template (ProjectTemplate) - The project template associated with the assignment.
  • role (Role).
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.

optional_fields
Array of strings

Allows you to request one or more optional fields as an array.

Items Enum: "total_estimated_minutes" "total_count" "role_initials" "role_name"
order
string
Default: "updated_at:desc"

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

Valid values: updated_at:asc and updated_at:desc.

page
integer <int32>
Default: 1
per_page
integer <int32> <= 200
Default: 20
project_template_id
integer <int32>

Limits project template assignments to a specific project template.

Responses
200

A list of Project Template Assignments have been retrieved.

Response Schema: application/json
count
integer <int32>
object
Array of objects
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_assignments
Request samples 
Response samples 
application/json
{
  • "count": 0,
  • "meta": {
    },
  • "results": [
    ],
  • "project_template_assignments": {
    },
  • "project_templates": {
    },
  • "roles": {
    }
}
Creating a new Project Template Assignment
This endpoint returns structured Project Template Assignment 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_assignments 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.


    

  • project_template (ProjectTemplate) - The project template associated with the assignment.
    • 

  • role (Role).
    • 



 
optional_fields
Array of strings
Allows you to request one or more optional fields as an array.


Items Enum: "total_estimated_minutes" "total_count" "role_initials" "role_name"  
Request Body schema: application/json
required
object
 
name
required
string
The name of resource or assignment placeholder for the associated project template.


 
project_template_id
required
integer <int32> 
The ID of the associated project template.


 
Responses 
200
Project Template Assignment has been created.


Response Schema: application/json
count
integer <int32> 
 
object
 
Array of objects
 
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_assignments
Request samples 
application/json
{
  • "project_template_assignment": {
    }
}
Response samples 
application/json
{
  • "count": 0,
  • "meta": {
    },
  • "results": [
    ],
  • "project_template_assignments": {
    },
  • "project_templates": {
    },
  • "roles": {
    }
}
Fetching a single Project Template Assignment
This endpoint returns structured Project Template Assignment 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_assignments 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.


    

  • project_template (ProjectTemplate) - The project template associated with the assignment.
    • 

  • role (Role).
    • 



 
optional_fields
Array of strings
Allows you to request one or more optional fields as an array.


Items Enum: "total_estimated_minutes" "total_count" "role_initials" "role_name"  
Responses 
200
The Project Template Assignment has been retrieved.


Response Schema: application/json
count
integer <int32> 
 
object
 
Array of objects
 
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_assignments/{id}
Request samples 
Response samples 
application/json
{
  • "count": 0,
  • "meta": {
    },
  • "results": [
    ],
  • "project_template_assignments": {
    },
  • "project_templates": {
    },
  • "roles": {
    }
}
Updating an existing Project Template Assignment
This endpoint returns structured Project Template Assignment 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_assignments 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.


    

  • project_template (ProjectTemplate) - The project template associated with the assignment.
    • 

  • role (Role).
    • 



 
optional_fields
Array of strings
Allows you to request one or more optional fields as an array.


Items Enum: "total_estimated_minutes" "total_count" "role_initials" "role_name"  
Request Body schema: application/json
required
object
 
name
required
string
The name of resource or assignment placeholder for the associated project template.


 
Responses 
200
Project Template Assignment has been updated.


Response Schema: application/json
count
integer <int32> 
 
object
 
Array of objects
 
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_assignments/{id}
Request samples 
application/json
{
  • "project_template_assignment": {
    }
}
Response samples 
application/json
{
  • "count": 0,
  • "meta": {
    },
  • "results": [
    ],
  • "project_template_assignments": {
    },
  • "project_templates": {
    },
  • "roles": {
    }
}
Deleting an existing Project Template Assignment
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 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_assignments/{id}
Request samples 
Response samples 
application/json
{
  • "errors": [
    ]
}
➔ Next to Project Templates