Querying Issue Lists via CSV¶
Since issues are treated as tabular data by the Issue Lists API API entry point,
issue query results can also be retrieved in CSV format. The CSV cells
will be quoted using double quotes ("). The column separator is the
CSV separator preference of the authenticated user
(see CSV Download). By default, columns
are separated using semicolons (;) if the preferred language in the
Accept-Language header of the request is de, and commas (,)
otherwise.
The CSV retrieval functionality is also used when
exporting CSVs from the
web interface by clicking Download CSV
in the
Table Menu.
To automate this, you do not necessarily need a programming language
to use the Dashboard JSON API; you can also achieve the result using a command-line tool like wget
or curl:
Authenticate via an ApiToken sent in the Authorization: AxToken header,
and send along the X-Axivion-User-Agent: ApiClient client identification
(see Authentication and General Hints).
Warning
The examples below reference the token via $DASHBOARD_API_TOKEN, but the
shell expands it before running the command, so the token still appears in
the process list (ps auwx), readable by any user on the machine. To avoid
this, read the token from a file instead (e.g. curl’s --header
@headerfile or a .netrc entry).
wget example:
wget -O download.csv --header "Authorization: AxToken $DASHBOARD_API_TOKEN" --header "X-Axivion-User-Agent: ApiClient" --header "Accept: text/csv" "http://localhost:9090/axivion/projects/<projectname>/issues/?kind=SV"
curl example:
curl --header "Authorization: AxToken $DASHBOARD_API_TOKEN" --header "X-Axivion-User-Agent: ApiClient" "http://localhost:9090/axivion/projects/<projectname>/issues/?kind=SV&format=csv"