Jira Software Cloud
Jira Service Management
Confluence Cloud
Atlassian Admin Cloud
📈
Dashboards
This resource represents dashboards. Use it to obtain the details of dashboards as well as add and remove item properties from dashboards.
.gif created using the video https://www.youtube.com/watch?v=VswPTqLQzqA
Get all dashboards
Returns a list of dashboards owned by or shared with the user. The list may be filtered to include only favorite or owned dashboards.
- 🔒 Permissions required: Anonymously
1
package main
2
3
import (
4
"context"
5
"github.com/ctreminiom/go-atlassian/jira/v2"
6
"log"
7
"os"
8
)
9
10
func main() {
11
12
var (
13
host = os.Getenv("HOST")
14
mail = os.Getenv("MAIL")
15
token = os.Getenv("TOKEN")
16
)
17
18
jiraCloud, err := v2.New(nil, host)
19
if err != nil {
20
return
21
}
22
23
jiraCloud.Auth.SetBasicAuth(mail, token)
24
jiraCloud.Auth.SetUserAgent("curl/7.54.0")
25
26
dashboards, response, err := jiraCloud.Dashboard.Gets(context.Background(), 0, 50, "")
27
28
if err != nil {
29
log.Fatal(err)
30
}
31
32
log.Println("HTTP Endpoint Used", response.Endpoint)
33
34
for _, dashboard := range dashboards.Dashboards {
35
log.Println(dashboard.ID, dashboard.Name)
36
}
37
}
Copied!
🧚♀️ Tips: You can extract the following struct tags
1
type DashboardPageScheme struct {
2
StartAt int `json:"startAt,omitempty"`
3
MaxResults int `json:"maxResults,omitempty"`
4
Total int `json:"total,omitempty"`
5
Dashboards []*DashboardScheme `json:"dashboards,omitempty"`
6
}
7
8
type DashboardScheme struct {
9
ID string `json:"id,omitempty"`
10
IsFavourite bool `json:"isFavourite,omitempty"`
11
Name string `json:"name,omitempty"`
12
Owner *UserScheme `json:"owner,omitempty"`
13
Popularity int `json:"popularity,omitempty"`
14
Rank int `json:"rank,omitempty"`
15
Self string `json:"self,omitempty"`
16
SharePermissions []*SharePermissionScheme `json:"sharePermissions,omitempty"`
17
EditPermission []*SharePermissionScheme `json:"editPermissions,omitempty"`
18
View string `json:"view,omitempty"`
19
}
20
21
type SharePermissionScheme struct {
22
ID int `json:"id,omitempty"`
23
Type string `json:"type,omitempty"`
24
Project *ProjectScheme `json:"project,omitempty"`
25
Role *ProjectRoleScheme `json:"role,omitempty"`
26
Group *GroupScheme `json:"group,omitempty"`
27
}
28
29
type DashboardSearchPageScheme struct {
30
Self string `json:"self,omitempty"`
31
MaxResults int `json:"maxResults,omitempty"`
32
StartAt int `json:"startAt,omitempty"`
33
Total int `json:"total,omitempty"`
34
IsLast bool `json:"isLast,omitempty"`
35
Values []*DashboardScheme `json:"values,omitempty"`
36
}
Copied!
Create dashboard
This method creates a dashboard on Jira Cloud.
1
package main
2
3
import (
4
"context"
5
"github.com/ctreminiom/go-atlassian/jira/v2"
6
"github.com/ctreminiom/go-atlassian/pkg/infra/models"
7
"log"
8
"os"
9
)
10
11
func main() {
12
13
var (
14
host = os.Getenv("HOST")
15
mail = os.Getenv("MAIL")
16
token = os.Getenv("TOKEN")
17
)
18
19
jiraCloud, err := v2.New(nil, host)
20
if err != nil {
21
return
22
}
23
24
jiraCloud.Auth.SetBasicAuth(mail, token)
25
jiraCloud.Auth.SetUserAgent("curl/7.54.0")
26
27
var payload = &models.DashboardPayloadScheme{
28
Name: "Team Tracking 4",
29
Description: "description sample",
30
SharePermissions: []*models.SharePermissionScheme{
31
{
32
Type: "project",
33
Project: &models.ProjectScheme{
34
ID: "10000",
35
},
36
Role: nil,
37
Group: nil,
38
},
39
{
40
Type: "group",
41
Group: &models.GroupScheme{Name: "jira-administrators"},
42
},
43
},
44
}
45
46
dashboard, response, err := jiraCloud.Dashboard.Create(context.Background(), payload)
47
if err != nil {
48
log.Fatal(err)
49
}
50
51
log.Println("Response HTTP Code", response.Code)
52
log.Println("HTTP Endpoint Used", response.Endpoint)
53
54
log.Printf("Dashboard Name: %v", dashboard.Name)
55
log.Printf("Dashboard ID: %v", dashboard.ID)
56
log.Printf("Dashboard View: %v", dashboard.View)
57
}
Copied!
🧚♀️ Tips: You can extract the following struct tags
1
type DashboardScheme struct {
2
ID string `json:"id,omitempty"`
3
IsFavourite bool `json:"isFavourite,omitempty"`
4
Name string `json:"name,omitempty"`
5
Owner *UserScheme `json:"owner,omitempty"`
6
Popularity int `json:"popularity,omitempty"`
7
Rank int `json:"rank,omitempty"`
8
Self string `json:"self,omitempty"`
9
SharePermissions []*SharePermissionScheme `json:"sharePermissions,omitempty"`
10
EditPermission []*SharePermissionScheme `json:"editPermissions,omitempty"`
11
View string `json:"view,omitempty"`
12
}
Copied!
Search for dashboards
Returns a paginated list of dashboards. This operation is similar to Get dashboards except that the results can be refined to include dashboards that have specific attributes. For example, dashboards with a particular name. When multiple attributes are specified only filters matching all attributes are returned.
1
package main
2
3
import (
4
"context"
5
"github.com/ctreminiom/go-atlassian/jira/v2"
6
"github.com/ctreminiom/go-atlassian/pkg/infra/models"
7
"log"
8
"os"
9
)
10
11
func main() {
12
13
var (
14
host = os.Getenv("HOST")
15
mail = os.Getenv("MAIL")
16
token = os.Getenv("TOKEN")
17
)
18
19
jiraCloud, err := v2.New(nil, host)
20
if err != nil {
21
return
22
}
23
24
jiraCloud.Auth.SetBasicAuth(mail, token)
25
jiraCloud.Auth.SetUserAgent("curl/7.54.0")
26
27
searchOptions := models.DashboardSearchOptionsScheme{
28
DashboardName: "Bug",
29
GroupPermissionName: "administrators",
30
OrderBy: "description",
31
Expand: []string{"description", "favourite", "sharePermissions"},
32
}
33
34
dashboards, response, err := jiraCloud.Dashboard.Search(context.Background(), &searchOptions, 0, 50)
35
if err != nil {
36
log.Fatal(err)
37
}
38
39
log.Println("HTTP Endpoint Used", response.Endpoint)
40
41
for _, dashboard := range dashboards.Values {
42
log.Printf("Dashboard Name: %v", dashboard.Name)
43
log.Printf("Dashboard ID: %v", dashboard.ID)
44
log.Printf("Dashboard View: %v", dashboard.View)
45
46
if dashboard.SharePermissions != nil {
47
for _, permission := range dashboard.SharePermissions {
48
log.Println(permission)
49
}
50
}
51
}
52
53
}
Copied!
Get dashboard
Returns a dashboard using the dashboard-id
- 🔒 Permissions required: Access to the application
However, to get a dashboard, the dashboard must be shared with the user or the user must own it. Note, users with Administer Jira global permission are considered owners of the System dashboard. The System dashboard is considered to be shared with all other users.
1
package main
2
3
import (
4
"context"
5
"github.com/ctreminiom/go-atlassian/jira/v2"
6
"log"
7
"os"
8
)
9
10
func main() {
11
12
var (
13
host = os.Getenv("HOST")
14
mail = os.Getenv("MAIL")
15
token = os.Getenv("TOKEN")
16
)
17
18
jiraCloud, err := v2.New(nil, host)
19
if err != nil {
20
return
21
}
22
23
jiraCloud.Auth.SetBasicAuth(mail, token)
24
jiraCloud.Auth.SetUserAgent("curl/7.54.0")
25
26
dashboard, response, err := jiraCloud.Dashboard.Get(context.Background(), "10001")
27
if err != nil {
28
log.Fatal(err)
29
}
30
31
log.Println("HTTP Endpoint Used", response.Endpoint)
32
33
log.Printf("Dashboard Name: %v", dashboard.Name)
34
log.Printf("Dashboard ID: %v", dashboard.ID)
35
log.Printf("Dashboard View: %v", dashboard.View)
36
}
Copied!
🧚♀️ Tips: You can extract the following struct tags
1
type DashboardScheme struct {
2
ID string `json:"id,omitempty"`
3
IsFavourite bool `json:"isFavourite,omitempty"`
4
Name string `json:"name,omitempty"`
5
Owner *UserScheme `json:"owner,omitempty"`
6
Popularity int `json:"popularity,omitempty"`
7
Rank int `json:"rank,omitempty"`
8
Self string `json:"self,omitempty"`
9
SharePermissions []*SharePermissionScheme `json:"sharePermissions,omitempty"`
10
EditPermission []*SharePermissionScheme `json:"editPermissions,omitempty"`
11
View string `json:"view,omitempty"`
12
}
13
14
type SharePermissionScheme struct {
15
ID int `json:"id,omitempty"`
16
Type string `json:"type,omitempty"`
17
Project *ProjectScheme `json:"project,omitempty"`
18
Role *ProjectRoleScheme `json:"role,omitempty"`
19
Group *GroupScheme `json:"group,omitempty"`
20
}
Copied!
Update dashboard
Updates a dashboard, replacing all the dashboard details with those provided. The dashboard to be updated must be owned by the user.
1
package main
2
3
import (
4
"context"
5
"github.com/ctreminiom/go-atlassian/jira/v2"
6
"github.com/ctreminiom/go-atlassian/pkg/infra/models"
7
"log"
8
"os"
9
)
10
11
func main() {
12
13
var (
14
host = os.Getenv("HOST")
15
mail = os.Getenv("MAIL")
16
token = os.Getenv("TOKEN")
17
)
18
19
jiraCloud, err := v2.New(nil, host)
20
if err != nil {
21
return
22
}
23
24
jiraCloud.Auth.SetBasicAuth(mail, token)
25
jiraCloud.Auth.SetUserAgent("curl/7.54.0")
26
27
var payload = &models.DashboardPayloadScheme{
28
Name: "Team Tracking #1111",
29
Description: "",
30
SharePermissions: []*models.SharePermissionScheme{
31
{
32
Type: "project",
33
Project: &models.ProjectScheme{
34
ID: "10000",
35
},
36
Role: nil,
37
Group: nil,
38
},
39
{
40
Type: "group",
41
Group: &models.GroupScheme{Name: "jira-administrators"},
42
},
43
},
44
}
45
46
dashboard, response, err := jiraCloud.Dashboard.Update(context.Background(), "10001", payload)
47
if err != nil {
48
log.Fatal(err)
49
}
50
51
log.Println("HTTP Endpoint Used", response.Endpoint)
52
53
log.Printf("Dashboard Name: %v", dashboard.Name)
54
log.Printf("Dashboard ID: %v", dashboard.ID)
55
log.Printf("Dashboard View: %v", dashboard.View)
56
}
57
Copied!
Delete dashboard
Deletes a dashboard, The dashboard to be deleted must be owned by the user.
1
package main
2
3
import (
4
"context"
5
"github.com/ctreminiom/go-atlassian/jira/v2"
6
"log"
7
"os"
8
)
9
10
func main() {
11
12
var (
13
host = os.Getenv("HOST")
14
mail = os.Getenv("MAIL")
15
token = os.Getenv("TOKEN")
16
)
17
18
jiraCloud, err := v2.New(nil, host)
19
if err != nil {
20
return
21
}
22
23
jiraCloud.Auth.SetBasicAuth(mail, token)
24
jiraCloud.Auth.SetUserAgent("curl/7.54.0")
25
26
response, err := jiraCloud.Dashboard.Delete(context.Background(), "10003")
27
if err != nil {
28
log.Fatal(err)
29
}
30
31
log.Println("Response HTTP Code", response.Code)
32
log.Println("HTTP Endpoint Used", response.Endpoint)
33
}
Copied!
Copy dashboard
Copies a dashboard. Any values provided in the
dashboard parameter replace those in the copied dashboard.1
package main
2
3
import (
4
"context"
5
"github.com/ctreminiom/go-atlassian/jira/v2"
6
"github.com/ctreminiom/go-atlassian/pkg/infra/models"
7
"log"
8
"os"
9
)
10
11
func main() {
12
13
var (
14
host = os.Getenv("HOST")
15
mail = os.Getenv("MAIL")
16
token = os.Getenv("TOKEN")
17
)
18
19
jiraCloud, err := v2.New(nil, host)
20
if err != nil {
21
return
22
}
23
24
jiraCloud.Auth.SetBasicAuth(mail, token)
25
jiraCloud.Auth.SetUserAgent("curl/7.54.0")
26
27
var payload = &models.DashboardPayloadScheme{
28
Name: "Team Tracking #2 copy",
29
Description: "Description sample",
30
SharePermissions: []*models.SharePermissionScheme{
31
{
32
Type: "project",
33
Project: &models.ProjectScheme{
34
ID: "10000",
35
},
36
Role: nil,
37
Group: nil,
38
},
39
{
40
Type: "group",
41
Group: &models.GroupScheme{Name: "jira-administrators"},
42
},
43
},
44
}
45
46
dashboard, response, err := jiraCloud.Dashboard.Copy(context.Background(), "10001", payload)
47
if err != nil {
48
if response != nil {
49
log.Println("Response HTTP Response", response.Bytes.String())
50
}
51
log.Fatal(err)
52
}
53
54
log.Println("Response HTTP Code", response.Code)
55
log.Println("HTTP Endpoint Used", response.Endpoint)
56
57
log.Printf("Dashboard Name: %v", dashboard.Name)
58
log.Printf("Dashboard ID: %v", dashboard.ID)
59
log.Printf("Dashboard View: %v", dashboard.View)
60
}
Copied!
Last modified 6mo ago
Export as PDF
Copy link