Versions Compared

Key

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

...

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

...


Expand
titleGET /api/v1/export/cucumber
Panel
borderColor#ccc
borderStylesolid

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

Request

QUERY PARAMETERS

parameter
type
description
keysString

a String containing a list of issue keys separated by ";"

filterIntegeran Integer that represents the filter id

keys and filter query parameters are optional if the other one provided but they can both be provided at the same time.


Tip
titleExample Request

curl -H "Content-Type: application/json" -X GET -H "Authorization: Bearer $token"  "https://xray.cloud.xpand-it.com/api/v1/export/cucumber?keys=DEMO-6;DEMO-7"


curl -H "Content-Type: application/json" -X GET -H "Authorization: Bearer $token"  "https://xray.cloud.xpand-it.com/api/v1/export/cucumber?filter=134"


curl -H "Content-Type: application/json" -X GET -H "Authorization: Bearer $token"  "https://xray.cloud.xpand-it.com/api/v1/export/cucumber?keys=DEMO-6;DEMO-7&filter=134"

Responses

200 OK : application/octet-stream : Successful. A compressed zip file will be downloaded containing the generated feature files.

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).