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

Project Template Additional Tabs

Project Template Additional Tabs are additional tabs configured in a project template that are added to a project when the template is applied.

Fetching a list of Project Template Additional Tabs

This endpoint returns structured Project Template Additional Tab 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_additional_tabs top-level JSON key. Please see our Response Format section for more information.

Request
query Parameters
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: "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>

Filter by project template ID.

Responses
200

A list of Project Template Additional Tabs have been retrieved.

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

Bad Request

401

Unauthorized request

403

Forbidden request

404

Page Not Found

422

Unprocessable Entity

503

Service is unavailable

get/project_template_additional_tabs
Request samples 
Response samples 
application/json
{
  • "count": 0,
  • "meta": {
    },
  • "results": [
    ],
  • "project_template_additional_tabs": {
    }
}
Creating a new Project Template Additional Tab
Adds an additional tab to a project template.


This endpoint returns structured Project Template Additional Tab 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_additional_tabs top-level JSON key.
Please see our Response Format section for more information.


Request 
Request Body schema: application/json
required
object
 
project_template_id
required
integer <int32> 
The ID of the template to add the additional tab to.


 
tab_type
required
string
The type of the additional tab. Options are form and dashboard (i.e. an Insights dynamic dashboard).


 
associated_tab_id
required
integer <int32> 
The ID of the form or dynamic dashboard.


 
Responses 
200
Project Template Additional Tab has been created.


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


401
Unauthorized request


403
Forbidden request


404
Page Not Found


422
Unprocessable Entity


503
Service is unavailable


post/project_template_additional_tabs
Request samples 
application/json
{
  • "project_template_additional_tab": {
    }
}
Response samples 
application/json
{
  • "count": 0,
  • "meta": {
    },
  • "results": [
    ],
  • "project_template_additional_tabs": {
    }
}
Deleting an existing Project Template Additional Tab
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 Additional Tab 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_additional_tabs/{id}
Request samples 
Response samples 
application/json
{
  • "errors": [
    ]
}
➔ Next to Project Template Assignments