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

Story Dependencies

Story dependencies define relationships between tasks and the sequence in which they must be completed in order to close a project. A dependency is between two tasks (stories) in a project (workspace), with one being the predecessor (source) task, and the other the successor (target) task. Each relationship is characterized by the type of dependency and lag between tasks. There are four (4) types of dependencies:

  • Finish to Start (FS)—The predecessor ends before the successor can begin.
  • Start to Start (SS)—The predecessor begins before the successor can begin.
  • Finish to Finish (FF)—The predecessor ends before the successor can end.
  • Start to Finish (SF)—The predecessor begins before the successor can end. Lag is the number of days between the predecessor task ending and the successor task beginning. To learn more about dependencies, see our Gantt Chart Dependencies article.

Fetching a list of Story Dependencies

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

Request
query Parameters
created_after
string

Filter for records created after a specified datetime.

created_before
string

Filter for records created before a specified datetime.

include
string

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

  • source (Story) - The tasks that are predecessor tasks.
  • target (Story) - The tasks that are successor tasks.
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
show_archived
boolean
Default: false

If set to true, includes in the response dependencies where the target is an archived task.

show_deleted
boolean
Default: false

If set to true, includes in the response dependencies where the target is an deleted task.

show_from_archived_workspaces
boolean
Default: false

If set to true, includes in the response dependencies where the tasks belong to archived projects.

source_id
integer <int32>

Filter for dependencies where this task is the predecessor, i.e. the task that controls the start or end date for all related successor tasks.

target_id
integer <int32>

Filter for dependencies where this task is the successor, i.e. the task whose start or end date is controlled by a predecessor.

updated_after
string

Filter for records updated after a specified datetime.

updated_before
string

Filter for records updated before a specified datetime.

workspace_id
integer <int32>

Filter for dependencies where the tasks belong to a specific project.

Responses
200

A list of Story Dependencies have been retrieved.

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

Bad Request

401

Unauthorized request

403

Forbidden request

404

Page Not Found

422

Unprocessable Entity

503

Service is unavailable

get/story_dependencies
Request samples 
Response samples 
application/json
{
  • "count": 0,
  • "meta": {
    },
  • "results": [
    ],
  • "story_dependencies": {
    },
  • "stories": {
    }
}
Fetching a single Story Dependency
This endpoint returns structured Story Dependency 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_dependencies 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.


    

  • source (Story) - The tasks that are predecessor tasks.
    • 

  • target (Story) - The tasks that are successor tasks.
    • 



 
Responses 
200
The Story Dependency has been retrieved.


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


401
Unauthorized request


403
Forbidden request


404
Page Not Found


422
Unprocessable Entity


503
Service is unavailable


get/story_dependencies/{id}
Request samples 
Response samples 
application/json
{
  • "count": 0,
  • "meta": {
    },
  • "results": [
    ],
  • "story_dependencies": {
    },
  • "stories": {
    }
}
➔ Next to Story State Changes