Working with Dashboards in JIRA

The following operations are available for working with dashboards.Click an operation name to see details on how to use it.

For a sample proxy service that illustrates how to work with dashboards, see Sample configuration .

Following is more information about these operations.

Getting dashboards

This operation returns a JSON representation of the list of dashboards, including their names, IDs, and more.

<jira.getDashboards>
	<maxResults>{$ctx:maxResults}</maxResults>
    <filter>{$ctx:filter}</filter>
	<startAt>{$ctx:startAt}</startAt>
</jira.getDashboards>

Properties

• maxResults: The maximum number of users to return, up to 1000 (default is 50).
• startAt : The index of the first dashboard to return (0-based). must be 0 or a multiple of maxResults.
• filter : An optional filter that is applied to the list of dashboards.

Sample request

Following is a sample REST/JSON request that can be handled by the getDashboards operation.

{
    "username":"admin",
    "password":"jira@jaffna",       
    "uri":"https://testcon.atlassian.net",        
    "maxResults":"50",
    "filter":"favourite"
}

Related Jira Documentation

https://developer.atlassian.com/static/rest/jira/6.1.html#d2e816

Getting a specific dashboard

This operation returns a JSON representation of the dashboard details, including its name, ID, and more.

<jira.getDashboardById>
  <id>{$ctx:id}</id>
</jira.getDashboardById>

Properties

• id: Identifies the dashboard whose details you want to get.

Sample request

Following is a sample REST/JSON request that can be handled by the getDashboardById operation.

{
    "username":"admin",
    "password":"jira@jaffna",       
    "uri":"https://testcon.atlassian.net",        
    "id":"10100"
}

Related Jira Documentation

https://developer.atlassian.com/static/rest/jira/6.1.html#d2e843

Sample Configuration

Following is a sample proxy service that illustrates how to connect to Jira with the init operation and use the getDashboardById operation. The sample request for this proxy can be found in getDashboardById sample request. You can use this sample as a template for using other operations in this category.

<proxy xmlns="http://ws.apache.org/ns/synapse"
       name="getDashboardById"
       transports="https http"
       startOnLoad="true"
       trace="disable">
   <description/>
   <target>
      <inSequence>
         <property name="username" expression="json-eval($.username)"/>
         <property name="password" expression="json-eval($.password)"/>
         <property name="uri" expression="json-eval($.uri)"/>
         <property name="id" expression="json-eval($.id)"/>
         <jira.init>
            <username>{$ctx:username}</username>
            <password>{$ctx:password}</password>
            <uri>{$ctx:uri}</uri>
         </jira.init>
         <jira.getDashboardById>
            <id>{$ctx:id}</id>
         </jira.getDashboardById>
         <log level="full"/>
         <respond/>
      </inSequence>
      <outSequence/>
      <faultSequence/>
   </target>
</proxy>