shortcut_client_ruby
Shortcut - the Ruby gem for the Shortcut API
Shortcut API
This SDK is automatically generated by the Swagger Codegen project:
- API version: 3.0
- Package version: 0.0.3
- Build package: io.swagger.codegen.v3.generators.ruby.RubyClientCodegen
Installation
Build a gem
To build the Ruby code into a gem:
gem build shortcut_client_ruby.gemspec
Then either install the gem locally:
gem install ./shortcut_client_ruby-0.0.3.gem
(for development, run gem install --dev ./shortcut_client_ruby-0.0.3.gem to install the development dependencies)
or publish the gem to a gem hosting service, e.g. RubyGems.
Finally add this to the Gemfile:
gem 'shortcut_client_ruby', '~> 0.0.3'
Install from Git
If the Ruby gem is hosted at a git repository: https://github.com/ngouy/shortcut_client_ruby, then add the following in the Gemfile:
gem 'shortcut_client_ruby', :git => 'https://github.com/ngouy/shortcut_client_ruby.git'
Include the Ruby code directly
Include the Ruby code directly using -I as follows:
ruby -Ilib script.rb
Getting Started
Please follow the installation procedure and then run the following code:
# Load the gem
require 'shortcut_client_ruby'
# Setup authorization
Shortcut.configure do |config|
# Configure API key authorization: api_token
config.api_key['Shortcut-Token'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
#config.api_key_prefix['Shortcut-Token'] = 'Bearer'
end
api_instance = Shortcut::DefaultApi.new
body = Shortcut::CreateCategory.new # CreateCategory |
begin
#Create Category
result = api_instance.create_category(body)
p result
rescue Shortcut::ApiError => e
puts "Exception when calling DefaultApi->create_category: #{e}"
end
# Setup authorization
Shortcut.configure do |config|
# Configure API key authorization: api_token
config.api_key['Shortcut-Token'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
#config.api_key_prefix['Shortcut-Token'] = 'Bearer'
end
api_instance = Shortcut::DefaultApi.new
body = Shortcut::CreateEntityTemplate.new # CreateEntityTemplate | Request paramaters for creating an entirely new entity template.
begin
#Create Entity Template
result = api_instance.create_entity_template(body)
p result
rescue Shortcut::ApiError => e
puts "Exception when calling DefaultApi->create_entity_template: #{e}"
end
# Setup authorization
Shortcut.configure do |config|
# Configure API key authorization: api_token
config.api_key['Shortcut-Token'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
#config.api_key_prefix['Shortcut-Token'] = 'Bearer'
end
api_instance = Shortcut::DefaultApi.new
body = Shortcut::CreateEpic.new # CreateEpic |
begin
#Create Epic
result = api_instance.create_epic(body)
p result
rescue Shortcut::ApiError => e
puts "Exception when calling DefaultApi->create_epic: #{e}"
end
# Setup authorization
Shortcut.configure do |config|
# Configure API key authorization: api_token
config.api_key['Shortcut-Token'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
#config.api_key_prefix['Shortcut-Token'] = 'Bearer'
end
api_instance = Shortcut::DefaultApi.new
body = Shortcut::CreateEpicComment.new # CreateEpicComment |
epic_public_id = 789 # Integer | The ID of the associated Epic.
begin
#Create Epic Comment
result = api_instance.create_epic_comment(body, epic_public_id)
p result
rescue Shortcut::ApiError => e
puts "Exception when calling DefaultApi->create_epic_comment: #{e}"
end
# Setup authorization
Shortcut.configure do |config|
# Configure API key authorization: api_token
config.api_key['Shortcut-Token'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
#config.api_key_prefix['Shortcut-Token'] = 'Bearer'
end
api_instance = Shortcut::DefaultApi.new
body = Shortcut::CreateCommentComment.new # CreateCommentComment |
epic_public_id = 789 # Integer | The ID of the associated Epic.
comment_public_id = 789 # Integer | The ID of the parent Epic Comment.
begin
#Create Epic Comment Comment
result = api_instance.create_epic_comment_comment(body, epic_public_id, comment_public_id)
p result
rescue Shortcut::ApiError => e
puts "Exception when calling DefaultApi->create_epic_comment_comment: #{e}"
end
# Setup authorization
Shortcut.configure do |config|
# Configure API key authorization: api_token
config.api_key['Shortcut-Token'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
#config.api_key_prefix['Shortcut-Token'] = 'Bearer'
end
api_instance = Shortcut::DefaultApi.new
body = Shortcut::CreateGroup.new # CreateGroup |
begin
#Create Group
result = api_instance.create_group(body)
p result
rescue Shortcut::ApiError => e
puts "Exception when calling DefaultApi->create_group: #{e}"
end
# Setup authorization
Shortcut.configure do |config|
# Configure API key authorization: api_token
config.api_key['Shortcut-Token'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
#config.api_key_prefix['Shortcut-Token'] = 'Bearer'
end
api_instance = Shortcut::DefaultApi.new
body = Shortcut::CreateIteration.new # CreateIteration |
begin
#Create Iteration
result = api_instance.create_iteration(body)
p result
rescue Shortcut::ApiError => e
puts "Exception when calling DefaultApi->create_iteration: #{e}"
end
# Setup authorization
Shortcut.configure do |config|
# Configure API key authorization: api_token
config.api_key['Shortcut-Token'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
#config.api_key_prefix['Shortcut-Token'] = 'Bearer'
end
api_instance = Shortcut::DefaultApi.new
body = Shortcut::CreateLabelParams.new # CreateLabelParams | Request parameters for creating a Label on a Shortcut Story.
begin
#Create Label
result = api_instance.create_label(body)
p result
rescue Shortcut::ApiError => e
puts "Exception when calling DefaultApi->create_label: #{e}"
end
# Setup authorization
Shortcut.configure do |config|
# Configure API key authorization: api_token
config.api_key['Shortcut-Token'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
#config.api_key_prefix['Shortcut-Token'] = 'Bearer'
end
api_instance = Shortcut::DefaultApi.new
body = Shortcut::CreateLinkedFile.new # CreateLinkedFile |
begin
#Create Linked File
result = api_instance.create_linked_file(body)
p result
rescue Shortcut::ApiError => e
puts "Exception when calling DefaultApi->create_linked_file: #{e}"
end
# Setup authorization
Shortcut.configure do |config|
# Configure API key authorization: api_token
config.api_key['Shortcut-Token'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
#config.api_key_prefix['Shortcut-Token'] = 'Bearer'
end
api_instance = Shortcut::DefaultApi.new
body = Shortcut::CreateMilestone.new # CreateMilestone |
begin
#Create Milestone
result = api_instance.create_milestone(body)
p result
rescue Shortcut::ApiError => e
puts "Exception when calling DefaultApi->create_milestone: #{e}"
end
# Setup authorization
Shortcut.configure do |config|
# Configure API key authorization: api_token
config.api_key['Shortcut-Token'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
#config.api_key_prefix['Shortcut-Token'] = 'Bearer'
end
api_instance = Shortcut::DefaultApi.new
body = Shortcut::CreateStories.new # CreateStories |
begin
#Create Multiple Stories
result = api_instance.create_multiple_stories(body)
p result
rescue Shortcut::ApiError => e
puts "Exception when calling DefaultApi->create_multiple_stories: #{e}"
end
# Setup authorization
Shortcut.configure do |config|
# Configure API key authorization: api_token
config.api_key['Shortcut-Token'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
#config.api_key_prefix['Shortcut-Token'] = 'Bearer'
end
api_instance = Shortcut::DefaultApi.new
body = Shortcut::CreateProject.new # CreateProject |
begin
#Create Project
result = api_instance.create_project(body)
p result
rescue Shortcut::ApiError => e
puts "Exception when calling DefaultApi->create_project: #{e}"
end
# Setup authorization
Shortcut.configure do |config|
# Configure API key authorization: api_token
config.api_key['Shortcut-Token'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
#config.api_key_prefix['Shortcut-Token'] = 'Bearer'
end
api_instance = Shortcut::DefaultApi.new
body = Shortcut::CreateStoryParams.new # CreateStoryParams | Request parameters for creating a story.
begin
#Create Story
result = api_instance.create_story(body)
p result
rescue Shortcut::ApiError => e
puts "Exception when calling DefaultApi->create_story: #{e}"
end
# Setup authorization
Shortcut.configure do |config|
# Configure API key authorization: api_token
config.api_key['Shortcut-Token'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
#config.api_key_prefix['Shortcut-Token'] = 'Bearer'
end
api_instance = Shortcut::DefaultApi.new
body = Shortcut::CreateStoryComment.new # CreateStoryComment |
story_public_id = 789 # Integer | The ID of the Story that the Comment is in.
begin
#Create Story Comment
result = api_instance.create_story_comment(body, story_public_id)
p result
rescue Shortcut::ApiError => e
puts "Exception when calling DefaultApi->create_story_comment: #{e}"
end
# Setup authorization
Shortcut.configure do |config|
# Configure API key authorization: api_token
config.api_key['Shortcut-Token'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
#config.api_key_prefix['Shortcut-Token'] = 'Bearer'
end
api_instance = Shortcut::DefaultApi.new
body = Shortcut::CreateStoryLink.new # CreateStoryLink |
begin
#Create Story Link
result = api_instance.create_story_link(body)
p result
rescue Shortcut::ApiError => e
puts "Exception when calling DefaultApi->create_story_link: #{e}"
end
# Setup authorization
Shortcut.configure do |config|
# Configure API key authorization: api_token
config.api_key['Shortcut-Token'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
#config.api_key_prefix['Shortcut-Token'] = 'Bearer'
end
api_instance = Shortcut::DefaultApi.new
body = Shortcut::CreateOrDeleteStoryReaction.new # CreateOrDeleteStoryReaction |
story_public_id = 789 # Integer | The ID of the Story that the Comment is in.
comment_public_id = 789 # Integer | The ID of the Comment.
begin
#Create Story Reaction
result = api_instance.create_story_reaction(body, story_public_id, comment_public_id)
p result
rescue Shortcut::ApiError => e
puts "Exception when calling DefaultApi->create_story_reaction: #{e}"
end
# Setup authorization
Shortcut.configure do |config|
# Configure API key authorization: api_token
config.api_key['Shortcut-Token'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
#config.api_key_prefix['Shortcut-Token'] = 'Bearer'
end
api_instance = Shortcut::DefaultApi.new
body = Shortcut::CreateTask.new # CreateTask |
story_public_id = 789 # Integer | The ID of the Story that the Task will be in.
begin
#Create Task
result = api_instance.create_task(body, story_public_id)
p result
rescue Shortcut::ApiError => e
puts "Exception when calling DefaultApi->create_task: #{e}"
end
# Setup authorization
Shortcut.configure do |config|
# Configure API key authorization: api_token
config.api_key['Shortcut-Token'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
#config.api_key_prefix['Shortcut-Token'] = 'Bearer'
end
api_instance = Shortcut::DefaultApi.new
category_public_id = 789 # Integer | The unique ID of the Category.
begin
#Delete Category
api_instance.delete_category(category_public_id)
rescue Shortcut::ApiError => e
puts "Exception when calling DefaultApi->delete_category: #{e}"
end
# Setup authorization
Shortcut.configure do |config|
# Configure API key authorization: api_token
config.api_key['Shortcut-Token'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
#config.api_key_prefix['Shortcut-Token'] = 'Bearer'
end
api_instance = Shortcut::DefaultApi.new
entity_template_public_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | The unique ID of the entity template.
begin
#Delete Entity Template
api_instance.delete_entity_template(entity_template_public_id)
rescue Shortcut::ApiError => e
puts "Exception when calling DefaultApi->delete_entity_template: #{e}"
end
# Setup authorization
Shortcut.configure do |config|
# Configure API key authorization: api_token
config.api_key['Shortcut-Token'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
#config.api_key_prefix['Shortcut-Token'] = 'Bearer'
end
api_instance = Shortcut::DefaultApi.new
epic_public_id = 789 # Integer | The unique ID of the Epic.
begin
#Delete Epic
api_instance.delete_epic(epic_public_id)
rescue Shortcut::ApiError => e
puts "Exception when calling DefaultApi->delete_epic: #{e}"
end
# Setup authorization
Shortcut.configure do |config|
# Configure API key authorization: api_token
config.api_key['Shortcut-Token'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
#config.api_key_prefix['Shortcut-Token'] = 'Bearer'
end
api_instance = Shortcut::DefaultApi.new
epic_public_id = 789 # Integer | The ID of the associated Epic.
comment_public_id = 789 # Integer | The ID of the Comment.
begin
#Delete Epic Comment
api_instance.delete_epic_comment(epic_public_id, comment_public_id)
rescue Shortcut::ApiError => e
puts "Exception when calling DefaultApi->delete_epic_comment: #{e}"
end
# Setup authorization
Shortcut.configure do |config|
# Configure API key authorization: api_token
config.api_key['Shortcut-Token'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
#config.api_key_prefix['Shortcut-Token'] = 'Bearer'
end
api_instance = Shortcut::DefaultApi.new
file_public_id = 789 # Integer | The File’s unique ID.
begin
#Delete File
api_instance.delete_file(file_public_id)
rescue Shortcut::ApiError => e
puts "Exception when calling DefaultApi->delete_file: #{e}"
end
# Setup authorization
Shortcut.configure do |config|
# Configure API key authorization: api_token
config.api_key['Shortcut-Token'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
#config.api_key_prefix['Shortcut-Token'] = 'Bearer'
end
api_instance = Shortcut::DefaultApi.new
iteration_public_id = 789 # Integer | The unique ID of the Iteration.
begin
#Delete Iteration
api_instance.delete_iteration(iteration_public_id)
rescue Shortcut::ApiError => e
puts "Exception when calling DefaultApi->delete_iteration: #{e}"
end
# Setup authorization
Shortcut.configure do |config|
# Configure API key authorization: api_token
config.api_key['Shortcut-Token'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
#config.api_key_prefix['Shortcut-Token'] = 'Bearer'
end
api_instance = Shortcut::DefaultApi.new
label_public_id = 789 # Integer | The unique ID of the Label.
begin
#Delete Label
api_instance.delete_label(label_public_id)
rescue Shortcut::ApiError => e
puts "Exception when calling DefaultApi->delete_label: #{e}"
end
# Setup authorization
Shortcut.configure do |config|
# Configure API key authorization: api_token
config.api_key['Shortcut-Token'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
#config.api_key_prefix['Shortcut-Token'] = 'Bearer'
end
api_instance = Shortcut::DefaultApi.new
linked_file_public_id = 789 # Integer | The unique identifier of the linked file.
begin
#Delete Linked File
api_instance.delete_linked_file(linked_file_public_id)
rescue Shortcut::ApiError => e
puts "Exception when calling DefaultApi->delete_linked_file: #{e}"
end
# Setup authorization
Shortcut.configure do |config|
# Configure API key authorization: api_token
config.api_key['Shortcut-Token'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
#config.api_key_prefix['Shortcut-Token'] = 'Bearer'
end
api_instance = Shortcut::DefaultApi.new
milestone_public_id = 789 # Integer | The ID of the Milestone.
begin
#Delete Milestone
api_instance.delete_milestone(milestone_public_id)
rescue Shortcut::ApiError => e
puts "Exception when calling DefaultApi->delete_milestone: #{e}"
end
# Setup authorization
Shortcut.configure do |config|
# Configure API key authorization: api_token
config.api_key['Shortcut-Token'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
#config.api_key_prefix['Shortcut-Token'] = 'Bearer'
end
api_instance = Shortcut::DefaultApi.new
body = Shortcut::DeleteStories.new # DeleteStories |
begin
#Delete Multiple Stories
api_instance.delete_multiple_stories(body)
rescue Shortcut::ApiError => e
puts "Exception when calling DefaultApi->delete_multiple_stories: #{e}"
end
# Setup authorization
Shortcut.configure do |config|
# Configure API key authorization: api_token
config.api_key['Shortcut-Token'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
#config.api_key_prefix['Shortcut-Token'] = 'Bearer'
end
api_instance = Shortcut::DefaultApi.new
project_public_id = 789 # Integer | The unique ID of the Project.
begin
#Delete Project
api_instance.delete_project(project_public_id)
rescue Shortcut::ApiError => e
puts "Exception when calling DefaultApi->delete_project: #{e}"
end
# Setup authorization
Shortcut.configure do |config|
# Configure API key authorization: api_token
config.api_key['Shortcut-Token'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
#config.api_key_prefix['Shortcut-Token'] = 'Bearer'
end
api_instance = Shortcut::DefaultApi.new
story_public_id = 789 # Integer | The ID of the Story.
begin
#Delete Story
api_instance.delete_story(story_public_id)
rescue Shortcut::ApiError => e
puts "Exception when calling DefaultApi->delete_story: #{e}"
end
# Setup authorization
Shortcut.configure do |config|
# Configure API key authorization: api_token
config.api_key['Shortcut-Token'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
#config.api_key_prefix['Shortcut-Token'] = 'Bearer'
end
api_instance = Shortcut::DefaultApi.new
story_public_id = 789 # Integer | The ID of the Story that the Comment is in.
comment_public_id = 789 # Integer | The ID of the Comment.
begin
#Delete Story Comment
api_instance.delete_story_comment(story_public_id, comment_public_id)
rescue Shortcut::ApiError => e
puts "Exception when calling DefaultApi->delete_story_comment: #{e}"
end
# Setup authorization
Shortcut.configure do |config|
# Configure API key authorization: api_token
config.api_key['Shortcut-Token'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
#config.api_key_prefix['Shortcut-Token'] = 'Bearer'
end
api_instance = Shortcut::DefaultApi.new
story_link_public_id = 789 # Integer | The unique ID of the Story Link.
begin
#Delete Story Link
api_instance.delete_story_link(story_link_public_id)
rescue Shortcut::ApiError => e
puts "Exception when calling DefaultApi->delete_story_link: #{e}"
end
# Setup authorization
Shortcut.configure do |config|
# Configure API key authorization: api_token
config.api_key['Shortcut-Token'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
#config.api_key_prefix['Shortcut-Token'] = 'Bearer'
end
api_instance = Shortcut::DefaultApi.new
body = Shortcut::CreateOrDeleteStoryReaction.new # CreateOrDeleteStoryReaction |
story_public_id = 789 # Integer | The ID of the Story that the Comment is in.
comment_public_id = 789 # Integer | The ID of the Comment.
begin
#Delete Story Reaction
api_instance.delete_story_reaction(body, story_public_id, comment_public_id)
rescue Shortcut::ApiError => e
puts "Exception when calling DefaultApi->delete_story_reaction: #{e}"
end
# Setup authorization
Shortcut.configure do |config|
# Configure API key authorization: api_token
config.api_key['Shortcut-Token'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
#config.api_key_prefix['Shortcut-Token'] = 'Bearer'
end
api_instance = Shortcut::DefaultApi.new
story_public_id = 789 # Integer | The unique ID of the Story this Task is associated with.
task_public_id = 789 # Integer | The unique ID of the Task.
begin
#Delete Task
api_instance.delete_task(story_public_id, task_public_id)
rescue Shortcut::ApiError => e
puts "Exception when calling DefaultApi->delete_task: #{e}"
end
# Setup authorization
Shortcut.configure do |config|
# Configure API key authorization: api_token
config.api_key['Shortcut-Token'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
#config.api_key_prefix['Shortcut-Token'] = 'Bearer'
end
api_instance = Shortcut::DefaultApi.new
begin
#Disable Groups
api_instance.disable_groups
rescue Shortcut::ApiError => e
puts "Exception when calling DefaultApi->disable_groups: #{e}"
end
# Setup authorization
Shortcut.configure do |config|
# Configure API key authorization: api_token
config.api_key['Shortcut-Token'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
#config.api_key_prefix['Shortcut-Token'] = 'Bearer'
end
api_instance = Shortcut::DefaultApi.new
begin
#Disable Iterations
api_instance.disable_iterations
rescue Shortcut::ApiError => e
puts "Exception when calling DefaultApi->disable_iterations: #{e}"
end
# Setup authorization
Shortcut.configure do |config|
# Configure API key authorization: api_token
config.api_key['Shortcut-Token'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
#config.api_key_prefix['Shortcut-Token'] = 'Bearer'
end
api_instance = Shortcut::DefaultApi.new
begin
#Disable Story Templates
api_instance.disable_story_templates
rescue Shortcut::ApiError => e
puts "Exception when calling DefaultApi->disable_story_templates: #{e}"
end
# Setup authorization
Shortcut.configure do |config|
# Configure API key authorization: api_token
config.api_key['Shortcut-Token'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
#config.api_key_prefix['Shortcut-Token'] = 'Bearer'
end
api_instance = Shortcut::DefaultApi.new
begin
#Enable Groups
api_instance.enable_groups
rescue Shortcut::ApiError => e
puts "Exception when calling DefaultApi->enable_groups: #{e}"
end
# Setup authorization
Shortcut.configure do |config|
# Configure API key authorization: api_token
config.api_key['Shortcut-Token'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
#config.api_key_prefix['Shortcut-Token'] = 'Bearer'
end
api_instance = Shortcut::DefaultApi.new
begin
#Enable Iterations
api_instance.enable_iterations
rescue Shortcut::ApiError => e
puts "Exception when calling DefaultApi->enable_iterations: #{e}"
end
# Setup authorization
Shortcut.configure do |config|
# Configure API key authorization: api_token
config.api_key['Shortcut-Token'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
#config.api_key_prefix['Shortcut-Token'] = 'Bearer'
end
api_instance = Shortcut::DefaultApi.new
begin
#Enable Story Templates
api_instance.enable_story_templates
rescue Shortcut::ApiError => e
puts "Exception when calling DefaultApi->enable_story_templates: #{e}"
end
# Setup authorization
Shortcut.configure do |config|
# Configure API key authorization: api_token
config.api_key['Shortcut-Token'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
#config.api_key_prefix['Shortcut-Token'] = 'Bearer'
end
api_instance = Shortcut::DefaultApi.new
category_public_id = 789 # Integer | The unique ID of the Category.
begin
#Get Category
result = api_instance.get_category(category_public_id)
p result
rescue Shortcut::ApiError => e
puts "Exception when calling DefaultApi->get_category: #{e}"
end
# Setup authorization
Shortcut.configure do |config|
# Configure API key authorization: api_token
config.api_key['Shortcut-Token'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
#config.api_key_prefix['Shortcut-Token'] = 'Bearer'
end
api_instance = Shortcut::DefaultApi.new
begin
#Get Current Member Info
result = api_instance.get_current_member_info
p result
rescue Shortcut::ApiError => e
puts "Exception when calling DefaultApi->get_current_member_info: #{e}"
end
# Setup authorization
Shortcut.configure do |config|
# Configure API key authorization: api_token
config.api_key['Shortcut-Token'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
#config.api_key_prefix['Shortcut-Token'] = 'Bearer'
end
api_instance = Shortcut::DefaultApi.new
entity_template_public_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | The unique ID of the entity template.
begin
#Get Entity Template
result = api_instance.get_entity_template(entity_template_public_id)
p result
rescue Shortcut::ApiError => e
puts "Exception when calling DefaultApi->get_entity_template: #{e}"
end
# Setup authorization
Shortcut.configure do |config|
# Configure API key authorization: api_token
config.api_key['Shortcut-Token'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
#config.api_key_prefix['Shortcut-Token'] = 'Bearer'
end
api_instance = Shortcut::DefaultApi.new
epic_public_id = 789 # Integer | The unique ID of the Epic.
begin
#Get Epic
result = api_instance.get_epic(epic_public_id)
p result
rescue Shortcut::ApiError => e
puts "Exception when calling DefaultApi->get_epic: #{e}"
end
# Setup authorization
Shortcut.configure do |config|
# Configure API key authorization: api_token
config.api_key['Shortcut-Token'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
#config.api_key_prefix['Shortcut-Token'] = 'Bearer'
end
api_instance = Shortcut::DefaultApi.new
epic_public_id = 789 # Integer | The ID of the associated Epic.
comment_public_id = 789 # Integer | The ID of the Comment.
begin
#Get Epic Comment
result = api_instance.get_epic_comment(epic_public_id, comment_public_id)
p result
rescue Shortcut::ApiError => e
puts "Exception when calling DefaultApi->get_epic_comment: #{e}"
end
# Setup authorization
Shortcut.configure do |config|
# Configure API key authorization: api_token
config.api_key['Shortcut-Token'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
#config.api_key_prefix['Shortcut-Token'] = 'Bearer'
end
api_instance = Shortcut::DefaultApi.new
begin
#Get Epic Workflow
result = api_instance.get_epic_workflow
p result
rescue Shortcut::ApiError => e
puts "Exception when calling DefaultApi->get_epic_workflow: #{e}"
end
# Setup authorization
Shortcut.configure do |config|
# Configure API key authorization: api_token
config.api_key['Shortcut-Token'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
#config.api_key_prefix['Shortcut-Token'] = 'Bearer'
end
api_instance = Shortcut::DefaultApi.new
body = Shortcut::GetExternalLinkStoriesParams.new # GetExternalLinkStoriesParams |
begin
#Get External Link Stories
result = api_instance.get_external_link_stories(body)
p result
rescue Shortcut::ApiError => e
puts "Exception when calling DefaultApi->get_external_link_stories: #{e}"
end
# Setup authorization
Shortcut.configure do |config|
# Configure API key authorization: api_token
config.api_key['Shortcut-Token'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
#config.api_key_prefix['Shortcut-Token'] = 'Bearer'
end
api_instance = Shortcut::DefaultApi.new
file_public_id = 789 # Integer | The File’s unique ID.
begin
#Get File
result = api_instance.get_file(file_public_id)
p result
rescue Shortcut::ApiError => e
puts "Exception when calling DefaultApi->get_file: #{e}"
end
# Setup authorization
Shortcut.configure do |config|
# Configure API key authorization: api_token
config.api_key['Shortcut-Token'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
#config.api_key_prefix['Shortcut-Token'] = 'Bearer'
end
api_instance = Shortcut::DefaultApi.new
group_public_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | The unique ID of the Group.
begin
#Get Group
result = api_instance.get_group(group_public_id)
p result
rescue Shortcut::ApiError => e
puts "Exception when calling DefaultApi->get_group: #{e}"
end
# Setup authorization
Shortcut.configure do |config|
# Configure API key authorization: api_token
config.api_key['Shortcut-Token'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
#config.api_key_prefix['Shortcut-Token'] = 'Bearer'
end
api_instance = Shortcut::DefaultApi.new
iteration_public_id = 789 # Integer | The unique ID of the Iteration.
begin
#Get Iteration
result = api_instance.get_iteration(iteration_public_id)
p result
rescue Shortcut::ApiError => e
puts "Exception when calling DefaultApi->get_iteration: #{e}"
end
# Setup authorization
Shortcut.configure do |config|
# Configure API key authorization: api_token
config.api_key['Shortcut-Token'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
#config.api_key_prefix['Shortcut-Token'] = 'Bearer'
end
api_instance = Shortcut::DefaultApi.new
label_public_id = 789 # Integer | The unique ID of the Label.
begin
#Get Label
result = api_instance.get_label(label_public_id)
p result
rescue Shortcut::ApiError => e
puts "Exception when calling DefaultApi->get_label: #{e}"
end
# Setup authorization
Shortcut.configure do |config|
# Configure API key authorization: api_token
config.api_key['Shortcut-Token'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
#config.api_key_prefix['Shortcut-Token'] = 'Bearer'
end
api_instance = Shortcut::DefaultApi.new
linked_file_public_id = 789 # Integer | The unique identifier of the linked file.
begin
#Get Linked File
result = api_instance.get_linked_file(linked_file_public_id)
p result
rescue Shortcut::ApiError => e
puts "Exception when calling DefaultApi->get_linked_file: #{e}"
end
# Setup authorization
Shortcut.configure do |config|
# Configure API key authorization: api_token
config.api_key['Shortcut-Token'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
#config.api_key_prefix['Shortcut-Token'] = 'Bearer'
end
api_instance = Shortcut::DefaultApi.new
body = Shortcut::GetMember.new # GetMember |
member_public_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | The Member's unique ID.
begin
#Get Member
result = api_instance.get_member(body, member_public_id)
p result
rescue Shortcut::ApiError => e
puts "Exception when calling DefaultApi->get_member: #{e}"
end
# Setup authorization
Shortcut.configure do |config|
# Configure API key authorization: api_token
config.api_key['Shortcut-Token'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
#config.api_key_prefix['Shortcut-Token'] = 'Bearer'
end
api_instance = Shortcut::DefaultApi.new
milestone_public_id = 789 # Integer | The ID of the Milestone.
begin
#Get Milestone
result = api_instance.get_milestone(milestone_public_id)
p result
rescue Shortcut::ApiError => e
puts "Exception when calling DefaultApi->get_milestone: #{e}"
end
# Setup authorization
Shortcut.configure do |config|
# Configure API key authorization: api_token
config.api_key['Shortcut-Token'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
#config.api_key_prefix['Shortcut-Token'] = 'Bearer'
end
api_instance = Shortcut::DefaultApi.new
project_public_id = 789 # Integer | The unique ID of the Project.
begin
#Get Project
result = api_instance.get_project(project_public_id)
p result
rescue Shortcut::ApiError => e
puts "Exception when calling DefaultApi->get_project: #{e}"
end
# Setup authorization
Shortcut.configure do |config|
# Configure API key authorization: api_token
config.api_key['Shortcut-Token'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
#config.api_key_prefix['Shortcut-Token'] = 'Bearer'
end
api_instance = Shortcut::DefaultApi.new
repo_public_id = 789 # Integer | The unique ID of the Repository.
begin
#Get Repository
result = api_instance.get_repository(repo_public_id)
p result
rescue Shortcut::ApiError => e
puts "Exception when calling DefaultApi->get_repository: #{e}"
end
# Setup authorization
Shortcut.configure do |config|
# Configure API key authorization: api_token
config.api_key['Shortcut-Token'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
#config.api_key_prefix['Shortcut-Token'] = 'Bearer'
end
api_instance = Shortcut::DefaultApi.new
story_public_id = 789 # Integer | The ID of the Story.
begin
#Get Story
result = api_instance.get_story(story_public_id)
p result
rescue Shortcut::ApiError => e
puts "Exception when calling DefaultApi->get_story: #{e}"
end
# Setup authorization
Shortcut.configure do |config|
# Configure API key authorization: api_token
config.api_key['Shortcut-Token'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
#config.api_key_prefix['Shortcut-Token'] = 'Bearer'
end
api_instance = Shortcut::DefaultApi.new
story_public_id = 789 # Integer | The ID of the Story that the Comment is in.
comment_public_id = 789 # Integer | The ID of the Comment.
begin
#Get Story Comment
result = api_instance.get_story_comment(story_public_id, comment_public_id)
p result
rescue Shortcut::ApiError => e
puts "Exception when calling DefaultApi->get_story_comment: #{e}"
end
# Setup authorization
Shortcut.configure do |config|
# Configure API key authorization: api_token
config.api_key['Shortcut-Token'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
#config.api_key_prefix['Shortcut-Token'] = 'Bearer'
end
api_instance = Shortcut::DefaultApi.new
story_link_public_id = 789 # Integer | The unique ID of the Story Link.
begin
#Get Story Link
result = api_instance.get_story_link(story_link_public_id)
p result
rescue Shortcut::ApiError => e
puts "Exception when calling DefaultApi->get_story_link: #{e}"
end
# Setup authorization
Shortcut.configure do |config|
# Configure API key authorization: api_token
config.api_key['Shortcut-Token'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
#config.api_key_prefix['Shortcut-Token'] = 'Bearer'
end
api_instance = Shortcut::DefaultApi.new
story_public_id = 789 # Integer | The unique ID of the Story this Task is associated with.
task_public_id = 789 # Integer | The unique ID of the Task.
begin
#Get Task
result = api_instance.get_task(story_public_id, task_public_id)
p result
rescue Shortcut::ApiError => e
puts "Exception when calling DefaultApi->get_task: #{e}"
end
# Setup authorization
Shortcut.configure do |config|
# Configure API key authorization: api_token
config.api_key['Shortcut-Token'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
#config.api_key_prefix['Shortcut-Token'] = 'Bearer'
end
api_instance = Shortcut::DefaultApi.new
workflow_public_id = 789 # Integer | The ID of the Workflow.
begin
#Get Workflow
result = api_instance.get_workflow(workflow_public_id)
p result
rescue Shortcut::ApiError => e
puts "Exception when calling DefaultApi->get_workflow: #{e}"
end
# Setup authorization
Shortcut.configure do |config|
# Configure API key authorization: api_token
config.api_key['Shortcut-Token'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
#config.api_key_prefix['Shortcut-Token'] = 'Bearer'
end
api_instance = Shortcut::DefaultApi.new
begin
#List Categories
result = api_instance.list_categories
p result
rescue Shortcut::ApiError => e
puts "Exception when calling DefaultApi->list_categories: #{e}"
end
# Setup authorization
Shortcut.configure do |config|
# Configure API key authorization: api_token
config.api_key['Shortcut-Token'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
#config.api_key_prefix['Shortcut-Token'] = 'Bearer'
end
api_instance = Shortcut::DefaultApi.new
category_public_id = 789 # Integer | The unique ID of the Category.
begin
#List Category Milestones
result = api_instance.list_category_milestones(category_public_id)
p result
rescue Shortcut::ApiError => e
puts "Exception when calling DefaultApi->list_category_milestones: #{e}"
end
# Setup authorization
Shortcut.configure do |config|
# Configure API key authorization: api_token
config.api_key['Shortcut-Token'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
#config.api_key_prefix['Shortcut-Token'] = 'Bearer'
end
api_instance = Shortcut::DefaultApi.new
begin
#List Entity Templates
result = api_instance.list_entity_templates
p result
rescue Shortcut::ApiError => e
puts "Exception when calling DefaultApi->list_entity_templates: #{e}"
end
# Setup authorization
Shortcut.configure do |config|
# Configure API key authorization: api_token
config.api_key['Shortcut-Token'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
#config.api_key_prefix['Shortcut-Token'] = 'Bearer'
end
api_instance = Shortcut::DefaultApi.new
epic_public_id = 789 # Integer | The unique ID of the Epic.
begin
#List Epic Comments
result = api_instance.list_epic_comments(epic_public_id)
p result
rescue Shortcut::ApiError => e
puts "Exception when calling DefaultApi->list_epic_comments: #{e}"
end
# Setup authorization
Shortcut.configure do |config|
# Configure API key authorization: api_token
config.api_key['Shortcut-Token'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
#config.api_key_prefix['Shortcut-Token'] = 'Bearer'
end
api_instance = Shortcut::DefaultApi.new
body = Shortcut::GetEpicStories.new # GetEpicStories |
epic_public_id = 789 # Integer | The unique ID of the Epic.
begin
#List Epic Stories
result = api_instance.list_epic_stories(body, epic_public_id)
p result
rescue Shortcut::ApiError => e
puts "Exception when calling DefaultApi->list_epic_stories: #{e}"
end
# Setup authorization
Shortcut.configure do |config|
# Configure API key authorization: api_token
config.api_key['Shortcut-Token'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
#config.api_key_prefix['Shortcut-Token'] = 'Bearer'
end
api_instance = Shortcut::DefaultApi.new
body = Shortcut::ListEpics.new # ListEpics |
begin
#List Epics
result = api_instance.list_epics(body)
p result
rescue Shortcut::ApiError => e
puts "Exception when calling DefaultApi->list_epics: #{e}"
end
# Setup authorization
Shortcut.configure do |config|
# Configure API key authorization: api_token
config.api_key['Shortcut-Token'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
#config.api_key_prefix['Shortcut-Token'] = 'Bearer'
end
api_instance = Shortcut::DefaultApi.new
begin
#List Files
result = api_instance.list_files
p result
rescue Shortcut::ApiError => e
puts "Exception when calling DefaultApi->list_files: #{e}"
end
# Setup authorization
Shortcut.configure do |config|
# Configure API key authorization: api_token
config.api_key['Shortcut-Token'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
#config.api_key_prefix['Shortcut-Token'] = 'Bearer'
end
api_instance = Shortcut::DefaultApi.new
body = Shortcut::ListGroupStories.new # ListGroupStories |
group_public_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | The unique ID of the Group.
begin
#List Group Stories
result = api_instance.list_group_stories(body, group_public_id)
p result
rescue Shortcut::ApiError => e
puts "Exception when calling DefaultApi->list_group_stories: #{e}"
end
# Setup authorization
Shortcut.configure do |config|
# Configure API key authorization: api_token
config.api_key['Shortcut-Token'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
#config.api_key_prefix['Shortcut-Token'] = 'Bearer'
end
api_instance = Shortcut::DefaultApi.new
begin
#List Groups
result = api_instance.list_groups
p result
rescue Shortcut::ApiError => e
puts "Exception when calling DefaultApi->list_groups: #{e}"
end
# Setup authorization
Shortcut.configure do |config|
# Configure API key authorization: api_token
config.api_key['Shortcut-Token'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
#config.api_key_prefix['Shortcut-Token'] = 'Bearer'
end
api_instance = Shortcut::DefaultApi.new
body = Shortcut::GetIterationStories.new # GetIterationStories |
iteration_public_id = 789 # Integer | The unique ID of the Iteration.
begin
#List Iteration Stories
result = api_instance.list_iteration_stories(body, iteration_public_id)
p result
rescue Shortcut::ApiError => e
puts "Exception when calling DefaultApi->list_iteration_stories: #{e}"
end
# Setup authorization
Shortcut.configure do |config|
# Configure API key authorization: api_token
config.api_key['Shortcut-Token'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
#config.api_key_prefix['Shortcut-Token'] = 'Bearer'
end
api_instance = Shortcut::DefaultApi.new
begin
#List Iterations
result = api_instance.list_iterations
p result
rescue Shortcut::ApiError => e
puts "Exception when calling DefaultApi->list_iterations: #{e}"
end
# Setup authorization
Shortcut.configure do |config|
# Configure API key authorization: api_token
config.api_key['Shortcut-Token'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
#config.api_key_prefix['Shortcut-Token'] = 'Bearer'
end
api_instance = Shortcut::DefaultApi.new
label_public_id = 789 # Integer | The unique ID of the Label.
begin
#List Label Epics
result = api_instance.list_label_epics(label_public_id)
p result
rescue Shortcut::ApiError => e
puts "Exception when calling DefaultApi->list_label_epics: #{e}"
end
# Setup authorization
Shortcut.configure do |config|
# Configure API key authorization: api_token
config.api_key['Shortcut-Token'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
#config.api_key_prefix['Shortcut-Token'] = 'Bearer'
end
api_instance = Shortcut::DefaultApi.new
body = Shortcut::GetLabelStories.new # GetLabelStories |
label_public_id = 789 # Integer | The unique ID of the Label.
begin
#List Label Stories
result = api_instance.list_label_stories(body, label_public_id)
p result
rescue Shortcut::ApiError => e
puts "Exception when calling DefaultApi->list_label_stories: #{e}"
end
# Setup authorization
Shortcut.configure do |config|
# Configure API key authorization: api_token
config.api_key['Shortcut-Token'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
#config.api_key_prefix['Shortcut-Token'] = 'Bearer'
end
api_instance = Shortcut::DefaultApi.new
body = Shortcut::ListLabels.new # ListLabels |
begin
#List Labels
result = api_instance.list_labels(body)
p result
rescue Shortcut::ApiError => e
puts "Exception when calling DefaultApi->list_labels: #{e}"
end
# Setup authorization
Shortcut.configure do |config|
# Configure API key authorization: api_token
config.api_key['Shortcut-Token'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
#config.api_key_prefix['Shortcut-Token'] = 'Bearer'
end
api_instance = Shortcut::DefaultApi.new
begin
#List Linked Files
result = api_instance.list_linked_files
p result
rescue Shortcut::ApiError => e
puts "Exception when calling DefaultApi->list_linked_files: #{e}"
end
# Setup authorization
Shortcut.configure do |config|
# Configure API key authorization: api_token
config.api_key['Shortcut-Token'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
#config.api_key_prefix['Shortcut-Token'] = 'Bearer'
end
api_instance = Shortcut::DefaultApi.new
body = Shortcut::ListMembers.new # ListMembers |
begin
#List Members
result = api_instance.list_members(body)
p result
rescue Shortcut::ApiError => e
puts "Exception when calling DefaultApi->list_members: #{e}"
end
# Setup authorization
Shortcut.configure do |config|
# Configure API key authorization: api_token
config.api_key['Shortcut-Token'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
#config.api_key_prefix['Shortcut-Token'] = 'Bearer'
end
api_instance = Shortcut::DefaultApi.new
milestone_public_id = 789 # Integer | The ID of the Milestone.
begin
#List Milestone Epics
result = api_instance.list_milestone_epics(milestone_public_id)
p result
rescue Shortcut::ApiError => e
puts "Exception when calling DefaultApi->list_milestone_epics: #{e}"
end
# Setup authorization
Shortcut.configure do |config|
# Configure API key authorization: api_token
config.api_key['Shortcut-Token'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
#config.api_key_prefix['Shortcut-Token'] = 'Bearer'
end
api_instance = Shortcut::DefaultApi.new
begin
#List Milestones
result = api_instance.list_milestones
p result
rescue Shortcut::ApiError => e
puts "Exception when calling DefaultApi->list_milestones: #{e}"
end
# Setup authorization
Shortcut.configure do |config|
# Configure API key authorization: api_token
config.api_key['Shortcut-Token'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
#config.api_key_prefix['Shortcut-Token'] = 'Bearer'
end
api_instance = Shortcut::DefaultApi.new
begin
#List Projects
result = api_instance.list_projects
p result
rescue Shortcut::ApiError => e
puts "Exception when calling DefaultApi->list_projects: #{e}"
end
# Setup authorization
Shortcut.configure do |config|
# Configure API key authorization: api_token
config.api_key['Shortcut-Token'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
#config.api_key_prefix['Shortcut-Token'] = 'Bearer'
end
api_instance = Shortcut::DefaultApi.new
begin
#List Repositories
result = api_instance.list_repositories
p result
rescue Shortcut::ApiError => e
puts "Exception when calling DefaultApi->list_repositories: #{e}"
end
# Setup authorization
Shortcut.configure do |config|
# Configure API key authorization: api_token
config.api_key['Shortcut-Token'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
#config.api_key_prefix['Shortcut-Token'] = 'Bearer'
end
api_instance = Shortcut::DefaultApi.new
body = Shortcut::GetProjectStories.new # GetProjectStories |
project_public_id = 789 # Integer | The unique ID of the Project.
begin
#List Stories
result = api_instance.list_stories(body, project_public_id)
p result
rescue Shortcut::ApiError => e
puts "Exception when calling DefaultApi->list_stories: #{e}"
end
# Setup authorization
Shortcut.configure do |config|
# Configure API key authorization: api_token
config.api_key['Shortcut-Token'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
#config.api_key_prefix['Shortcut-Token'] = 'Bearer'
end
api_instance = Shortcut::DefaultApi.new
begin
#List Workflows
result = api_instance.list_workflows
p result
rescue Shortcut::ApiError => e
puts "Exception when calling DefaultApi->list_workflows: #{e}"
end
# Setup authorization
Shortcut.configure do |config|
# Configure API key authorization: api_token
config.api_key['Shortcut-Token'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
#config.api_key_prefix['Shortcut-Token'] = 'Bearer'
end
api_instance = Shortcut::DefaultApi.new
body = Shortcut::Search.new # Search |
begin
#Search
result = api_instance.search(body)
p result
rescue Shortcut::ApiError => e
puts "Exception when calling DefaultApi->search: #{e}"
end
# Setup authorization
Shortcut.configure do |config|
# Configure API key authorization: api_token
config.api_key['Shortcut-Token'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
#config.api_key_prefix['Shortcut-Token'] = 'Bearer'
end
api_instance = Shortcut::DefaultApi.new
body = Shortcut::Search.new # Search |
begin
#Search Epics
result = api_instance.search_epics(body)
p result
rescue Shortcut::ApiError => e
puts "Exception when calling DefaultApi->search_epics: #{e}"
end
# Setup authorization
Shortcut.configure do |config|
# Configure API key authorization: api_token
config.api_key['Shortcut-Token'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
#config.api_key_prefix['Shortcut-Token'] = 'Bearer'
end
api_instance = Shortcut::DefaultApi.new
body = Shortcut::Search.new # Search |
begin
#Search Stories
result = api_instance.search_stories(body)
p result
rescue Shortcut::ApiError => e
puts "Exception when calling DefaultApi->search_stories: #{e}"
end
# Setup authorization
Shortcut.configure do |config|
# Configure API key authorization: api_token
config.api_key['Shortcut-Token'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
#config.api_key_prefix['Shortcut-Token'] = 'Bearer'
end
api_instance = Shortcut::DefaultApi.new
body = Shortcut::SearchStories.new # SearchStories |
begin
#Search Stories (Old)
result = api_instance.search_stories_old(body)
p result
rescue Shortcut::ApiError => e
puts "Exception when calling DefaultApi->search_stories_old: #{e}"
end
# Setup authorization
Shortcut.configure do |config|
# Configure API key authorization: api_token
config.api_key['Shortcut-Token'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
#config.api_key_prefix['Shortcut-Token'] = 'Bearer'
end
api_instance = Shortcut::DefaultApi.new
story_public_id = 789 # Integer | The ID of the Story.
begin
#Story History
result = api_instance.story_history(story_public_id)
p result
rescue Shortcut::ApiError => e
puts "Exception when calling DefaultApi->story_history: #{e}"
end
# Setup authorization
Shortcut.configure do |config|
# Configure API key authorization: api_token
config.api_key['Shortcut-Token'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
#config.api_key_prefix['Shortcut-Token'] = 'Bearer'
end
api_instance = Shortcut::DefaultApi.new
epic_public_id = 789 # Integer | The unique ID of the Epic.
begin
#Unlink Productboard from Epic
api_instance.unlink_productboard_from_epic(epic_public_id)
rescue Shortcut::ApiError => e
puts "Exception when calling DefaultApi->unlink_productboard_from_epic: #{e}"
end
# Setup authorization
Shortcut.configure do |config|
# Configure API key authorization: api_token
config.api_key['Shortcut-Token'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
#config.api_key_prefix['Shortcut-Token'] = 'Bearer'
end
api_instance = Shortcut::DefaultApi.new
body = Shortcut::UpdateCategory.new # UpdateCategory |
category_public_id = 789 # Integer | The unique ID of the Category you wish to update.
begin
#Update Category
result = api_instance.update_category(body, category_public_id)
p result
rescue Shortcut::ApiError => e
puts "Exception when calling DefaultApi->update_category: #{e}"
end
# Setup authorization
Shortcut.configure do |config|
# Configure API key authorization: api_token
config.api_key['Shortcut-Token'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
#config.api_key_prefix['Shortcut-Token'] = 'Bearer'
end
api_instance = Shortcut::DefaultApi.new
body = Shortcut::UpdateEntityTemplate.new # UpdateEntityTemplate | Request parameters for changing either a template's name or any of the attributes it is designed to pre-populate.
entity_template_public_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | The unique ID of the template to be updated.
begin
#Update Entity Template
result = api_instance.update_entity_template(body, entity_template_public_id)
p result
rescue Shortcut::ApiError => e
puts "Exception when calling DefaultApi->update_entity_template: #{e}"
end
# Setup authorization
Shortcut.configure do |config|
# Configure API key authorization: api_token
config.api_key['Shortcut-Token'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
#config.api_key_prefix['Shortcut-Token'] = 'Bearer'
end
api_instance = Shortcut::DefaultApi.new
body = Shortcut::UpdateEpic.new # UpdateEpic |
epic_public_id = 789 # Integer | The unique ID of the Epic.
begin
#Update Epic
result = api_instance.update_epic(body, epic_public_id)
p result
rescue Shortcut::ApiError => e
puts "Exception when calling DefaultApi->update_epic: #{e}"
end
# Setup authorization
Shortcut.configure do |config|
# Configure API key authorization: api_token
config.api_key['Shortcut-Token'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
#config.api_key_prefix['Shortcut-Token'] = 'Bearer'
end
api_instance = Shortcut::DefaultApi.new
body = Shortcut::UpdateComment.new # UpdateComment |
epic_public_id = 789 # Integer | The ID of the associated Epic.
comment_public_id = 789 # Integer | The ID of the Comment.
begin
#Update Epic Comment
result = api_instance.update_epic_comment(body, epic_public_id, comment_public_id)
p result
rescue Shortcut::ApiError => e
puts "Exception when calling DefaultApi->update_epic_comment: #{e}"
end
# Setup authorization
Shortcut.configure do |config|
# Configure API key authorization: api_token
config.api_key['Shortcut-Token'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
#config.api_key_prefix['Shortcut-Token'] = 'Bearer'
end
api_instance = Shortcut::DefaultApi.new
body = Shortcut::UpdateFile.new # UpdateFile |
file_public_id = 789 # Integer | The unique ID assigned to the file in Shortcut.
begin
#Update File
result = api_instance.update_file(body, file_public_id)
p result
rescue Shortcut::ApiError => e
puts "Exception when calling DefaultApi->update_file: #{e}"
end
# Setup authorization
Shortcut.configure do |config|
# Configure API key authorization: api_token
config.api_key['Shortcut-Token'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
#config.api_key_prefix['Shortcut-Token'] = 'Bearer'
end
api_instance = Shortcut::DefaultApi.new
body = Shortcut::UpdateGroup.new # UpdateGroup |
group_public_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | The unique ID of the Group.
begin
#Update Group
result = api_instance.update_group(body, group_public_id)
p result
rescue Shortcut::ApiError => e
puts "Exception when calling DefaultApi->update_group: #{e}"
end
# Setup authorization
Shortcut.configure do |config|
# Configure API key authorization: api_token
config.api_key['Shortcut-Token'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
#config.api_key_prefix['Shortcut-Token'] = 'Bearer'
end
api_instance = Shortcut::DefaultApi.new
body = Shortcut::UpdateIteration.new # UpdateIteration |
iteration_public_id = 789 # Integer | The unique ID of the Iteration.
begin
#Update Iteration
result = api_instance.update_iteration(body, iteration_public_id)
p result
rescue Shortcut::ApiError => e
puts "Exception when calling DefaultApi->update_iteration: #{e}"
end
# Setup authorization
Shortcut.configure do |config|
# Configure API key authorization: api_token
config.api_key['Shortcut-Token'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
#config.api_key_prefix['Shortcut-Token'] = 'Bearer'
end
api_instance = Shortcut::DefaultApi.new
body = Shortcut::UpdateLabel.new # UpdateLabel |
label_public_id = 789 # Integer | The unique ID of the Label you wish to update.
begin
#Update Label
result = api_instance.update_label(body, label_public_id)
p result
rescue Shortcut::ApiError => e
puts "Exception when calling DefaultApi->update_label: #{e}"
end
# Setup authorization
Shortcut.configure do |config|
# Configure API key authorization: api_token
config.api_key['Shortcut-Token'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
#config.api_key_prefix['Shortcut-Token'] = 'Bearer'
end
api_instance = Shortcut::DefaultApi.new
body = Shortcut::UpdateLinkedFile.new # UpdateLinkedFile |
linked_file_public_id = 789 # Integer | The unique identifier of the linked file.
begin
#Update Linked File
result = api_instance.update_linked_file(body, linked_file_public_id)
p result
rescue Shortcut::ApiError => e
puts "Exception when calling DefaultApi->update_linked_file: #{e}"
end
# Setup authorization
Shortcut.configure do |config|
# Configure API key authorization: api_token
config.api_key['Shortcut-Token'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
#config.api_key_prefix['Shortcut-Token'] = 'Bearer'
end
api_instance = Shortcut::DefaultApi.new
body = Shortcut::UpdateMilestone.new # UpdateMilestone |
milestone_public_id = 789 # Integer | The ID of the Milestone.
begin
#Update Milestone
result = api_instance.update_milestone(body, milestone_public_id)
p result
rescue Shortcut::ApiError => e
puts "Exception when calling DefaultApi->update_milestone: #{e}"
end
# Setup authorization
Shortcut.configure do |config|
# Configure API key authorization: api_token
config.api_key['Shortcut-Token'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
#config.api_key_prefix['Shortcut-Token'] = 'Bearer'
end
api_instance = Shortcut::DefaultApi.new
body = Shortcut::UpdateStories.new # UpdateStories |
begin
#Update Multiple Stories
result = api_instance.update_multiple_stories(body)
p result
rescue Shortcut::ApiError => e
puts "Exception when calling DefaultApi->update_multiple_stories: #{e}"
end
# Setup authorization
Shortcut.configure do |config|
# Configure API key authorization: api_token
config.api_key['Shortcut-Token'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
#config.api_key_prefix['Shortcut-Token'] = 'Bearer'
end
api_instance = Shortcut::DefaultApi.new
body = Shortcut::UpdateProject.new # UpdateProject |
project_public_id = 789 # Integer | The unique ID of the Project.
begin
#Update Project
result = api_instance.update_project(body, project_public_id)
p result
rescue Shortcut::ApiError => e
puts "Exception when calling DefaultApi->update_project: #{e}"
end
# Setup authorization
Shortcut.configure do |config|
# Configure API key authorization: api_token
config.api_key['Shortcut-Token'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
#config.api_key_prefix['Shortcut-Token'] = 'Bearer'
end
api_instance = Shortcut::DefaultApi.new
body = Shortcut::UpdateStory.new # UpdateStory |
story_public_id = 789 # Integer | The unique identifier of this story.
begin
#Update Story
result = api_instance.update_story(body, story_public_id)
p result
rescue Shortcut::ApiError => e
puts "Exception when calling DefaultApi->update_story: #{e}"
end
# Setup authorization
Shortcut.configure do |config|
# Configure API key authorization: api_token
config.api_key['Shortcut-Token'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
#config.api_key_prefix['Shortcut-Token'] = 'Bearer'
end
api_instance = Shortcut::DefaultApi.new
body = Shortcut::UpdateStoryComment.new # UpdateStoryComment |
story_public_id = 789 # Integer | The ID of the Story that the Comment is in.
comment_public_id = 789 # Integer | The ID of the Comment
begin
#Update Story Comment
result = api_instance.update_story_comment(body, story_public_id, comment_public_id)
p result
rescue Shortcut::ApiError => e
puts "Exception when calling DefaultApi->update_story_comment: #{e}"
end
# Setup authorization
Shortcut.configure do |config|
# Configure API key authorization: api_token
config.api_key['Shortcut-Token'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
#config.api_key_prefix['Shortcut-Token'] = 'Bearer'
end
api_instance = Shortcut::DefaultApi.new
body = Shortcut::UpdateStoryLink.new # UpdateStoryLink |
story_link_public_id = 789 # Integer | The unique ID of the Story Link.
begin
#Update Story Link
result = api_instance.update_story_link(body, story_link_public_id)
p result
rescue Shortcut::ApiError => e
puts "Exception when calling DefaultApi->update_story_link: #{e}"
end
# Setup authorization
Shortcut.configure do |config|
# Configure API key authorization: api_token
config.api_key['Shortcut-Token'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
#config.api_key_prefix['Shortcut-Token'] = 'Bearer'
end
api_instance = Shortcut::DefaultApi.new
body = Shortcut::UpdateTask.new # UpdateTask |
story_public_id = 789 # Integer | The unique identifier of the parent Story.
task_public_id = 789 # Integer | The unique identifier of the Task you wish to update.
begin
#Update Task
result = api_instance.update_task(body, story_public_id, task_public_id)
p result
rescue Shortcut::ApiError => e
puts "Exception when calling DefaultApi->update_task: #{e}"
end
# Setup authorization
Shortcut.configure do |config|
# Configure API key authorization: api_token
config.api_key['Shortcut-Token'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
#config.api_key_prefix['Shortcut-Token'] = 'Bearer'
end
api_instance = Shortcut::DefaultApi.new
story_id = 789 # Integer |
file0 = 'file0_example' # String |
file1 = 'file1_example' # String |
file2 = 'file2_example' # String |
file3 = 'file3_example' # String |
begin
#Upload Files
result = api_instance.upload_files(story_id, file0, file1, file2, file3)
p result
rescue Shortcut::ApiError => e
puts "Exception when calling DefaultApi->upload_files: #{e}"
end
Documentation for API Endpoints
All URIs are relative to https://api.app.shortcut.com/
| Class | Method | HTTP request | Description |
|---|---|---|---|
| Shortcut::DefaultApi | create_category | POST /api/v3/categories | Create Category |
| Shortcut::DefaultApi | create_entity_template | POST /api/v3/entity-templates | Create Entity Template |
| Shortcut::DefaultApi | create_epic | POST /api/v3/epics | Create Epic |
| Shortcut::DefaultApi | create_epic_comment | POST /api/v3/epics/epic-public-id/comments | Create Epic Comment |
| Shortcut::DefaultApi | create_epic_comment_comment | POST /api/v3/epics/epic-public-id/comments/comment-public-id | Create Epic Comment Comment |
| Shortcut::DefaultApi | create_group | POST /api/v3/groups | Create Group |
| Shortcut::DefaultApi | create_iteration | POST /api/v3/iterations | Create Iteration |
| Shortcut::DefaultApi | create_label | POST /api/v3/labels | Create Label |
| Shortcut::DefaultApi | create_linked_file | POST /api/v3/linked-files | Create Linked File |
| Shortcut::DefaultApi | create_milestone | POST /api/v3/milestones | Create Milestone |
| Shortcut::DefaultApi | create_multiple_stories | POST /api/v3/stories/bulk | Create Multiple Stories |
| Shortcut::DefaultApi | create_project | POST /api/v3/projects | Create Project |
| Shortcut::DefaultApi | create_story | POST /api/v3/stories | Create Story |
| Shortcut::DefaultApi | create_story_comment | POST /api/v3/stories/story-public-id/comments | Create Story Comment |
| Shortcut::DefaultApi | create_story_link | POST /api/v3/story-links | Create Story Link |
| Shortcut::DefaultApi | create_story_reaction | POST /api/v3/stories/story-public-id/comments/comment-public-id/reactions | Create Story Reaction |
| Shortcut::DefaultApi | create_task | POST /api/v3/stories/story-public-id/tasks | Create Task |
| Shortcut::DefaultApi | delete_category | DELETE /api/v3/categories/category-public-id | Delete Category |
| Shortcut::DefaultApi | delete_entity_template | DELETE /api/v3/entity-templates/entity-template-public-id | Delete Entity Template |
| Shortcut::DefaultApi | delete_epic | DELETE /api/v3/epics/epic-public-id | Delete Epic |
| Shortcut::DefaultApi | delete_epic_comment | DELETE /api/v3/epics/epic-public-id/comments/comment-public-id | Delete Epic Comment |
| Shortcut::DefaultApi | delete_file | DELETE /api/v3/files/file-public-id | Delete File |
| Shortcut::DefaultApi | delete_iteration | DELETE /api/v3/iterations/iteration-public-id | Delete Iteration |
| Shortcut::DefaultApi | delete_label | DELETE /api/v3/labels/label-public-id | Delete Label |
| Shortcut::DefaultApi | delete_linked_file | DELETE /api/v3/linked-files/linked-file-public-id | Delete Linked File |
| Shortcut::DefaultApi | delete_milestone | DELETE /api/v3/milestones/milestone-public-id | Delete Milestone |
| Shortcut::DefaultApi | delete_multiple_stories | DELETE /api/v3/stories/bulk | Delete Multiple Stories |
| Shortcut::DefaultApi | delete_project | DELETE /api/v3/projects/project-public-id | Delete Project |
| Shortcut::DefaultApi | delete_story | DELETE /api/v3/stories/story-public-id | Delete Story |
| Shortcut::DefaultApi | delete_story_comment | DELETE /api/v3/stories/story-public-id/comments/comment-public-id | Delete Story Comment |
| Shortcut::DefaultApi | delete_story_link | DELETE /api/v3/story-links/story-link-public-id | Delete Story Link |
| Shortcut::DefaultApi | delete_story_reaction | DELETE /api/v3/stories/story-public-id/comments/comment-public-id/reactions | Delete Story Reaction |
| Shortcut::DefaultApi | delete_task | DELETE /api/v3/stories/story-public-id/tasks/task-public-id | Delete Task |
| Shortcut::DefaultApi | disable_groups | PUT /api/v3/groups/disable | Disable Groups |
| Shortcut::DefaultApi | disable_iterations | PUT /api/v3/iterations/disable | Disable Iterations |
| Shortcut::DefaultApi | disable_story_templates | PUT /api/v3/entity-templates/disable | Disable Story Templates |
| Shortcut::DefaultApi | enable_groups | PUT /api/v3/groups/enable | Enable Groups |
| Shortcut::DefaultApi | enable_iterations | PUT /api/v3/iterations/enable | Enable Iterations |
| Shortcut::DefaultApi | enable_story_templates | PUT /api/v3/entity-templates/enable | Enable Story Templates |
| Shortcut::DefaultApi | get_category | GET /api/v3/categories/category-public-id | Get Category |
| Shortcut::DefaultApi | get_current_member_info | GET /api/v3/member | Get Current Member Info |
| Shortcut::DefaultApi | get_entity_template | GET /api/v3/entity-templates/entity-template-public-id | Get Entity Template |
| Shortcut::DefaultApi | get_epic | GET /api/v3/epics/epic-public-id | Get Epic |
| Shortcut::DefaultApi | get_epic_comment | GET /api/v3/epics/epic-public-id/comments/comment-public-id | Get Epic Comment |
| Shortcut::DefaultApi | get_epic_workflow | GET /api/v3/epic-workflow | Get Epic Workflow |
| Shortcut::DefaultApi | get_external_link_stories | GET /api/v3/external-link/stories | Get External Link Stories |
| Shortcut::DefaultApi | get_file | GET /api/v3/files/file-public-id | Get File |
| Shortcut::DefaultApi | get_group | GET /api/v3/groups/group-public-id | Get Group |
| Shortcut::DefaultApi | get_iteration | GET /api/v3/iterations/iteration-public-id | Get Iteration |
| Shortcut::DefaultApi | get_label | GET /api/v3/labels/label-public-id | Get Label |
| Shortcut::DefaultApi | get_linked_file | GET /api/v3/linked-files/linked-file-public-id | Get Linked File |
| Shortcut::DefaultApi | get_member | GET /api/v3/members/member-public-id | Get Member |
| Shortcut::DefaultApi | get_milestone | GET /api/v3/milestones/milestone-public-id | Get Milestone |
| Shortcut::DefaultApi | get_project | GET /api/v3/projects/project-public-id | Get Project |
| Shortcut::DefaultApi | get_repository | GET /api/v3/repositories/repo-public-id | Get Repository |
| Shortcut::DefaultApi | get_story | GET /api/v3/stories/story-public-id | Get Story |
| Shortcut::DefaultApi | get_story_comment | GET /api/v3/stories/story-public-id/comments/comment-public-id | Get Story Comment |
| Shortcut::DefaultApi | get_story_link | GET /api/v3/story-links/story-link-public-id | Get Story Link |
| Shortcut::DefaultApi | get_task | GET /api/v3/stories/story-public-id/tasks/task-public-id | Get Task |
| Shortcut::DefaultApi | get_workflow | GET /api/v3/workflows/workflow-public-id | Get Workflow |
| Shortcut::DefaultApi | list_categories | GET /api/v3/categories | List Categories |
| Shortcut::DefaultApi | list_category_milestones | GET /api/v3/categories/category-public-id/milestones | List Category Milestones |
| Shortcut::DefaultApi | list_entity_templates | GET /api/v3/entity-templates | List Entity Templates |
| Shortcut::DefaultApi | list_epic_comments | GET /api/v3/epics/epic-public-id/comments | List Epic Comments |
| Shortcut::DefaultApi | list_epic_stories | GET /api/v3/epics/epic-public-id/stories | List Epic Stories |
| Shortcut::DefaultApi | list_epics | GET /api/v3/epics | List Epics |
| Shortcut::DefaultApi | list_files | GET /api/v3/files | List Files |
| Shortcut::DefaultApi | list_group_stories | GET /api/v3/groups/group-public-id/stories | List Group Stories |
| Shortcut::DefaultApi | list_groups | GET /api/v3/groups | List Groups |
| Shortcut::DefaultApi | list_iteration_stories | GET /api/v3/iterations/iteration-public-id/stories | List Iteration Stories |
| Shortcut::DefaultApi | list_iterations | GET /api/v3/iterations | List Iterations |
| Shortcut::DefaultApi | list_label_epics | GET /api/v3/labels/label-public-id/epics | List Label Epics |
| Shortcut::DefaultApi | list_label_stories | GET /api/v3/labels/label-public-id/stories | List Label Stories |
| Shortcut::DefaultApi | list_labels | GET /api/v3/labels | List Labels |
| Shortcut::DefaultApi | list_linked_files | GET /api/v3/linked-files | List Linked Files |
| Shortcut::DefaultApi | list_members | GET /api/v3/members | List Members |
| Shortcut::DefaultApi | list_milestone_epics | GET /api/v3/milestones/milestone-public-id/epics | List Milestone Epics |
| Shortcut::DefaultApi | list_milestones | GET /api/v3/milestones | List Milestones |
| Shortcut::DefaultApi | list_projects | GET /api/v3/projects | List Projects |
| Shortcut::DefaultApi | list_repositories | GET /api/v3/repositories | List Repositories |
| Shortcut::DefaultApi | list_stories | GET /api/v3/projects/project-public-id/stories | List Stories |
| Shortcut::DefaultApi | list_workflows | GET /api/v3/workflows | List Workflows |
| Shortcut::DefaultApi | search | GET /api/v3/search | Search |
| Shortcut::DefaultApi | search_epics | GET /api/v3/search/epics | Search Epics |
| Shortcut::DefaultApi | search_stories | GET /api/v3/search/stories | Search Stories |
| Shortcut::DefaultApi | search_stories_old | POST /api/v3/stories/search | Search Stories (Old) |
| Shortcut::DefaultApi | story_history | GET /api/v3/stories/story-public-id/history | Story History |
| Shortcut::DefaultApi | unlink_productboard_from_epic | POST /api/v3/epics/epic-public-id/unlink-productboard | Unlink Productboard from Epic |
| Shortcut::DefaultApi | update_category | PUT /api/v3/categories/category-public-id | Update Category |
| Shortcut::DefaultApi | update_entity_template | PUT /api/v3/entity-templates/entity-template-public-id | Update Entity Template |
| Shortcut::DefaultApi | update_epic | PUT /api/v3/epics/epic-public-id | Update Epic |
| Shortcut::DefaultApi | update_epic_comment | PUT /api/v3/epics/epic-public-id/comments/comment-public-id | Update Epic Comment |
| Shortcut::DefaultApi | update_file | PUT /api/v3/files/file-public-id | Update File |
| Shortcut::DefaultApi | update_group | PUT /api/v3/groups/group-public-id | Update Group |
| Shortcut::DefaultApi | update_iteration | PUT /api/v3/iterations/iteration-public-id | Update Iteration |
| Shortcut::DefaultApi | update_label | PUT /api/v3/labels/label-public-id | Update Label |
| Shortcut::DefaultApi | update_linked_file | PUT /api/v3/linked-files/linked-file-public-id | Update Linked File |
| Shortcut::DefaultApi | update_milestone | PUT /api/v3/milestones/milestone-public-id | Update Milestone |
| Shortcut::DefaultApi | update_multiple_stories | PUT /api/v3/stories/bulk | Update Multiple Stories |
| Shortcut::DefaultApi | update_project | PUT /api/v3/projects/project-public-id | Update Project |
| Shortcut::DefaultApi | update_story | PUT /api/v3/stories/story-public-id | Update Story |
| Shortcut::DefaultApi | update_story_comment | PUT /api/v3/stories/story-public-id/comments/comment-public-id | Update Story Comment |
| Shortcut::DefaultApi | update_story_link | PUT /api/v3/story-links/story-link-public-id | Update Story Link |
| Shortcut::DefaultApi | update_task | PUT /api/v3/stories/story-public-id/tasks/task-public-id | Update Task |
| Shortcut::DefaultApi | upload_files | POST /api/v3/files | Upload Files |
Documentation for Models
- Shortcut::BasicWorkspaceInfo
- Shortcut::Branch
- Shortcut::Category
- Shortcut::Commit
- Shortcut::CreateCategory
- Shortcut::CreateCategoryParams
- Shortcut::CreateCommentComment
- Shortcut::CreateEntityTemplate
- Shortcut::CreateEpic
- Shortcut::CreateEpicComment
- Shortcut::CreateGroup
- Shortcut::CreateIteration
- Shortcut::CreateLabelParams
- Shortcut::CreateLinkedFile
- Shortcut::CreateMilestone
- Shortcut::CreateOrDeleteStoryReaction
- Shortcut::CreateProject
- Shortcut::CreateStories
- Shortcut::CreateStoryComment
- Shortcut::CreateStoryCommentParams
- Shortcut::CreateStoryContents
- Shortcut::CreateStoryLink
- Shortcut::CreateStoryLinkParams
- Shortcut::CreateStoryParams
- Shortcut::CreateTask
- Shortcut::CreateTaskParams
- Shortcut::DeleteStories
- Shortcut::EntityTemplate
- Shortcut::EntityTemplateTask
- Shortcut::Epic
- Shortcut::EpicSearchResults
- Shortcut::EpicSlim
- Shortcut::EpicState
- Shortcut::EpicStats
- Shortcut::EpicWorkflow
- Shortcut::GetEpicStories
- Shortcut::GetExternalLinkStoriesParams
- Shortcut::GetIterationStories
- Shortcut::GetLabelStories
- Shortcut::GetMember
- Shortcut::GetProjectStories
- Shortcut::Group
- Shortcut::History
- Shortcut::HistoryActionBranchCreate
- Shortcut::HistoryActionBranchMerge
- Shortcut::HistoryActionBranchPush
- Shortcut::HistoryActionLabelCreate
- Shortcut::HistoryActionLabelDelete
- Shortcut::HistoryActionLabelUpdate
- Shortcut::HistoryActionProjectUpdate
- Shortcut::HistoryActionPullRequest
- Shortcut::HistoryActionStoryCommentCreate
- Shortcut::HistoryActionStoryCreate
- Shortcut::HistoryActionStoryDelete
- Shortcut::HistoryActionStoryLinkCreate
- Shortcut::HistoryActionStoryLinkDelete
- Shortcut::HistoryActionStoryLinkUpdate
- Shortcut::HistoryActionStoryUpdate
- Shortcut::HistoryActionTaskCreate
- Shortcut::HistoryActionTaskDelete
- Shortcut::HistoryActionTaskUpdate
- Shortcut::HistoryChangesStory
- Shortcut::HistoryChangesStoryLink
- Shortcut::HistoryChangesTask
- Shortcut::HistoryReferenceBranch
- Shortcut::HistoryReferenceCommit
- Shortcut::HistoryReferenceEpic
- Shortcut::HistoryReferenceGeneral
- Shortcut::HistoryReferenceGroup
- Shortcut::HistoryReferenceIteration
- Shortcut::HistoryReferenceLabel
- Shortcut::HistoryReferenceProject
- Shortcut::HistoryReferenceStory
- Shortcut::HistoryReferenceStoryTask
- Shortcut::HistoryReferenceWorkflowState
- Shortcut::Icon
- Shortcut::Identity
- Shortcut::Iteration
- Shortcut::IterationSlim
- Shortcut::IterationStats
- Shortcut::Label
- Shortcut::LabelSlim
- Shortcut::LabelStats
- Shortcut::LinkedFile
- Shortcut::ListEpics
- Shortcut::ListGroupStories
- Shortcut::ListLabels
- Shortcut::ListMembers
- Shortcut::MaxSearchResultsExceededError
- Shortcut::Member
- Shortcut::MemberInfo
- Shortcut::Milestone
- Shortcut::MilestoneStats
- Shortcut::Profile
- Shortcut::Project
- Shortcut::ProjectStats
- Shortcut::PullRequest
- Shortcut::PullRequestLabel
- Shortcut::Repository
- Shortcut::Search
- Shortcut::SearchResults
- Shortcut::SearchStories
- Shortcut::Story
- Shortcut::StoryComment
- Shortcut::StoryContents
- Shortcut::StoryContentsTask
- Shortcut::StoryHistoryChangeAddsRemovesInt
- Shortcut::StoryHistoryChangeAddsRemovesUuid
- Shortcut::StoryHistoryChangeOldNewBool
- Shortcut::StoryHistoryChangeOldNewInt
- Shortcut::StoryHistoryChangeOldNewStr
- Shortcut::StoryHistoryChangeOldNewUuid
- Shortcut::StoryLink
- Shortcut::StoryReaction
- Shortcut::StorySearchResults
- Shortcut::StorySlim
- Shortcut::StoryStats
- Shortcut::Task
- Shortcut::ThreadedComment
- Shortcut::TypedStoryLink
- Shortcut::UnusableEntitlementError
- Shortcut::UpdateCategory
- Shortcut::UpdateComment
- Shortcut::UpdateEntityTemplate
- Shortcut::UpdateEpic
- Shortcut::UpdateFile
- Shortcut::UpdateGroup
- Shortcut::UpdateIteration
- Shortcut::UpdateLabel
- Shortcut::UpdateLinkedFile
- Shortcut::UpdateMilestone
- Shortcut::UpdateProject
- Shortcut::UpdateStories
- Shortcut::UpdateStory
- Shortcut::UpdateStoryComment
- Shortcut::UpdateStoryContents
- Shortcut::UpdateStoryLink
- Shortcut::UpdateTask
- Shortcut::UploadedFile
- Shortcut::V3FilesBody
- Shortcut::Workflow
- Shortcut::WorkflowState
Documentation for Authorization
api_token
- Type: API key
- API key parameter name: Shortcut-Token
- Location: HTTP header