7.2.1.9. Issue Lists API

The Issue List API has two main entry points:

  • /api/projects/{projectName}/issues_meta/ for querying descriptive

    table meta information and named filters stored for the table. It is not necessary to use this entry point in order to receive issue data.

  • /api/projects/{projectName}/issues/ for querying issue lists

    using flexible filtering and sorting options.

Endpoints

GET

/projects/{projectName}/issues

DEPRECATED Use /api/projects/{projectName}/issues instead

GET

/api/projects/{projectName}/issues

Query tabular issue data

GET

/projects/{projectName}/issues_meta

DEPRECATED Use /api/projects/{projectName}/issues_meta instead

GET

/api/projects/{projectName}/issues_meta

Query Issue Table Metadata
GET /projects/{projectName}/issues

Use /api/projects/{projectName}/issues instead.

Deprecated since 7.2.0

Parameters:

  • projectName – path

    The project name

Status Codes:
GET /api/projects/{projectName}/issues

Query tabular issue data.

Since: 7.2.0

Allows querying issue lists using flexible filtering and sorting options.

In the Python API this functionality is provided by axivion.dashboard.Project.fetch_issues().

Parameters:

  • projectName – path

    The project name

  • kind – query

    IssueKind Shortname for an erosion issue kind

    The issue kind

  • start – query

    The baseline version when filtering for an issue delta. When this is specified with a value other than EMPTY, the result will only consider issues that are found in the given end-version if they are not also found in the given start-version. See also Version Strings.

  • end – query

    The diff end version as gotten by the version’s date property. Defaults to the newest version if omitted. See also Version Strings.

  • version – query

    An alias for end, however this is preferred when omitting start as no diff is being queried.

  • state – query

    Especially relevant when querying an actual diff:

    added

    Show only column-values for issues that did not exist in start but exist in end .

    removed

    Show only column-values for issues that existed in start but do not exist in end any more.

    changed

    Show column-values for added and removed issues.

    When not querying an actual diff all values have added issues.

  • user – query

    Only show values the given user has existing issues for, referenced by the name attribute of the project user. Defaults to ANYBODY, i.e. the result is not filtered by owner at all.

  • filter_{column} – query

    A filter expression applied on {column} where each column is identified by its key attribute. The file filter is treated as a special column referenced by the key any path. See here how to write filter expressions.

  • sort – query

    An SQL-like sorting expression using the column’s key attribute as column identifier. E.g. errorNumber ASC, id desc for issue table.

  • namedFilter – query

    Named filters are stored filter and sorter configurations that store column filters and sorters and the path filter. A special permission is required in order to be able to create and delete named filters.

  • offset – query

    Omit the rows before the given 0 based index. Returns a deterministic result. Useful for paging.

  • limit – query

    Limit the number of returned rows to the given number. Returns a deterministic result. Useful for paging.

  • computeTotalRowCount – query

    Whether to include total row counts in the result. Useful for paging. Be aware that calculating this might involve additional database accesses. See here on how to specify a boolean as a string.

  • columns – query

    A comma-separated list of columns to return. If you do not specify anything here, a default set of columns will be returned which is more or less the same set of columns that is also displayed in the Web-Dashboard.

Status Codes:
GET /projects/{projectName}/issues_meta

Use /api/projects/{projectName}/issues_meta instead.

Since: 6.9.0

Deprecated since 7.2.0

Parameters:

  • projectName – path

    The project name

Status Codes:
GET /api/projects/{projectName}/issues_meta

Query Issue Table Metadata.

Since: 7.2.0

It is not necessary to query this entry point before querying issues via the issues entry point, but it can be of help in reflecting the issue data.

This entry point also serves for querying the so called Named Filters which are persisted filter and sorter configurations that can be used in order to define custom use cases.

In the Python API this functionality is provided by axivion.dashboard.Project.get_issue_table_info().

Parameters:

  • projectName – path

    The project name

  • kind – query

    IssueKind Shortname for an erosion issue kind

    The issue kind

Status Codes:

Types

IssueKind (enum)

Shortname for an erosion issue kind

IssueTable

Result of querying the issue-list retrieval entry point mainly containing a list of issues

TableInfo

Contains meta information for issuelist querying of a specific issue kind

ColumnInfo

Represents a table column

ColumnType (enum)

The type of the column values

ColumnTypeOption

Additional TypeInfo of a ColumnType

TableCellAlignment (enum)

How the column values should be aligned

SortInfo

A Column Key + Sort Direction to indicate table sort preferences

SortDirection (enum)

A sorting direction

IssueTag

An issue tag as returned by the Issue-List API

TableOptions

Table Gadget Options
IssueKind

Shortname for an erosion issue kind.

one of AV, CL, CY, DE, MV, SV

IssueTable

Result of querying the issue-list retrieval entry point mainly containing a list of issues.

Properties:

  • startVersion (AnalysisVersion) The version of the removed issues.

    If the query was not an actual diff query this will be unset.

  • endVersion (AnalysisVersion) The version of the added issues for a diff query or simply the version of a normal issue list query (no startVersion)

  • tableViewUrl (string) Since 7.2.1. Url to view the issues in the Dashboard Browser UI

  • columns (array) Element Type: ColumnInfo. DEPRECATED. The Issue Table Columns describing the issue fields.

    Deprecated since 7.1.0. Use :json:object`TableInfo` instead

  • rows (array) Element Type: object. The actual issue data objects.

    The issue object contents are dynamic and depend on the queried issue kind. See here for the individual field descriptions depending on the issue kind. The values need to be interpreted according to their columntype.

    This only contains a subset of the complete data if paging is enabled via offset and limit.

  • totalRowCount (integer) The total number of issues.

    Only available when computeTotalRowCount was specified as true. Mostly useful when doing paged queries using the query parameters limit and offset.

  • totalAddedCount (integer) The total number of issues existing in the current version and not in the baseline version.

    Only useful in diff queries and only calculated when computeTotalRowCount was specified as true.

  • totalRemovedCount (integer) The total number of issues existing in the baseline version and not in the current version.

    Only useful in diff queries and only calculated when computeTotalRowCount was specified as true.

TableInfo

Contains meta information for issuelist querying of a specific issue kind.

Since: 6.9.0

Properties:

  • tableDataUri (string) Host-relative URL to query the rows of the issue table.

    Needs get parameters to specify which data is requested exactly.

  • issueBaseViewUri (string) Since 7.2.1. Host-relative URL base to view an issue in the dashboard.

    In order to construct the issue URL it is necessary to append the issue-id (e.g. SV123) to the URL path. Also the query-parameter is not part of the URL base and can be added.

  • columns (array) Element Type: ColumnInfo. Columns with detailed information on how to create a table to display the data.

  • filters (array) Element Type: NamedFilterInfo. The Named Filters available for the chosen issue kind.

    This will contain predefined and custom filter configurations and never be empty.

    The list order is a recommendation for UI display.

  • userDefaultFilter (string) The key of the configured default filter.

    This will not be given if the configured default is not also visible to the requesting user.

  • axivionDefaultFilter (string) The key of the factory default filter.

    This will always point to an existing and visible named filter.

ColumnInfo

Represents a table column.

Properties:

  • key (string) Key used to identify the column in the rows and for sorting/filtering.

    For Issue-Table columns, see column.

  • header (string) Nice header name for the column for UI display purposes.

  • canSort (boolean) Specifies whether this column can be sorted.

  • canFilter (boolean) Specifies whether this column can be filtered.

  • alignment (string) Possible values: TableCellAlignment. How the column values should be aligned.

  • type (string) Possible values: ColumnType. The column type.

    Possible values: * string - a unicode string or null * number - either null or "Infinity" or "-Infinity" or "NaN" (string!) or a decimal number with base 10. * state - The fields are strings. Possible values are defined via typeOptions. * boolean - The fields are boolean values, either false or true. Has typeOptions. * path - Since 6.4.1 similar to string or null, however they are normalized (guaranteed single-slash separators) for easy parsing as path * tags - Since 6.5.0 an array of IssueTag * comments - Since 6.9.0 array of IssueComment * owners - Since 7.0.0 array of UserRef

  • typeOptions (array) Element Type: ColumnTypeOption. Describes possible values for the field.

    Currently this is only used for the types state and boolean. In case of type boolean this always contains exactly 2 elements, the first describing the false-equivalent, the second describing the true-equivalent. In case of type state this contains the possible string values the field may have.

  • width (integer) Suggested column width in pixels

  • showByDefault (boolean) whether a gui should show this column by default.

  • linkKey (string) Property under which the rows contain hyperlinks for this column. This is useful when creating a table gadget to have the dashboard render cells of this column as links. The designated property of the rows is optional. If present the value must either be an absolute URL or start with a slash. In the latter case the dashboard will automatically prepend its base path.

  • colorKey (string) To be used only in combination with the custom table visualization. Property under which a row may define a text color for a cell. The property is optional and its values must be strings that represent CSS color values, e.g. red, #ff0000 or even rgb(255, 0, 0).

ColumnType

The type of the column values.

The column type.

Possible values: * string - a unicode string or null * number - either null or "Infinity" or "-Infinity" or "NaN" (string!) or a decimal number with base 10. * state - The fields are strings. Possible values are defined via typeOptions. * boolean - The fields are boolean values, either false or true. Has typeOptions. * path - Since 6.4.1 similar to string or null, however they are normalized (guaranteed single-slash separators) for easy parsing as path * tags - Since 6.5.0 an array of IssueTag * comments - Since 6.9.0 array of IssueComment * owners - Since 7.0.0 array of UserRef

ColumnTypeOption

Additional TypeInfo of a ColumnType.

Properties:

  • key (string) The name of the option that shall be used for displaying and filtering as well.

  • displayName (string) DEPRECATED. Name for displaying the option in UIs.

    Deprecated since 6.9.0. Use key instead. # Older aclipse versions rely on the field being non-null

  • displayColor (string) A color hex code recommended for displaying the value in GUIs.

    Example colors are: “#FF0000” - red “#008000” - green

TableCellAlignment

How the column values should be aligned.

  • left - Align value to the left of its cell

  • right - Align value to the right of its cell

  • center - Center value in its cell

SortInfo

A Column Key + Sort Direction to indicate table sort preferences.

Properties:

  • key (string) The column key

  • direction (string) Possible values: SortDirection. The sort direction associated with this column.

SortDirection

A sorting direction.

  • ASC - smaller values first

  • DESC - greater values first

IssueTag

An issue tag as returned by the Issue-List API.

Properties:

  • tag (string) Use this for displaying the tag

  • color (string) An RGB hex color in the form #RRGGBB directly usable by css.

    The colors are best suited to draw a label on bright background and to contain white letters for labeling.

TableOptions

Table Gadget Options.

Contains options to configure how the dashboard table gadget displays it data.

Properties:

  • subRowsProp (string) If set determines the property that is used to store sub rows in a row object.

  • maxHeight (integer) Maximum height for the table gadget in rows.