Versions Compared

Old Version 10

changes.mady.by.user user-0caa0

Saved on

compared with

New Version Current

changes.mady.by.user Diamantino Campos

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

When exporting Cucumber feature files, the Export Cucumber Features backup rules are followed. The input for the export REST method is a String containing Jira issue keys separated by ";".

...


Expand
titleGET /rest/raven/1.0/export/test
Panel
borderColor#ccc
borderStylesolid

Returns the generated feature file(s) for the Tests matched by the input "keys" or/and by the input "filter" and by the input "fz". 

Request

QUERY PARAMETERS

parameter
type
description
keysString

a String containing a list of issue keys separated by ";".When using Xray enterprise, you can specify the test version from which to export the feature file, e.g., CALC-345@v2

filterIntegeran Integer that represents the filter id
fzBooleana Boolean that indicates if the export of single feature files has to be a compressed zip file

keys and filter query parameters are optional if the other one provided but they can both be provided at the same time. fz query parameter is also optional and its default value is false.

Tip
titleExample Request

(With Xray Enterprise) /rest/raven/1.0/export/test?keys=DEMO-66@v2;DEMO-77@cucumber_1 

/rest/raven/1.0/export/test?filter=134

/rest/raven/1.0/export/test?keys=DEMO-6;DEMO-7&filter=134

/rest/raven/1.0/export/test?keys=DEMO-6&fz=true

Responses

200 OK : application/octet-stream : Successful. A file will be downloaded with the generated feature files. If multiple features where generated the result is a compressed zip file. If it is just a single feature file and the query parameter fz is true, then the result is also a compressed file zip. Otherwise a plain text file will be downloaded.

400 BAD_REQUEST : text/plain: No feature files where generated. Please check Jira log.

401 UNAUTHORIZED : text/plain : The Xray license is not valid.

500  INTERNAL SERVER ERROR : text/plain : An internal error occurred when generating the feature file(s).