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

Workspace Status Changes

Workspace Status Changes represent changes made to the status of a project.

Fetching a list of Workspace Status Changes

Returns all project status changes that are visible to the user for the passed project ID.

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

Request
query Parameters
workspace_id
required
integer <int32>

Required parameter for retrieving status changes for a specified project.

created_after
string <date-time>

Filter for records created after a specified datetime. The datetime must be in ISO 8601 format.

created_before
string <date-time>

Filter for records created before a specified datetime. The datetime must be in ISO 8601 format.

include
string

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

  • user (User) - References the user who made the change.
  • workspace (Workspace) - References the project for which the status changed.
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
updated_after
string <date-time>

Filter for records updated after a specified datetime. The datetime must be in ISO 8601 format.

updated_before
string <date-time>

Filter for records updated before a specified datetime. The datetime must be in ISO 8601 format.

Responses
200

A list of Workspace Status Changes 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/workspace_status_changes
Request samples 
Response samples 
application/json
{
  • "count": 0,
  • "meta": {
    },
  • "results": [
    ],
  • "workspace_status_changes": {
    },
  • "users": {
    },
  • "workspaces": {
    }
}
Creating a new Workspace Status Change
This endpoint returns structured Workspace Status Change 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_status_changes 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.


    

  • user (User) - References the user who made the change.
    • 

  • workspace (Workspace) - References the project for which the status changed.
    • 



 
Request Body schema: application/json
required
object
 
workspace_id
required
integer <int32> 
The ID of the project that contains the project status change.


 
to_status_key
required
integer <int32> 
The status key for the new project status. See the Knowledge Base for a list of project status IDs. Note that setting a project's status to its current status will result in an error. To avoid this, you can use the update workspace endpoint and its status_key parameter instead.


 
Responses 
200
Workspace Status Change 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/workspace_status_changes
Request samples 
application/json
{
  • "workspace_status_change": {
    }
}
Response samples 
application/json
{
  • "count": 0,
  • "meta": {
    },
  • "results": [
    ],
  • "workspace_status_changes": {
    },
  • "users": {
    },
  • "workspaces": {
    }
}
Fetching a single Workspace Status Change
Return the status change for the passed project status change ID.


This endpoint returns structured Workspace Status Change 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_status_changes 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.


    

  • user (User) - References the user who made the change.
    • 

  • workspace (Workspace) - References the project for which the status changed.
    • 



 
Responses 
200
The Workspace Status Change 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/workspace_status_changes/{id}
Request samples 
Response samples 
application/json
{
  • "count": 0,
  • "meta": {
    },
  • "results": [
    ],
  • "workspace_status_changes": {
    },
  • "users": {
    },
  • "workspaces": {
    }
}
➔ Next to Workspaces