Jama Connect

App · 20 actions

Connect Jama Connect to automate requirements, projects and relationships.

Actions

ActionWhat it does
Create itemCreate an item, such as a requirement, in a project with its item type, location and field values.
Create relationshipLink two items, from a source item to a target item, with a relationship type.
Delete itemDelete an item, such as a requirement or test case, from its project by the item ID.
Delete relationshipDelete a relationship between two items by its ID.
Get itemGet 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 typeGet one item type by its ID, with its name, display plural and the fields its items have.
Get projectGet one project by its ID, with its key, name, description and parent folder.
Get relationshipGet one relationship by its ID, with its source item, target item and relationship type.
Get userGet one Jama Connect user by their ID, with their username, name, email and whether they are active.
List activitiesList recent activity, such as items created, edited or deleted, optionally in one project, with who did it and when.
List item childrenList the items directly under an item in the project tree, by the parent item's ID.
List item commentsList the comments on an item, by its ID, with each comment's text, author and date.
List item typesList the item types set up in Jama Connect, such as requirement or test case, with each type's ID, name and fields.
List itemsList items such as requirements and test cases, optionally filtered by project, item type, text they contain or last modified date.
List projectsList the Jama Connect projects you can see, with each project's ID, key, name and parent folder.
List relationshipsList the relationships between items in a project, with each relationship's ID, source item, target item and relationship type.
List releasesList the releases in a project, with each release's ID, name, description and release date.
List tagsList the tags you can use, optionally in one project, with each tag's ID and name.
List usersList the users in your Jama Connect instance, with each user's ID, username, name, email and whether they are active.
Update itemReplace 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

ProjectprojectnumberRequired
Project for this request.
Item typeitem_typenumberRequired
Item type for this request.
LocationlocationobjectRequired
Location for this request.
FieldsfieldsobjectRequired
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 itemfrom_itemnumberRequired
From item for this request.
To itemto_itemnumberRequired
To item for this request.
Relationship typerelationship_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 iditem_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 idrelationship_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 iditem_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 iditem_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 idproject_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 idrelationship_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 idrecord_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

Projectprojectnumber
Project for this request.
Start atstart_atnumber
Start at for this request.At least 0.
Max resultsmax_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 iditem_idnumberRequired
Item id for this request.
Start atstart_atnumber
Start at for this request.At least 0.
Max resultsmax_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 iditem_idnumberRequired
Item id for this request.
Start atstart_atnumber
Start at for this request.At least 0.
Max resultsmax_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 atstart_atnumber
Start at for this request.At least 0.
Max resultsmax_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

Projectprojectnumber
Project for this request.
Item typeitem_typenumber
Item type for this request.
Containscontainstext
Contains for this request.
Modified datemodified_datedate and time
Modified date for this request.
Start atstart_atnumber
Start at for this request.At least 0.
Max resultsmax_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 atstart_atnumber
Start at for this request.At least 0.
Max resultsmax_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

ProjectprojectnumberRequired
Project for this request.
Start atstart_atnumber
Start at for this request.At least 0.
Max resultsmax_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

ProjectprojectnumberRequired
Project for this request.
Start atstart_atnumber
Start at for this request.At least 0.
Max resultsmax_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

Projectprojectnumber
Project for this request.
Start atstart_atnumber
Start at for this request.At least 0.
Max resultsmax_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 atstart_atnumber
Start at for this request.At least 0.
Max resultsmax_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 iditem_idnumberRequired
Item id for this request.
FieldsfieldsobjectRequired
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
}

On this page