Swagger V3 Export to Word

This page describes the process of exporting items to Word via Swagger.

Introduction

Since Codebeamer release 2.1 (IMPALA), a new Export endpoint is available in Swagger to export tracker items to Word:

POST/v3/export/exportToWord

Using this endpoint, any tracker items can be exported to Word regardless of what is configured in the Export to Word workflow action.

Usage

To export the items of a tracker to Word,

1. Use the POST/v3/export/exportToWord endpoint in Swagger.
2. Add the relevant details to the Request body.
   Example:
   

   {
     "currentItemAndItsChildren": true,
     "currentItemId": 1234,
     "exportTargetTrackerFolderId": 5679,
     "exportTargetTrackerId": 5678,
     "newVersion": true,
     "reportId": null,
     "wordFilename": "TestFileName",
     "wordTemplateName": "template-items-base.docx"
   }
   

3. Click Execute. The jobId of the export is returned in the response.
   
   
   Clicking Execute triggers the file export by starting a background job which is indicated by a green pop-up notification displayed on the User Interface.
   Once the background job is finished, clicking the name of the exported .docx file on the green pop-up notification, displayed on the bottom right of the screen, opens the target documentation type tracker or the target folder defined in the Request body.
   To download the exported file, click the file name in the Document field.
   
   
4. Use the Background job GET/v3/job/{jobId} endpoint to retrieve and monitor the status of the export based on the jobId.
   
   

Parameters of the Request Body

The following details need to be provided in the Request body. The same parameters must be provided in the Request body as if the export was executed on the user interface.

By default, the "currentItemId", "exportTargetTrackerFolderId", "exportTargetTrackerId" and "reportId" values are set to 0. In case any of these parameters is not relevant, change the related value from 0 to null, otherwise, the API call will not be executed.

Since Codebeamer release 2.1 (IMPALA), the Export to Word workflow action is available as well. For further information, see page Export to Word Workflow Action.