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

Workspace Baselines

A Gantt workspace baseline is a snapshot of a workspace at a particular point in time. The snapshot contains aggregate statistics and certain data about each story (task).

Fetching a list of Workspace Baselines

Returns a list of Gantt workspace baselines associated with workspaces (projects) that are visible to the authenticated user. Visibility restrictions on projects are detailed in the Workspaces API documentation

This endpoint returns structured Workspace Baseline 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_baselines 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) - The user who created this workspace baseline.
  • payload (BaselinePayload) - The baseline payload associated with this workspace baseline.
  • workspace (Workspace) - The workspace represented in this workspace baseline.
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 and created_at:desc.

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

A list of Workspace Baselines 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_baselines
Request samples 
Response samples 
application/json
{
  • "count": 0,
  • "meta": {
    },
  • "results": [
    ],
  • "workspace_baselines": {
    },
  • "workspaces": {
    },
  • "users": {
    },
  • "baseline_payloads": {
    }
}
Creating a new Workspace Baseline
Creates a Gantt workspace baseline for a specified workspace (project). The baseline will contain aggregate statistics and certain data about each story (task).


This endpoint returns structured Workspace Baseline 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_baselines 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) - The user who created this workspace baseline.
    • 

  • payload (BaselinePayload) - The baseline payload associated with this workspace baseline.
    • 

  • workspace (Workspace) - The workspace represented in this workspace baseline.
    • 



 
Request Body schema: application/json
required
object
 
title
required
string
The title of the workspace baseline.


 
description
string
The description of the workspace baseline.


 
workspace_id
integer <int32> 
The ID of the workspace the workspace baseline will belong to.


 
Responses 
200
Workspace Baseline 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_baselines
Request samples 
application/json
{
  • "workspace_baseline": {
    }
}
Response samples 
application/json
{
  • "count": 0,
  • "meta": {
    },
  • "results": [
    ],
  • "workspace_baselines": {
    },
  • "workspaces": {
    },
  • "users": {
    },
  • "baseline_payloads": {
    }
}
Fetching a single Workspace Baseline
Returns a specified Gantt workspace baseline.


This endpoint returns structured Workspace Baseline 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_baselines 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) - The user who created this workspace baseline.
    • 

  • payload (BaselinePayload) - The baseline payload associated with this workspace baseline.
    • 

  • workspace (Workspace) - The workspace represented in this workspace baseline.
    • 



 
Responses 
200
The Workspace Baseline 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_baselines/{id}
Request samples 
Response samples 
application/json
{
  • "count": 0,
  • "meta": {
    },
  • "results": [
    ],
  • "workspace_baselines": {
    },
  • "workspaces": {
    },
  • "users": {
    },
  • "baseline_payloads": {
    }
}
Updating an existing Workspace Baseline
Updates a specified Gantt workspace baseline.


This endpoint returns structured Workspace Baseline 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_baselines 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) - The user who created this workspace baseline.
    • 

  • payload (BaselinePayload) - The baseline payload associated with this workspace baseline.
    • 

  • workspace (Workspace) - The workspace represented in this workspace baseline.
    • 



 
Request Body schema: application/json
required
object
 
title
required
string
The title of the workspace baseline.


 
description
string
The description of the workspace baseline.


 
workspace_id
integer <int32> 
The ID of the workspace the workspace baseline will belong to.


 
Responses 
200
Workspace Baseline 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_baselines/{id}
Request samples 
application/json
{
  • "workspace_baseline": {
    }
}
Response samples 
application/json
{
  • "count": 0,
  • "meta": {
    },
  • "results": [
    ],
  • "workspace_baselines": {
    },
  • "workspaces": {
    },
  • "users": {
    },
  • "baseline_payloads": {
    }
}
Deleting an existing Workspace Baseline
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 Baseline 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_baselines/{id}
Request samples 
Response samples 
application/json
{
  • "errors": [
    ]
}
➔ Next to Workspace Groups