Server
Jira Data Center / Reference / REST API

dashboard

Postman Collection
Operations
GET/api/2/dashboardGET/api/2/dashboard/{dashboardId}/items/{itemId}/propertiesGET/api/2/dashboard/{dashboardId}/items/{itemId}/properties/{propertyKey}PUT/api/2/dashboard/{dashboardId}/items/{itemId}/properties/{propertyKey}DEL/api/2/dashboard/{dashboardId}/items/{itemId}/properties/{propertyKey}GET/api/2/dashboard/{id}
GET

Get all dashboards with optional filtering

Returns a list of all dashboards, optionally filtering them.

Request

Query parameters

filter

string

maxResults

string

startAt

string

Responses

Returns a list of dashboards.

application/json

DashboardsBean
GET/api/2/dashboard
1 2 3 4 curl --request GET \ --url 'http://{baseurl}/rest/api/2/dashboard' \ --user 'email@example.com:<api_token>' \ --header 'Accept: application/json'
GET

Get all properties keys for a dashboard item

Returns the keys of all properties for the dashboard item identified by the id.

Request

Path parameters

itemId

string

Required
dashboardId

string

Required

Responses

Returned if the dashboard item was found.

application/json

EntityPropertiesKeysBean
GET/api/2/dashboard/{dashboardId}/items/{itemId}/properties
1 2 3 4 curl --request GET \ --url 'http://{baseurl}/rest/api/2/dashboard/{dashboardId}/items/{itemId}/properties' \ --user 'email@example.com:<api_token>' \ --header 'Accept: application/json'
GET

Get a property from a dashboard item

Returns the value of the property with a given key from the dashboard item identified by the id.

Request

Path parameters

propertyKey

string

Required
itemId

string

Required
dashboardId

string

Required

Responses

Returned if the dashboard item property was found.

application/json

EntityPropertyBean
GET/api/2/dashboard/{dashboardId}/items/{itemId}/properties/{propertyKey}
1 2 3 4 curl --request GET \ --url 'http://{baseurl}/rest/api/2/dashboard/{dashboardId}/items/{itemId}/properties/{propertyKey}' \ --user 'email@example.com:<api_token>' \ --header 'Accept: application/json'
PUT

Set a property on a dashboard item

Sets the value of the property with a given key on the dashboard item identified by the id.

Request

Path parameters

propertyKey

string

Required
itemId

string

Required
dashboardId

string

Required

Responses

Returned if the dashboard item property is successfully updated.

PUT/api/2/dashboard/{dashboardId}/items/{itemId}/properties/{propertyKey}
1 2 3 curl --request PUT \ --url 'http://{baseurl}/rest/api/2/dashboard/{dashboardId}/items/{itemId}/properties/{propertyKey}' \ --user 'email@example.com:<api_token>'
DEL

Delete a property from a dashboard item

Removes the property from the dashboard item identified by the key or by the id.

Request

Path parameters

propertyKey

string

Required
itemId

string

Required
dashboardId

string

Required

Responses

Returned if the dashboard item property was removed successfully.

DEL/api/2/dashboard/{dashboardId}/items/{itemId}/properties/{propertyKey}
1 2 3 curl --request DELETE \ --url 'http://{baseurl}/rest/api/2/dashboard/{dashboardId}/items/{itemId}/properties/{propertyKey}' \ --user 'email@example.com:<api_token>'
GET

Get a single dashboard by ID

Returns a single dashboard.

Request

Path parameters

id

string

Required

Responses

Returns a single dashboard.

application/json

DashboardBean
GET/api/2/dashboard/{id}
1 2 3 4 curl --request GET \ --url 'http://{baseurl}/rest/api/2/dashboard/{id}' \ --user 'email@example.com:<api_token>' \ --header 'Accept: application/json'

Rate this page: