StorySlim.md

Shortcut::StorySlim

Properties

Name	Type	Description	Notes
app_url	String	The Shortcut application url for the Story.
description	String	The description of the Story.	[optional]
archived	Boolean	True if the story has been archived or not.
started	Boolean	A true/false boolean indicating if the Story has been started.
story_links	Array<TypedStoryLink>	An array of story links attached to the Story.
entity_type	String	A string description of this resource.
labels	Array<LabelSlim>	An array of labels attached to the story.
task_ids	Array<Integer>	An array of IDs of Tasks attached to the story.
mention_ids	Array<String>	Deprecated: use member_mention_ids.
member_mention_ids	Array<String>	An array of Member IDs that have been mentioned in the Story description.
story_type	String	The type of story (feature, bug, chore).
file_ids	Array<Integer>	An array of IDs of Files attached to the story.
num_tasks_completed	Integer	The number of tasks on the story which are complete.
workflow_id	Integer	The ID of the workflow the story belongs to.
completed_at_override	Time	A manual override for the time/date the Story was completed.
started_at	Time	The time/date the Story was started.
completed_at	Time	The time/date the Story was completed.
name	String	The name of the story.
completed	Boolean	A true/false boolean indicating if the Story has been completed.
blocker	Boolean	A true/false boolean indicating if the Story is currently a blocker of another story.
epic_id	Integer	The ID of the epic the story belongs to.
story_template_id	String	The ID of the story template used to create this story, or null if not created using a template.
external_links	Array<String>	An array of external links (strings) associated with a Story
previous_iteration_ids	Array<Integer>	The IDs of the iteration the story belongs to.
requested_by_id	String	The ID of the Member that requested the story.
iteration_id	Integer	The ID of the iteration the story belongs to.
label_ids	Array<Integer>	An array of label ids attached to the story.
started_at_override	Time	A manual override for the time/date the Story was started.
group_id	String	The ID of the group associated with the story.
workflow_state_id	Integer	The ID of the workflow state the story is currently in.
updated_at	Time	The time/date the Story was updated.
group_mention_ids	Array<String>	An array of Group IDs that have been mentioned in the Story description.
follower_ids	Array<String>	An array of UUIDs for any Members listed as Followers.
owner_ids	Array<String>	An array of UUIDs of the owners of this story.
external_id	String	This field can be set to another unique ID. In the case that the Story has been imported from another tool, the ID in the other tool can be indicated here.
id	Integer	The unique ID of the Story.
lead_time	Integer	The lead time (in seconds) of this story when complete.	[optional]
estimate	Integer	The numeric point estimate of the story. Can also be null, which means unestimated.
position	Integer	A number representing the position of the story in relation to every other story in the current project.
blocked	Boolean	A true/false boolean indicating if the Story is currently blocked.
project_id	Integer	The ID of the project the story belongs to.
linked_file_ids	Array<Integer>	An array of IDs of LinkedFiles attached to the story.
deadline	Time	The due date of the story.
stats	StoryStats
comment_ids	Array<Integer>	An array of IDs of Comments attached to the story.
cycle_time	Integer	The cycle time (in seconds) of this story when complete.	[optional]
created_at	Time	The time/date the Story was created.
moved_at	Time	The time/date the Story was last changed workflow-state.

Example

require 'shortcut_client_ruby'

instance = Shortcut::StorySlim.new(
  app_url: null,
  description: null,
  archived: null,
  started: null,
  story_links: null,
  entity_type: null,
  labels: null,
  task_ids: null,
  mention_ids: null,
  member_mention_ids: null,
  story_type: null,
  file_ids: null,
  num_tasks_completed: null,
  workflow_id: null,
  completed_at_override: null,
  started_at: null,
  completed_at: null,
  name: null,
  completed: null,
  blocker: null,
  epic_id: null,
  story_template_id: null,
  external_links: null,
  previous_iteration_ids: null,
  requested_by_id: null,
  iteration_id: null,
  label_ids: null,
  started_at_override: null,
  group_id: null,
  workflow_state_id: null,
  updated_at: null,
  group_mention_ids: null,
  follower_ids: null,
  owner_ids: null,
  external_id: null,
  id: null,
  lead_time: null,
  estimate: null,
  position: null,
  blocked: null,
  project_id: null,
  linked_file_ids: null,
  deadline: null,
  stats: null,
  comment_ids: null,
  cycle_time: null,
  created_at: null,
  moved_at: null
)