Skip to content

Story State Changes

Story State Changes in Kantata OX act as an audit trail for changes to the state of a Story. Story State Changes cannot be created directly. They will be created for you automatically when you set the state of a Story. Story State Changes cannot be modified or deleted.

Fetching a list of Story State Changes

Request

The story state changes endpoint provides a list of state changes for a specified story. story_id is a required parameter to retrieve story state changes for a specified story.

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

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

  • story (Story) - Will reference the Story for which the story state change belongs.
  • user (User) - Will reference the User for which the story state change belongs.
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: created_at:asc and created_at:desc.

Default:"created_at:asc"
pageinteger, (int32)
Default:1
per_pageinteger, (int32), <= 200
Default:20
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.

GET
/story_state_changes
curl -i -X GET \
  'https://api.mavenlink.com/api/v1/story_state_changes?created_after=2019-08-24T14%3A15%3A22Z&created_before=2019-08-24T14%3A15%3A22Z&include=string&only=string&order=created_at%3Aasc&page=1&per_page=20&updated_after=2019-08-24T14%3A15%3A22Z&updated_before=2019-08-24T14%3A15%3A22Z'

Responses

A list of Story State Changes have been retrieved.

Bodyapplication/json
countinteger, (int32)
metaobject
resultsArray of objects
story_state_changesobject
usersobject
storiesobject
Response
{ "count": 0, "meta": { "count": 0, "page_count": 0, "page_number": 0, "page_size": 0 }, "results": [ { "key": "string", "id": "string" } ], "story_state_changes": { "property1": { "created_at": "2019-08-24T14:15:22Z", "formatted_state": "string", "state": "string", "story_id": "string", "updated_at": "2019-08-24T14:15:22Z", "user_id": "string" }, "property2": { "created_at": "2019-08-24T14:15:22Z", "formatted_state": "string", "state": "string", "story_id": "string", "updated_at": "2019-08-24T14:15:22Z", "user_id": "string" } }, "users": { "property1": { "abbreviated_timezone": "string", "account_membership_id": "string", "bio": "string", "city": "string", "classification": "string", "country": "string", "custom_field_value_ids": [ "string" ], "email_address": "string", "external_reference_ids": [ "string" ], "full_name": "string", "headline": "string", "last_site_activity": "2019-08-24T14:15:22Z", "manager_id": "string", "photo_path": "string", "role_id": "string", "skill_ids": [ "string" ], "skill_membership_ids": [ "string" ], "state": "string", "website": "string", "work_sample_ids": [ "string" ] }, "property2": { "abbreviated_timezone": "string", "account_membership_id": "string", "bio": "string", "city": "string", "classification": "string", "country": "string", "custom_field_value_ids": [ "string" ], "email_address": "string", "external_reference_ids": [ "string" ], "full_name": "string", "headline": "string", "last_site_activity": "2019-08-24T14:15:22Z", "manager_id": "string", "photo_path": "string", "role_id": "string", "skill_ids": [ "string" ], "skill_membership_ids": [ "string" ], "state": "string", "website": "string", "work_sample_ids": [ "string" ] } }, "stories": { "property1": { "ancestor_ids": [ "string" ], "ancestry_depth": 0, "archived": true, "archived_editable": true, "assigned_role_id": "string", "assignee_ids": [ "string" ], "assignment_timestamped_at": "2019-08-24T14:15:22Z", "attachment_ids": [ "string" ], "billable": true, "budget_estimate_in_cents": 0, "budget_used_in_cents": 0, "can_align_time": true, "can_edit": true, "can_post": true, "created_at": "2019-08-24T14:15:22Z", "creator_id": "string", "current_assignment_ids": [ "string" ], "custom_field_value_ids": [ "string" ], "custom_task_status_id": 0, "deleted_at": "2019-08-24T14:15:22Z", "descendant_ids": [ "string" ], "description": "string", "due_date": "2019-08-24", "external_reference_ids": [ "string" ], "fixed_fee": true, "follower_ids": [ "string" ], "formatted_description": "string", "google_document_ids": [ "string" ], "has_out_of_bounds_sads": true, "invoiced_balance_in_cents": 0, "is_time_trackable_type": true, "logged_billable_time_in_minutes": 0, "logged_nonbillable_time_in_minutes": 0, "parent_id": "string", "parsed_description": "string", "percentage_complete": 0, "position": 0, "potential_workspace_resource_ids": [ "string" ], "potential_workspace_resources_with_unnamed_ids": [ "string" ], "priority": 0, "project_plan": true, "read_only": true, "render_description_markdown": true, "reply_ids": [ "string" ], "root_id": "string", "source_dependency_ids": [ "string" ], "start_date": "2019-08-24", "state": "string", "status": "string", "story_state_change_ids": [ "string" ], "story_task_ids": [ "string" ], "story_type": "string", "sub_stories_billable_time_in_minutes": 0, "sub_stories_budget_estimate_in_cents": 0, "sub_stories_budget_used_in_cents": 0, "sub_stories_time_estimate_in_minutes": 0, "sub_story_count": 0, "sub_story_ids": [ "string" ], "subtree_depth": 0, "tag_ids": [ "string" ], "target_dependency_ids": [ "string" ], "time_estimate_in_minutes": 0, "time_trackable": true, "title": "string", "uninvoiced_balance_in_cents": 0, "updated_at": "2019-08-24T14:15:22Z", "weight": 0, "workspace_id": "string", "workspace_resource_ids": [ "string" ], "workspace_resources_with_unnamed_ids": [ "string" ] }, "property2": { "ancestor_ids": [ "string" ], "ancestry_depth": 0, "archived": true, "archived_editable": true, "assigned_role_id": "string", "assignee_ids": [ "string" ], "assignment_timestamped_at": "2019-08-24T14:15:22Z", "attachment_ids": [ "string" ], "billable": true, "budget_estimate_in_cents": 0, "budget_used_in_cents": 0, "can_align_time": true, "can_edit": true, "can_post": true, "created_at": "2019-08-24T14:15:22Z", "creator_id": "string", "current_assignment_ids": [ "string" ], "custom_field_value_ids": [ "string" ], "custom_task_status_id": 0, "deleted_at": "2019-08-24T14:15:22Z", "descendant_ids": [ "string" ], "description": "string", "due_date": "2019-08-24", "external_reference_ids": [ "string" ], "fixed_fee": true, "follower_ids": [ "string" ], "formatted_description": "string", "google_document_ids": [ "string" ], "has_out_of_bounds_sads": true, "invoiced_balance_in_cents": 0, "is_time_trackable_type": true, "logged_billable_time_in_minutes": 0, "logged_nonbillable_time_in_minutes": 0, "parent_id": "string", "parsed_description": "string", "percentage_complete": 0, "position": 0, "potential_workspace_resource_ids": [ "string" ], "potential_workspace_resources_with_unnamed_ids": [ "string" ], "priority": 0, "project_plan": true, "read_only": true, "render_description_markdown": true, "reply_ids": [ "string" ], "root_id": "string", "source_dependency_ids": [ "string" ], "start_date": "2019-08-24", "state": "string", "status": "string", "story_state_change_ids": [ "string" ], "story_task_ids": [ "string" ], "story_type": "string", "sub_stories_billable_time_in_minutes": 0, "sub_stories_budget_estimate_in_cents": 0, "sub_stories_budget_used_in_cents": 0, "sub_stories_time_estimate_in_minutes": 0, "sub_story_count": 0, "sub_story_ids": [ "string" ], "subtree_depth": 0, "tag_ids": [ "string" ], "target_dependency_ids": [ "string" ], "time_estimate_in_minutes": 0, "time_trackable": true, "title": "string", "uninvoiced_balance_in_cents": 0, "updated_at": "2019-08-24T14:15:22Z", "weight": 0, "workspace_id": "string", "workspace_resource_ids": [ "string" ], "workspace_resources_with_unnamed_ids": [ "string" ] } } }