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

Story Tasks

Story Tasks are used in Kantata OX to track a list of checklist items within a Story. This model includes a completion boolean and a position integer.

Fetching a list of Story Tasks

Returns all story tasks belonging to stories in projects that the user is partcipating in.

This endpoint returns structured Story Task 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 story_tasks top-level JSON key. Please see our Response Format section for more information.

Request
query Parameters
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.

  • completed_by (User) - The User who completed this Story task, if any.
  • story (Story) - The Story on which this Story Task exists.
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: "position:asc"

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

Valid values: position:asc and position:desc.

page
integer <int32>
Default: 1
per_page
integer <int32> <= 200
Default: 20
show_archived
boolean
Default: false

Include Story Tasks on archived Stories.

show_deleted
boolean
Default: false

Include Story Tasks on deleted Stories.

show_from_archived_workspaces
boolean
Default: false

Include Story Tasks on Stories in archived Workspaces.

story_id
integer <int32>

Only return the Story Task associated with the specified story_id.

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 Story Tasks 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/story_tasks
Request samples 
Response samples 
application/json
{
  • "count": 0,
  • "meta": {
    },
  • "results": [
    ],
  • "story_tasks": {
    },
  • "users": {
    },
  • "stories": {
    }
}
Creating a new Story Task
This endpoint returns structured Story Task 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 story_tasks 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.


    

  • completed_by (User) - The User who completed this Story task, if any.
    • 

  • story (Story) - The Story on which this Story Task exists.
    • 



 
Request Body schema: application/json
required
object
 
story_id
required
integer <int32> 
The ID of the associated Story.


 
name
required
string
The name of the story task.


 
completed
boolean
Represents the completion of the story task.


 
position
integer <int32> 
The Story Task's position in the list of story tasks.


 
Responses 
200
Story Task 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/story_tasks
Request samples 
application/json
{
  • "story_task": {
    }
}
Response samples 
application/json
{
  • "count": 0,
  • "meta": {
    },
  • "results": [
    ],
  • "story_tasks": {
    },
  • "users": {
    },
  • "stories": {
    }
}
Fetching a single Story Task
This endpoint returns structured Story Task 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 story_tasks 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.


    

  • completed_by (User) - The User who completed this Story task, if any.
    • 

  • story (Story) - The Story on which this Story Task exists.
    • 



 
Responses 
200
The Story Task 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/story_tasks/{id}
Request samples 
Response samples 
application/json
{
  • "count": 0,
  • "meta": {
    },
  • "results": [
    ],
  • "story_tasks": {
    },
  • "users": {
    },
  • "stories": {
    }
}
Updating an existing Story Task
This endpoint returns structured Story Task 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 story_tasks 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.


    

  • completed_by (User) - The User who completed this Story task, if any.
    • 

  • story (Story) - The Story on which this Story Task exists.
    • 



 
Request Body schema: application/json
required
object
 
name
string
The name of the story task.


 
completed
boolean
Represents the completion of the story task.


 
position
integer <int32> 
The Story Task's position in the list of story tasks.


 
Responses 
200
Story Task 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/story_tasks/{id}
Request samples 
application/json
{
  • "story_task": {
    }
}
Response samples 
application/json
{
  • "count": 0,
  • "meta": {
    },
  • "results": [
    ],
  • "story_tasks": {
    },
  • "users": {
    },
  • "stories": {
    }
}
Deleting an existing Story Task
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
Story Task has been deleted.


400
Bad Request


401
Unauthorized request


403
Forbidden request


404
Page Not Found


422
Unprocessable Entity


503
Service is unavailable


delete/story_tasks/{id}
Request samples 
Response samples 
application/json
{
  • "errors": [
    ]
}
➔ Next to Line Item Locks