SCRUM REST API for importing projects, boards, tasks

Administrator Admin_h3zvmz

I want to import Scrum projects with tasks & boards.

INitially my app will read all projects and then read the boards with tasks of selected projects. PLease advise the APIs needed to do this.

Adria Alonso

Hello,

Here you have the API's doc:

https://docs.atlassian.com/software/jira/docs/api/REST/8.5.3/?_ga=2.225755802.148088738.1578900665-1282193207.1558624760

I believe:

GET /rest/api/2/project

Returns all projects which are visible for the currently logged in user. If no user is logged in, it returns the list of projects that are visible when using anonymous access.

Request

QUERY PARAMETERS

parametertypedescription

expand	string	the parameters to expand
recent	int	if this parameter is set then only projects recently accessed by the current user (if not logged in then based on HTTP session) will be returned (maximum count limited to the specified number but no more than 20).
includeArchived	boolean	whether to include archived projects in response, default: false
browseArchive	boolean	whether to include only projects where current user can browse archive

The /dashboard resource.

ListGET /rest/api/2/dashboard

Returns a list of all dashboards, optionally filtering them.

Request

QUERY PARAMETERS

parametertypedescription

filter	string	an optional filter that is applied to the list of dashboards. Valid values include "favourite" for returning only favourite dashboards, and "my" for returning dashboards that are owned by the calling user.
startAt	int	the index of the first dashboard to return (0-based). must be 0 or a multiple of maxResults
maxResults	int	a hint as to the the maximum number of dashboards to return in each call. Note that the JIRA server reserves the right to impose a maxResults limit that is lower than the value that a client provides, dues to lack or resources or any other condition. When this happens, your results will be truncated. Callers should always check the returned maxResults to determine the value that is effectively being used.

Responses

• STATUS 200Returns a list of dashboards.

  EXAMPLE

  {
      "<span>startAt</span>": <span>10</span>,
      "<span>maxResults</span>": <span>10</span>,
      "<span>total</span>": <span>143</span>,
      "<span>prev</span>": <span>"http://www.example.com/jira/rest/api/2/dashboard?startAt=0"</span>,
      "<span>next</span>": <span>"http://www.example.com/jira/rest/api/2/dashboard?startAt=10"</span>,
      "<span>dashboards</span>": <span>[
          {
              "id": "10000",
              "name": "System Dashboard",
              "self": "http://www.example.com/jira/rest/api/2/dashboard/10000",
              "view": "http://www.example.com/jira/secure/Dashboard.jspa?selectPageId=10000"
          },
          {
              "id": "20000",
              "name": "Build Engineering",
              "self": "http://www.example.com/jira/rest/api/2/dashboard/20000",
              "view": "http://www.example.com/jira/secure/Dashboard.jspa?selectPageId=20000"
          }
      ]</span>}

  SCHEMA

Get dashboardGET /rest/api/2/dashboard/{id}

Returns a single dashboard.

Responses

• STATUS 200Returns a single dashboard.

  EXAMPLE

  {
      "<span>id</span>": <span>"10000"</span>,
      "<span>name</span>": <span>"System Dashboard"</span>,
      "<span>self</span>": <span>"http://www.example.com/jira/rest/api/2/dashboard/10000"</span>,
      "<span>view</span>": <span>"http://www.example.com/jira/secure/Dashboard.jspa?selectPageId=10000"</span>}