Description

For building automation around the Jazz Platform and esp. DNG we need more public documented APIs.

The public APIs shall cover all functionality and information that the private APIs have.
The public API's uri shall be mentioned in root-services to find the correct uri, when having more then one instance.

For that purpose we need public API functions for (ranked by priority):

1. Module: Read/Modify Module information (Public API does not cover all data, e.g. the asset folder is not available in public api 2.0)

2. Views: Read/Create/Modify Views (incl. Columns, Filters etc.)

3. Changesets: Create/Modifiy/Deliver/Discard...

4. Baselines: Create/Modify/Archive...

5. Links: Read out- and inlinks/Create/Delete

6. Streams: Create/Modify/Archive/Deliver/Accept...

7. ReqIF: Read ReqIF-Mapping-Data (Reading the ReqIF-ID to DNG URI Mapping, to find corresponding DNG Resource by ReqIF ID and vice versa)

8. Locks: Create/Release

9. Project-Areas: Read/Create/Modify

10. Components: Read/Create/Modify/Archive

If already public and documented APIs do exist for some topics, please point us to the documentation url.

Motivation / Reason

Public APIs that are well-documented are a requirement for stable automation on the Jazz Platform. The above APIs are prioritized to cover automation around DOORS Next ReqIF Import / Export among other things, but the APIs can also be used for a variety of other automation functionalities.

Currently, some Jazz Platform functionalities:

• Are not available at all via API

• Are only available via Private API, and not via Public API

• Are available, but are not properly documented

Only Public APIs that are well-documented should ideally be used for automation by non-IBM developers. If these are not available, we face the following challenges:

• If a functionality is not available at all via API:

  • The development of automation is severely limited as some tasks cannot be automated.

• If an API is Private instead of Public:

  • The API's behavior might be changed by IBM without warning as the API is Private. Any tool using the API will likely not work anymore.

• If an API is not well-documented, i.e. it is not clearly defined what the expected behavior of the API is:

  • It is more difficult to use the APIs in development, as we need to find out what the API does by trial and error

  • The API might be changed by IBM without warning because if the behavior was never defined, there is no "guarantee" that the API will behave a certain way. Any tool using the API will likely not work anymore.

ReqIF Ranking

1

Idea History

This idea has been copied from the following RFE:

https://jazz.net/jazz03/web/projects/Requirements%20Management#action=com.ibm.team.workitem.viewWorkItem&id=138012

Creation date of original RFE:

Oct 5, 2020