API ID Appears to Change During Review Process

Carmen Santos
Carmen Santos
  • Updated
  • Jama Connect® all versions
    • Cloud/CVC
    • Self-hosted

IMPORTANT: Access to the REST API and the Jama Connect Cloud MCP Server is restricted to users with a Named Creator Jama Connect license, which includes access to v1, Labs, and SCIM endpoints. Users without a Named Creator license—including those with a Creator Float license—do not have access.

Summary

The API ID always points to the latest version of an item. Reviews and baselines, however, reference historical versions captured at a specific point in time. These historical versions are stored in the database with different document IDs, marked as inactive, and are not retrievable using the API ID.

As a result, when querying with the API ID, the system always returns the most up-to-date version of the item. Searching for older IDs associated with previous versions will not return any results. This behavior can lead to confusion when viewing API-IDs within reviews.

Resolution

Understand API ID behavior

The API ID is designed to reference only the current version of an item. It does not provide access to historical versions stored in reviews or baselines. This is expected system behavior and not an error.

Adjust expectations when working with reviews

When working within reviews or baselines, keep in mind that the items displayed represent snapshots in time. These versions are stored separately from the active item and use different internal document IDs.

Hide the API ID field in reviews (optional)

If the API ID field causes confusion in reviews, you can hide it from the review view. This helps prevent misinterpretation, since the API ID does not correspond to the historical version being displayed.

Validate your use case

If you need to reference item versions programmatically or through integrations, review your use case to ensure it aligns with how API IDs function. The API will only return the latest version of an item.

Seek further assistance if needed

If your workflow depends on accessing historical versions via API or you need help adapting your process, consider scheduling a call with our Solutions to review your use case and explore possible options.

Additional Resources

Feedback:
We welcome your input! Please sign in to leave any comments, suggestions, or ideas for improvement below.

Was this article helpful?

0 out of 0 found this helpful

Have more questions? Submit a request

Comments

0 comments

Please sign in to leave a comment.