Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Update response codes for endpoint "export/excel"

...

Panel
titleColor#FFFFFF
titleBGColor#6c809a
titlecom.easesolutions.jira.plugins.coverage/1.0/export/excel

Export the coverage view to an excel file

Expand
titleClick here for details...
REQUEST
Panel
bgColor#f6f5f5
POST

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


Code Block
titleExample 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
colourGreen
titleSTATUS 201200
- Returned if excel file creation is successful

Code Block
titleExample Response JSON
EXCEL FILE

Status
colourRed
titleSTATUS 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
colourRed
titleSTATUS 401
- Returned if invalid user credentials, or the user has no permission to use Requirements for JIRA plugin

Status
colourRed
titleSTATUS 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
colourRed
titleSTATUS 404500
- Returned if project is not found


...