Skip to main content
Server path: /shortcut-epics | Type: Application | PCID required: Yes

Tools


shortcut_epics_create_epic

Create Epic Parameters:
ParameterTypeRequiredDefaultDescription
completed_at_overridestringNoA manual override for the time/date the Epic was completed.
converted_from_story_idintegerNoThe ID of the Story that was converted to an Epic.
created_atstringNoDefaults to the time/date it is created but can be set to reflect another date.
deadlinestringNoThe Epic’s deadline.
descriptionstringNoThe Epic’s description.
epic_state_idintegerNoThe ID of the Epic State.
external_idstringNoThis field can be set to another unique ID. In the case that the Epic has been imported from another tool, the ID in the other tool can be indicated here.
follower_idsstring[]NoAn array of UUIDs for any Members you want to add as Followers on this new Epic.
group_idstringNoDeprecated The ID of the group to associate with the epic. Use group_ids.
group_idsstring[]NoAn array of UUIDS for Groups to which this Epic is related.
labelsobject[]NoAn array of Labels attached to the Epic.
milestone_idintegerNoDeprecated The ID of the Milestone this Epic is related to. Use objective_ids.
namestringYesThe Epic’s name.
objective_idsinteger[]NoAn array of IDs for Objectives to which this Epic is related.
owner_idsstring[]NoAn array of UUIDs for any members you want to add as Owners on this new Epic.
planned_start_datestringNoThe Epic’s planned start date.
requested_by_idstringNoThe ID of the member that requested the epic.
started_at_overridestringNoA manual override for the time/date the Epic was started.
statestringNoDeprecated The Epic’s state (to do, in progress, or done); will be ignored when epic_state_id is set.
updated_atstringNoDefaults to the time/date it is created but can be set to reflect another date.

shortcut_epics_create_epic_comment

Create Epic Comment Parameters:
ParameterTypeRequiredDefaultDescription
epic-public-idintegerYesThe ID of the associated Epic.
author_idstringNoThe Member ID of the Comment’s author. Defaults to the user identified by the API token.
created_atstringNoDefaults to the time/date the comment is created, but can be set to reflect another date.
external_idstringNoThis field can be set to another unique ID. In the case that the comment has been imported from another tool, the ID in the other tool can be indicated here.
textstringYesThe comment text.
updated_atstringNoDefaults to the time/date the comment is last updated, but can be set to reflect another date.

shortcut_epics_create_epic_comment_comment

Create Epic Comment Comment Parameters:
ParameterTypeRequiredDefaultDescription
epic-public-idintegerYesThe ID of the associated Epic.
comment-public-idintegerYesThe ID of the parent Epic Comment.
author_idstringNoThe Member ID of the Comment’s author. Defaults to the user identified by the API token.
created_atstringNoDefaults to the time/date the comment is created, but can be set to reflect another date.
external_idstringNoThis field can be set to another unique ID. In the case that the comment has been imported from another tool, the ID in the other tool can be indicated here.
textstringYesThe comment text.
updated_atstringNoDefaults to the time/date the comment is last updated, but can be set to reflect another date.

shortcut_epics_create_epic_health

Create Epic Health Parameters:
ParameterTypeRequiredDefaultDescription
epic-public-idintegerYesThe unique ID of the Epic.
statusstringYesThe health status of the Epic.
textstringNoThe description of the Health status.

shortcut_epics_create_objective

Create Objective Parameters:
ParameterTypeRequiredDefaultDescription
categoriesobject[]NoAn array of IDs of Categories attached to the Objective.
completed_at_overridestringNoA manual override for the time/date the Objective was completed.
descriptionstringNoThe Objective’s description.
namestringYesThe name of the Objective.
started_at_overridestringNoA manual override for the time/date the Objective was started.
statestringNoThe workflow state that the Objective is in.

shortcut_epics_create_objective_health

Create Objective Health Parameters:
ParameterTypeRequiredDefaultDescription
objective-public-idintegerYesThe unique ID of the Objective.
statusstringYesThe health status of the Objective.
textstringNoThe description of the Health status.

shortcut_epics_delete_epic

Delete Epic Parameters:
ParameterTypeRequiredDefaultDescription
epic-public-idintegerYesThe unique ID of the Epic.

shortcut_epics_delete_epic_comment

Delete Epic Comment Parameters:
ParameterTypeRequiredDefaultDescription
epic-public-idintegerYesThe ID of the associated Epic.
comment-public-idintegerYesThe ID of the Comment.

shortcut_epics_delete_objective

Delete Objective Parameters:
ParameterTypeRequiredDefaultDescription
objective-public-idintegerYesThe ID of the Objective.

shortcut_epics_get_epic

Get Epic Parameters:
ParameterTypeRequiredDefaultDescription
epic-public-idintegerYesThe unique ID of the Epic.

shortcut_epics_get_epic_comment

Get Epic Comment Parameters:
ParameterTypeRequiredDefaultDescription
epic-public-idintegerYesThe ID of the associated Epic.
comment-public-idintegerYesThe ID of the Comment.

shortcut_epics_get_epic_health

Get Epic Health Parameters:
ParameterTypeRequiredDefaultDescription
epic-public-idintegerYesThe unique ID of the Epic.

shortcut_epics_get_epic_workflow

Get Epic Workflow

shortcut_epics_get_key_result

Get Key Result Parameters:
ParameterTypeRequiredDefaultDescription
key-result-public-idstringYesThe ID of the Key Result.

shortcut_epics_get_objective

Get Objective Parameters:
ParameterTypeRequiredDefaultDescription
objective-public-idintegerYesThe ID of the Objective.

shortcut_epics_get_objective_health

Get Objective Health Parameters:
ParameterTypeRequiredDefaultDescription
objective-public-idintegerYesThe unique ID of the Objective.

shortcut_epics_list_epic_comments

List Epic Comments Parameters:
ParameterTypeRequiredDefaultDescription
epic-public-idintegerYesThe unique ID of the Epic.

shortcut_epics_list_epic_documents

List Epic Documents Parameters:
ParameterTypeRequiredDefaultDescription
epic-public-idintegerYesThe unique ID of the Epic.

shortcut_epics_list_epic_healths

List Epic Healths Parameters:
ParameterTypeRequiredDefaultDescription
epic-public-idintegerYesThe unique ID of the Epic.

shortcut_epics_list_epic_stories

List Epic Stories Parameters:
ParameterTypeRequiredDefaultDescription
epic-public-idintegerYesThe unique ID of the Epic.
includes_descriptionbooleanNoA true/false boolean indicating whether to return Stories with their descriptions.

shortcut_epics_list_epics

List Epics Parameters:
ParameterTypeRequiredDefaultDescription
includes_descriptionbooleanNoA true/false boolean indicating whether to return Epics with their descriptions.

shortcut_epics_list_epics_paginated

List Epics Paginated Parameters:
ParameterTypeRequiredDefaultDescription
includes_descriptionbooleanNoA true/false boolean indicating whether to return Epics with their descriptions.
pageintegerNoThe page number to return, starting with 1. Defaults to 1.
page_sizeintegerNoThe number of Epics to return per page. Minimum 1, maximum 250, default 10.

shortcut_epics_list_objective_epics

List Objective Epics Parameters:
ParameterTypeRequiredDefaultDescription
objective-public-idintegerYesThe ID of the Objective.

shortcut_epics_list_objective_healths

List Objective Healths Parameters:
ParameterTypeRequiredDefaultDescription
objective-public-idintegerYesThe unique ID of the Objective.

shortcut_epics_list_objectives

List Objectives

shortcut_epics_update_epic

Update Epic Parameters:
ParameterTypeRequiredDefaultDescription
epic-public-idintegerYesThe unique ID of the Epic.
after_idintegerNoThe ID of the Epic we want to move this Epic after.
archivedbooleanNoA true/false boolean indicating whether the Epic is in archived state.
before_idintegerNoThe ID of the Epic we want to move this Epic before.
completed_at_overridestringNoA manual override for the time/date the Epic was completed.
deadlinestringNoThe Epic’s deadline.
descriptionstringNoThe Epic’s description.
epic_state_idintegerNoThe ID of the Epic State.
external_idstringNoThis field can be set to another unique ID. In the case that the Epic has been imported from another tool, the ID in the other tool can be indicated here.
follower_idsstring[]NoAn array of UUIDs for any Members you want to add as Followers on this Epic.
group_idstringNoDeprecated The ID of the group to associate with the epic. Use group_ids.
group_idsstring[]NoAn array of UUIDS for Groups to which this Epic is related.
labelsobject[]NoAn array of Labels attached to the Epic.
milestone_idintegerNoDeprecated The ID of the Milestone this Epic is related to. Use objective_ids.
namestringNoThe Epic’s name.
objective_idsinteger[]NoAn array of IDs for Objectives to which this Epic is related.
owner_idsstring[]NoAn array of UUIDs for any members you want to add as Owners on this Epic.
planned_start_datestringNoThe Epic’s planned start date.
requested_by_idstringNoThe ID of the member that requested the epic.
started_at_overridestringNoA manual override for the time/date the Epic was started.
statestringNoDeprecated The Epic’s state (to do, in progress, or done); will be ignored when epic_state_id is set.

shortcut_epics_update_epic_comment

Update Epic Comment Parameters:
ParameterTypeRequiredDefaultDescription
epic-public-idintegerYesThe ID of the associated Epic.
comment-public-idintegerYesThe ID of the Comment.
textstringYesThe updated comment text.

shortcut_epics_update_key_result

Update Key Result Parameters:
ParameterTypeRequiredDefaultDescription
key-result-public-idstringYesThe ID of the Key Result.
initial_observed_valueobjectNoThe starting value of the Key Result.
namestringNoThe name of the Key Result.
observed_valueobjectNoThe starting value of the Key Result.
target_valueobjectNoThe starting value of the Key Result.

shortcut_epics_update_objective

Update Objective Parameters:
ParameterTypeRequiredDefaultDescription
objective-public-idintegerYesThe ID of the Objective.
after_idintegerNoThe ID of the Objective we want to move this Objective after.
archivedbooleanNoA boolean indicating whether the Objective is archived or not
before_idintegerNoThe ID of the Objective we want to move this Objective before.
categoriesobject[]NoAn array of IDs of Categories attached to the Objective.
completed_at_overridestringNoA manual override for the time/date the Objective was completed.
descriptionstringNoThe Objective’s description.
namestringNoThe name of the Objective.
started_at_overridestringNoA manual override for the time/date the Objective was started.
statestringNoThe workflow state that the Objective is in.