Jama Connect
App · 20 actions
Connect Jama Connect to automate requirements, projects and relationships.
Actions
| Action | What it does |
|---|---|
| Create item | Create an item, such as a requirement, in a project with its item type, location and field values. |
| Create relationship | Link two items, from a source item to a target item, with a relationship type. |
| Delete item | Delete an item, such as a requirement or test case, from its project by the item ID. |
| Delete relationship | Delete a relationship between two items by its ID. |
| Get item | Get one item, such as a requirement or test case, by its ID, with its type, location in the project and all its field values. |
| Get item type | Get one item type by its ID, with its name, display plural and the fields its items have. |
| Get project | Get one project by its ID, with its key, name, description and parent folder. |
| Get relationship | Get one relationship by its ID, with its source item, target item and relationship type. |
| Get user | Get one Jama Connect user by their ID, with their username, name, email and whether they are active. |
| List activities | List recent activity, such as items created, edited or deleted, optionally in one project, with who did it and when. |
| List item children | List the items directly under an item in the project tree, by the parent item's ID. |
| List item comments | List the comments on an item, by its ID, with each comment's text, author and date. |
| List item types | List the item types set up in Jama Connect, such as requirement or test case, with each type's ID, name and fields. |
| List items | List items such as requirements and test cases, optionally filtered by project, item type, text they contain or last modified date. |
| List projects | List the Jama Connect projects you can see, with each project's ID, key, name and parent folder. |
| List relationships | List the relationships between items in a project, with each relationship's ID, source item, target item and relationship type. |
| List releases | List the releases in a project, with each release's ID, name, description and release date. |
| List tags | List the tags you can use, optionally in one project, with each tag's ID and name. |
| List users | List the users in your Jama Connect instance, with each user's ID, username, name, email and whether they are active. |
| Update item | Replace the field values of an item by its ID. |
Create item
Create an item, such as a requirement, in a project with its item type, location and field values. Returns the new item's ID.
Inputs
- Project
projectnumberRequired - Project for this request.
- Item type
item_typenumberRequired - Item type for this request.
- Location
locationobjectRequired - Location for this request.
- Fields
fieldsobjectRequired - Fields for this request.
Outputs
dataobject- The service response, including all records and metadata.
has_moretrue/false- Whether another page is available.
next_cursortext- Continuation value for the next page.
Example output
{
"data": {},
"has_more": false,
"next_cursor": null
}Create relationship
Link two items, from a source item to a target item, with a relationship type. Returns the new relationship's ID.
Inputs
- From item
from_itemnumberRequired - From item for this request.
- To item
to_itemnumberRequired - To item for this request.
- Relationship type
relationship_typenumberRequired - Relationship type for this request.
Outputs
dataobject- The service response, including all records and metadata.
has_moretrue/false- Whether another page is available.
next_cursortext- Continuation value for the next page.
Example output
{
"data": {},
"has_more": false,
"next_cursor": null
}Delete item
Delete an item, such as a requirement or test case, from its project by the item ID.
Inputs
- Item id
item_idnumberRequired - Item id for this request.
Outputs
dataobject- The service response, including all records and metadata.
has_moretrue/false- Whether another page is available.
next_cursortext- Continuation value for the next page.
Example output
{
"data": null,
"has_more": false,
"next_cursor": null
}Delete relationship
Delete a relationship between two items by its ID. The items themselves are kept.
Inputs
- Relationship id
relationship_idnumberRequired - Relationship id for this request.
Outputs
dataobject- The service response, including all records and metadata.
has_moretrue/false- Whether another page is available.
next_cursortext- Continuation value for the next page.
Example output
{
"data": null,
"has_more": false,
"next_cursor": null
}Get item
Get one item, such as a requirement or test case, by its ID, with its type, location in the project and all its field values.
Inputs
- Item id
item_idnumberRequired - Item id for this request.At least 1.
Outputs
dataobject- The service response, including all records and metadata.
has_moretrue/false- Whether another page is available.
next_cursortext- Continuation value for the next page.
Example output
{
"data": {},
"has_more": false,
"next_cursor": null
}Get item type
Get one item type by its ID, with its name, display plural and the fields its items have.
Inputs
- Item type id
item_type_idnumberRequired - Item type id for this request.At least 1.
Outputs
dataobject- The service response, including all records and metadata.
has_moretrue/false- Whether another page is available.
next_cursortext- Continuation value for the next page.
Example output
{
"data": {},
"has_more": false,
"next_cursor": null
}Get project
Get one project by its ID, with its key, name, description and parent folder.
Inputs
- Project id
project_idnumberRequired - Project id for this request.At least 1.
Outputs
dataobject- The service response, including all records and metadata.
has_moretrue/false- Whether another page is available.
next_cursortext- Continuation value for the next page.
Example output
{
"data": {},
"has_more": false,
"next_cursor": null
}Get relationship
Get one relationship by its ID, with its source item, target item and relationship type.
Inputs
- Relationship id
relationship_idnumberRequired - Relationship id for this request.At least 1.
Outputs
dataobject- The service response, including all records and metadata.
has_moretrue/false- Whether another page is available.
next_cursortext- Continuation value for the next page.
Example output
{
"data": {},
"has_more": false,
"next_cursor": null
}Get user
Get one Jama Connect user by their ID, with their username, name, email and whether they are active.
Inputs
- Record user id
record_user_idnumberRequired - Record user id for this request.At least 1.
Outputs
dataobject- The service response, including all records and metadata.
has_moretrue/false- Whether another page is available.
next_cursortext- Continuation value for the next page.
Example output
{
"data": {},
"has_more": false,
"next_cursor": null
}List activities
List recent activity, such as items created, edited or deleted, optionally in one project, with who did it and when.
Inputs
- Project
projectnumber - Project for this request.
- Start at
start_atnumber - Start at for this request.At least 0.
- Max results
max_resultsnumber - Max results for this request.From 1 to 50.
Outputs
dataobject- The service response, including all records and metadata.
has_moretrue/false- Whether another page is available.
next_cursortext- Continuation value for the next page.
Example output
{
"data": {},
"has_more": false,
"next_cursor": null
}List item children
List the items directly under an item in the project tree, by the parent item's ID.
Inputs
- Item id
item_idnumberRequired - Item id for this request.
- Start at
start_atnumber - Start at for this request.At least 0.
- Max results
max_resultsnumber - Max results for this request.From 1 to 50.
Outputs
dataobject- The service response, including all records and metadata.
has_moretrue/false- Whether another page is available.
next_cursortext- Continuation value for the next page.
Example output
{
"data": {},
"has_more": false,
"next_cursor": null
}List item comments
List the comments on an item, by its ID, with each comment's text, author and date.
Inputs
- Item id
item_idnumberRequired - Item id for this request.
- Start at
start_atnumber - Start at for this request.At least 0.
- Max results
max_resultsnumber - Max results for this request.From 1 to 50.
Outputs
dataobject- The service response, including all records and metadata.
has_moretrue/false- Whether another page is available.
next_cursortext- Continuation value for the next page.
Example output
{
"data": {},
"has_more": false,
"next_cursor": null
}List item types
List the item types set up in Jama Connect, such as requirement or test case, with each type's ID, name and fields.
Inputs
- Start at
start_atnumber - Start at for this request.At least 0.
- Max results
max_resultsnumber - Max results for this request.From 1 to 50.
Outputs
dataobject- The service response, including all records and metadata.
has_moretrue/false- Whether another page is available.
next_cursortext- Continuation value for the next page.
Example output
{
"data": {},
"has_more": false,
"next_cursor": null
}List items
List items such as requirements and test cases, optionally filtered by project, item type, text they contain or last modified date. Returns each item's ID, type and fields.
Inputs
- Project
projectnumber - Project for this request.
- Item type
item_typenumber - Item type for this request.
- Contains
containstext - Contains for this request.
- Modified date
modified_datedate and time - Modified date for this request.
- Start at
start_atnumber - Start at for this request.At least 0.
- Max results
max_resultsnumber - Max results for this request.From 1 to 50.
Outputs
dataobject- The service response, including all records and metadata.
has_moretrue/false- Whether another page is available.
next_cursortext- Continuation value for the next page.
Example output
{
"data": {},
"has_more": false,
"next_cursor": null
}List projects
List the Jama Connect projects you can see, with each project's ID, key, name and parent folder.
Inputs
- Start at
start_atnumber - Start at for this request.At least 0.
- Max results
max_resultsnumber - Max results for this request.From 1 to 50.
Outputs
dataobject- The service response, including all records and metadata.
has_moretrue/false- Whether another page is available.
next_cursortext- Continuation value for the next page.
Example output
{
"data": {},
"has_more": false,
"next_cursor": null
}List relationships
List the relationships between items in a project, with each relationship's ID, source item, target item and relationship type.
Inputs
- Project
projectnumberRequired - Project for this request.
- Start at
start_atnumber - Start at for this request.At least 0.
- Max results
max_resultsnumber - Max results for this request.From 1 to 50.
Outputs
dataobject- The service response, including all records and metadata.
has_moretrue/false- Whether another page is available.
next_cursortext- Continuation value for the next page.
Example output
{
"data": {},
"has_more": false,
"next_cursor": null
}List releases
List the releases in a project, with each release's ID, name, description and release date.
Inputs
- Project
projectnumberRequired - Project for this request.
- Start at
start_atnumber - Start at for this request.At least 0.
- Max results
max_resultsnumber - Max results for this request.From 1 to 50.
Outputs
dataobject- The service response, including all records and metadata.
has_moretrue/false- Whether another page is available.
next_cursortext- Continuation value for the next page.
Example output
{
"data": {},
"has_more": false,
"next_cursor": null
}List tags
List the tags you can use, optionally in one project, with each tag's ID and name.
Inputs
- Project
projectnumber - Project for this request.
- Start at
start_atnumber - Start at for this request.At least 0.
- Max results
max_resultsnumber - Max results for this request.From 1 to 50.
Outputs
dataobject- The service response, including all records and metadata.
has_moretrue/false- Whether another page is available.
next_cursortext- Continuation value for the next page.
Example output
{
"data": {},
"has_more": false,
"next_cursor": null
}List users
List the users in your Jama Connect instance, with each user's ID, username, name, email and whether they are active.
Inputs
- Start at
start_atnumber - Start at for this request.At least 0.
- Max results
max_resultsnumber - Max results for this request.From 1 to 50.
Outputs
dataobject- The service response, including all records and metadata.
has_moretrue/false- Whether another page is available.
next_cursortext- Continuation value for the next page.
Example output
{
"data": {},
"has_more": false,
"next_cursor": null
}Update item
Replace the field values of an item by its ID. Fields you leave out keep their current values.
Inputs
- Item id
item_idnumberRequired - Item id for this request.
- Fields
fieldsobjectRequired - Fields for this request.
Outputs
dataobject- The service response, including all records and metadata.
has_moretrue/false- Whether another page is available.
next_cursortext- Continuation value for the next page.
Example output
{
"data": {},
"has_more": false,
"next_cursor": null
}