atlassian.jira.dashboards — net.clojars.deadmeme5441/atlassian-sdk 0.3.0

Jira Cloud Dashboard endpoints.

All functions take a client (built via atlassian.jira.client/client) as their first arg and delegate to atlassian.jira.client/request.

add-gadget clj

(add-gadget client dashboard-id body)

Add gadget to dashboard. POST /rest/api/3/dashboard/{dashboardId}/gadget Required path param: dashboardId Body: DashboardGadgetSettings — {:moduleKey str :uri str :color str :position {:row int :column int} :title str :ignoreUriAndModuleKeyValidation bool}

bulk-edit-dashboards clj

(bulk-edit-dashboards client body)

Bulk edit dashboards. PUT /rest/api/3/dashboard/bulk/edit Body: BulkEditShareableEntityRequest — {:action str :entityIds [int] :changeOwnerDetails {...} :extendAdminPermissions bool :permissionDetails {...}}

copy-dashboard clj

(copy-dashboard client id body)

(copy-dashboard client id body opts)

Copy dashboard. POST /rest/api/3/dashboard/{id}/copy Required path param: id Body: DashboardDetails — {:name str :editPermissions [...] :sharePermissions [...] :description str} opts: :extendAdminPermissions (optional query param)

create-dashboard clj

(create-dashboard client body)

(create-dashboard client body opts)

Create dashboard. POST /rest/api/3/dashboard Body: DashboardDetails — {:name str :editPermissions [...] :sharePermissions [...] :description str} opts: :extendAdminPermissions (optional query param)

delete-dashboard clj

(delete-dashboard client id)

Delete dashboard. DELETE /rest/api/3/dashboard/{id} Required path param: id

delete-dashboard-item-property clj

(delete-dashboard-item-property client dashboard-id item-id property-key)

Delete dashboard item property. DELETE /rest/api/3/dashboard/{dashboardId}/items/{itemId}/properties/{propertyKey} Required path params: dashboardId, itemId, propertyKey

get-all-available-dashboard-gadgets clj

(get-all-available-dashboard-gadgets client)

Get available gadgets. GET /rest/api/3/dashboard/gadgets

get-all-dashboards clj

(get-all-dashboards client)

(get-all-dashboards client opts)

Get all dashboards. GET /rest/api/3/dashboard opts: :filter, :startAt, :maxResults (all optional query params)

get-all-gadgets clj

(get-all-gadgets client dashboard-id)

(get-all-gadgets client dashboard-id opts)

Get gadgets for a dashboard. GET /rest/api/3/dashboard/{dashboardId}/gadget Required path param: dashboardId opts: :moduleKey, :uri, :gadgetId (all optional query params, accept arrays)

get-dashboard clj

(get-dashboard client id)

Get dashboard. GET /rest/api/3/dashboard/{id} Required path param: id

get-dashboard-item-property clj

(get-dashboard-item-property client dashboard-id item-id property-key)

Get dashboard item property. GET /rest/api/3/dashboard/{dashboardId}/items/{itemId}/properties/{propertyKey} Required path params: dashboardId, itemId, propertyKey

get-dashboard-item-property-keys clj

(get-dashboard-item-property-keys client dashboard-id item-id)

Get dashboard item property keys. GET /rest/api/3/dashboard/{dashboardId}/items/{itemId}/properties Required path params: dashboardId, itemId

get-dashboards-paginated clj

(get-dashboards-paginated client)

(get-dashboards-paginated client opts)

Search for dashboards. GET /rest/api/3/dashboard/search opts: :dashboardName, :accountId, :owner, :groupname, :groupId, :projectId, :orderBy, :startAt, :maxResults, :status, :expand (all optional query params)

remove-gadget clj

(remove-gadget client dashboard-id gadget-id)

Remove gadget from dashboard. DELETE /rest/api/3/dashboard/{dashboardId}/gadget/{gadgetId} Required path params: dashboardId, gadgetId

set-dashboard-item-property clj

(set-dashboard-item-property client dashboard-id item-id property-key body)

Set dashboard item property. PUT /rest/api/3/dashboard/{dashboardId}/items/{itemId}/properties/{propertyKey} Required path params: dashboardId, itemId, propertyKey Body: arbitrary JSON value to store as the property value.

update-dashboard clj

(update-dashboard client id body)

(update-dashboard client id body opts)

Update dashboard. PUT /rest/api/3/dashboard/{id} Required path param: id Body: DashboardDetails — {:name str :editPermissions [...] :sharePermissions [...] :description str} opts: :extendAdminPermissions (optional query param)

update-gadget clj

(update-gadget client dashboard-id gadget-id body)

Update gadget on dashboard. PUT /rest/api/3/dashboard/{dashboardId}/gadget/{gadgetId} Required path params: dashboardId, gadgetId Body: DashboardGadgetUpdateRequest — {:color str :position {:row int :column int} :title str}