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

Tools

ToolDescription
shortcut_projects_create_categoryCreate Category
shortcut_projects_create_groupCreate Group
shortcut_projects_create_iterationCreate Iteration
shortcut_projects_create_labelCreate Label
shortcut_projects_create_projectCreate Project
shortcut_projects_delete_categoryDelete Category
shortcut_projects_delete_custom_fieldDelete Custom Field
shortcut_projects_delete_iterationDelete Iteration
shortcut_projects_delete_labelDelete Label
shortcut_projects_delete_projectDelete Project
shortcut_projects_disable_iterationsDisable Iterations
shortcut_projects_enable_iterationsEnable Iterations
shortcut_projects_get_categoryGet Category
shortcut_projects_get_custom_fieldGet Custom Field
shortcut_projects_get_groupGet Group
shortcut_projects_get_iterationGet Iteration
shortcut_projects_get_labelGet Label
shortcut_projects_get_projectGet Project
shortcut_projects_get_workflowGet Workflow
shortcut_projects_list_categoriesList Categories
shortcut_projects_list_category_milestonesList Category Milestones
shortcut_projects_list_category_objectivesList Category Objectives
shortcut_projects_list_custom_fieldsList Custom Fields
shortcut_projects_list_group_storiesList Group Stories
shortcut_projects_list_groupsList Groups
shortcut_projects_list_iteration_storiesList Iteration Stories
shortcut_projects_list_iterationsList Iterations
shortcut_projects_list_label_epicsList Label Epics
shortcut_projects_list_label_storiesList Label Stories
shortcut_projects_list_labelsList Labels
shortcut_projects_list_projectsList Projects
shortcut_projects_list_storiesList Stories
shortcut_projects_list_workflowsList Workflows
shortcut_projects_update_categoryUpdate Category
shortcut_projects_update_custom_fieldUpdate Custom Field
shortcut_projects_update_groupUpdate Group
shortcut_projects_update_iterationUpdate Iteration
shortcut_projects_update_labelUpdate Label
shortcut_projects_update_projectUpdate Project

shortcut_projects_create_category

Create Category Parameters:
ParameterTypeRequiredDefaultDescription
colorstringNoThe hex color to be displayed with the Category (for example, “#ff0000”).
external_idstringNoThis field can be set to another unique ID. In the case that the Category has been imported from another tool, the ID in the other tool can be indicated here.
namestringYesThe name of the new Category.
typestringNoThe type of entity this Category is associated with; currently Milestone or Objective is the only type of Category.

shortcut_projects_create_group

Create Group Parameters:
ParameterTypeRequiredDefaultDescription
colorstringNoThe color you wish to use for the Group in the system.
color_keystringNoThe color key you wish to use for the Group in the system.
descriptionstringNoThe description of the Group.
display_icon_idstringNoThe Icon id for the avatar of this Group.
member_idsstring[]NoThe Member ids to add to this Group.
mention_namestringYesThe mention name of this Group.
namestringYesThe name of this Group.
workflow_idsinteger[]NoThe Workflow ids to add to the Group.

shortcut_projects_create_iteration

Create Iteration Parameters:
ParameterTypeRequiredDefaultDescription
descriptionstringNoThe description of the Iteration.
end_datestringYesThe date this Iteration ends, e.g. 2019-07-01.
follower_idsstring[]NoAn array of UUIDs for any Members you want to add as Followers.
group_idsstring[]NoAn array of UUIDs for any Groups you want to add as Followers. Currently, only one Group association is presented in our web UI.
labelsobject[]NoAn array of Labels attached to the Iteration.
namestringYesThe name of this Iteration.
start_datestringYesThe date this Iteration begins, e.g. 2019-07-01.

shortcut_projects_create_label

Create Label Parameters:
ParameterTypeRequiredDefaultDescription
colorstringNoThe hex color to be displayed with the Label (for example, “#ff0000”).
descriptionstringNoThe description of the new Label.
external_idstringNoThis field can be set to another unique ID. In the case that the Label has been imported from another tool, the ID in the other tool can be indicated here.
namestringYesThe name of the new Label.

shortcut_projects_create_project

Create Project Parameters:
ParameterTypeRequiredDefaultDescription
abbreviationstringNoThe Project abbreviation used in Story summaries. Should be kept to 3 characters at most.
colorstringNoThe color you wish to use for the Project in the system.
created_atstringNoDefaults to the time/date it is created but can be set to reflect another date.
descriptionstringNoThe Project description.
external_idstringNoThis field can be set to another unique ID. In the case that the Project 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 Owners on this new Epic.
iteration_lengthintegerNoThe number of weeks per iteration in this Project.
namestringYesThe name of the Project.
start_timestringNoThe date at which the Project was started.
team_idintegerYesThe ID of the team the project belongs to.
updated_atstringNoDefaults to the time/date it is created but can be set to reflect another date.

shortcut_projects_delete_category

Delete Category Parameters:
ParameterTypeRequiredDefaultDescription
category-public-idintegerYesThe unique ID of the Category.

shortcut_projects_delete_custom_field

Delete Custom Field Parameters:
ParameterTypeRequiredDefaultDescription
custom-field-public-idstringYesThe unique ID of the CustomField.

shortcut_projects_delete_iteration

Delete Iteration Parameters:
ParameterTypeRequiredDefaultDescription
iteration-public-idintegerYesThe unique ID of the Iteration.

shortcut_projects_delete_label

Delete Label Parameters:
ParameterTypeRequiredDefaultDescription
label-public-idintegerYesThe unique ID of the Label.

shortcut_projects_delete_project

Delete Project Parameters:
ParameterTypeRequiredDefaultDescription
project-public-idintegerYesThe unique ID of the Project.

shortcut_projects_disable_iterations

Disable Iterations

shortcut_projects_enable_iterations

Enable Iterations

shortcut_projects_get_category

Get Category Parameters:
ParameterTypeRequiredDefaultDescription
category-public-idintegerYesThe unique ID of the Category.

shortcut_projects_get_custom_field

Get Custom Field Parameters:
ParameterTypeRequiredDefaultDescription
custom-field-public-idstringYesThe unique ID of the CustomField.

shortcut_projects_get_group

Get Group Parameters:
ParameterTypeRequiredDefaultDescription
group-public-idstringYesThe unique ID of the Group.

shortcut_projects_get_iteration

Get Iteration Parameters:
ParameterTypeRequiredDefaultDescription
iteration-public-idintegerYesThe unique ID of the Iteration.

shortcut_projects_get_label

Get Label Parameters:
ParameterTypeRequiredDefaultDescription
label-public-idintegerYesThe unique ID of the Label.

shortcut_projects_get_project

Get Project Parameters:
ParameterTypeRequiredDefaultDescription
project-public-idintegerYesThe unique ID of the Project.

shortcut_projects_get_workflow

Get Workflow Parameters:
ParameterTypeRequiredDefaultDescription
workflow-public-idintegerYesThe ID of the Workflow.

shortcut_projects_list_categories

List Categories

shortcut_projects_list_category_milestones

List Category Milestones Parameters:
ParameterTypeRequiredDefaultDescription
category-public-idintegerYesThe unique ID of the Category.

shortcut_projects_list_category_objectives

List Category Objectives Parameters:
ParameterTypeRequiredDefaultDescription
category-public-idintegerYesThe unique ID of the Category.

shortcut_projects_list_custom_fields

List Custom Fields

shortcut_projects_list_group_stories

List Group Stories Parameters:
ParameterTypeRequiredDefaultDescription
group-public-idstringYesThe unique ID of the Group.
limitintegerNoThe maximum number of results to return. (Defaults to 1000, max 1000)
offsetintegerNoThe offset at which to begin returning results. (Defaults to 0)

shortcut_projects_list_groups

List Groups Parameters:
ParameterTypeRequiredDefaultDescription
archivedbooleanNoFilter groups by their archived state. If true, returns only archived groups. If false, returns only unarchived groups. If not provided, returns all groups

shortcut_projects_list_iteration_stories

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

shortcut_projects_list_iterations

List Iterations

shortcut_projects_list_label_epics

List Label Epics Parameters:
ParameterTypeRequiredDefaultDescription
label-public-idintegerYesThe unique ID of the Label.

shortcut_projects_list_label_stories

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

shortcut_projects_list_labels

List Labels Parameters:
ParameterTypeRequiredDefaultDescription
slimbooleanNoA true/false boolean indicating if the slim versions of the Label should be returned.

shortcut_projects_list_projects

List Projects

shortcut_projects_list_stories

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

shortcut_projects_list_workflows

List Workflows

shortcut_projects_update_category

Update Category Parameters:
ParameterTypeRequiredDefaultDescription
category-public-idintegerYesThe unique ID of the Category you wish to update.
archivedbooleanNoA true/false boolean indicating if the Category has been archived.
colorstringNoThe hex color to be displayed with the Category (for example, “#ff0000”).
namestringNoThe new name of the Category.

shortcut_projects_update_custom_field

Update Custom Field Parameters:
ParameterTypeRequiredDefaultDescription
custom-field-public-idstringYesThe unique ID of the CustomField.
after_idstringNoThe ID of the CustomField we want to move this CustomField after.
before_idstringNoThe ID of the CustomField we want to move this CustomField before.
descriptionstringNoA description of the purpose of this field.
enabledbooleanNoIndicates whether the Field is enabled for the Workspace. Only enabled fields can be applied to Stories.
icon_set_identifierstringNoA frontend-controlled string that represents the icon for this custom field.
namestringNoA collection of objects representing reporting periods for years.
valuesobject[]NoA collection of EnumValue objects representing the values in the domain of some Custom Field.

shortcut_projects_update_group

Update Group Parameters:
ParameterTypeRequiredDefaultDescription
group-public-idstringYesThe unique ID of the Group.
archivedbooleanNoWhether or not this Group is archived.
colorstringNoThe color you wish to use for the Group in the system.
color_keystringNoThe color key you wish to use for the Group in the system.
default_workflow_idintegerNoThe ID of the default workflow for stories created in this group.
descriptionstringNoThe description of this Group.
display_icon_idstringNoThe Icon id for the avatar of this Group.
member_idsstring[]NoThe Member ids to add to this Group.
mention_namestringNoThe mention name of this Group.
namestringNoThe name of this Group.
workflow_idsinteger[]NoThe Workflow ids to add to the Group.

shortcut_projects_update_iteration

Update Iteration Parameters:
ParameterTypeRequiredDefaultDescription
iteration-public-idintegerYesThe unique ID of the Iteration.
descriptionstringNoThe description of the Iteration.
end_datestringNoThe date this Iteration ends, e.g. 2019-07-05.
follower_idsstring[]NoAn array of UUIDs for any Members you want to add as Followers.
group_idsstring[]NoAn array of UUIDs for any Groups you want to add as Followers. Currently, only one Group association is presented in our web UI.
labelsobject[]NoAn array of Labels attached to the Iteration.
namestringNoThe name of this Iteration
start_datestringNoThe date this Iteration begins, e.g. 2019-07-01

shortcut_projects_update_label

Update Label Parameters:
ParameterTypeRequiredDefaultDescription
label-public-idintegerYesThe unique ID of the Label you wish to update.
archivedbooleanNoA true/false boolean indicating if the Label has been archived.
colorstringNoThe hex color to be displayed with the Label (for example, “#ff0000”).
descriptionstringNoThe new description of the label.
namestringNoThe new name of the label.

shortcut_projects_update_project

Update Project Parameters:
ParameterTypeRequiredDefaultDescription
project-public-idintegerYesThe unique ID of the Project.
abbreviationstringNoThe Project abbreviation used in Story summaries. Should be kept to 3 characters at most.
archivedbooleanNoA true/false boolean indicating whether the Story is in archived state.
colorstringNoThe color that represents the Project in the UI.
days_to_thermometerintegerNoThe number of days before the thermometer appears in the Story summary.
descriptionstringNoThe Project’s description.
follower_idsstring[]NoAn array of UUIDs for any Members you want to add as Followers.
namestringNoThe Project’s name.
show_thermometerbooleanNoConfiguration to enable or disable thermometers in the Story summary.
team_idintegerNoThe ID of the team the project belongs to.