REST API endpoint irregularities

REST API endpoint irregularities

This page catalogs known endpoints that deviate from the norm when using defaults.

/api/dormant-users

1. GET results in HTTP response status code 406: not_acceptable

• Affects version(s): 2021.2

Workaround: specify explicit accept header

headers = {'accept': "application/vnd.blackducksoftware.user-4+json"}
items = bd.get_resource('dormantUsers', headers=headers)

/api/journal/projects/{}/versions/{}

1. Event dict returned is non-standard i.e. has no ['_meta']['links']
2. Retrieving all items using pagination may return duplicates and thus giving incorrect results.

• Affects version(s): 2021.2
• Fixed version: 2021.4

Workaround: specify a sort order

url = f"/api/journal/projects/{projectId}/versions/{versionId}"
params = {'sort': "timestamp ASC"}
events = list(bd.get_items(url, page_size=1000, params=params))