Package: py-jama-rest-client
Jama SoftwareJama 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, visitjamasoftware.com.Please visitdev.jamasoftware.comfor additional resources and join the discussion in our
communitycommunity.jamasoftware.com.py-jama-rest-clientpy-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.RequirementsPython 3.7Pipenv(recommended)SetupCreate a new directory and install py-jama-rest-client using pipenv.mkdirexample_projectcdexample_project
pipenv--python3.7
pipenvinstallpy-jama-rest-clientREST Calls Supported in the ClientAPI informationGETavailable endpointsAbstract ItemsGET abstract items by document key(Deprecated)GETabstract items(second method added to support all parameter options.  Previous method left to preserve backwards
compatibility)GETa specific abstract item by IDGETall versions of an abtract itemGETthe numbered version of an abstract itemGETan abstract item at a specified versionAttachmentsPUTattachment file, uploads content to an attachment object by attachmentIDGETa specific attachment by IDBaselinesGETBaseline  Gets the baseline with the specified IDGETBaselines Gets all baselines for a specified projectGETBaselines versioneditems, Gets all of the versioned items associated with the specified baselineFiltersGETfilter results, gets all results for the specified filter id.ItemsGETall items by projectGETa specific item by IDGETall downstream relationships for an item by item IDGETall downstream related items for an item by item IDGETall upstream relationships for an item by item IDGETall upstream related items for an item by item IDGETall children of an itemGETall synced itemsGETall tags of an itemGETsynced item sync statusGETLocked state of an itemGETall versions of an itemGETthe numbered version of an itemGETall valid workflow transitions that can be made on the item by item IDGETan item at a specified versionDELETEan Item by IDPATCHan ItemPOSTan item to a projectPOSTitem attachmentPOSTitem syncPOSTa tag to an itemPUTan itemPUTitem lockRelationship Rule SetsGETall relationship rule setsGETa specific relationship rule set by IDGETall projects for a specific relationship rule set by IDRelationship TypesGETall relationship typesGETa specific relationship type by IDItem TypesGETall item typesGETa specific item type by IDPick listsGETall pick listsGETa specific pick list by IDGETall pick list options for a specific pick list by pick list IDPick list optionsGETa specific pick list option by pick list option IDProjects:GETall projectsPOSTnew attachment itemTagsGETall tags for a specific projectPOSTa new tag to a specific projectGETall items with tag idTest CyclesGETtest cycle by test cycle idTest PlansPOSTa new test cycle to a test plan by test plan idTest RunsGETall test runs associated with a particular test cycle idPUTtest runs by id. Allows updating of test run fields.UsersGETall active users visable to the current userGETa single user by idGETthe current userPOSTa new userPUTupdate an existing user with user idPUTupdate an existing user's active status with user idRelationshipsPOSTrelationshipGETrelationship by idGETrelationships by project idPUTrelationship by id, from item, and to itemDELETErelationship by idUsage ExamplesClient instantiationTo instantiate a Basic authentication client:frompy_jama_rest_client.clientimportJamaClientbasic_auth_client=JamaClient('https://yourdomain.jamacloud.com',credentials=('username','password'))To instantiate a OAuth authenticated client:frompy_jama_rest_client.clientimportJamaClientoauth_client=JamaClient('https://yourdomain.jamacloud.com',credentials=('clientID','ClientSecret'),oauth=True)LoggingThe Py Jama Rest Client will log API messages to the logger 'py_jama_rest_client' you can get this logger for
setup / customization by callinglogging.getLogger('py_jama_rest_client')Get all projectsDownloadget_all_projets.pyto your example_project directoryEnter 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:pipenvrunpythonget_all_projects.pyAdditional DocumentationDeveloper DocumentationPypi docs