KAkantata
Story Dependencies

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.

get/story_dependencies

Request

  • Base URL
    https://api.mavenlink.com/api/v1
  • Auth
    none declared

Query parameters

created_afterstring date-time

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

created_beforestring date-time

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

includestring

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.
onlystring

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.

orderstring

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.

pageinteger
per_pageinteger
show_archivedboolean

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

show_deletedboolean

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

show_from_archived_workspacesboolean

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

source_idinteger

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_idinteger

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

updated_afterstring date-time

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

updated_beforestring date-time

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

workspace_idinteger

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

Response

A list of Story Dependencies have been retrieved.

countinteger
story_dependenciesobject
storiesobject

Changes

No recorded changes to this operation across all 1 revision of this API.