A client for the Jama Connect REST API
Project description
Jama Software
Jama Software is the definitive system of record and action for product development. The company’s modern requirements and test management solution helps enterprises accelerate development time, mitigate risk, slash complexity and verify regulatory compliance. More than 600 product-centric organizations, including NASA, Boeing and Caterpillar use Jama to modernize their process for bringing complex products to market. The venture-backed company is headquartered in Portland, Oregon. For more information, visit jamasoftware.com.
Please visit dev.jamasoftware.com for additional resources and join the discussion in our community community.jamasoftware.com.
py-jama-rest-client
py-jama-rest-client by Jama Software is a Python REST API client for Jama Connect™. The client will allow customers to easily access the REST API to retrieve, and modify data within their Jama Instance.
Please note that this client is distributed as-is as an example and will likely require modification to work for your specific use-case.
Requirements
Setup
Create a new directory and install py-jama-rest-client using pipenv.
mkdir example_project
cd example_project
pipenv --python 3.7
pipenv install py-jama-rest-client
REST Calls Supported in the Client
API information
GET
available endpoints
Abstract Items
GET abstract items by document key(Deprecated)GET
abstract items(second method added to support all parameter options. Previous method left to preserve backwards compatibility)
Attachments
PUT
attachment file, uploads content to an attachment object by attachmentIDGET
a specific attachment by ID
Baselines
GET
Baseline Gets the baseline with the specified IDGET
Baselines Gets all baselines for a specified projectGET
Baselines versioneditems, Gets all of the versioned items associated with the specified baseline
Filters
GET
filter results, gets all results for the specified filter id.
Items
GET
all items by projectGET
a specific item by IDGET
all downstream relationships for an item by item IDGET
all downstream related items for an item by item IDGET
all upstream relationships for an item by item IDGET
all children of an itemGET
all synced itemsGET
synced item sync statusGET
Locked state of an itemDELETE
an Item by IDPATCH
an ItemPOST
an item to a projectPOST
item attachmentPOST
item syncPOST
a tag to an itemPUT
an itemPUT
item lock
Relationship Types
GET
all relationship typesGET
a specific relationship type by ID
Item Types
GET
all item typesGET
a specific item type by ID
Pick lists
GET
all pick listsGET
a specific pick list by IDGET
all pick list options for a specific pick list by pick list ID
Pick list options
GET
a specific pick list option by pick list option ID
Projects:
GET
all projectsPOST
new attachment item
Tags
GET
all tags for a specific projectPOST
a new tag to a specific projectGET
all items with tag id
Test Cycles
GET
test cycle by test cycle id
Test Plans
POST
a new test cycle to a test plan by test plan id
Test Runs
GET
all test runs associated with a particular test cycle idPUT
test runs by id. Allows updating of test run fields.
Users
GET
all active users visable to the current userGET
a single user by idGET
the current userPOST
a new userPUT
update an existing user with user idPUT
update an existing user's active status with user id
Relationships
POST
relationshipGET
relationship by idGET
relationships by project idDELETE
relationship by id
Usage Examples
Client instantiation
To instantiate a Basic authentication client:
from py_jama_rest_client.client import JamaClient
basic_auth_client = JamaClient('https://yourdomain.jamacloud.com', credentials=('username', 'password'))
To instantiate a OAuth authenticated client:
from py_jama_rest_client.client import JamaClient
oauth_client = JamaClient('https://yourdomain.jamacloud.com', credentials=('clientID', 'ClientSecret'), oauth=True)
Logging
The Py Jama Rest Client will log API messages to the logger 'py_jama_rest_client' you can get this logger for
setup / customization by calling logging.getLogger('py_jama_rest_client')
Get all projects
- Download get_all_projets.py to your example_project directory
- Enter your Jama URL, username, and password into the corrisponding variables at the top of the file.
- To execute the script execute the following form your example_project directory:
pipenv run python get_all_projects.py
Additional Documentation
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for py-jama-rest-client-1.14.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 77771e596b273be19658acc28857f7d25a354175f947fc0440b99953e71b441c |
|
MD5 | f6041025ee75e5a5c39c354fc21172ec |
|
BLAKE2b-256 | f19ce4d51243fdcba7d8d8d9e9f86fee9e62ccfa858313736a76dfdea30ca3a2 |
Hashes for py_jama_rest_client-1.14.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 92c7c2d98f05aa6bff2943e0eab717541ab535cbe5eb526e6f06a2941eb309db |
|
MD5 | 7e3bea5d60a2c683cb4127b665c79113 |
|
BLAKE2b-256 | 7680d9923355884b9b710da24ad5971fe932e75a0f1b67c66b516183429a37e6 |