	REST API: Coverage#columnFilterJsonObject	Construct definition
POST	com.easesolutions.jira.plugins.coverage/1.0/data	Evaluates coverage data for view
GET	com.easesolutions.jira.plugins.coverage/1.0/displayFields	Get display fields available for coverage view

...

Expand

title	Click here for details...

...

title

Panel

titleColor #FFFFFF

titleBGColor #6c809a

REQUEST

Panel

bgColor	#f6f5f5

POST

/rest/com.easesolutions.jira.plugins.requirements/1.0/coverage/prjKey/createcoverageview?name&isPublic&columns

PARAMETERS

parameter	type	description
prjKey*	string	the project the view to be created
name	string	the name of the view
isPublic	boolean	the visibility of the view
columns	string	an array of objects compose of name, type ("filter", "jql", or "issue types"), filter, and link types example: ^[ ^{{"name": "Column 1","type": "jql","filter": "issuetype in (bug, improvement)","linkTypes": []},} ^{{"name": "Column 2","type": "filter","filter": "10000": ["relates to","trace to","duplicates"]},} ^{{"name": "Column 2","type": "issue types","filter": ["task", "bug"],"linkTypes": []}} ^]
fieldsToDisplay	string	an array of field names (Note: name is case sensitive)
folderId	long	the tree folder id (Optional)

RESPONSES

Status

colour	Green
title	STATUS 200

- Returned if a coverage view is created

Example Response JSON

Code Block
View name has been successfully created

Status

colour	Red
title	STATUS 400

- Returned if the project is invalid, name is invalid or already exist, columns is invalid or contains invalid values, or an error occurs while creating the coverage view

Status

colour	Red
title	STATUS 401

- Returned if invalid user credentials, or the user has no permission to use Requirements for JIRA plugin

Status

colour	Red
title	STATUS 403

- Returned if the license is invalid or has expired, incompatible JIRA version, the project is not configured for Requirements for JIRA, or no permission to create coverage view

Status

colour	Red
title	STATUS 404

- Returned if project is not found

...

com.easesolutions.jira.plugins.coverage/1.0/filter/saveFilter

Trigger the creation of a coverage view

Expand

title	Click here for details...

...

titleBGColor

Panel

titleColor #FFFFFF

REQUEST

Panel

bgColor	#f6f5f5

POST

/rest/com.easesolutions.jira.plugins.coverage/1.0/filter/saveFilter

Code Block

title	Example Request JSON

{
  "projectId": 10000,
  "isPublic": true,
  "name": "Coverage View",
  "addedFieldsJsonArray": ["issuetype","issuekey","status","priority","summary"],
  "columnFilterJsonObject": {<this object is defined elsewhere>}
}

Definition:

projectId - the project the view to be created
isPublic - the visibility of the view
name - the name of the view
addedFieldsJsonArray - an array of field names
columnFilterJsonObject - an object containing column data relevant to the coverage view

RESPONSES

Status


colour	Green
title	STATUS 200

- Returned if a coverage view is created

Code Block

title	Example Response JSON

{
	"id": 1,
	"name": "Coverage View"
}

Status


colour	Red
title	STATUS 400

- Returned if the project is invalid, name is invalid or already exist, columns is invalid or contains invalid values, or an error occurs while creating the coverage view

Status

colour	Red
title	STATUS 401

- Returned if invalid user credentials, or the user has no permission to use Requirements for JIRA plugin

Status

colour	Red
title	STATUS 403

- Returned if the license is invalid or has expired, incompatible JIRA version, the project is not configured for Requirements for JIRA, or no permission to create coverage view

Status


colour	Red
title	STATUS 404

- Returned if project is not found

...

	#6c809a	title

com.easesolutions.jira.plugins.coverage/1.0/data

Evaluates coverage data for view

Expand

title	Click here for details...

...

title

Panel

titleColor

#FFFFFF

titleBGColor

#6c809a

REQUEST

Panel

bgColor	#f6f5f5

POST

com.easesolutions.jira.plugins.coverage/1.0/data

Code Block

title	Example Request JSON

{
  "columns": [{
      "label": "Level 1",
      "jiraJql": "",
      "jiraFilterId": "",
      "linkTypes": [{"id": "-1","directions": {"in": true,"out": true}}],
      "currentIssueTypes": ["-1"],
      "projects": ["10000,DEMO,DEMO"],
      "fromLevel": -1
   }],
  "fields": [],
  "folderIssueKeys": [],
  "filterId": 0,
  "folderId": 0,
  "folderName": "",
  "projectId": 10000,
  "fromColumn": 0,
  "isFiltered": false
}

RESPONSES

Status


colour	Green
title	STATUS 201

- Returned if data successfully parsed

Code Block

title	Example Response JSON

{  
   "headerList":[  
      {  
         "label":"Level 1",
         "issueTypes":"<any>",
         "linkTypes":"<any>",
         "fromLevel":-1,
         "projects":"DEMO (DEMO)",
         "columnTotal":5
      }
   ],
   "columns":{  
      "0":[  
         {  
            "issues":[{...}],
            "pathid":""
         }
      ]
   },
   "fromColumn":0,
   "maxLimit":1000
}

Status


colour	Red
title	STATUS 400

- Returned if the project is invalid, name is invalid or already exist, columns is invalid or contains invalid values, or an error occurs while creating the coverage view

Status

colour	Red
title	STATUS 401

- Returned if invalid user credentials, or the user has no permission to use Requirements for JIRA plugin

Status

colour	Red
title	STATUS 403

- Returned if the license is invalid or has expired, incompatible JIRA version, the project is not configured for Requirements for JIRA, or no permission to create coverage view

Status


colour	Red
title	STATUS 404

- Returned if project is not found

...

- Returned if project is not found

com.easesolutions.jira.plugins.coverage/1.0/displayFields

Get display fields for coverage view

Expand

title	Click here for details...

...

title

Panel

titleColor

#FFFFFF

titleBGColor

#6c809a

REQUEST

Panel

bgColor	#f6f5f5

POST

com.easesolutions.jira.plugins.coverage/1.0/displayFields

RESPONSES

Status


colour	Green
title	STATUS 201

- Returned if successful

Code Block

title	Example Response JSON

[
  {
    "id": "issuetype",
    "name": "Issue Type",
    "selected": true
  },
  ....
]

Status


colour	Red
title	STATUS 400

- Returned if the project is invalid, name is invalid or already exist, columns is invalid or contains invalid values, or an error occurs while creating the coverage view

Status

colour	Red
title	STATUS 401

- Returned if invalid user credentials, or the user has no permission to use Requirements for JIRA plugin

Status

colour	Red
title	STATUS 403

- Returned if the license is invalid or has expired, incompatible JIRA version, the project is not configured for Requirements for JIRA, or no permission to create coverage view

Status


colour	Red
title	STATUS 404

- Returned if project is not found

...

com.easesolutions.jira.plugins.coverage/1.0/filter/renameFilter

Rename coverage filter

Expand

title	Click here for details...

...

title

Panel

titleColor

#FFFFFF

titleBGColor

#6c809a

REQUEST

Panel

bgColor	#f6f5f5

POST

com.easesolutions.jira.plugins.coverage/1.0/filter/renameFilter

Code Block

title	Example Request JSON

{
  "projectId": 10000,
  "name": "Filter C",
  "isPublic": false,
  "filterId": "3"
}

RESPONSES

Status


colour	Green
title	STATUS 200

- Returned if successful rename

Code Block

title	Example Response JSON

{
  "id": "3",
  "name": "Filter C"
}

Status


colour	Red
title	STATUS 400

- Returned if the project is invalid, name is invalid or already exist, columns is invalid or contains invalid values, or an error occurs while creating the coverage view

Status

colour	Red
title	STATUS 401

- Returned if invalid user credentials, or the user has no permission to use Requirements for JIRA plugin

Status

colour	Red
title	STATUS 403

- Returned if the license is invalid or has expired, incompatible JIRA version, the project is not configured for Requirements for JIRA, or no permission to create coverage view

Status


colour	Red
title	STATUS 404

- Returned if project is not found

...

com.easesolutions.jira.plugins.coverage/1.0/filter/updateFilter

Update coverage filter columns

Expand

title	Click here for details...

...

#6c809a

Panel

titleColor

#FFFFFF

titleBGColor

REQUEST

Panel

bgColor	#f6f5f5

POST

com.easesolutions.jira.plugins.coverage/1.0/filter/updateFilter

Code Block

title	Example Request JSON

{
  "projectId": 10000,
  "filterId": "4",
  "isPublic": true,
  "columnFilterJsonObject": "{<this object is defined elsewhere>}",
  "addedFieldsJsonArray": ["issuetype","issuekey","status","priority","summary"]
}

Definition:

projectId - the project the view to be created
filterId - id of filter to update
isPublic - the visibility of the view
addedFieldsJsonArray - an array of field names
columnFilterJsonObject - an object containing column data relevant to the coverage view

RESPONSES

Status


colour	Green
title	STATUS 200

- Returned if successful update

Code Block

title	Example Response JSON

{
  "id": "4",
  "name": "C",
  "columnFilterJsonObject": "{....}",
  "addedFieldsJsonArray": "[....]"
}

Status


colour	Red
title	STATUS 400

- Returned if the project is invalid, name is invalid or already exist, columns is invalid or contains invalid values, or an error occurs while creating the coverage view

Status

colour	Red
title	STATUS 401

- Returned if invalid user credentials, or the user has no permission to use Requirements for JIRA plugin

Status

colour	Red
title	STATUS 403

- Returned if the license is invalid or has expired, incompatible JIRA version, the project is not configured for Requirements for JIRA, or no permission to create coverage view

Status


colour	Red
title	STATUS 404

- Returned if project is not found

...

	title

com.easesolutions.jira.plugins.coverage/1.0/filter/deleteFilter

Delete coverage filter

Expand

title	Click here for details...

...

title - Returned if project is not found

Panel

titleColor

#FFFFFF

titleBGColor

#6c809a

REQUEST

Panel

bgColor	#f6f5f5

POST

com.easesolutions.jira.plugins.coverage/1.0/filter/deleteFilter

PARAMETERS

parameter	type	description
projectId	Long	project id of filter to be deleted
filterId	Long	filterId of filter to be deleted

RESPONSES

Status


colour	Green
title	STATUS 200

- Returned if coverage is successfully deleted

Status


colour	Red
title	STATUS 400

- Returned if the project is invalid, name is invalid or already exist, columns is invalid or contains invalid values, or an error occurs while creating the coverage view

Status

colour	Red
title	STATUS 401

- Returned if invalid user credentials, or the user has no permission to use Requirements for JIRA plugin

Status

colour	Red
title	STATUS 403

- Returned if the license is invalid or has expired, incompatible JIRA version, the project is not configured for Requirements for JIRA, or no permission to create coverage view

Status

colour

Red

title

STATUS 404

...


colour	Red
title	STATUS 404

- Returned if project is not found

com.easesolutions.jira.plugins.coverage/1.0/filter/getAllFilters

Get all public and personal coverage filters for user

Expand

title	Click here for details...

...

title

Panel

titleColor

#FFFFFF

titleBGColor

#6c809a

REQUEST

Panel

bgColor	#f6f5f5

GET

com.easesolutions.jira.plugins.coverage/1.0/filter/getAllFilters

RESPONSES

Status


colour	Green
title	STATUS 201

- Returned if successful

Code Block

title	Example Response JSON

{
   "publicFilters":[
      {
         "id":"1",
         "name":"Filter A",
		 "projectId": 10000
      },
      {
         "id":"2",
         "name":"Filter B",
		 "projectId": 10001
      }
   ],
   "personalFilters":[
      {
         "id":"3",
         "name":"Filter C",
		 "projectId": 10000
      }
   ]
}

Status


colour	Red
title	STATUS 400

- Returned if the project is invalid, name is invalid or already exist, columns is invalid or contains invalid values, or an error occurs while creating the coverage view

Status

colour	Red
title	STATUS 401

- Returned if invalid user credentials, or the user has no permission to use Requirements for JIRA plugin

Status

colour	Red
title	STATUS 403

- Returned if the license is invalid or has expired, incompatible JIRA version, the project is not configured for Requirements for JIRA, or no permission to create coverage view

Status


colour	Red
title	STATUS 404

- Returned if project is not found

...

com.easesolutions.jira.plugins.coverage/1.0/filter/getFilter

Get specific coverage filter

Expand

title	Click here for details...

...

titleBGColor

Panel

titleColor

#FFFFFF

REQUEST

Panel

bgColor	#f6f5f5

GET

com.easesolutions.jira.plugins.coverage/1.0/filter/getFilter

PARAMETERS

parameter	type	description
projectId	Long	project id of filter to get
filterId	Long	filterId of filter to get

RESPONSES

Status


colour	Green
title	STATUS 200

- Returned if successful

Code Block

title	Example Response JSON

{
  "id": "1",
  "name": "Filter A",
  "columnFilterJsonObject": "{....}",
  "addedFieldsJsonArray": "[....]"
}

Status


colour	Red
title	STATUS 400

- Returned if the project is invalid, name is invalid or already exist, columns is invalid or contains invalid values, or an error occurs while creating the coverage view

Status

colour	Red
title	STATUS 401

- Returned if invalid user credentials, or the user has no permission to use Requirements for JIRA plugin

Status

colour	Red
title	STATUS 403

- Returned if the license is invalid or has expired, incompatible JIRA version, the project is not configured for Requirements for JIRA, or no permission to create coverage view

Status


colour	Red
title	STATUS 404

- Returned if project is not found

...

	#6c809a	title

com.easesolutions.jira.plugins.coverage/1.0/filter/getFilters

Get public and personal coverage filters for project

Expand

title	Click here for details...

...

title

Panel

titleColor

#FFFFFF

titleBGColor

#6c809a

REQUEST

Panel

bgColor	#f6f5f5

GET

com.easesolutions.jira.plugins.coverage/1.0/filter/getFilters

PARAMETERS

parameter	type	description
projectId	Long	project id of filter to get

RESPONSES

Status


colour	Green
title	STATUS 201

- Returned if successful

Code Block

title	Example Response JSON

{
  "publicFilters": [{"id": "1","name": "Filter A"}, {"id": "2","name": "Filter B"}],
  "personalFilters": [{"id": "3","name": "Filter C"}]
}

Status


colour	Red
title	STATUS 400

- Returned if the project is invalid, name is invalid or already exist, columns is invalid or contains invalid values, or an error occurs while creating the coverage view

Status

colour	Red
title	STATUS 401

- Returned if invalid user credentials, or the user has no permission to use Requirements for JIRA plugin

Status

colour	Red
title	STATUS 403

- Returned if the license is invalid or has expired, incompatible JIRA version, the project is not configured for Requirements for JIRA, or no permission to create coverage view

Status


colour	Red
title	STATUS 404

- Returned if project is not found

...

com.easesolutions.jira.plugins.coverage/1.0/export/excel

Export the coverage view to an excel file

Expand

title	Click here for details...

...

title

Panel

titleColor

#FFFFFF

titleBGColor

#6c809a

REQUEST

Panel

bgColor	#f6f5f5

POST

com.easesolutions.jira.plugins.coverage/1.0/export/excel

Code Block

title	Example Request JSON

{
  "columns": [{
      "label": "Level 1",
      "jiraJql": "",
      "jiraFilterId": "",
      "linkTypes": [{
          "id": "-1",
          "directions": {"in": true,"out": true}
      }],
      "currentIssueTypes": ["-1"],
      "projects": ["10000,DEMO,DEMO"],
      "fromLevel": -1,
      "issueSize": 0,
      "coverageCompleteness": 0
  }],
  "fields": [],
  "folderIssueKeys": [],
  "filterId": 0,
  "folderId": 0,
  "folderName": "",
  "projectId": 10000,
  "fromColumn": 0,
  "isFiltered": false
}

RESPONSES

Status


colour	Green
title	STATUS 200

- Returned if excel file creation is successful

Code Block

title	Example Response JSON

EXCEL FILE

Status


colour	Red
title	STATUS 400

- Returned if the project is invalid, name is invalid or already exist, columns is invalid or contains invalid values, or an error occurs while creating the coverage view

Status

colour	Red
title	STATUS 401

- Returned if invalid user credentials, or the user has no permission to use Requirements for JIRA plugin

Status

colour	Red
title	STATUS 403

- Returned if the license is invalid or has expired, incompatible JIRA version, the project is not configured for Requirements for JIRA, or no permission to create coverage view

Status


colour	Red
title	STATUS 500

- Returned if project is not found

...

com.easesolutions.jira.plugins.coverage/1.0/export/xml

Export the coverage view to an xml file

Expand

title	Click here for details...

REQUEST

Panel

bgColor	#f6f5f5

POST

com.easesolutions.jira.plugins.coverage/1.0/export/xml

Code Block

title	Example Request JSON

{
  "columns": [{
      "label": "Level 1",
      "jiraJql": "",
      "jiraFilterId": "",
      "linkTypes": [{
          "id": "-1",
          "directions": {"in": true,"out": true}
      }],
      "currentIssueTypes": ["-1"],
      "projects": ["10000,DEMO,DEMO"],
      "fromLevel": -1
  }],
  "fields": [],
  "folderIssueKeys": [],
  "filterId": 0,
  "folderId": 0,
  "folderName": "",
  "projectId": 10000,
  "fromColumn": 0,
  "isFiltered": false
}

RESPONSES

Status


colour	Green
title	STATUS 201

- Returned if xml file creation is successful

Code Block

title	Example Response JSON

XML FILE

Status


colour	Red
title	STATUS 400

- Returned if the project is invalid, name is invalid or already exist, columns is invalid or contains invalid values, or an error occurs while creating the coverage view

Status

colour	Red
title	STATUS 401

- Returned if invalid user credentials, or the user has no permission to use Requirements for JIRA plugin

Status

colour	Red
title	STATUS 403

- Returned if the license is invalid or has expired, incompatible JIRA version, the project is not configured for Requirements for JIRA, or no permission to create coverage view

Status


colour	Red
title	STATUS 404

- Returned if project is not found

Page Comparison

Versions Compared

Old Version 23

New Version 24

Key

REQUEST

POST

PARAMETERS

RESPONSES

Example Response JSON

com.easesolutions.jira.plugins.coverage/1.0/filter/saveFilter

REQUEST

POST

RESPONSES

com.easesolutions.jira.plugins.coverage/1.0/data

REQUEST

POST

RESPONSES

com.easesolutions.jira.plugins.coverage/1.0/displayFields

REQUEST

POST

RESPONSES

com.easesolutions.jira.plugins.coverage/1.0/filter/renameFilter

REQUEST

POST

RESPONSES

com.easesolutions.jira.plugins.coverage/1.0/filter/updateFilter

REQUEST

POST

RESPONSES

com.easesolutions.jira.plugins.coverage/1.0/filter/deleteFilter

REQUEST

POST

PARAMETERS

RESPONSES

com.easesolutions.jira.plugins.coverage/1.0/filter/getAllFilters

REQUEST

GET

RESPONSES

com.easesolutions.jira.plugins.coverage/1.0/filter/getFilter

REQUEST

GET

PARAMETERS

RESPONSES

com.easesolutions.jira.plugins.coverage/1.0/filter/getFilters

REQUEST

GET

PARAMETERS

RESPONSES

com.easesolutions.jira.plugins.coverage/1.0/export/excel

REQUEST

POST

RESPONSES

com.easesolutions.jira.plugins.coverage/1.0/export/xml

REQUEST

POST

RESPONSES