The GitScrum API is an automated system designed to help organizations manage their project workflows more efficiently. With the API, users can easily create and customize workflow columns, edit them, and delete them as needed. This allows teams to quickly track progress and make changes to their projects without having to manually manage everything.
The GitScrum API provides endpoints for managing these workflow columns and other related resources.
| GET |
/project-templates/workflow |
| POST |
/project-templates/workflow |
| PUT |
/project-templates/workflow/:id |
| DELETE |
/project-templates/workflow/:id |
Attributes
id NUMBER
Unique identifier for the workflow object.
slug STRING
Unique identifier for the workflow object.
title STRING
The title attribute of a workflow is a string that describes the workflow column name.
More Attributes
{
"id": number,
"title": string,
"description": string,
"slug": string,
"type": string,
"color": string,
"position": number,
"state": number,
"default": boolean,
"emails": string or null,
"autoarchive": boolean
}The Create Workflow Column endpoint on the GitScrum API allows users to add workflow columns to a project remotely by making a POST request.
Parameters
title STRING REQUIRED
The title attribute of a workflow is a string that describes the workflow column name
state STRING OPTIONAL
The state parameter is used to represent the current status of a workflow column, and can have one of three possible values: Todo, In Progress, or Done.
More Parameters
POST /project-templates/workflow
{
"id": 1,
"title": "Todo",
"description": "changed notifications to \"todo\"",
"slug": "issue-todo",
"type": "issues",
"color": "#b3dc6c",
"position": 1,
"state": 0,
"default": true,
"emails": null,
"autoarchive": 0
}To modify the specified workflow column by changing the values of the supplied parameters, send a PUT request with the updated parameter values. Any parameters not provided will remain unchanged.
Parameters
id NUMBER REQUIRED
Unique identifier for the workflow column object.
title STRING OPTIONAL
The title parameter should provide a short name for task types such as developing new features, bug fixes and investigations, for example.
state STRING OPTIONAL
The state parameter is used to represent the current status of a workflow column, and can have one of three possible values: Todo, In Progress, or Done.
color STRING OPTIONAL
The color parameter is used to store the color associated with a Workflow Column, represented as a hexadecimal string
More Parameters
PUT /project-templates/workflow/:id
{
"id": 1,
"title": "Todo",
"description": "changed notifications to \"todo\"",
"slug": "issue-todo",
"type": "issues",
"color": "#b3dc6c",
"position": 1,
"state": 0,
"default": true,
"emails": null,
"autoarchive": 0
}Make a GET request to return a sorted list of your Workflow Columns, with the Workflow Columns being sorted by the position attribute in ascending order.
Parameters
No parameters.
GET /project-templates/workflow
{
"data": [
{ ... },
{ ... },
{ ... }
]
}