Endpoints

Endpoint abstractitems

The abstractitems endpoint has the following operations:

1. GET /abstractitems
2. GET /abstractitems/{id}
3. GET /abstractitems/{id}/versions/{versionNum}
4. GET /abstractitems/{id}/versions/{versionNum}/versioneditem
5. GET /abstractitems/{id}/versionedrelationships
6. GET /abstractitems/{id}/versions

Below is more detail for each of the operations of the abstractitems endpoint.

GET /abstractitems

Summary: Search for items, test plans, test cycles, test runs, or attachments

Consumes: this API call consumes the following media types via the Content-Type request header:

• application/json

Request headers:

• xJamaDateFieldsWithTime (optional)
  

Query parameters:

• project (optional)
  
• itemType (optional)
  
• documentKey (optional)
  
• release (optional)
  
• createdDate (optional)
  Filter datetime fields after a single date or within a range of values. Provide one or two values in ISO8601 format (milliseconds or seconds) - \"yyyy-MM-dd'T'HH:mm:ss.SSSZ\" or \"yyyy-MM-dd'T'HH:mm:ssZ\"
• modifiedDate (optional)
  Filter datetime fields after a single date or within a range of values. Provide one or two values in ISO8601 format (milliseconds or seconds) - \"yyyy-MM-dd'T'HH:mm:ss.SSSZ\" or \"yyyy-MM-dd'T'HH:mm:ssZ\"
• lastActivityDate (optional)
  Filter datetime fields after a single date or within a range of values. Provide one or two values in ISO8601 format (milliseconds or seconds) - \"yyyy-MM-dd'T'HH:mm:ss.SSSZ\" or \"yyyy-MM-dd'T'HH:mm:ssZ\"
• contains (optional)
  Filter on the text contents of the item. Strings taken literally. Multiple 'contains' values will be bitwise ORed.
• sortBy (optional)
  Sort orders can be added with the name of the field by which to sort, followed by .asc or .desc (e.g. 'name.asc' or 'modifiedDate.desc'). If not set, this defaults to sorting by sequence.asc and then documentKey.asc
• startAt (optional)
  
• maxResults (optional)
  If not set, this defaults to 20. This cannot be larger than 50
• include (optional)
  Links to include as full objects in the linked map

Examples:

• Example data, content-type: application/json
  
  { "data" : [ { "itemType" : 1, "globalId" : "globalId", "project" : 6, "resources" : { "key" : { "allowed" : [ "allowed", "allowed" ] } }, "childItemType" : 5, "createdDate" : "2000-01-23T04:56:07.000+00:00", "lastActivityDate" : "2000-01-23T04:56:07.000+00:00", "createdBy" : 5, "documentKey" : "documentKey", "modifiedDate" : "2000-01-23T04:56:07.000+00:00", "lock" : { "lockedBy" : 7, "lastLockedDate" : "2000-01-23T04:56:07.000+00:00", "locked" : true }, "modifiedBy" : 2, "location" : { "sequence" : "sequence", "parent" : { "item" : 4, "project" : 2 }, "sortOrder" : 9, "globalSortOrder" : 3 }, "id" : 0, "fields" : { "key" : "{}" }, "baselinedAppliedCategorySnapshots" : [ { "categoryPathSequence" : "categoryPathSequence", "itemVersionNumberApplied" : 2 }, { "categoryPathSequence" : "categoryPathSequence", "itemVersionNumberApplied" : 2 } ] }, { "itemType" : 1, "globalId" : "globalId", "project" : 6, "resources" : { "key" : { "allowed" : [ "allowed", "allowed" ] } }, "childItemType" : 5, "createdDate" : "2000-01-23T04:56:07.000+00:00", "lastActivityDate" : "2000-01-23T04:56:07.000+00:00", "createdBy" : 5, "documentKey" : "documentKey", "modifiedDate" : "2000-01-23T04:56:07.000+00:00", "lock" : { "lockedBy" : 7, "lastLockedDate" : "2000-01-23T04:56:07.000+00:00", "locked" : true }, "modifiedBy" : 2, "location" : { "sequence" : "sequence", "parent" : { "item" : 4, "project" : 2 }, "sortOrder" : 9, "globalSortOrder" : 3 }, "id" : 0, "fields" : { "key" : "{}" }, "baselinedAppliedCategorySnapshots" : [ { "categoryPathSequence" : "categoryPathSequence", "itemVersionNumberApplied" : 2 }, { "categoryPathSequence" : "categoryPathSequence", "itemVersionNumberApplied" : 2 } ] } ], "meta" : { "pageInfo" : { "startIndex" : 5, "resultCount" : 5, "totalResults" : 2 }, "status" : "OK", "timestamp" : "2000-01-23T04:56:07.000+00:00" }, "links" : { "key" : { "href" : "href", "type" : "type" } }, "linked" : { "key" : { "key" : "{}" } } }

Produces: API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header:

• application/json

Response: ItemDataListWrapper

GET /abstractitems/{id}

Summary: Get any item, test plan, test cycle, test run, or attachment with the specified ID

Path parameters:

• id (required)
  

Consumes: this API call consumes the following media types via the Content-Type request header:

• application/json

Request headers:

• xJamaDateFieldsWithTime (optional)
  

Query parameters:

• include (optional)
  Links to include as full objects in the linked map

Examples:

• Example data, content-type: application/json
  
  { "data" : { "itemType" : 1, "globalId" : "globalId", "project" : 6, "resources" : { "key" : { "allowed" : [ "allowed", "allowed" ] } }, "createdDate" : "2000-01-23T04:56:07.000+00:00", "lastActivityDate" : "2000-01-23T04:56:07.000+00:00", "createdBy" : 5, "documentKey" : "documentKey", "modifiedDate" : "2000-01-23T04:56:07.000+00:00", "modifiedBy" : 5, "id" : 0, "fields" : { "key" : "{}" }, "baselinedAppliedCategorySnapshots" : [ { "categoryPathSequence" : "categoryPathSequence", "itemVersionNumberApplied" : 2 }, { "categoryPathSequence" : "categoryPathSequence", "itemVersionNumberApplied" : 2 } ] }, "meta" : { "status" : "OK", "timestamp" : "2000-01-23T04:56:07.000+00:00" }, "links" : { "key" : { "href" : "href", "type" : "type" } }, "linked" : { "key" : { "key" : "{}" } } }

Produces: API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header:

• application/json

Response: AbstractItemDataWrapper

GET /abstractitems/{id}/versions/{versionNum}

Summary: Get the numbered version for the item with the specified ID

Path parameters:

• versionNum (required)
  
• id (required)
  

Consumes: this API call consumes the following media types via the Content-Type request header:

• application/json

Request headers:

• xJamaDateFieldsWithTime (optional)
  

Query parameters:

• include (optional)
  Links to include as full objects in the linked map

Examples:

• Example data, content-type: application/json
  
  { "data" : { "item" : 6, "createdDate" : "2000-01-23T04:56:07.000+00:00", "versionedItem" : [ 0, 0 ], "createdBy" : 5, "comment" : "comment", "type" : "type", "userName" : "userName", "versionNumber" : 1, "changeDetails" : "changeDetails" }, "meta" : { "status" : "OK", "timestamp" : "2000-01-23T04:56:07.000+00:00" }, "links" : { "key" : { "href" : "href", "type" : "type" } }, "linked" : { "key" : { "key" : "{}" } } }

Produces: API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header:

• application/json

Response: VersionDataWrapper

GET /abstractitems/{id}/versions/{versionNum}/versioneditem

Summary: Get the snapshot of the item at the specified version

Path parameters:

• versionNum (required)
  
• id (required)
  

Consumes: this API call consumes the following media types via the Content-Type request header:

• application/json

Request headers:

• xJamaDateFieldsWithTime (optional)
  

Query parameters:

• include (optional)
  Links to include as full objects in the linked map

Examples:

• Example data, content-type: application/json
  
  { "data" : { "id" : 6, "type" : "type", "version" : 0, "currentVersion" : 1 }, "meta" : { "status" : "OK", "timestamp" : "2000-01-23T04:56:07.000+00:00" }, "links" : { "key" : { "href" : "href", "type" : "type" } }, "linked" : { "key" : { "key" : "{}" } } }

Produces: API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header:

• application/json

Response: AbstractVersionedItemDataWrapper

GET /abstractitems/{id}/versionedrelationships

Summary: Get all versioned relationships that were associated to the item at the specified time

Path parameters:

• id (required)
  

Consumes: this API call consumes the following media types via the Content-Type request header:

• application/json

Query parameters:

• timestamp (required)
  Get relationships for the specified item at this date and time. Requires ISO8601 formatting (milliseconds or seconds) - \"yyyy-MM-dd'T'HH:mm:ss.SSSZ\" or \"yyyy-MM-dd'T'HH:mm:ssZ\"
• startAt (optional)
  
• maxResults (optional)
  If not set, this defaults to 20. This cannot be larger than 50
• include (optional)
  Links to include as full objects in the linked map

Examples:

• Example data, content-type: application/json
  
  { "data" : [ { "relationshipType" : [ "{}", "{}" ], "fromItem" : [ 6, 6 ], "id" : 0, "suspect" : true, "toItem" : [ 1, 1 ] }, { "relationshipType" : [ "{}", "{}" ], "fromItem" : [ 6, 6 ], "id" : 0, "suspect" : true, "toItem" : [ 1, 1 ] } ], "meta" : { "pageInfo" : { "startIndex" : 5, "resultCount" : 5, "totalResults" : 2 }, "status" : "OK", "timestamp" : "2000-01-23T04:56:07.000+00:00" }, "links" : { "key" : { "href" : "href", "type" : "type" } }, "linked" : { "key" : { "key" : "{}" } } }

Produces: API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header:

• application/json

Response: VersionedRelationshipDataListWrapper

GET /abstractitems/{id}/versions

Summary: Get all versions for the item with the specified ID

Path parameters:

• id (required)
  

Consumes: this API call consumes the following media types via the Content-Type request header:

• application/json

Request headers:

• xJamaDateFieldsWithTime (optional)
  

Query parameters:

• startAt (optional)
  
• maxResults (optional)
  If not set, this defaults to 20. This cannot be larger than 50
• include (optional)
  Links to include as full objects in the linked map

Examples:

• Example data, content-type: application/json
  
  { "data" : [ { "item" : 6, "createdDate" : "2000-01-23T04:56:07.000+00:00", "versionedItem" : [ 0, 0 ], "createdBy" : 5, "comment" : "comment", "type" : "type", "userName" : "userName", "versionNumber" : 1, "changeDetails" : "changeDetails" }, { "item" : 6, "createdDate" : "2000-01-23T04:56:07.000+00:00", "versionedItem" : [ 0, 0 ], "createdBy" : 5, "comment" : "comment", "type" : "type", "userName" : "userName", "versionNumber" : 1, "changeDetails" : "changeDetails" } ], "meta" : { "pageInfo" : { "startIndex" : 5, "resultCount" : 5, "totalResults" : 2 }, "status" : "OK", "timestamp" : "2000-01-23T04:56:07.000+00:00" }, "links" : { "key" : { "href" : "href", "type" : "type" } }, "linked" : { "key" : { "key" : "{}" } } }

Produces: API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header:

• application/json

Response: VersionDataListWrapper

Endpoint activities

The activities endpoint has the following operations:

1. GET /activities
2. GET /activities/{activityId}
3. GET /activities/adminActivity
4. GET /activities/{activityId}/affecteditems
5. POST /activities/{activityId}/restore

Below is more detail for each of the operations of the activities endpoint.

GET /activities

Summary: Get all activities in the project with the specified ID

Consumes: this API call consumes the following media types via the Content-Type request header:

• application/json

Request headers:

• xJamaDateFieldsWithTime (optional)
  

Query parameters:

• project (required)
  
• eventType (optional)
  Event type to filter on. More than one event type can be chosen
• objectType (optional)
  Object type to filter on. More than one object type can be chosen
• itemType (optional)
  ID of item type to filter on. More than one item type can be chosen
• date (optional)
  Filter datetime fields after a single date or within a range of values. Provide one or two values in ISO8601 format (milliseconds or seconds) - \"yyyy-MM-dd'T'HH:mm:ss.SSSZ\" or \"yyyy-MM-dd'T'HH:mm:ssZ\"
• deleteEvents (optional)
  Get item delete events only
• startAt (optional)
  
• maxResults (optional)
  If not set, this defaults to 20. This cannot be larger than 50
• include (optional)
  Links to include as full objects in the linked map

Examples:

• Example data, content-type: application/json
  
  { "data" : [ { "date" : "2000-01-23T04:56:07.000+00:00", "item" : 1, "itemType" : 5, "userComment" : "userComment", "action" : "action", "details" : "details", "id" : 0, "eventType" : "CREATE", "userName" : "userName", "user" : 6, "objectType" : "PROJECT" }, { "date" : "2000-01-23T04:56:07.000+00:00", "item" : 1, "itemType" : 5, "userComment" : "userComment", "action" : "action", "details" : "details", "id" : 0, "eventType" : "CREATE", "userName" : "userName", "user" : 6, "objectType" : "PROJECT" } ], "meta" : { "pageInfo" : { "startIndex" : 5, "resultCount" : 5, "totalResults" : 2 }, "status" : "OK", "timestamp" : "2000-01-23T04:56:07.000+00:00" }, "links" : { "key" : { "href" : "href", "type" : "type" } }, "linked" : { "key" : { "key" : "{}" } } }

Produces: API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header:

• application/json

Response: ActivityDataListWrapper

GET /activities/{activityId}

Summary: Get the activity with the specified ID

Path parameters:

• activityId (required)
  

Consumes: this API call consumes the following media types via the Content-Type request header:

• application/json

Request headers:

• xJamaDateFieldsWithTime (optional)
  

Query parameters:

• include (optional)
  Links to include as full objects in the linked map

Examples:

• Example data, content-type: application/json
  
  { "data" : { "date" : "2000-01-23T04:56:07.000+00:00", "item" : 1, "itemType" : 5, "userComment" : "userComment", "action" : "action", "details" : "details", "id" : 0, "eventType" : "CREATE", "userName" : "userName", "user" : 6, "objectType" : "PROJECT" }, "meta" : { "status" : "OK", "timestamp" : "2000-01-23T04:56:07.000+00:00" }, "links" : { "key" : { "href" : "href", "type" : "type" } }, "linked" : { "key" : { "key" : "{}" } } }

Produces: API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header:

• application/json

Response: ActivityDataWrapper

GET /activities/adminActivity

Summary: Get all activities at the admin level

Consumes: this API call consumes the following media types via the Content-Type request header:

• application/json

Request headers:

• xJamaDateFieldsWithTime (optional)
  

Query parameters:

• startAt (optional)
  
• maxResults (optional)
  If not set, this defaults to 20. This cannot be larger than 50
• filterTerm (optional)
  Filter on the text contents of the activities. Strings in quotations taken literally. Multiple values will be treated as separate tokens for matching.
• projectId (optional)
  Filter by Project ID. User must be at least Project Administrator

Examples:

• Example data, content-type: application/json
  
  { "headers" : { "key" : [ "headers", "headers" ] }, "pageInfo" : { "startIndex" : 5, "resultCount" : 5, "totalResults" : 2 }, "statusReasonPhrase" : "statusReasonPhrase", "status" : 0 }

Produces: API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header:

• application/json

Response: AbstractRestResponse

GET /activities/{activityId}/affecteditems

Summary: Get all items affected by the activity with the specified ID

Path parameters:

• activityId (required)
  

Consumes: this API call consumes the following media types via the Content-Type request header:

• application/json

Request headers:

• xJamaDateFieldsWithTime (optional)
  

Query parameters:

• startAt (optional)
  
• maxResults (optional)
  If not set, this defaults to 20. This cannot be larger than 50
• include (optional)
  Links to include as full objects in the linked map

Examples:

• Example data, content-type: application/json
  
  { "data" : [ { "itemType" : 1, "globalId" : "globalId", "project" : 6, "resources" : { "key" : { "allowed" : [ "allowed", "allowed" ] } }, "childItemType" : 5, "createdDate" : "2000-01-23T04:56:07.000+00:00", "lastActivityDate" : "2000-01-23T04:56:07.000+00:00", "createdBy" : 5, "documentKey" : "documentKey", "modifiedDate" : "2000-01-23T04:56:07.000+00:00", "lock" : { "lockedBy" : 7, "lastLockedDate" : "2000-01-23T04:56:07.000+00:00", "locked" : true }, "modifiedBy" : 2, "location" : { "sequence" : "sequence", "parent" : { "item" : 4, "project" : 2 }, "sortOrder" : 9, "globalSortOrder" : 3 }, "id" : 0, "fields" : { "key" : "{}" }, "baselinedAppliedCategorySnapshots" : [ { "categoryPathSequence" : "categoryPathSequence", "itemVersionNumberApplied" : 2 }, { "categoryPathSequence" : "categoryPathSequence", "itemVersionNumberApplied" : 2 } ] }, { "itemType" : 1, "globalId" : "globalId", "project" : 6, "resources" : { "key" : { "allowed" : [ "allowed", "allowed" ] } }, "childItemType" : 5, "createdDate" : "2000-01-23T04:56:07.000+00:00", "lastActivityDate" : "2000-01-23T04:56:07.000+00:00", "createdBy" : 5, "documentKey" : "documentKey", "modifiedDate" : "2000-01-23T04:56:07.000+00:00", "lock" : { "lockedBy" : 7, "lastLockedDate" : "2000-01-23T04:56:07.000+00:00", "locked" : true }, "modifiedBy" : 2, "location" : { "sequence" : "sequence", "parent" : { "item" : 4, "project" : 2 }, "sortOrder" : 9, "globalSortOrder" : 3 }, "id" : 0, "fields" : { "key" : "{}" }, "baselinedAppliedCategorySnapshots" : [ { "categoryPathSequence" : "categoryPathSequence", "itemVersionNumberApplied" : 2 }, { "categoryPathSequence" : "categoryPathSequence", "itemVersionNumberApplied" : 2 } ] } ], "meta" : { "pageInfo" : { "startIndex" : 5, "resultCount" : 5, "totalResults" : 2 }, "status" : "OK", "timestamp" : "2000-01-23T04:56:07.000+00:00" }, "links" : { "key" : { "href" : "href", "type" : "type" } }, "linked" : { "key" : { "key" : "{}" } } }

Produces: API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header:

• application/json

Response: ItemDataListWrapper

POST /activities/{activityId}/restore

Summary: Restore item(s) associated with a delete activity.

Path parameters:

• activityId (required)
  

Consumes: this API call consumes the following media types via the Content-Type request header:

• application/json

Examples:

• Example data, content-type: application/json
  
  { "headers" : { "key" : [ "headers", "headers" ] }, "pageInfo" : { "startIndex" : 5, "resultCount" : 5, "totalResults" : 2 }, "statusReasonPhrase" : "statusReasonPhrase", "status" : 0 }

Produces: API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header:

• application/json

Response: AbstractRestResponse

Endpoint attachments

The attachments endpoint has the following operations:

1. GET /attachments/{attachmentId}/file
2. GET /attachments/{attachmentId}
3. GET /attachments/{attachmentId}/comments
4. GET /attachments/{attachmentId}/lock
5. GET /attachments/{attachmentId}/versions/{versionNum}
6. GET /attachments/{attachmentId}/versions/{versionNum}/versioneditem
7. GET /attachments/{attachmentId}/versions
8. PUT /attachments/{attachmentId}/lock
9. PUT /attachments/{attachmentId}/file

Below is more detail for each of the operations of the attachments endpoint.

GET /attachments/{attachmentId}/file

Summary: Download attachment file from the attachment with the specified ID

Path parameters:

• attachmentId (required)
  

Consumes: this API call consumes the following media types via the Content-Type request header:

• application/json

Request headers:

• xJamaDateFieldsWithTime (optional)
  

Produces: API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header:

• application/octet-stream

Response:

GET /attachments/{attachmentId}

Summary: Get the attachment with the specified ID

Path parameters:

• attachmentId (required)
  

Consumes: this API call consumes the following media types via the Content-Type request header:

• application/json

Request headers:

• xJamaDateFieldsWithTime (optional)
  

Query parameters:

• include (optional)
  Links to include as full objects in the linked map

Examples:

• Example data, content-type: application/json
  
  { "data" : { "fileName" : "fileName", "itemType" : 5, "globalId" : "globalId", "project" : 1, "resources" : { "key" : { "allowed" : [ "allowed", "allowed" ] } }, "mimeType" : "mimeType", "createdDate" : "2000-01-23T04:56:07.000+00:00", "fileSize" : 0, "lastActivityDate" : "2000-01-23T04:56:07.000+00:00", "createdBy" : 5, "documentKey" : "documentKey", "modifiedDate" : "2000-01-23T04:56:07.000+00:00", "lock" : { "lockedBy" : 7, "lastLockedDate" : "2000-01-23T04:56:07.000+00:00", "locked" : true }, "modifiedBy" : 2, "id" : 6, "fields" : { "key" : "{}" }, "baselinedAppliedCategorySnapshots" : [ { "categoryPathSequence" : "categoryPathSequence", "itemVersionNumberApplied" : 2 }, { "categoryPathSequence" : "categoryPathSequence", "itemVersionNumberApplied" : 2 } ] }, "meta" : { "status" : "OK", "timestamp" : "2000-01-23T04:56:07.000+00:00" }, "links" : { "key" : { "href" : "href", "type" : "type" } }, "linked" : { "key" : { "key" : "{}" } } }

Produces: API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header:

• application/json

Response: AttachmentDataWrapper

GET /attachments/{attachmentId}/comments

Summary: Get all comments for the item with the specified ID

Path parameters:

• attachmentId (required)
  

Consumes: this API call consumes the following media types via the Content-Type request header:

• application/json

Request headers:

• xJamaDateFieldsWithTime (optional)
  

Query parameters:

• startAt (optional)
  
• maxResults (optional)
  If not set, this defaults to 20. This cannot be larger than 50
• rootCommentsOnly (optional)
  , default value: false
• include (optional)
  Links to include as full objects in the linked map

Examples:

• Example data, content-type: application/json
  
  { "data" : [ { "createdDate" : "2000-01-23T04:56:07.000+00:00", "deleted" : true, "createdBy" : 1, "inReplyTo" : 6, "commentType" : "GENERAL", "modifiedBy" : 5, "location" : { "item" : 5, "project" : 2 }, "id" : 0, "body" : { "text" : "text" }, "status" : "OPEN" }, { "createdDate" : "2000-01-23T04:56:07.000+00:00", "deleted" : true, "createdBy" : 1, "inReplyTo" : 6, "commentType" : "GENERAL", "modifiedBy" : 5, "location" : { "item" : 5, "project" : 2 }, "id" : 0, "body" : { "text" : "text" }, "status" : "OPEN" } ], "meta" : { "pageInfo" : { "startIndex" : 5, "resultCount" : 5, "totalResults" : 2 }, "status" : "OK", "timestamp" : "2000-01-23T04:56:07.000+00:00" }, "links" : { "key" : { "href" : "href", "type" : "type" } }, "linked" : { "key" : { "key" : "{}" } } }

Produces: API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header:

• application/json

Response: CommentDataListWrapper

GET /attachments/{attachmentId}/lock

Summary: Get the locked state, last locked date, and last locked by user for the item with the specified ID

Path parameters:

• attachmentId (required)
  

Consumes: this API call consumes the following media types via the Content-Type request header:

• application/json

Request headers:

• xJamaDateFieldsWithTime (optional)
  

Query parameters:

• include (optional)
  Links to include as full objects in the linked map

Examples:

• Example data, content-type: application/json
  
  { "data" : { "lockedBy" : 7, "lastLockedDate" : "2000-01-23T04:56:07.000+00:00", "locked" : true }, "meta" : { "status" : "OK", "timestamp" : "2000-01-23T04:56:07.000+00:00" }, "links" : { "key" : { "href" : "href", "type" : "type" } }, "linked" : { "key" : { "key" : "{}" } } }

Produces: API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header:

• application/json

Response: LockDataWrapper

GET /attachments/{attachmentId}/versions/{versionNum}

Summary: Get the numbered version for the item with the specified ID

Path parameters:

• versionNum (required)
  
• attachmentId (required)
  

Consumes: this API call consumes the following media types via the Content-Type request header:

• application/json

Request headers:

• xJamaDateFieldsWithTime (optional)
  

Query parameters:

• include (optional)
  Links to include as full objects in the linked map

Examples:

• Example data, content-type: application/json
  
  { "data" : { "item" : 6, "createdDate" : "2000-01-23T04:56:07.000+00:00", "versionedItem" : [ 0, 0 ], "createdBy" : 5, "comment" : "comment", "type" : "type", "userName" : "userName", "versionNumber" : 1, "changeDetails" : "changeDetails" }, "meta" : { "status" : "OK", "timestamp" : "2000-01-23T04:56:07.000+00:00" }, "links" : { "key" : { "href" : "href", "type" : "type" } }, "linked" : { "key" : { "key" : "{}" } } }

Produces: API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header:

• application/json

Response: VersionDataWrapper

GET /attachments/{attachmentId}/versions/{versionNum}/versioneditem

Summary: Get the snapshot of the attachment at the specified version

Path parameters:

• versionNum (required)
  
• attachmentId (required)
  

Consumes: this API call consumes the following media types via the Content-Type request header:

• application/json

Request headers:

• xJamaDateFieldsWithTime (optional)
  

Query parameters:

• include (optional)
  Links to include as full objects in the linked map

Examples:

• Example data, content-type: application/json
  
  { "data" : { "fileName" : "fileName", "itemType" : 2, "globalId" : "globalId", "project" : 5, "resources" : { "key" : { "allowed" : [ "allowed", "allowed" ] } }, "mimeType" : "mimeType", "version" : 6, "currentVersion" : 1, "createdDate" : "2000-01-23T04:56:07.000+00:00", "fileSize" : 0, "lastActivityDate" : "2000-01-23T04:56:07.000+00:00", "createdBy" : 7, "documentKey" : "documentKey", "modifiedDate" : "2000-01-23T04:56:07.000+00:00", "lock" : { "lockedBy" : 7, "lastLockedDate" : "2000-01-23T04:56:07.000+00:00", "locked" : true }, "modifiedBy" : 9, "id" : 5, "fields" : { "key" : "{}" }, "baselinedAppliedCategorySnapshots" : [ { "categoryPathSequence" : "categoryPathSequence", "itemVersionNumberApplied" : 2 }, { "categoryPathSequence" : "categoryPathSequence", "itemVersionNumberApplied" : 2 } ] }, "meta" : { "status" : "OK", "timestamp" : "2000-01-23T04:56:07.000+00:00" }, "links" : { "key" : { "href" : "href", "type" : "type" } }, "linked" : { "key" : { "key" : "{}" } } }

Produces: API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header:

• application/json

Response: VersionedAttachmentDataWrapper

GET /attachments/{attachmentId}/versions

Summary: Get all versions for the item with the specified ID

Path parameters:

• attachmentId (required)
  

Consumes: this API call consumes the following media types via the Content-Type request header:

• application/json

Request headers:

• xJamaDateFieldsWithTime (optional)
  

Query parameters:

• startAt (optional)
  
• maxResults (optional)
  If not set, this defaults to 20. This cannot be larger than 50
• include (optional)
  Links to include as full objects in the linked map

Examples:

• Example data, content-type: application/json
  
  { "data" : [ { "item" : 6, "createdDate" : "2000-01-23T04:56:07.000+00:00", "versionedItem" : [ 0, 0 ], "createdBy" : 5, "comment" : "comment", "type" : "type", "userName" : "userName", "versionNumber" : 1, "changeDetails" : "changeDetails" }, { "item" : 6, "createdDate" : "2000-01-23T04:56:07.000+00:00", "versionedItem" : [ 0, 0 ], "createdBy" : 5, "comment" : "comment", "type" : "type", "userName" : "userName", "versionNumber" : 1, "changeDetails" : "changeDetails" } ], "meta" : { "pageInfo" : { "startIndex" : 5, "resultCount" : 5, "totalResults" : 2 }, "status" : "OK", "timestamp" : "2000-01-23T04:56:07.000+00:00" }, "links" : { "key" : { "href" : "href", "type" : "type" } }, "linked" : { "key" : { "key" : "{}" } } }

Produces: API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header:

• application/json

Response: VersionDataListWrapper

PUT /attachments/{attachmentId}/lock

Summary: Update the locked state of the item with the specified ID

Path parameters:

• attachmentId (required)
  

Consumes: this API call consumes the following media types via the Content-Type request header:

• application/json

Body:

RequestLock

Examples:

• Example data, content-type: application/json
  
  { "headers" : { "key" : [ "headers", "headers" ] }, "pageInfo" : { "startIndex" : 5, "resultCount" : 5, "totalResults" : 2 }, "statusReasonPhrase" : "statusReasonPhrase", "status" : 0 }

Produces: API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header:

• application/json

Response: AbstractRestResponse

PUT /attachments/{attachmentId}/file

Summary: Upload attachment file to the attachment with the specified ID

Path parameters:

• attachmentId (required)
  

Consumes: this API call consumes the following media types via the Content-Type request header:

• multipart/form-data

Body:

FormDataMultiPart

Examples:

• Example data, content-type: application/json
  
  { "headers" : { "key" : [ "headers", "headers" ] }, "pageInfo" : { "startIndex" : 5, "resultCount" : 5, "totalResults" : 2 }, "statusReasonPhrase" : "statusReasonPhrase", "status" : 0 }

Produces: API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header:

• application/json

Response: AbstractRestResponse

Endpoint baselines

The baselines endpoint has the following operations:

1. DELETE /baselines/{baselineId}
2. GET /baselines/{baselineId}
3. GET /baselines
4. GET /baselines/{baselineId}/versioneditems/{itemId}/versionedrelationships
5. GET /baselines/{baselineId}/reviewlink
6. GET /baselines/{baselineId}/versioneditems/{itemId}
7. GET /baselines/{baselineId}/versioneditems
8. PUT /baselines/{baselineId}

Below is more detail for each of the operations of the baselines endpoint.

DELETE /baselines/{baselineId}

Summary: Delete the baseline with the specified ID

Path parameters:

• baselineId (required)
  

Consumes: this API call consumes the following media types via the Content-Type request header:

• application/json

Examples:

• Example data, content-type: application/json
  
  { "headers" : { "key" : [ "headers", "headers" ] }, "pageInfo" : { "startIndex" : 5, "resultCount" : 5, "totalResults" : 2 }, "statusReasonPhrase" : "statusReasonPhrase", "status" : 0 }

Produces: API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header:

• application/json

Response: AbstractRestResponse

GET /baselines/{baselineId}

Summary: Get the baseline with the specified ID

Path parameters:

• baselineId (required)
  

Consumes: this API call consumes the following media types via the Content-Type request header:

• application/json

Request headers:

• xJamaDateFieldsWithTime (optional)
  

Query parameters:

• include (optional)
  Links to include as full objects in the linked map

Examples:

• Example data, content-type: application/json
  
  { "data" : { "sourceKey" : "sourceKey", "baselineKey" : "baselineKey", "origin" : { "filter" : 2, "item" : 5, "testCycle" : 3, "release" : 7, "simplefilter" : 9, "testPlan" : 2, "project" : 5 }, "description" : "description", "project" : 1, "signed" : true, "source" : 4, "type" : "type", "createdDate" : "2000-01-23T04:56:07.000+00:00", "createdBy" : 6, "name" : "name", "id" : 0, "sourceName" : "sourceName", "baselinePickListOption" : "{}" }, "meta" : { "status" : "OK", "timestamp" : "2000-01-23T04:56:07.000+00:00" }, "links" : { "key" : { "href" : "href", "type" : "type" } }, "linked" : { "key" : { "key" : "{}" } } }

Produces: API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header:

• application/json

Response: BaselineDataWrapper

GET /baselines

Summary: Get all baselines in the project with the specified ID

Consumes: this API call consumes the following media types via the Content-Type request header:

• application/json

Request headers:

• xJamaDateFieldsWithTime (optional)
  

Query parameters:

• project (required)
  
• createdBy (optional)
  
• source (optional)
  
• startAt (optional)
  
• maxResults (optional)
  If not set, this defaults to 20. This cannot be larger than 50
• include (optional)
  Links to include as full objects in the linked map

Examples:

• Example data, content-type: application/json
  
  { "data" : [ { "sourceKey" : "sourceKey", "baselineKey" : "baselineKey", "origin" : { "filter" : 2, "item" : 5, "testCycle" : 3, "release" : 7, "simplefilter" : 9, "testPlan" : 2, "project" : 5 }, "description" : "description", "project" : 1, "signed" : true, "source" : 4, "type" : "type", "createdDate" : "2000-01-23T04:56:07.000+00:00", "createdBy" : 6, "name" : "name", "id" : 0, "sourceName" : "sourceName", "baselinePickListOption" : "{}" }, { "sourceKey" : "sourceKey", "baselineKey" : "baselineKey", "origin" : { "filter" : 2, "item" : 5, "testCycle" : 3, "release" : 7, "simplefilter" : 9, "testPlan" : 2, "project" : 5 }, "description" : "description", "project" : 1, "signed" : true, "source" : 4, "type" : "type", "createdDate" : "2000-01-23T04:56:07.000+00:00", "createdBy" : 6, "name" : "name", "id" : 0, "sourceName" : "sourceName", "baselinePickListOption" : "{}" } ], "meta" : { "pageInfo" : { "startIndex" : 5, "resultCount" : 5, "totalResults" : 2 }, "status" : "OK", "timestamp" : "2000-01-23T04:56:07.000+00:00" }, "links" : { "key" : { "href" : "href", "type" : "type" } }, "linked" : { "key" : { "key" : "{}" } } }

Produces: API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header:

• application/json

Response: BaselineDataListWrapper

GET /baselines/{baselineId}/versioneditems/{itemId}/versionedrelationships

Summary: Get all versioned relationships for the item in the baseline

Path parameters:

• itemId (required)
  
• baselineId (required)
  

Consumes: this API call consumes the following media types via the Content-Type request header:

• application/json

Request headers:

• xJamaDateFieldsWithTime (optional)
  

Query parameters:

• startAt (optional)
  
• maxResults (optional)
  If not set, this defaults to 20. This cannot be larger than 50
• include (optional)
  Links to include as full objects in the linked map

Examples:

• Example data, content-type: application/json
  
  { "data" : [ { "relationshipType" : [ "{}", "{}" ], "fromItem" : [ 6, 6 ], "id" : 0, "suspect" : true, "toItem" : [ 1, 1 ] }, { "relationshipType" : [ "{}", "{}" ], "fromItem" : [ 6, 6 ], "id" : 0, "suspect" : true, "toItem" : [ 1, 1 ] } ], "meta" : { "pageInfo" : { "startIndex" : 5, "resultCount" : 5, "totalResults" : 2 }, "status" : "OK", "timestamp" : "2000-01-23T04:56:07.000+00:00" }, "links" : { "key" : { "href" : "href", "type" : "type" } }, "linked" : { "key" : { "key" : "{}" } } }

Produces: API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header:

• application/json

Response: VersionedRelationshipDataListWrapper

GET /baselines/{baselineId}/reviewlink

Summary: Get related review link

Path parameters:

• baselineId (required)
  

Consumes: this API call consumes the following media types via the Content-Type request header:

• application/json

Examples:

• Example data, content-type: application/json
  
  { "headers" : { "key" : [ "headers", "headers" ] }, "pageInfo" : { "startIndex" : 5, "resultCount" : 5, "totalResults" : 2 }, "statusReasonPhrase" : "statusReasonPhrase", "status" : 0 }

Produces: API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header:

• application/json

Response: AbstractRestResponse

GET /baselines/{baselineId}/versioneditems/{itemId}

Summary: Get the baseline item with the specified ID in a baseline with the specified ID

Path parameters:

• itemId (required)
  
• baselineId (required)
  

Consumes: this API call consumes the following media types via the Content-Type request header:

• application/json

Request headers:

• xJamaDateFieldsWithTime (optional)
  

Query parameters:

• include (optional)
  Links to include as full objects in the linked map

Examples:

• Example data, content-type: application/json
  
  { "data" : { "itemType" : 9, "globalId" : "globalId", "project" : 7, "resources" : { "key" : { "allowed" : [ "allowed", "allowed" ] } }, "baseline" : 1, "type" : "type", "childItemType" : 3, "version" : 0, "currentVersion" : 6, "createdDate" : "2000-01-23T04:56:07.000+00:00", "lastActivityDate" : "2000-01-23T04:56:07.000+00:00", "createdBy" : 2, "documentKey" : "documentKey", "modifiedDate" : "2000-01-23T04:56:07.000+00:00", "modifiedBy" : 4, "id" : 2, "fields" : { "key" : "{}" }, "baselineLocation" : { "sequence" : "sequence", "parent" : { "item" : [ 5, 5 ], "project" : 5 } }, "baselinedAppliedCategorySnapshots" : [ { "categoryPathSequence" : "categoryPathSequence", "itemVersionNumberApplied" : 2 }, { "categoryPathSequence" : "categoryPathSequence", "itemVersionNumberApplied" : 2 } ] }, "meta" : { "status" : "OK", "timestamp" : "2000-01-23T04:56:07.000+00:00" }, "links" : { "key" : { "href" : "href", "type" : "type" } }, "linked" : { "key" : { "key" : "{}" } } }

Produces: API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header:

• application/json

Response: BaselineItemDataWrapper

GET /baselines/{baselineId}/versioneditems

Summary: Get all baseline items in a baseline with the specified ID

Path parameters:

• baselineId (required)
  

Consumes: this API call consumes the following media types via the Content-Type request header:

• application/json

Request headers:

• xJamaDateFieldsWithTime (optional)
  

Query parameters:

• startAt (optional)
  
• maxResults (optional)
  If not set, this defaults to 20. This cannot be larger than 50
• include (optional)
  Links to include as full objects in the linked map
• categories (optional)
  If true, will return all categories applied at the time the baseline was created

Examples:

• Example data, content-type: application/json
  
  { "data" : [ { "itemType" : 9, "globalId" : "globalId", "project" : 7, "resources" : { "key" : { "allowed" : [ "allowed", "allowed" ] } }, "baseline" : 1, "type" : "type", "childItemType" : 3, "version" : 0, "currentVersion" : 6, "createdDate" : "2000-01-23T04:56:07.000+00:00", "lastActivityDate" : "2000-01-23T04:56:07.000+00:00", "createdBy" : 2, "documentKey" : "documentKey", "modifiedDate" : "2000-01-23T04:56:07.000+00:00", "modifiedBy" : 4, "id" : 2, "fields" : { "key" : "{}" }, "baselineLocation" : { "sequence" : "sequence", "parent" : { "item" : [ 5, 5 ], "project" : 5 } }, "baselinedAppliedCategorySnapshots" : [ { "categoryPathSequence" : "categoryPathSequence", "itemVersionNumberApplied" : 2 }, { "categoryPathSequence" : "categoryPathSequence", "itemVersionNumberApplied" : 2 } ] }, { "itemType" : 9, "globalId" : "globalId", "project" : 7, "resources" : { "key" : { "allowed" : [ "allowed", "allowed" ] } }, "baseline" : 1, "type" : "type", "childItemType" : 3, "version" : 0, "currentVersion" : 6, "createdDate" : "2000-01-23T04:56:07.000+00:00", "lastActivityDate" : "2000-01-23T04:56:07.000+00:00", "createdBy" : 2, "documentKey" : "documentKey", "modifiedDate" : "2000-01-23T04:56:07.000+00:00", "modifiedBy" : 4, "id" : 2, "fields" : { "key" : "{}" }, "baselineLocation" : { "sequence" : "sequence", "parent" : { "item" : [ 5, 5 ], "project" : 5 } }, "baselinedAppliedCategorySnapshots" : [ { "categoryPathSequence" : "categoryPathSequence", "itemVersionNumberApplied" : 2 }, { "categoryPathSequence" : "categoryPathSequence", "itemVersionNumberApplied" : 2 } ] } ], "meta" : { "pageInfo" : { "startIndex" : 5, "resultCount" : 5, "totalResults" : 2 }, "status" : "OK", "timestamp" : "2000-01-23T04:56:07.000+00:00" }, "links" : { "key" : { "href" : "href", "type" : "type" } }, "linked" : { "key" : { "key" : "{}" } } }

Produces: API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header:

• application/json

Response: BaselineItemDataListWrapper

PUT /baselines/{baselineId}

Summary: Update the baseline with the specified ID

Path parameters:

• baselineId (required)
  

Consumes: this API call consumes the following media types via the Content-Type request header:

• application/json

Body:

RequestBaseline

Examples:

• Example data, content-type: application/json
  
  { "headers" : { "key" : [ "headers", "headers" ] }, "pageInfo" : { "startIndex" : 5, "resultCount" : 5, "totalResults" : 2 }, "statusReasonPhrase" : "statusReasonPhrase", "status" : 0 }

Produces: API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header:

• application/json

Response: AbstractRestResponse

Endpoint comments

The comments endpoint has the following operations:

1. POST /comments
2. GET /comments/{id}
3. GET /comments
4. GET /comments/{id}/replies

Below is more detail for each of the operations of the comments endpoint.

POST /comments

Summary: Create a new comment

Consumes: this API call consumes the following media types via the Content-Type request header:

• application/json

Body:

RequestComment

Examples:

• Example data, content-type: application/json
  
  { "headers" : { "key" : [ "headers", "headers" ] }, "pageInfo" : { "startIndex" : 5, "resultCount" : 5, "totalResults" : 2 }, "location" : "http://example.com/aeiou", "id" : 6, "statusReasonPhrase" : "statusReasonPhrase", "status" : 0 }

Produces: API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header:

• application/json

Response: CreatedResponse

GET /comments/{id}

Summary: Get the comment with the specified ID

Path parameters:

• id (required)
  

Consumes: this API call consumes the following media types via the Content-Type request header:

• application/json

Request headers:

• xJamaDateFieldsWithTime (optional)
  

Query parameters:

• include (optional)
  Links to include as full objects in the linked map

Examples:

• Example data, content-type: application/json
  
  { "data" : { "createdDate" : "2000-01-23T04:56:07.000+00:00", "deleted" : true, "createdBy" : 1, "inReplyTo" : 6, "commentType" : "GENERAL", "modifiedBy" : 5, "location" : { "item" : 5, "project" : 2 }, "id" : 0, "body" : { "text" : "text" }, "status" : "OPEN" }, "meta" : { "status" : "OK", "timestamp" : "2000-01-23T04:56:07.000+00:00" }, "links" : { "key" : { "href" : "href", "type" : "type" } }, "linked" : { "key" : { "key" : "{}" } } }

Produces: API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header:

• application/json

Response: CommentDataWrapper

GET /comments

Summary: Get all comments viewable by the current user

Consumes: this API call consumes the following media types via the Content-Type request header:

• application/json

Request headers:

• xJamaDateFieldsWithTime (optional)
  

Query parameters:

• startAt (optional)
  
• maxResults (optional)
  If not set, this defaults to 20. This cannot be larger than 50
• rootCommentsOnly (optional)
  whether to show only root comments; true to get only root comments, without their comment replies, default value: false
• include (optional)
  Links to include as full objects in the linked map

Examples:

• Example data, content-type: application/json
  
  { "data" : [ { "createdDate" : "2000-01-23T04:56:07.000+00:00", "deleted" : true, "createdBy" : 1, "inReplyTo" : 6, "commentType" : "GENERAL", "modifiedBy" : 5, "location" : { "item" : 5, "project" : 2 }, "id" : 0, "body" : { "text" : "text" }, "status" : "OPEN" }, { "createdDate" : "2000-01-23T04:56:07.000+00:00", "deleted" : true, "createdBy" : 1, "inReplyTo" : 6, "commentType" : "GENERAL", "modifiedBy" : 5, "location" : { "item" : 5, "project" : 2 }, "id" : 0, "body" : { "text" : "text" }, "status" : "OPEN" } ], "meta" : { "pageInfo" : { "startIndex" : 5, "resultCount" : 5, "totalResults" : 2 }, "status" : "OK", "timestamp" : "2000-01-23T04:56:07.000+00:00" }, "links" : { "key" : { "href" : "href", "type" : "type" } }, "linked" : { "key" : { "key" : "{}" } } }

Produces: API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header:

• application/json

Response: CommentDataListWrapper

GET /comments/{id}/replies

Summary: Get all reply comments for the comment with the specified ID

Path parameters:

• id (required)
  

Consumes: this API call consumes the following media types via the Content-Type request header:

• application/json

Request headers:

• xJamaDateFieldsWithTime (optional)
  

Query parameters:

• startAt (optional)
  
• maxResults (optional)
  If not set, this defaults to 20. This cannot be larger than 50
• include (optional)
  Links to include as full objects in the linked map

Examples:

• Example data, content-type: application/json
  
  { "data" : [ { "createdDate" : "2000-01-23T04:56:07.000+00:00", "deleted" : true, "createdBy" : 1, "inReplyTo" : 6, "commentType" : "GENERAL", "modifiedBy" : 5, "location" : { "item" : 5, "project" : 2 }, "id" : 0, "body" : { "text" : "text" }, "status" : "OPEN" }, { "createdDate" : "2000-01-23T04:56:07.000+00:00", "deleted" : true, "createdBy" : 1, "inReplyTo" : 6, "commentType" : "GENERAL", "modifiedBy" : 5, "location" : { "item" : 5, "project" : 2 }, "id" : 0, "body" : { "text" : "text" }, "status" : "OPEN" } ], "meta" : { "pageInfo" : { "startIndex" : 5, "resultCount" : 5, "totalResults" : 2 }, "status" : "OK", "timestamp" : "2000-01-23T04:56:07.000+00:00" }, "links" : { "key" : { "href" : "href", "type" : "type" } }, "linked" : { "key" : { "key" : "{}" } } }

Produces: API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header:

• application/json

Response: CommentDataListWrapper

Endpoint files

The files endpoint has the following operations:

1. GET /files

Below is more detail for each of the operations of the files endpoint.

GET /files

Summary: Download attachment file from the attachment with the specified Jama URL

Consumes: this API call consumes the following media types via the Content-Type request header:

• application/json

Request headers:

• xJamaDateFieldsWithTime (optional)
  

Query parameters:

• url (required)
  

Produces: API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header:

• application/json
• application/octet-stream

Response:

Endpoint filters

The filters endpoint has the following operations:

1. GET /filters/{filterId}/count
2. GET /filters/{filterId}
3. GET /filters
4. GET /filters/{filterId}/results

Below is more detail for each of the operations of the filters endpoint.

GET /filters/{filterId}/count

Summary: Get the count for the filter with the specified ID

Path parameters:

• filterId (required)
  

Consumes: this API call consumes the following media types via the Content-Type request header:

• application/json

Examples:

• Example data, content-type: application/json
  
  { "data" : [ { "itemType" : 1, "globalId" : "globalId", "project" : 6, "resources" : { "key" : { "allowed" : [ "allowed", "allowed" ] } }, "childItemType" : 5, "createdDate" : "2000-01-23T04:56:07.000+00:00", "lastActivityDate" : "2000-01-23T04:56:07.000+00:00", "createdBy" : 5, "documentKey" : "documentKey", "modifiedDate" : "2000-01-23T04:56:07.000+00:00", "lock" : { "lockedBy" : 7, "lastLockedDate" : "2000-01-23T04:56:07.000+00:00", "locked" : true }, "modifiedBy" : 2, "location" : { "sequence" : "sequence", "parent" : { "item" : 4, "project" : 2 }, "sortOrder" : 9, "globalSortOrder" : 3 }, "id" : 0, "fields" : { "key" : "{}" }, "baselinedAppliedCategorySnapshots" : [ { "categoryPathSequence" : "categoryPathSequence", "itemVersionNumberApplied" : 2 }, { "categoryPathSequence" : "categoryPathSequence", "itemVersionNumberApplied" : 2 } ] }, { "itemType" : 1, "globalId" : "globalId", "project" : 6, "resources" : { "key" : { "allowed" : [ "allowed", "allowed" ] } }, "childItemType" : 5, "createdDate" : "2000-01-23T04:56:07.000+00:00", "lastActivityDate" : "2000-01-23T04:56:07.000+00:00", "createdBy" : 5, "documentKey" : "documentKey", "modifiedDate" : "2000-01-23T04:56:07.000+00:00", "lock" : { "lockedBy" : 7, "lastLockedDate" : "2000-01-23T04:56:07.000+00:00", "locked" : true }, "modifiedBy" : 2, "location" : { "sequence" : "sequence", "parent" : { "item" : 4, "project" : 2 }, "sortOrder" : 9, "globalSortOrder" : 3 }, "id" : 0, "fields" : { "key" : "{}" }, "baselinedAppliedCategorySnapshots" : [ { "categoryPathSequence" : "categoryPathSequence", "itemVersionNumberApplied" : 2 }, { "categoryPathSequence" : "categoryPathSequence", "itemVersionNumberApplied" : 2 } ] } ], "meta" : { "pageInfo" : { "startIndex" : 5, "resultCount" : 5, "totalResults" : 2 }, "status" : "OK", "timestamp" : "2000-01-23T04:56:07.000+00:00" }, "links" : { "key" : { "href" : "href", "type" : "type" } }, "linked" : { "key" : { "key" : "{}" } } }

Produces: API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header:

• application/json

Response: ItemDataListWrapper

GET /filters/{filterId}

Summary: Get the filter with the specified ID

Path parameters:

• filterId (required)
  

Consumes: this API call consumes the following media types via the Content-Type request header:

• application/json

Request headers:

• xJamaDateFieldsWithTime (optional)
  

Query parameters:

• include (optional)
  Links to include as full objects in the linked map

Examples:

• Example data, content-type: application/json
  
  { "data" : { "specifiedProject" : 1, "public" : true, "author" : 6, "name" : "name", "id" : 0, "projectScope" : "ALL", "filterQuery" : { "orderRules" : [ { "field" : { "display" : "display", "name" : "name", "id" : 5, "fieldDataType" : "INTEGER" }, "direction" : "ASC" }, { "field" : { "display" : "display", "name" : "name", "id" : 5, "fieldDataType" : "INTEGER" }, "direction" : "ASC" } ], "name" : "name", "rule" : { "itemType" : 5, "field" : { "display" : "display", "name" : "name", "id" : 5, "fieldDataType" : "INTEGER" }, "values" : [ "values", "values" ], "rules" : [ null, null ], "operator" : "GROUP_OR" } } }, "meta" : { "status" : "OK", "timestamp" : "2000-01-23T04:56:07.000+00:00" }, "links" : { "key" : { "href" : "href", "type" : "type" } }, "linked" : { "key" : { "key" : "{}" } } }

Produces: API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header:

• application/json

Response: FilterDataWrapper

GET /filters

Summary: Get all filters viewable by the current user

Consumes: this API call consumes the following media types via the Content-Type request header:

• application/json

Request headers:

• xJamaDateFieldsWithTime (optional)
  

Query parameters:

• project (optional)
  
• author (optional)
  
• filterScope (optional)
  Filter scope. More than one scope can be selected
• startAt (optional)
  
• maxResults (optional)
  If not set, this defaults to 20. This cannot be larger than 50
• include (optional)
  Links to include as full objects in the linked map
• accessSpecifier (optional)
  

Examples:

• Example data, content-type: application/json
  
  { "data" : [ { "specifiedProject" : 1, "public" : true, "author" : 6, "name" : "name", "id" : 0, "projectScope" : "ALL", "filterQuery" : { "orderRules" : [ { "field" : { "display" : "display", "name" : "name", "id" : 5, "fieldDataType" : "INTEGER" }, "direction" : "ASC" }, { "field" : { "display" : "display", "name" : "name", "id" : 5, "fieldDataType" : "INTEGER" }, "direction" : "ASC" } ], "name" : "name", "rule" : { "itemType" : 5, "field" : { "display" : "display", "name" : "name", "id" : 5, "fieldDataType" : "INTEGER" }, "values" : [ "values", "values" ], "rules" : [ null, null ], "operator" : "GROUP_OR" } } }, { "specifiedProject" : 1, "public" : true, "author" : 6, "name" : "name", "id" : 0, "projectScope" : "ALL", "filterQuery" : { "orderRules" : [ { "field" : { "display" : "display", "name" : "name", "id" : 5, "fieldDataType" : "INTEGER" }, "direction" : "ASC" }, { "field" : { "display" : "display", "name" : "name", "id" : 5, "fieldDataType" : "INTEGER" }, "direction" : "ASC" } ], "name" : "name", "rule" : { "itemType" : 5, "field" : { "display" : "display", "name" : "name", "id" : 5, "fieldDataType" : "INTEGER" }, "values" : [ "values", "values" ], "rules" : [ null, null ], "operator" : "GROUP_OR" } } } ], "meta" : { "pageInfo" : { "startIndex" : 5, "resultCount" : 5, "totalResults" : 2 }, "status" : "OK", "timestamp" : "2000-01-23T04:56:07.000+00:00" }, "links" : { "key" : { "href" : "href", "type" : "type" } }, "linked" : { "key" : { "key" : "{}" } } }

Produces: API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header:

• application/json

Response: FilterDataListWrapper

GET /filters/{filterId}/results

Summary: Get all result items for the filter with the specified ID

Path parameters:

• filterId (required)
  

Consumes: this API call consumes the following media types via the Content-Type request header:

• application/json

Request headers:

• xJamaDateFieldsWithTime (optional)
  

Query parameters:

• project (optional)
  Use only for filters that run on any project, where \"projectScope\" is \"CURRENT\"
• lastActivityDate (optional)
  Filter datetime fields after a single date or within a range of values. Provide one or two values in ISO8601 format (milliseconds or seconds) - \"yyyy-MM-dd'T'HH:mm:ss.SSSZ\" or \"yyyy-MM-dd'T'HH:mm:ssZ\"
• startAt (optional)
  
• maxResults (optional)
  If not set, this defaults to 20. This cannot be larger than 50
• include (optional)
  Links to include as full objects in the linked map

Examples:

• Example data, content-type: application/json
  
  { "data" : [ { "itemType" : 1, "globalId" : "globalId", "project" : 6, "resources" : { "key" : { "allowed" : [ "allowed", "allowed" ] } }, "childItemType" : 5, "createdDate" : "2000-01-23T04:56:07.000+00:00", "lastActivityDate" : "2000-01-23T04:56:07.000+00:00", "createdBy" : 5, "documentKey" : "documentKey", "modifiedDate" : "2000-01-23T04:56:07.000+00:00", "lock" : { "lockedBy" : 7, "lastLockedDate" : "2000-01-23T04:56:07.000+00:00", "locked" : true }, "modifiedBy" : 2, "location" : { "sequence" : "sequence", "parent" : { "item" : 4, "project" : 2 }, "sortOrder" : 9, "globalSortOrder" : 3 }, "id" : 0, "fields" : { "key" : "{}" }, "baselinedAppliedCategorySnapshots" : [ { "categoryPathSequence" : "categoryPathSequence", "itemVersionNumberApplied" : 2 }, { "categoryPathSequence" : "categoryPathSequence", "itemVersionNumberApplied" : 2 } ] }, { "itemType" : 1, "globalId" : "globalId", "project" : 6, "resources" : { "key" : { "allowed" : [ "allowed", "allowed" ] } }, "childItemType" : 5, "createdDate" : "2000-01-23T04:56:07.000+00:00", "lastActivityDate" : "2000-01-23T04:56:07.000+00:00", "createdBy" : 5, "documentKey" : "documentKey", "modifiedDate" : "2000-01-23T04:56:07.000+00:00", "lock" : { "lockedBy" : 7, "lastLockedDate" : "2000-01-23T04:56:07.000+00:00", "locked" : true }, "modifiedBy" : 2, "location" : { "sequence" : "sequence", "parent" : { "item" : 4, "project" : 2 }, "sortOrder" : 9, "globalSortOrder" : 3 }, "id" : 0, "fields" : { "key" : "{}" }, "baselinedAppliedCategorySnapshots" : [ { "categoryPathSequence" : "categoryPathSequence", "itemVersionNumberApplied" : 2 }, { "categoryPathSequence" : "categoryPathSequence", "itemVersionNumberApplied" : 2 } ] } ], "meta" : { "pageInfo" : { "startIndex" : 5, "resultCount" : 5, "totalResults" : 2 }, "status" : "OK", "timestamp" : "2000-01-23T04:56:07.000+00:00" }, "links" : { "key" : { "href" : "href", "type" : "type" } }, "linked" : { "key" : { "key" : "{}" } } }

Produces: API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header:

• application/json

Response: ItemDataListWrapper

Endpoint items

The items endpoint has the following operations:

1. POST /items/{id}/attachments
2. POST /items
3. POST /items/{id}/links
4. POST /items/{id}/tags
5. DELETE /items/{id}/synceditems/{syncedItemId}
6. POST /items/{id}/synceditems
7. DELETE /items/{id}
8. DELETE /items/{id}/links/{linkId}
9. POST /items/{id}/duplicate
10. POST /items/{id}/workflowtransitions
11. GET /items/{id}/activities
12. GET /items/{id}/attachments
13. GET /items/{id}/children
14. GET /items/{id}/downstreamrelated
15. GET /items/{id}/downstreamrelationships
16. GET /items/{id}
17. GET /items/{id}/comments
18. GET /items/{id}/links
19. GET /items
20. GET /items/{id}/links/{linkId}
21. GET /items/{id}/location
22. GET /items/{id}/lock
23. GET /items/{id}/parent
24. GET /items/{id}/synceditems
25. GET /items/{id}/synceditems/{syncedItemId}/syncstatus
26. GET /items/{id}/tags/{tagId}
27. GET /items/{id}/tags
28. GET /items/{id}/upstreamrelated
29. GET /items/{id}/upstreamrelationships
30. GET /items/{id}/versions/{versionNum}
31. GET /items/{id}/versionedcategories
32. GET /items/{id}/versions/{versionNum}/versioneditem
33. GET /items/{id}/versions
34. GET /items/{id}/workflowtransitionoptions
35. PUT /items/{treeLocation}
36. PATCH /items/{id}
37. PATCH /items
38. PUT /items/{id}
39. DELETE /items/{id}/attachments/{attachmentId}
40. DELETE /items/{id}/tags/{tagId}
41. PUT /items/{id}/links/{linkId}
42. PUT /items/{id}/location
43. PUT /items/{id}/lock

Below is more detail for each of the operations of the items endpoint.

POST /items/{id}/attachments

Summary: Add an existing attachment to the item with the specified ID

Path parameters:

• id (required)
  

Consumes: this API call consumes the following media types via the Content-Type request header:

• application/json

Body:

RequestItemAttachment

Examples:

• Example data, content-type: application/json
  
  { "headers" : { "key" : [ "headers", "headers" ] }, "pageInfo" : { "startIndex" : 5, "resultCount" : 5, "totalResults" : 2 }, "location" : "http://example.com/aeiou", "id" : 6, "statusReasonPhrase" : "statusReasonPhrase", "status" : 0 }

Produces: API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header:

• application/json

Response: CreatedResponse

POST /items

Summary: Create a new item

Consumes: this API call consumes the following media types via the Content-Type request header:

• application/json

Body:

RequestItem

Query parameters:

• setGlobalIdManually (optional)
  This value must be set to true if you attempt to manually set the Global ID field of an item

Examples:

• Example data, content-type: application/json
  
  { "headers" : { "key" : [ "headers", "headers" ] }, "pageInfo" : { "startIndex" : 5, "resultCount" : 5, "totalResults" : 2 }, "location" : "http://example.com/aeiou", "id" : 6, "statusReasonPhrase" : "statusReasonPhrase", "status" : 0 }

Produces: API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header:

• application/json

Response: CreatedResponse

POST /items/{id}/links

Summary: Create a new link for the item with the specified ID

Path parameters:

• id (required)
  

Consumes: this API call consumes the following media types via the Content-Type request header:

• application/json

Body:

RequestLink

Examples:

• Example data, content-type: application/json
  
  { "headers" : { "key" : [ "headers", "headers" ] }, "pageInfo" : { "startIndex" : 5, "resultCount" : 5, "totalResults" : 2 }, "location" : "http://example.com/aeiou", "id" : 6, "statusReasonPhrase" : "statusReasonPhrase", "status" : 0 }

Produces: API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header:

• application/json

Response: CreatedResponse

POST /items/{id}/tags

Summary: Add an existing tag to the item with the specified ID

Path parameters:

• id (required)
  

Consumes: this API call consumes the following media types via the Content-Type request header:

• application/json

Body:

RequestItemTag

Examples:

• Example data, content-type: application/json
  
  { "headers" : { "key" : [ "headers", "headers" ] }, "pageInfo" : { "startIndex" : 5, "resultCount" : 5, "totalResults" : 2 }, "location" : "http://example.com/aeiou", "id" : 6, "statusReasonPhrase" : "statusReasonPhrase", "status" : 0 }

Produces: API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header:

• application/json

Response: CreatedResponse

DELETE /items/{id}/synceditems/{syncedItemId}

Summary: Remove an existing item from the Global ID pool of the item with the specified ID (break sync)

Path parameters:

• syncedItemId (required)
  
• id (required)
  

Consumes: this API call consumes the following media types via the Content-Type request header:

• application/json

Examples:

• Example data, content-type: application/json
  
  { "headers" : { "key" : [ "headers", "headers" ] }, "pageInfo" : { "startIndex" : 5, "resultCount" : 5, "totalResults" : 2 }, "statusReasonPhrase" : "statusReasonPhrase", "status" : 0 }

Produces: API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header:

• application/json

Response: AbstractRestResponse

POST /items/{id}/synceditems

Summary: Add an existing item to the Global ID pool of the item with the specified ID

Path parameters:

• id (required)
  

Consumes: this API call consumes the following media types via the Content-Type request header:

• application/json

Body:

RequestItemSyncedItem

Examples:

• Example data, content-type: application/json
  
  { "headers" : { "key" : [ "headers", "headers" ] }, "pageInfo" : { "startIndex" : 5, "resultCount" : 5, "totalResults" : 2 }, "location" : "http://example.com/aeiou", "id" : 6, "statusReasonPhrase" : "statusReasonPhrase", "status" : 0 }

Produces: API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header:

• application/json

Response: CreatedResponse

DELETE /items/{id}

Summary: Delete the item with the specified ID (item becomes inactive and can be un-deleted if necessary)

Path parameters:

• id (required)
  

Consumes: this API call consumes the following media types via the Content-Type request header:

• application/json

Examples:

• Example data, content-type: application/json
  
  { "headers" : { "key" : [ "headers", "headers" ] }, "pageInfo" : { "startIndex" : 5, "resultCount" : 5, "totalResults" : 2 }, "statusReasonPhrase" : "statusReasonPhrase", "status" : 0 }

Produces: API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header:

• application/json

Response: AbstractRestResponse

DELETE /items/{id}/links/{linkId}

Summary: Delete the link with the specified ID

Path parameters:

• linkId (required)
  
• id (required)
  

Consumes: this API call consumes the following media types via the Content-Type request header:

• application/json

Examples:

• Example data, content-type: application/json
  
  { "headers" : { "key" : [ "headers", "headers" ] }, "pageInfo" : { "startIndex" : 5, "resultCount" : 5, "totalResults" : 2 }, "statusReasonPhrase" : "statusReasonPhrase", "status" : 0 }

Produces: API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header:

• application/json

Response: AbstractRestResponse

POST /items/{id}/duplicate

Summary: Create a duplicate of item

Copies the name and description fields. Only items without children can be have a duplicate created.

Path parameters:

• id (required)
  

Consumes: this API call consumes the following media types via the Content-Type request header:

• application/json

Body:

DuplicateConfig

Examples:

• Example data, content-type: application/json
  
  { "headers" : { "key" : [ "headers", "headers" ] }, "pageInfo" : { "startIndex" : 5, "resultCount" : 5, "totalResults" : 2 }, "location" : "http://example.com/aeiou", "id" : 6, "statusReasonPhrase" : "statusReasonPhrase", "status" : 0 }

Produces: API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header:

• application/json

Response: CreatedResponse

POST /items/{id}/workflowtransitions

Summary: Executes a workflow transition for the item with the specified ID. Valid transitions can be found at /items/{id}/workflowtransitionoptions

Path parameters:

• id (required)
  

Consumes: this API call consumes the following media types via the Content-Type request header:

• application/json

Body:

RequestTransition

Examples:

• Example data, content-type: application/json
  
  { "headers" : { "key" : [ "headers", "headers" ] }, "pageInfo" : { "startIndex" : 5, "resultCount" : 5, "totalResults" : 2 }, "location" : "http://example.com/aeiou", "id" : 6, "statusReasonPhrase" : "statusReasonPhrase", "status" : 0 }

Produces: API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header:

• application/json

Response: CreatedResponse

GET /items/{id}/activities

Summary: Get all activities for the item with the specified ID

Path parameters:

• id (required)
  

Consumes: this API call consumes the following media types via the Content-Type request header:

• application/json

Request headers:

• xJamaDateFieldsWithTime (optional)
  

Query parameters:

• startAt (optional)
  
• maxResults (optional)
  If not set, this defaults to 20. This cannot be larger than 50
• include (optional)
  Links to include as full objects in the linked map

Examples:

• Example data, content-type: application/json
  
  { "data" : [ { "date" : "2000-01-23T04:56:07.000+00:00", "item" : 1, "itemType" : 5, "userComment" : "userComment", "action" : "action", "details" : "details", "id" : 0, "eventType" : "CREATE", "userName" : "userName", "user" : 6, "objectType" : "PROJECT" }, { "date" : "2000-01-23T04:56:07.000+00:00", "item" : 1, "itemType" : 5, "userComment" : "userComment", "action" : "action", "details" : "details", "id" : 0, "eventType" : "CREATE", "userName" : "userName", "user" : 6, "objectType" : "PROJECT" } ], "meta" : { "pageInfo" : { "startIndex" : 5, "resultCount" : 5, "totalResults" : 2 }, "status" : "OK", "timestamp" : "2000-01-23T04:56:07.000+00:00" }, "links" : { "key" : { "href" : "href", "type" : "type" } }, "linked" : { "key" : { "key" : "{}" } } }

Produces: API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header:

• application/json

Response: ActivityDataListWrapper

GET /items/{id}/attachments

Summary: Get all attachments for the item with the specified ID

Path parameters:

• id (required)
  

Consumes: this API call consumes the following media types via the Content-Type request header:

• application/json

Request headers:

• xJamaDateFieldsWithTime (optional)
  

Query parameters:

• startAt (optional)
  
• maxResults (optional)
  If not set, this defaults to 20. This cannot be larger than 50
• include (optional)
  Links to include as full objects in the linked map

Examples:

• Example data, content-type: application/json
  
  { "data" : [ { "fileName" : "fileName", "itemType" : 5, "globalId" : "globalId", "project" : 1, "resources" : { "key" : { "allowed" : [ "allowed", "allowed" ] } }, "mimeType" : "mimeType", "createdDate" : "2000-01-23T04:56:07.000+00:00", "fileSize" : 0, "lastActivityDate" : "2000-01-23T04:56:07.000+00:00", "createdBy" : 5, "documentKey" : "documentKey", "modifiedDate" : "2000-01-23T04:56:07.000+00:00", "lock" : { "lockedBy" : 7, "lastLockedDate" : "2000-01-23T04:56:07.000+00:00", "locked" : true }, "modifiedBy" : 2, "id" : 6, "fields" : { "key" : "{}" }, "baselinedAppliedCategorySnapshots" : [ { "categoryPathSequence" : "categoryPathSequence", "itemVersionNumberApplied" : 2 }, { "categoryPathSequence" : "categoryPathSequence", "itemVersionNumberApplied" : 2 } ] }, { "fileName" : "fileName", "itemType" : 5, "globalId" : "globalId", "project" : 1, "resources" : { "key" : { "allowed" : [ "allowed", "allowed" ] } }, "mimeType" : "mimeType", "createdDate" : "2000-01-23T04:56:07.000+00:00", "fileSize" : 0, "lastActivityDate" : "2000-01-23T04:56:07.000+00:00", "createdBy" : 5, "documentKey" : "documentKey", "modifiedDate" : "2000-01-23T04:56:07.000+00:00", "lock" : { "lockedBy" : 7, "lastLockedDate" : "2000-01-23T04:56:07.000+00:00", "locked" : true }, "modifiedBy" : 2, "id" : 6, "fields" : { "key" : "{}" }, "baselinedAppliedCategorySnapshots" : [ { "categoryPathSequence" : "categoryPathSequence", "itemVersionNumberApplied" : 2 }, { "categoryPathSequence" : "categoryPathSequence", "itemVersionNumberApplied" : 2 } ] } ], "meta" : { "pageInfo" : { "startIndex" : 5, "resultCount" : 5, "totalResults" : 2 }, "status" : "OK", "timestamp" : "2000-01-23T04:56:07.000+00:00" }, "links" : { "key" : { "href" : "href", "type" : "type" } }, "linked" : { "key" : { "key" : "{}" } } }

Produces: API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header:

• application/json

Response: AttachmentDataListWrapper

GET /items/{id}/children

Summary: Get all children items for the item with the specified ID

Path parameters:

• id (required)
  

Consumes: this API call consumes the following media types via the Content-Type request header:

• application/json

Request headers:

• xJamaDateFieldsWithTime (optional)
  

Query parameters:

• startAt (optional)
  
• maxResults (optional)
  If not set, this defaults to 20. This cannot be larger than 50
• include (optional)
  Links to include as full objects in the linked map

Examples:

• Example data, content-type: application/json
  
  { "data" : [ { "itemType" : 1, "globalId" : "globalId", "project" : 6, "resources" : { "key" : { "allowed" : [ "allowed", "allowed" ] } }, "childItemType" : 5, "createdDate" : "2000-01-23T04:56:07.000+00:00", "lastActivityDate" : "2000-01-23T04:56:07.000+00:00", "createdBy" : 5, "documentKey" : "documentKey", "modifiedDate" : "2000-01-23T04:56:07.000+00:00", "lock" : { "lockedBy" : 7, "lastLockedDate" : "2000-01-23T04:56:07.000+00:00", "locked" : true }, "modifiedBy" : 2, "location" : { "sequence" : "sequence", "parent" : { "item" : 4, "project" : 2 }, "sortOrder" : 9, "globalSortOrder" : 3 }, "id" : 0, "fields" : { "key" : "{}" }, "baselinedAppliedCategorySnapshots" : [ { "categoryPathSequence" : "categoryPathSequence", "itemVersionNumberApplied" : 2 }, { "categoryPathSequence" : "categoryPathSequence", "itemVersionNumberApplied" : 2 } ] }, { "itemType" : 1, "globalId" : "globalId", "project" : 6, "resources" : { "key" : { "allowed" : [ "allowed", "allowed" ] } }, "childItemType" : 5, "createdDate" : "2000-01-23T04:56:07.000+00:00", "lastActivityDate" : "2000-01-23T04:56:07.000+00:00", "createdBy" : 5, "documentKey" : "documentKey", "modifiedDate" : "2000-01-23T04:56:07.000+00:00", "lock" : { "lockedBy" : 7, "lastLockedDate" : "2000-01-23T04:56:07.000+00:00", "locked" : true }, "modifiedBy" : 2, "location" : { "sequence" : "sequence", "parent" : { "item" : 4, "project" : 2 }, "sortOrder" : 9, "globalSortOrder" : 3 }, "id" : 0, "fields" : { "key" : "{}" }, "baselinedAppliedCategorySnapshots" : [ { "categoryPathSequence" : "categoryPathSequence", "itemVersionNumberApplied" : 2 }, { "categoryPathSequence" : "categoryPathSequence", "itemVersionNumberApplied" : 2 } ] } ], "meta" : { "pageInfo" : { "startIndex" : 5, "resultCount" : 5, "totalResults" : 2 }, "status" : "OK", "timestamp" : "2000-01-23T04:56:07.000+00:00" }, "links" : { "key" : { "href" : "href", "type" : "type" } }, "linked" : { "key" : { "key" : "{}" } } }

Produces: API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header:

• application/json

Response: ItemDataListWrapper

GET /items/{id}/downstreamrelated

Summary: Get all downstream related items for the item with the specified ID

Path parameters:

• id (required)
  

Consumes: this API call consumes the following media types via the Content-Type request header:

• application/json

Request headers:

• xJamaDateFieldsWithTime (optional)
  

Query parameters:

• startAt (optional)
  
• maxResults (optional)
  If not set, this defaults to 20. This cannot be larger than 50
• include (optional)
  Links to include as full objects in the linked map

Examples:

• Example data, content-type: application/json
  
  { "data" : [ { "itemType" : 1, "globalId" : "globalId", "project" : 6, "resources" : { "key" : { "allowed" : [ "allowed", "allowed" ] } }, "childItemType" : 5, "createdDate" : "2000-01-23T04:56:07.000+00:00", "lastActivityDate" : "2000-01-23T04:56:07.000+00:00", "createdBy" : 5, "documentKey" : "documentKey", "modifiedDate" : "2000-01-23T04:56:07.000+00:00", "lock" : { "lockedBy" : 7, "lastLockedDate" : "2000-01-23T04:56:07.000+00:00", "locked" : true }, "modifiedBy" : 2, "location" : { "sequence" : "sequence", "parent" : { "item" : 4, "project" : 2 }, "sortOrder" : 9, "globalSortOrder" : 3 }, "id" : 0, "fields" : { "key" : "{}" }, "baselinedAppliedCategorySnapshots" : [ { "categoryPathSequence" : "categoryPathSequence", "itemVersionNumberApplied" : 2 }, { "categoryPathSequence" : "categoryPathSequence", "itemVersionNumberApplied" : 2 } ] }, { "itemType" : 1, "globalId" : "globalId", "project" : 6, "resources" : { "key" : { "allowed" : [ "allowed", "allowed" ] } }, "childItemType" : 5, "createdDate" : "2000-01-23T04:56:07.000+00:00", "lastActivityDate" : "2000-01-23T04:56:07.000+00:00", "createdBy" : 5, "documentKey" : "documentKey", "modifiedDate" : "2000-01-23T04:56:07.000+00:00", "lock" : { "lockedBy" : 7, "lastLockedDate" : "2000-01-23T04:56:07.000+00:00", "locked" : true }, "modifiedBy" : 2, "location" : { "sequence" : "sequence", "parent" : { "item" : 4, "project" : 2 }, "sortOrder" : 9, "globalSortOrder" : 3 }, "id" : 0, "fields" : { "key" : "{}" }, "baselinedAppliedCategorySnapshots" : [ { "categoryPathSequence" : "categoryPathSequence", "itemVersionNumberApplied" : 2 }, { "categoryPathSequence" : "categoryPathSequence", "itemVersionNumberApplied" : 2 } ] } ], "meta" : { "pageInfo" : { "startIndex" : 5, "resultCount" : 5, "totalResults" : 2 }, "status" : "OK", "timestamp" : "2000-01-23T04:56:07.000+00:00" }, "links" : { "key" : { "href" : "href", "type" : "type" } }, "linked" : { "key" : { "key" : "{}" } } }

Produces: API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header:

• application/json

Response: ItemDataListWrapper

GET /items/{id}/downstreamrelationships

Summary: Get all downstream relationships for the item with the specified ID

Path parameters:

• id (required)
  

Consumes: this API call consumes the following media types via the Content-Type request header:

• application/json

Request headers:

• xJamaDateFieldsWithTime (optional)
  

Query parameters:

• startAt (optional)
  
• maxResults (optional)
  If not set, this defaults to 20. This cannot be larger than 50
• include (optional)
  Links to include as full objects in the linked map

Examples:

• Example data, content-type: application/json
  
  { "data" : [ { "relationshipType" : 5, "fromItem" : 6, "id" : 0, "suspect" : true, "toItem" : 1 }, { "relationshipType" : 5, "fromItem" : 6, "id" : 0, "suspect" : true, "toItem" : 1 } ], "meta" : { "pageInfo" : { "startIndex" : 5, "resultCount" : 5, "totalResults" : 2 }, "status" : "OK", "timestamp" : "2000-01-23T04:56:07.000+00:00" }, "links" : { "key" : { "href" : "href", "type" : "type" } }, "linked" : { "key" : { "key" : "{}" } } }

Produces: API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header:

• application/json

Response: RelationshipDataListWrapper

GET /items/{id}

Summary: Get the item with the specified ID

Path parameters:

• id (required)
  

Consumes: this API call consumes the following media types via the Content-Type request header:

• application/json

Request headers:

• xJamaDateFieldsWithTime (optional)
  

Query parameters:

• include (optional)
  Links to include as full objects in the linked map

Examples:

• Example data, content-type: application/json
  
  { "data" : { "itemType" : 1, "globalId" : "globalId", "project" : 6, "resources" : { "key" : { "allowed" : [ "allowed", "allowed" ] } }, "childItemType" : 5, "createdDate" : "2000-01-23T04:56:07.000+00:00", "lastActivityDate" : "2000-01-23T04:56:07.000+00:00", "createdBy" : 5, "documentKey" : "documentKey", "modifiedDate" : "2000-01-23T04:56:07.000+00:00", "lock" : { "lockedBy" : 7, "lastLockedDate" : "2000-01-23T04:56:07.000+00:00", "locked" : true }, "modifiedBy" : 2, "location" : { "sequence" : "sequence", "parent" : { "item" : 4, "project" : 2 }, "sortOrder" : 9, "globalSortOrder" : 3 }, "id" : 0, "fields" : { "key" : "{}" }, "baselinedAppliedCategorySnapshots" : [ { "categoryPathSequence" : "categoryPathSequence", "itemVersionNumberApplied" : 2 }, { "categoryPathSequence" : "categoryPathSequence", "itemVersionNumberApplied" : 2 } ] }, "meta" : { "status" : "OK", "timestamp" : "2000-01-23T04:56:07.000+00:00" }, "links" : { "key" : { "href" : "href", "type" : "type" } }, "linked" : { "key" : { "key" : "{}" } } }

Produces: API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header:

• application/json

Response: ItemDataWrapper

GET /items/{id}/comments

Summary: Get all comments for the item with the specified ID

Path parameters:

• id (required)
  

Consumes: this API call consumes the following media types via the Content-Type request header:

• application/json

Request headers:

• xJamaDateFieldsWithTime (optional)
  

Query parameters:

• startAt (optional)
  
• maxResults (optional)
  If not set, this defaults to 20. This cannot be larger than 50
• rootCommentsOnly (optional)
  , default value: false
• include (optional)
  Links to include as full objects in the linked map

Examples:

• Example data, content-type: application/json
  
  { "data" : [ { "createdDate" : "2000-01-23T04:56:07.000+00:00", "deleted" : true, "createdBy" : 1, "inReplyTo" : 6, "commentType" : "GENERAL", "modifiedBy" : 5, "location" : { "item" : 5, "project" : 2 }, "id" : 0, "body" : { "text" : "text" }, "status" : "OPEN" }, { "createdDate" : "2000-01-23T04:56:07.000+00:00", "deleted" : true, "createdBy" : 1, "inReplyTo" : 6, "commentType" : "GENERAL", "modifiedBy" : 5, "location" : { "item" : 5, "project" : 2 }, "id" : 0, "body" : { "text" : "text" }, "status" : "OPEN" } ], "meta" : { "pageInfo" : { "startIndex" : 5, "resultCount" : 5, "totalResults" : 2 }, "status" : "OK", "timestamp" : "2000-01-23T04:56:07.000+00:00" }, "links" : { "key" : { "href" : "href", "type" : "type" } }, "linked" : { "key" : { "key" : "{}" } } }

Produces: API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header:

• application/json

Response: CommentDataListWrapper

GET /items/{id}/links

Summary: Get all links for the item with the specified ID

Path parameters:

• id (required)
  

Consumes: this API call consumes the following media types via the Content-Type request header:

• application/json

Request headers:

• xJamaDateFieldsWithTime (optional)
  

Query parameters:

• startAt (optional)
  
• maxResults (optional)
  If not set, this defaults to 20. This cannot be larger than 50
• include (optional)
  Links to include as full objects in the linked map

Examples:

• Example data, content-type: application/json
  
  { "data" : [ { "href" : "href", "type" : "type" }, { "href" : "href", "type" : "type" } ], "meta" : { "pageInfo" : { "startIndex" : 5, "resultCount" : 5, "totalResults" : 2 }, "status" : "OK", "timestamp" : "2000-01-23T04:56:07.000+00:00" }, "links" : { "key" : { "href" : "href", "type" : "type" } }, "linked" : { "key" : { "key" : "{}" } } }

Produces: API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header:

• application/json

Response: LinkDataListWrapper

GET /items

Summary: Get all items in the project with the specified ID

Consumes: this API call consumes the following media types via the Content-Type request header:

• application/json

Request headers:

• xJamaDateFieldsWithTime (optional)
  

Query parameters:

• project (required)
  
• rootOnly (optional)
  Set this to true to only get root-level nodes from the item tree
• startAt (optional)
  
• maxResults (optional)
  If not set, this defaults to 20. This cannot be larger than 50
• include (optional)
  Links to include as full objects in the linked map

Examples:

• Example data, content-type: application/json
  
  { "data" : [ { "itemType" : 1, "globalId" : "globalId", "project" : 6, "resources" : { "key" : { "allowed" : [ "allowed", "allowed" ] } }, "childItemType" : 5, "createdDate" : "2000-01-23T04:56:07.000+00:00", "lastActivityDate" : "2000-01-23T04:56:07.000+00:00", "createdBy" : 5, "documentKey" : "documentKey", "modifiedDate" : "2000-01-23T04:56:07.000+00:00", "lock" : { "lockedBy" : 7, "lastLockedDate" : "2000-01-23T04:56:07.000+00:00", "locked" : true }, "modifiedBy" : 2, "location" : { "sequence" : "sequence", "parent" : { "item" : 4, "project" : 2 }, "sortOrder" : 9, "globalSortOrder" : 3 }, "id" : 0, "fields" : { "key" : "{}" }, "baselinedAppliedCategorySnapshots" : [ { "categoryPathSequence" : "categoryPathSequence", "itemVersionNumberApplied" : 2 }, { "categoryPathSequence" : "categoryPathSequence", "itemVersionNumberApplied" : 2 } ] }, { "itemType" : 1, "globalId" : "globalId", "project" : 6, "resources" : { "key" : { "allowed" : [ "allowed", "allowed" ] } }, "childItemType" : 5, "createdDate" : "2000-01-23T04:56:07.000+00:00", "lastActivityDate" : "2000-01-23T04:56:07.000+00:00", "createdBy" : 5, "documentKey" : "documentKey", "modifiedDate" : "2000-01-23T04:56:07.000+00:00", "lock" : { "lockedBy" : 7, "lastLockedDate" : "2000-01-23T04:56:07.000+00:00", "locked" : true }, "modifiedBy" : 2, "location" : { "sequence" : "sequence", "parent" : { "item" : 4, "project" : 2 }, "sortOrder" : 9, "globalSortOrder" : 3 }, "id" : 0, "fields" : { "key" : "{}" }, "baselinedAppliedCategorySnapshots" : [ { "categoryPathSequence" : "categoryPathSequence", "itemVersionNumberApplied" : 2 }, { "categoryPathSequence" : "categoryPathSequence", "itemVersionNumberApplied" : 2 } ] } ], "meta" : { "pageInfo" : { "startIndex" : 5, "resultCount" : 5, "totalResults" : 2 }, "status" : "OK", "timestamp" : "2000-01-23T04:56:07.000+00:00" }, "links" : { "key" : { "href" : "href", "type" : "type" } }, "linked" : { "key" : { "key" : "{}" } } }

Produces: API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header:

• application/json

Response: ItemDataListWrapper

GET /items/{id}/links/{linkId}

Summary: Get the link with the specified ID

Path parameters:

• linkId (required)
  
• id (required)
  

Consumes: this API call consumes the following media types via the Content-Type request header:

• application/json

Request headers:

• xJamaDateFieldsWithTime (optional)
  

Query parameters:

• include (optional)
  Links to include as full objects in the linked map

Examples:

• Example data, content-type: application/json
  
  { "data" : { "href" : "href", "type" : "type" }, "meta" : { "status" : "OK", "timestamp" : "2000-01-23T04:56:07.000+00:00" }, "links" : { "key" : { "href" : "href", "type" : "type" } }, "linked" : { "key" : { "key" : "{}" } } }

Produces: API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header:

• application/json

Response: LinkDataWrapper

GET /items/{id}/location

Summary: Get the location for the item with the specified ID

Path parameters:

• id (required)
  

Consumes: this API call consumes the following media types via the Content-Type request header:

• application/json

Request headers:

• xJamaDateFieldsWithTime (optional)
  

Query parameters:

• include (optional)
  Links to include as full objects in the linked map

Examples:

• Example data, content-type: application/json
  
  { "data" : { "sequence" : "sequence", "parent" : { "item" : 4, "project" : 2 }, "sortOrder" : 9, "globalSortOrder" : 3 }, "meta" : { "status" : "OK", "timestamp" : "2000-01-23T04:56:07.000+00:00" }, "links" : { "key" : { "href" : "href", "type" : "type" } }, "linked" : { "key" : { "key" : "{}" } } }

Produces: API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header:

• application/json

Response: LocationDataWrapper

GET /items/{id}/lock

Summary: Get the locked state, last locked date, and last locked by user for the item with the specified ID

Path parameters:

• id (required)
  

Consumes: this API call consumes the following media types via the Content-Type request header:

• application/json

Request headers:

• xJamaDateFieldsWithTime (optional)
  

Query parameters:

• include (optional)
  Links to include as full objects in the linked map

Examples:

• Example data, content-type: application/json
  
  { "data" : { "lockedBy" : 7, "lastLockedDate" : "2000-01-23T04:56:07.000+00:00", "locked" : true }, "meta" : { "status" : "OK", "timestamp" : "2000-01-23T04:56:07.000+00:00" }, "links" : { "key" : { "href" : "href", "type" : "type" } }, "linked" : { "key" : { "key" : "{}" } } }

Produces: API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header:

• application/json

Response: LockDataWrapper

GET /items/{id}/parent

Summary: Get the parent item for the item with the specified ID

Path parameters:

• id (required)
  

Consumes: this API call consumes the following media types via the Content-Type request header:

• application/json

Request headers:

• xJamaDateFieldsWithTime (optional)
  

Query parameters:

• include (optional)
  Links to include as full objects in the linked map

Examples:

• Example data, content-type: application/json
  
  { "data" : { "itemType" : 1, "globalId" : "globalId", "project" : 6, "resources" : { "key" : { "allowed" : [ "allowed", "allowed" ] } }, "childItemType" : 5, "createdDate" : "2000-01-23T04:56:07.000+00:00", "lastActivityDate" : "2000-01-23T04:56:07.000+00:00", "createdBy" : 5, "documentKey" : "documentKey", "modifiedDate" : "2000-01-23T04:56:07.000+00:00", "lock" : { "lockedBy" : 7, "lastLockedDate" : "2000-01-23T04:56:07.000+00:00", "locked" : true }, "modifiedBy" : 2, "location" : { "sequence" : "sequence", "parent" : { "item" : 4, "project" : 2 }, "sortOrder" : 9, "globalSortOrder" : 3 }, "id" : 0, "fields" : { "key" : "{}" }, "baselinedAppliedCategorySnapshots" : [ { "categoryPathSequence" : "categoryPathSequence", "itemVersionNumberApplied" : 2 }, { "categoryPathSequence" : "categoryPathSequence", "itemVersionNumberApplied" : 2 } ] }, "meta" : { "status" : "OK", "timestamp" : "2000-01-23T04:56:07.000+00:00" }, "links" : { "key" : { "href" : "href", "type" : "type" } }, "linked" : { "key" : { "key" : "{}" } } }

Produces: API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header:

• application/json

Response: ItemDataWrapper

GET /items/{id}/synceditems

Summary: Get all synchronized items for the item with the specified ID

Path parameters:

• id (required)
  

Consumes: this API call consumes the following media types via the Content-Type request header:

• application/json

Request headers:

• xJamaDateFieldsWithTime (optional)
  

Query parameters:

• startAt (optional)
  
• maxResults (optional)
  If not set, this defaults to 20. This cannot be larger than 50
• include (optional)
  Links to include as full objects in the linked map

Examples:

• Example data, content-type: application/json
  
  { "data" : [ { "itemType" : 1, "globalId" : "globalId", "project" : 6, "resources" : { "key" : { "allowed" : [ "allowed", "allowed" ] } }, "childItemType" : 5, "createdDate" : "2000-01-23T04:56:07.000+00:00", "lastActivityDate" : "2000-01-23T04:56:07.000+00:00", "createdBy" : 5, "documentKey" : "documentKey", "modifiedDate" : "2000-01-23T04:56:07.000+00:00", "lock" : { "lockedBy" : 7, "lastLockedDate" : "2000-01-23T04:56:07.000+00:00", "locked" : true }, "modifiedBy" : 2, "location" : { "sequence" : "sequence", "parent" : { "item" : 4, "project" : 2 }, "sortOrder" : 9, "globalSortOrder" : 3 }, "id" : 0, "fields" : { "key" : "{}" }, "baselinedAppliedCategorySnapshots" : [ { "categoryPathSequence" : "categoryPathSequence", "itemVersionNumberApplied" : 2 }, { "categoryPathSequence" : "categoryPathSequence", "itemVersionNumberApplied" : 2 } ] }, { "itemType" : 1, "globalId" : "globalId", "project" : 6, "resources" : { "key" : { "allowed" : [ "allowed", "allowed" ] } }, "childItemType" : 5, "createdDate" : "2000-01-23T04:56:07.000+00:00", "lastActivityDate" : "2000-01-23T04:56:07.000+00:00", "createdBy" : 5, "documentKey" : "documentKey", "modifiedDate" : "2000-01-23T04:56:07.000+00:00", "lock" : { "lockedBy" : 7, "lastLockedDate" : "2000-01-23T04:56:07.000+00:00", "locked" : true }, "modifiedBy" : 2, "location" : { "sequence" : "sequence", "parent" : { "item" : 4, "project" : 2 }, "sortOrder" : 9, "globalSortOrder" : 3 }, "id" : 0, "fields" : { "key" : "{}" }, "baselinedAppliedCategorySnapshots" : [ { "categoryPathSequence" : "categoryPathSequence", "itemVersionNumberApplied" : 2 }, { "categoryPathSequence" : "categoryPathSequence", "itemVersionNumberApplied" : 2 } ] } ], "meta" : { "pageInfo" : { "startIndex" : 5, "resultCount" : 5, "totalResults" : 2 }, "status" : "OK", "timestamp" : "2000-01-23T04:56:07.000+00:00" }, "links" : { "key" : { "href" : "href", "type" : "type" } }, "linked" : { "key" : { "key" : "{}" } } }

Produces: API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header:

• application/json

Response: ItemDataListWrapper

GET /items/{id}/synceditems/{syncedItemId}/syncstatus

Summary: Get the sync status for the synced item with the specified ID

Path parameters:

• syncedItemId (required)
  
• id (required)
  

Consumes: this API call consumes the following media types via the Content-Type request header:

• application/json

Request headers:

• xJamaDateFieldsWithTime (optional)
  

Query parameters:

• include (optional)
  Links to include as full objects in the linked map

Examples:

• Example data, content-type: application/json
  
  { "data" : { "inSync" : true, "collectionSummary" : { "totalMissing" : 6, "totalOutOfSync" : 1, "totalChildren" : 0 } }, "meta" : { "status" : "OK", "timestamp" : "2000-01-23T04:56:07.000+00:00" }, "links" : { "key" : { "href" : "href", "type" : "type" } }, "linked" : { "key" : { "key" : "{}" } } }

Produces: API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header:

• application/json

Response: SyncStatusDataWrapper

GET /items/{id}/tags/{tagId}

Summary: Get the tag with the specified ID

Path parameters:

• tagId (required)
  
• id (required)
  

Consumes: this API call consumes the following media types via the Content-Type request header:

• application/json

Request headers:

• xJamaDateFieldsWithTime (optional)
  

Query parameters:

• include (optional)
  Links to include as full objects in the linked map

Examples:

• Example data, content-type: application/json
  
  { "data" : { "name" : "name", "project" : 6, "id" : 0 }, "meta" : { "status" : "OK", "timestamp" : "2000-01-23T04:56:07.000+00:00" }, "links" : { "key" : { "href" : "href", "type" : "type" } }, "linked" : { "key" : { "key" : "{}" } } }

Produces: API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header:

• application/json

Response: TagDataWrapper

GET /items/{id}/tags

Summary: Get all tags for the item with the specified ID

Path parameters:

• id (required)
  

Consumes: this API call consumes the following media types via the Content-Type request header:

• application/json

Request headers:

• xJamaDateFieldsWithTime (optional)
  

Query parameters:

• startAt (optional)
  
• maxResults (optional)
  If not set, this defaults to 20. This cannot be larger than 50
• include (optional)
  Links to include as full objects in the linked map

Examples:

• Example data, content-type: application/json
  
  { "data" : [ { "name" : "name", "project" : 6, "id" : 0 }, { "name" : "name", "project" : 6, "id" : 0 } ], "meta" : { "pageInfo" : { "startIndex" : 5, "resultCount" : 5, "totalResults" : 2 }, "status" : "OK", "timestamp" : "2000-01-23T04:56:07.000+00:00" }, "links" : { "key" : { "href" : "href", "type" : "type" } }, "linked" : { "key" : { "key" : "{}" } } }

Produces: API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header:

• application/json

Response: TagDataListWrapper

GET /items/{id}/upstreamrelated

Summary: Get all upstream related items for the item with the specified ID

Path parameters:

• id (required)
  

Consumes: this API call consumes the following media types via the Content-Type request header:

• application/json

Request headers:

• xJamaDateFieldsWithTime (optional)
  

Query parameters:

• startAt (optional)
  
• maxResults (optional)
  If not set, this defaults to 20. This cannot be larger than 50
• include (optional)
  Links to include as full objects in the linked map

Examples:

• Example data, content-type: application/json
  
  { "data" : [ { "itemType" : 1, "globalId" : "globalId", "project" : 6, "resources" : { "key" : { "allowed" : [ "allowed", "allowed" ] } }, "childItemType" : 5, "createdDate" : "2000-01-23T04:56:07.000+00:00", "lastActivityDate" : "2000-01-23T04:56:07.000+00:00", "createdBy" : 5, "documentKey" : "documentKey", "modifiedDate" : "2000-01-23T04:56:07.000+00:00", "lock" : { "lockedBy" : 7, "lastLockedDate" : "2000-01-23T04:56:07.000+00:00", "locked" : true }, "modifiedBy" : 2, "location" : { "sequence" : "sequence", "parent" : { "item" : 4, "project" : 2 }, "sortOrder" : 9, "globalSortOrder" : 3 }, "id" : 0, "fields" : { "key" : "{}" }, "baselinedAppliedCategorySnapshots" : [ { "categoryPathSequence" : "categoryPathSequence", "itemVersionNumberApplied" : 2 }, { "categoryPathSequence" : "categoryPathSequence", "itemVersionNumberApplied" : 2 } ] }, { "itemType" : 1, "globalId" : "globalId", "project" : 6, "resources" : { "key" : { "allowed" : [ "allowed", "allowed" ] } }, "childItemType" : 5, "createdDate" : "2000-01-23T04:56:07.000+00:00", "lastActivityDate" : "2000-01-23T04:56:07.000+00:00", "createdBy" : 5, "documentKey" : "documentKey", "modifiedDate" : "2000-01-23T04:56:07.000+00:00", "lock" : { "lockedBy" : 7, "lastLockedDate" : "2000-01-23T04:56:07.000+00:00", "locked" : true }, "modifiedBy" : 2, "location" : { "sequence" : "sequence", "parent" : { "item" : 4, "project" : 2 }, "sortOrder" : 9, "globalSortOrder" : 3 }, "id" : 0, "fields" : { "key" : "{}" }, "baselinedAppliedCategorySnapshots" : [ { "categoryPathSequence" : "categoryPathSequence", "itemVersionNumberApplied" : 2 }, { "categoryPathSequence" : "categoryPathSequence", "itemVersionNumberApplied" : 2 } ] } ], "meta" : { "pageInfo" : { "startIndex" : 5, "resultCount" : 5, "totalResults" : 2 }, "status" : "OK", "timestamp" : "2000-01-23T04:56:07.000+00:00" }, "links" : { "key" : { "href" : "href", "type" : "type" } }, "linked" : { "key" : { "key" : "{}" } } }

Produces: API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header:

• application/json

Response: ItemDataListWrapper

GET /items/{id}/upstreamrelationships

Summary: Get all upstream relationships for the item with the specified ID

Path parameters:

• id (required)
  

Consumes: this API call consumes the following media types via the Content-Type request header:

• application/json

Request headers:

• xJamaDateFieldsWithTime (optional)
  

Query parameters:

• startAt (optional)
  
• maxResults (optional)
  If not set, this defaults to 20. This cannot be larger than 50
• include (optional)
  Links to include as full objects in the linked map

Examples:

• Example data, content-type: application/json
  
  { "data" : [ { "relationshipType" : 5, "fromItem" : 6, "id" : 0, "suspect" : true, "toItem" : 1 }, { "relationshipType" : 5, "fromItem" : 6, "id" : 0, "suspect" : true, "toItem" : 1 } ], "meta" : { "pageInfo" : { "startIndex" : 5, "resultCount" : 5, "totalResults" : 2 }, "status" : "OK", "timestamp" : "2000-01-23T04:56:07.000+00:00" }, "links" : { "key" : { "href" : "href", "type" : "type" } }, "linked" : { "key" : { "key" : "{}" } } }

Produces: API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header:

• application/json

Response: RelationshipDataListWrapper

GET /items/{id}/versions/{versionNum}

Summary: Get the numbered version for the item with the specified ID

Path parameters:

• versionNum (required)
  
• id (required)
  

Consumes: this API call consumes the following media types via the Content-Type request header:

• application/json

Request headers:

• xJamaDateFieldsWithTime (optional)
  

Query parameters:

• include (optional)
  Links to include as full objects in the linked map

Examples:

• Example data, content-type: application/json
  
  { "data" : { "item" : 6, "createdDate" : "2000-01-23T04:56:07.000+00:00", "versionedItem" : [ 0, 0 ], "createdBy" : 5, "comment" : "comment", "type" : "type", "userName" : "userName", "versionNumber" : 1, "changeDetails" : "changeDetails" }, "meta" : { "status" : "OK", "timestamp" : "2000-01-23T04:56:07.000+00:00" }, "links" : { "key" : { "href" : "href", "type" : "type" } }, "linked" : { "key" : { "key" : "{}" } } }

Produces: API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header:

• application/json

Response: VersionDataWrapper

GET /items/{id}/versionedcategories

Summary: Get all versioned categories for the item with the specified version number

Path parameters:

• id (required)
  

Consumes: this API call consumes the following media types via the Content-Type request header:

• application/json

Query parameters:

• versionNumber (optional)
  
• startAt (optional)
  , default value: 0
• maxResults (optional)
  , default value: 50

Examples:

• Example data, content-type: application/json
  
  { "headers" : { "key" : [ "headers", "headers" ] }, "pageInfo" : { "startIndex" : 5, "resultCount" : 5, "totalResults" : 2 }, "statusReasonPhrase" : "statusReasonPhrase", "status" : 0 }

Produces: API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header:

• application/json

Response: AbstractRestResponse

GET /items/{id}/versions/{versionNum}/versioneditem

Summary: Get the snapshot of the item at the specified version

Path parameters:

• versionNum (required)
  
• id (required)
  

Consumes: this API call consumes the following media types via the Content-Type request header:

• application/json

Request headers:

• xJamaDateFieldsWithTime (optional)
  

Query parameters:

• include (optional)
  Links to include as full objects in the linked map

Examples:

• Example data, content-type: application/json
  
  { "data" : { "itemType" : 5, "globalId" : "globalId", "project" : 5, "resources" : { "key" : { "allowed" : [ "allowed", "allowed" ] } }, "childItemType" : 2, "version" : 0, "currentVersion" : 6, "createdDate" : "2000-01-23T04:56:07.000+00:00", "lastActivityDate" : "2000-01-23T04:56:07.000+00:00", "createdBy" : 7, "documentKey" : "documentKey", "modifiedDate" : "2000-01-23T04:56:07.000+00:00", "modifiedBy" : 9, "id" : 1, "fields" : { "key" : "{}" }, "baselinedAppliedCategorySnapshots" : [ { "categoryPathSequence" : "categoryPathSequence", "itemVersionNumberApplied" : 2 }, { "categoryPathSequence" : "categoryPathSequence", "itemVersionNumberApplied" : 2 } ] }, "meta" : { "status" : "OK", "timestamp" : "2000-01-23T04:56:07.000+00:00" }, "links" : { "key" : { "href" : "href", "type" : "type" } }, "linked" : { "key" : { "key" : "{}" } } }

Produces: API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header:

• application/json

Response: VersionedItemDataWrapper

GET /items/{id}/versions

Summary: Get all versions for the item with the specified ID

Path parameters:

• id (required)
  

Consumes: this API call consumes the following media types via the Content-Type request header:

• application/json

Request headers:

• xJamaDateFieldsWithTime (optional)
  

Query parameters:

• startAt (optional)
  
• maxResults (optional)
  If not set, this defaults to 20. This cannot be larger than 50
• include (optional)
  Links to include as full objects in the linked map

Examples:

• Example data, content-type: application/json
  
  { "data" : [ { "item" : 6, "createdDate" : "2000-01-23T04:56:07.000+00:00", "versionedItem" : [ 0, 0 ], "createdBy" : 5, "comment" : "comment", "type" : "type", "userName" : "userName", "versionNumber" : 1, "changeDetails" : "changeDetails" }, { "item" : 6, "createdDate" : "2000-01-23T04:56:07.000+00:00", "versionedItem" : [ 0, 0 ], "createdBy" : 5, "comment" : "comment", "type" : "type", "userName" : "userName", "versionNumber" : 1, "changeDetails" : "changeDetails" } ], "meta" : { "pageInfo" : { "startIndex" : 5, "resultCount" : 5, "totalResults" : 2 }, "status" : "OK", "timestamp" : "2000-01-23T04:56:07.000+00:00" }, "links" : { "key" : { "href" : "href", "type" : "type" } }, "linked" : { "key" : { "key" : "{}" } } }

Produces: API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header:

• application/json

Response: VersionDataListWrapper

GET /items/{id}/workflowtransitionoptions

Summary: Get all valid workflow transitions that can be made on the item with the specified ID

Path parameters:

• id (required)
  

Consumes: this API call consumes the following media types via the Content-Type request header:

• application/json

Request headers:

• xJamaDateFieldsWithTime (optional)
  

Query parameters:

• startAt (optional)
  
• maxResults (optional)
  If not set, this defaults to 20. This cannot be larger than 50
• include (optional)
  Links to include as full objects in the linked map

Examples:

• Example data, content-type: application/json
  
  { "data" : [ { "newStatus" : 0, "action" : "action", "id" : "id" }, { "newStatus" : 0, "action" : "action", "id" : "id" } ], "meta" : { "pageInfo" : { "startIndex" : 5, "resultCount" : 5, "totalResults" : 2 }, "status" : "OK", "timestamp" : "2000-01-23T04:56:07.000+00:00" }, "links" : { "key" : { "href" : "href", "type" : "type" } }, "linked" : { "key" : { "key" : "{}" } } }

Produces: API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header:

• application/json

Response: WorkflowTransitionDataListWrapper

PUT /items/{treeLocation}

Summary:

Consumes: this API call consumes the following media types via the Content-Type request header:

• application/json

Body:

TreeLocationRequest

Examples:

• Example data, content-type: application/json
  
  { "headers" : { "key" : [ "headers", "headers" ] }, "pageInfo" : { "startIndex" : 5, "resultCount" : 5, "totalResults" : 2 }, "statusReasonPhrase" : "statusReasonPhrase", "status" : 0 }

Produces: API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header:

• application/json

Response: AbstractRestResponse

PATCH /items/{id}

Summary: Update the item with the specified ID

Path parameters:

• id (required)
  

Consumes: this API call consumes the following media types via the Content-Type request header:

• application/json

Body:

array[RequestPatchOperation]

Query parameters:

• returnItem (optional)
  , default value: false

Examples:

• Example data, content-type: application/json
  
  { "headers" : { "key" : [ "headers", "headers" ] }, "pageInfo" : { "startIndex" : 5, "resultCount" : 5, "totalResults" : 2 }, "statusReasonPhrase" : "statusReasonPhrase", "status" : 0 }

Produces: API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header:

• application/json

Response: AbstractRestResponse

PATCH /items

Summary: Update the items with the specified ID as an asynchronous request (a successful response signifies that the work was started and a work identifier is given. This identifier will be used in a future feature)

Consumes: this API call consumes the following media types via the Content-Type request header:

• application/json

Body:

array[RequestItemsPatchOperations]

Examples:

• Example data, content-type: application/json
  
  { "headers" : { "key" : [ "headers", "headers" ] }, "payload" : "{}", "pageInfo" : { "startIndex" : 5, "resultCount" : 5, "totalResults" : 2 }, "type" : "type", "statusReasonPhrase" : "statusReasonPhrase", "status" : 0, "linked" : { "key" : { "key" : "{}" } } }

Produces: API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header:

• application/json

Response: ObjectResponse

Response: BadRequestResponse

PUT /items/{id}

Summary: Update the item with the specified ID

Path parameters:

• id (required)
  

Consumes: this API call consumes the following media types via the Content-Type request header:

• application/json

Body:

RequestItem

Query parameters:

• setGlobalIdManually (optional)
  This value must be set to true if you attempt to manually set the Global ID field of an item

Examples:

• Example data, content-type: application/json
  
  { "headers" : { "key" : [ "headers", "headers" ] }, "pageInfo" : { "startIndex" : 5, "resultCount" : 5, "totalResults" : 2 }, "statusReasonPhrase" : "statusReasonPhrase", "status" : 0 }

Produces: API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header:

• application/json

Response: AbstractRestResponse

DELETE /items/{id}/attachments/{attachmentId}

Summary: Remove an existing attachment from the item

Path parameters:

• attachmentId (required)
  
• id (required)
  

Consumes: this API call consumes the following media types via the Content-Type request header:

• application/json

Examples:

• Example data, content-type: application/json
  
  { "headers" : { "key" : [ "headers", "headers" ] }, "pageInfo" : { "startIndex" : 5, "resultCount" : 5, "totalResults" : 2 }, "statusReasonPhrase" : "statusReasonPhrase", "status" : 0 }

Produces: API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header:

• application/json

Response: AbstractRestResponse

DELETE /items/{id}/tags/{tagId}

Summary: Remove an existing tag from the item with the specified ID

Path parameters:

• tagId (required)
  
• id (required)
  

Consumes: this API call consumes the following media types via the Content-Type request header:

• application/json

Examples:

• Example data, content-type: application/json
  
  { "headers" : { "key" : [ "headers", "headers" ] }, "pageInfo" : { "startIndex" : 5, "resultCount" : 5, "totalResults" : 2 }, "statusReasonPhrase" : "statusReasonPhrase", "status" : 0 }

Produces: API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header:

• application/json

Response: AbstractRestResponse

PUT /items/{id}/links/{linkId}

Summary: Update the link with the specified ID

Path parameters:

• linkId (required)
  
• id (required)
  

Consumes: this API call consumes the following media types via the Content-Type request header:

• application/json

Body:

RequestLink

Examples:

• Example data, content-type: application/json
  
  { "headers" : { "key" : [ "headers", "headers" ] }, "pageInfo" : { "startIndex" : 5, "resultCount" : 5, "totalResults" : 2 }, "statusReasonPhrase" : "statusReasonPhrase", "status" : 0 }

Produces: API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header:

• application/json

Response: AbstractRestResponse

PUT /items/{id}/location

Summary: Update the location for the item with the specified ID as an asynchronous request (a successful response signifies that the work was started and a work identifier is given. This identifier will be used in a future feature). Any child items are moved along with this item. Note that this currently only supports moving items between projects

Path parameters:

• id (required)
  

Consumes: this API call consumes the following media types via the Content-Type request header:

• application/json

Body:

RequestMoveLocation

Examples:

• Example data, content-type: application/json
  
  { "headers" : { "key" : [ "headers", "headers" ] }, "pageInfo" : { "startIndex" : 5, "resultCount" : 5, "totalResults" : 2 }, "statusReasonPhrase" : "statusReasonPhrase", "status" : 0 }

Produces: API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header:

• application/json

Response: AbstractRestResponse

PUT /items/{id}/lock

Summary: Update the locked state of the item with the specified ID

Path parameters:

• id (required)
  

Consumes: this API call consumes the following media types via the Content-Type request header:

• application/json

Body:

RequestLock

Examples:

• Example data, content-type: application/json
  
  { "headers" : { "key" : [ "headers", "headers" ] }, "pageInfo" : { "startIndex" : 5, "resultCount" : 5, "totalResults" : 2 }, "statusReasonPhrase" : "statusReasonPhrase", "status" : 0 }

Produces: API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header:

• application/json

Response: AbstractRestResponse

Endpoint itemtypes

The itemtypes endpoint has the following operations:

1. POST /itemtypes/{itemTypeId}/fields
2. POST /itemtypes
3. GET /itemtypes/{itemTypeId}
4. GET /itemtypes

Below is more detail for each of the operations of the itemtypes endpoint.

POST /itemtypes/{itemTypeId}/fields

Summary: Create a new item type field for the item type with the specified ID

Path parameters:

• itemTypeId (required)
  

Consumes: this API call consumes the following media types via the Content-Type request header:

• application/json

Body:

RequestItemTypeField

Examples:

• Example data, content-type: application/json
  
  { "headers" : { "key" : [ "headers", "headers" ] }, "pageInfo" : { "startIndex" : 5, "resultCount" : 5, "totalResults" : 2 }, "statusReasonPhrase" : "statusReasonPhrase", "status" : 0 }

Produces: API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header:

• application/json

Response: AbstractRestResponse

POST /itemtypes

Summary: Create a new item type

Consumes: this API call consumes the following media types via the Content-Type request header:

• application/json

Body:

RequestItemType

Examples:

• Example data, content-type: application/json
  
  { "headers" : { "key" : [ "headers", "headers" ] }, "pageInfo" : { "startIndex" : 5, "resultCount" : 5, "totalResults" : 2 }, "statusReasonPhrase" : "statusReasonPhrase", "status" : 0 }

Produces: API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header:

• application/json

Response: AbstractRestResponse

GET /itemtypes/{itemTypeId}

Summary: Get the item type with the specified ID

Path parameters:

• itemTypeId (required)
  

Consumes: this API call consumes the following media types via the Content-Type request header:

• application/json

Request headers:

• xJamaDateFieldsWithTime (optional)
  

Query parameters:

• include (optional)
  Links to include as full objects in the linked map

Examples:

• Example data, content-type: application/json
  
  { "data" : { "image" : "image", "typeKey" : "typeKey", "system" : true, "display" : "display", "description" : "description", "id" : 0, "category" : "CORE", "widgets" : [ { "name" : "ACTIVITIES", "synchronize" : true }, { "name" : "ACTIVITIES", "synchronize" : true } ], "fields" : [ { "readOnlyAllowApiOverwrite" : true, "itemType" : 5, "pickList" : 1, "name" : "name", "readOnly" : true, "textType" : "TEXTAREA", "id" : 6, "label" : "label", "fieldType" : "INTEGER", "required" : true, "triggerSuspect" : true, "synchronize" : true }, { "readOnlyAllowApiOverwrite" : true, "itemType" : 5, "pickList" : 1, "name" : "name", "readOnly" : true, "textType" : "TEXTAREA", "id" : 6, "label" : "label", "fieldType" : "INTEGER", "required" : true, "triggerSuspect" : true, "synchronize" : true } ], "displayPlural" : "displayPlural" }, "meta" : { "status" : "OK", "timestamp" : "2000-01-23T04:56:07.000+00:00" }, "links" : { "key" : { "href" : "href", "type" : "type" } }, "linked" : { "key" : { "key" : "{}" } } }

Produces: API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header:

• application/json

Response: ItemTypeDataWrapper

GET /itemtypes

Summary: Get all item types

Consumes: this API call consumes the following media types via the Content-Type request header:

• application/json

Request headers:

• xJamaDateFieldsWithTime (optional)
  

Query parameters:

• startAt (optional)
  
• maxResults (optional)
  If not set, this defaults to 20. This cannot be larger than 50
• include (optional)
  Links to include as full objects in the linked map

Examples:

• Example data, content-type: application/json
  
  { "data" : [ { "image" : "image", "typeKey" : "typeKey", "system" : true, "display" : "display", "description" : "description", "id" : 0, "category" : "CORE", "widgets" : [ { "name" : "ACTIVITIES", "synchronize" : true }, { "name" : "ACTIVITIES", "synchronize" : true } ], "fields" : [ { "readOnlyAllowApiOverwrite" : true, "itemType" : 5, "pickList" : 1, "name" : "name", "readOnly" : true, "textType" : "TEXTAREA", "id" : 6, "label" : "label", "fieldType" : "INTEGER", "required" : true, "triggerSuspect" : true, "synchronize" : true }, { "readOnlyAllowApiOverwrite" : true, "itemType" : 5, "pickList" : 1, "name" : "name", "readOnly" : true, "textType" : "TEXTAREA", "id" : 6, "label" : "label", "fieldType" : "INTEGER", "required" : true, "triggerSuspect" : true, "synchronize" : true } ], "displayPlural" : "displayPlural" }, { "image" : "image", "typeKey" : "typeKey", "system" : true, "display" : "display", "description" : "description", "id" : 0, "category" : "CORE", "widgets" : [ { "name" : "ACTIVITIES", "synchronize" : true }, { "name" : "ACTIVITIES", "synchronize" : true } ], "fields" : [ { "readOnlyAllowApiOverwrite" : true, "itemType" : 5, "pickList" : 1, "name" : "name", "readOnly" : true, "textType" : "TEXTAREA", "id" : 6, "label" : "label", "fieldType" : "INTEGER", "required" : true, "triggerSuspect" : true, "synchronize" : true }, { "readOnlyAllowApiOverwrite" : true, "itemType" : 5, "pickList" : 1, "name" : "name", "readOnly" : true, "textType" : "TEXTAREA", "id" : 6, "label" : "label", "fieldType" : "INTEGER", "required" : true, "triggerSuspect" : true, "synchronize" : true } ], "displayPlural" : "displayPlural" } ], "meta" : { "pageInfo" : { "startIndex" : 5, "resultCount" : 5, "totalResults" : 2 }, "status" : "OK", "timestamp" : "2000-01-23T04:56:07.000+00:00" }, "links" : { "key" : { "href" : "href", "type" : "type" } }, "linked" : { "key" : { "key" : "{}" } } }

Produces: API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header:

• application/json

Response: ItemTypeDataListWrapper

Endpoint picklistoptions

The picklistoptions endpoint has the following operations:

1. GET /picklistoptions/{picklistOptionId}
2. PUT /picklistoptions/{picklistOptionId}

Below is more detail for each of the operations of the picklistoptions endpoint.

GET /picklistoptions/{picklistOptionId}

Summary: Get the pick list option with the specified ID

Path parameters:

• picklistOptionId (required)
  

Consumes: this API call consumes the following media types via the Content-Type request header:

• application/json

Request headers:

• xJamaDateFieldsWithTime (optional)
  

Query parameters:

• include (optional)
  Links to include as full objects in the linked map

Examples:

• Example data, content-type: application/json
  
  { "data" : { "archived" : true, "default" : true, "color" : "color", "pickList" : 0, "sortOrder" : 1, "name" : "name", "description" : "description", "active" : true, "id" : 6, "value" : "value" }, "meta" : { "status" : "OK", "timestamp" : "2000-01-23T04:56:07.000+00:00" }, "links" : { "key" : { "href" : "href", "type" : "type" } }, "linked" : { "key" : { "key" : "{}" } } }

Produces: API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header:

• application/json

Response: PickListOptionDataWrapper

PUT /picklistoptions/{picklistOptionId}

Summary: Update the pick list option with the specified ID

Path parameters:

• picklistOptionId (required)
  

Consumes: this API call consumes the following media types via the Content-Type request header:

• application/json

Body:

RequestPickListOption

Examples:

• Example data, content-type: application/json
  
  { "headers" : { "key" : [ "headers", "headers" ] }, "pageInfo" : { "startIndex" : 5, "resultCount" : 5, "totalResults" : 2 }, "statusReasonPhrase" : "statusReasonPhrase", "status" : 0 }

Produces: API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header:

• application/json

Response: AbstractRestResponse

Endpoint picklists

The picklists endpoint has the following operations:

1. POST /picklists/{picklistId}/options
2. POST /picklists
3. DELETE /picklists/{picklistId}
4. GET /picklists/{picklistId}
5. GET /picklists/{picklistId}/options
6. GET /picklists

Below is more detail for each of the operations of the picklists endpoint.

POST /picklists/{picklistId}/options

Summary: Create a new pick list option for the pick list with the specified ID

Path parameters:

• picklistId (required)
  

Consumes: this API call consumes the following media types via the Content-Type request header:

• application/json

Body:

RequestPickListOption

Examples:

• Example data, content-type: application/json
  
  { "headers" : { "key" : [ "headers", "headers" ] }, "pageInfo" : { "startIndex" : 5, "resultCount" : 5, "totalResults" : 2 }, "location" : "http://example.com/aeiou", "id" : 6, "statusReasonPhrase" : "statusReasonPhrase", "status" : 0 }

Produces: API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header:

• application/json

Response: CreatedResponse

POST /picklists

Summary: Create a new pick list

Consumes: this API call consumes the following media types via the Content-Type request header:

• application/json

Body:

RequestPickList

Examples:

• Example data, content-type: application/json
  
  { "headers" : { "key" : [ "headers", "headers" ] }, "pageInfo" : { "startIndex" : 5, "resultCount" : 5, "totalResults" : 2 }, "statusReasonPhrase" : "statusReasonPhrase", "status" : 0 }

Produces: API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header:

• application/json

Response: AbstractRestResponse

DELETE /picklists/{picklistId}

Summary: Delete the pick list

Path parameters:

• picklistId (required)
  

Consumes: this API call consumes the following media types via the Content-Type request header:

• application/json

Examples:

• Example data, content-type: application/json
  
  { "headers" : { "key" : [ "headers", "headers" ] }, "pageInfo" : { "startIndex" : 5, "resultCount" : 5, "totalResults" : 2 }, "statusReasonPhrase" : "statusReasonPhrase", "status" : 0 }

Produces: API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header:

• application/json

Response: AbstractRestResponse

GET /picklists/{picklistId}

Summary: Get the pick list with the specified ID

Path parameters:

• picklistId (required)
  

Consumes: this API call consumes the following media types via the Content-Type request header:

• application/json

Request headers:

• xJamaDateFieldsWithTime (optional)
  

Query parameters:

• include (optional)
  Links to include as full objects in the linked map

Examples:

• Example data, content-type: application/json
  
  { "data" : { "name" : "name", "description" : "description", "id" : 0, "type" : "type" }, "meta" : { "status" : "OK", "timestamp" : "2000-01-23T04:56:07.000+00:00" }, "links" : { "key" : { "href" : "href", "type" : "type" } }, "linked" : { "key" : { "key" : "{}" } } }

Produces: API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header:

• application/json

Response: PickListDataWrapper

GET /picklists/{picklistId}/options

Summary: Get all pick list options for the pick list with the specified ID

Path parameters:

• picklistId (required)
  

Consumes: this API call consumes the following media types via the Content-Type request header:

• application/json

Request headers:

• xJamaDateFieldsWithTime (optional)
  

Query parameters:

• startAt (optional)
  
• maxResults (optional)
  If not set, this defaults to 20. This cannot be larger than 50
• include (optional)
  Links to include as full objects in the linked map

Examples:

• Example data, content-type: application/json
  
  { "data" : [ { "archived" : true, "default" : true, "color" : "color", "pickList" : 0, "sortOrder" : 1, "name" : "name", "description" : "description", "active" : true, "id" : 6, "value" : "value" }, { "archived" : true, "default" : true, "color" : "color", "pickList" : 0, "sortOrder" : 1, "name" : "name", "description" : "description", "active" : true, "id" : 6, "value" : "value" } ], "meta" : { "pageInfo" : { "startIndex" : 5, "resultCount" : 5, "totalResults" : 2 }, "status" : "OK", "timestamp" : "2000-01-23T04:56:07.000+00:00" }, "links" : { "key" : { "href" : "href", "type" : "type" } }, "linked" : { "key" : { "key" : "{}" } } }

Produces: API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header:

• application/json

Response: PickListOptionDataListWrapper

GET /picklists

Summary: Get all pick lists

Consumes: this API call consumes the following media types via the Content-Type request header:

• application/json

Request headers:

• xJamaDateFieldsWithTime (optional)
  

Query parameters:

• startAt (optional)
  
• maxResults (optional)
  If not set, this defaults to 20. This cannot be larger than 50
• include (optional)
  Links to include as full objects in the linked map

Examples:

• Example data, content-type: application/json
  
  { "data" : [ { "name" : "name", "description" : "description", "id" : 0, "type" : "type" }, { "name" : "name", "description" : "description", "id" : 0, "type" : "type" } ], "meta" : { "pageInfo" : { "startIndex" : 5, "resultCount" : 5, "totalResults" : 2 }, "status" : "OK", "timestamp" : "2000-01-23T04:56:07.000+00:00" }, "links" : { "key" : { "href" : "href", "type" : "type" } }, "linked" : { "key" : { "key" : "{}" } } }

Produces: API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header:

• application/json

Response: PickListDataListWrapper

Endpoint projects

The projects endpoint has the following operations:

1. PUT /projects/{projectId}/itemtypes/{itemTypeId}
2. POST /projects
3. GET /projects/{projectId}/itemtypes
4. GET /projects/{projectId}
5. GET /projects
6. GET /projects/{projectId}/tags
7. POST /projects/{projectId}/attachments
8. PUT /projects/{projectId}
9. DELETE /projects/{projectId}/itemtypes/{itemTypeId}

Below is more detail for each of the operations of the projects endpoint.

PUT /projects/{projectId}/itemtypes/{itemTypeId}

Summary: Add an Item Type to a Project

Path parameters:

• itemTypeId (required)
  
• projectId (required)
  

Consumes: this API call consumes the following media types via the Content-Type request header:

• application/json

Examples:

• Example data, content-type: application/json
  
  { "headers" : { "key" : [ "headers", "headers" ] }, "pageInfo" : { "startIndex" : 5, "resultCount" : 5, "totalResults" : 2 }, "statusReasonPhrase" : "statusReasonPhrase", "status" : 0 }

Produces: API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header:

• application/json

Response: AbstractRestResponse

POST /projects

Summary: Create a new project

Consumes: this API call consumes the following media types via the Content-Type request header:

• application/json

Body:

RequestProject

Examples:

• Example data, content-type: application/json
  
  { "headers" : { "key" : [ "headers", "headers" ] }, "pageInfo" : { "startIndex" : 5, "resultCount" : 5, "totalResults" : 2 }, "location" : "http://example.com/aeiou", "id" : 6, "statusReasonPhrase" : "statusReasonPhrase", "status" : 0 }

Produces: API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header:

• application/json

Response: CreatedResponse

GET /projects/{projectId}/itemtypes

Summary: Get all item types for the project with the specified ID

Path parameters:

• projectId (required)
  

Consumes: this API call consumes the following media types via the Content-Type request header:

• application/json

Request headers:

• xJamaDateFieldsWithTime (optional)
  

Query parameters:

• startAt (optional)
  
• maxResults (optional)
  If not set, this defaults to 20. This cannot be larger than 50
• include (optional)
  Links to include as full objects in the linked map

Examples:

• Example data, content-type: application/json
  
  { "data" : [ { "image" : "image", "typeKey" : "typeKey", "system" : true, "display" : "display", "description" : "description", "id" : 0, "category" : "CORE", "widgets" : [ { "name" : "ACTIVITIES", "synchronize" : true }, { "name" : "ACTIVITIES", "synchronize" : true } ], "fields" : [ { "readOnlyAllowApiOverwrite" : true, "itemType" : 5, "pickList" : 1, "name" : "name", "readOnly" : true, "textType" : "TEXTAREA", "id" : 6, "label" : "label", "fieldType" : "INTEGER", "required" : true, "triggerSuspect" : true, "synchronize" : true }, { "readOnlyAllowApiOverwrite" : true, "itemType" : 5, "pickList" : 1, "name" : "name", "readOnly" : true, "textType" : "TEXTAREA", "id" : 6, "label" : "label", "fieldType" : "INTEGER", "required" : true, "triggerSuspect" : true, "synchronize" : true } ], "displayPlural" : "displayPlural" }, { "image" : "image", "typeKey" : "typeKey", "system" : true, "display" : "display", "description" : "description", "id" : 0, "category" : "CORE", "widgets" : [ { "name" : "ACTIVITIES", "synchronize" : true }, { "name" : "ACTIVITIES", "synchronize" : true } ], "fields" : [ { "readOnlyAllowApiOverwrite" : true, "itemType" : 5, "pickList" : 1, "name" : "name", "readOnly" : true, "textType" : "TEXTAREA", "id" : 6, "label" : "label", "fieldType" : "INTEGER", "required" : true, "triggerSuspect" : true, "synchronize" : true }, { "readOnlyAllowApiOverwrite" : true, "itemType" : 5, "pickList" : 1, "name" : "name", "readOnly" : true, "textType" : "TEXTAREA", "id" : 6, "label" : "label", "fieldType" : "INTEGER", "required" : true, "triggerSuspect" : true, "synchronize" : true } ], "displayPlural" : "displayPlural" } ], "meta" : { "pageInfo" : { "startIndex" : 5, "resultCount" : 5, "totalResults" : 2 }, "status" : "OK", "timestamp" : "2000-01-23T04:56:07.000+00:00" }, "links" : { "key" : { "href" : "href", "type" : "type" } }, "linked" : { "key" : { "key" : "{}" } } }

Produces: API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header:

• application/json

Response: ItemTypeDataListWrapper

GET /projects/{projectId}

Summary: Get the project with the specified ID

Path parameters:

• projectId (required)
  

Consumes: this API call consumes the following media types via the Content-Type request header:

• application/json

Request headers:

• xJamaDateFieldsWithTime (optional)
  

Query parameters:

• include (optional)
  Links to include as full objects in the linked map

Examples:

• Example data, content-type: application/json
  
  { "data" : { "parent" : 6, "projectKey" : "projectKey", "isFolder" : true, "createdDate" : "2000-01-23T04:56:07.000+00:00", "createdBy" : 1, "modifiedDate" : "2000-01-23T04:56:07.000+00:00", "modifiedBy" : 5, "id" : 0, "fields" : { "key" : "{}" } }, "meta" : { "status" : "OK", "timestamp" : "2000-01-23T04:56:07.000+00:00" }, "links" : { "key" : { "href" : "href", "type" : "type" } }, "linked" : { "key" : { "key" : "{}" } } }

Produces: API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header:

• application/json

Response: ProjectDataWrapper

GET /projects

Summary: Get all projects

Consumes: this API call consumes the following media types via the Content-Type request header:

• application/json

Request headers:

• xJamaDateFieldsWithTime (optional)
  

Query parameters:

• startAt (optional)
  
• maxResults (optional)
  If not set, this defaults to 20. This cannot be larger than 50
• include (optional)
  Links to include as full objects in the linked map

Examples:

• Example data, content-type: application/json
  
  { "data" : [ { "parent" : 6, "projectKey" : "projectKey", "isFolder" : true, "createdDate" : "2000-01-23T04:56:07.000+00:00", "createdBy" : 1, "modifiedDate" : "2000-01-23T04:56:07.000+00:00", "modifiedBy" : 5, "id" : 0, "fields" : { "key" : "{}" } }, { "parent" : 6, "projectKey" : "projectKey", "isFolder" : true, "createdDate" : "2000-01-23T04:56:07.000+00:00", "createdBy" : 1, "modifiedDate" : "2000-01-23T04:56:07.000+00:00", "modifiedBy" : 5, "id" : 0, "fields" : { "key" : "{}" } } ], "meta" : { "pageInfo" : { "startIndex" : 5, "resultCount" : 5, "totalResults" : 2 }, "status" : "OK", "timestamp" : "2000-01-23T04:56:07.000+00:00" }, "links" : { "key" : { "href" : "href", "type" : "type" } }, "linked" : { "key" : { "key" : "{}" } } }

Produces: API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header:

• application/json

Response: ProjectDataListWrapper

GET /projects/{projectId}/tags

Summary: Get all tags for the project with the specified ID

Path parameters:

• projectId (required)
  

Consumes: this API call consumes the following media types via the Content-Type request header:

• application/json

Request headers:

• xJamaDateFieldsWithTime (optional)
  

Query parameters:

• startAt (optional)
  
• maxResults (optional)
  If not set, this defaults to 20. This cannot be larger than 50
• include (optional)
  Links to include as full objects in the linked map

Examples:

• Example data, content-type: application/json
  
  { "data" : [ { "name" : "name", "project" : 6, "id" : 0 }, { "name" : "name", "project" : 6, "id" : 0 } ], "meta" : { "pageInfo" : { "startIndex" : 5, "resultCount" : 5, "totalResults" : 2 }, "status" : "OK", "timestamp" : "2000-01-23T04:56:07.000+00:00" }, "links" : { "key" : { "href" : "href", "type" : "type" } }, "linked" : { "key" : { "key" : "{}" } } }

Produces: API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header:

• application/json

Response: TagDataListWrapper

POST /projects/{projectId}/attachments

Summary: Create a new attachment in the project with the specified ID

Path parameters:

• projectId (required)
  

Consumes: this API call consumes the following media types via the Content-Type request header:

• application/json

Body:

RequestAttachment

Examples:

• Example data, content-type: application/json
  
  { "headers" : { "key" : [ "headers", "headers" ] }, "pageInfo" : { "startIndex" : 5, "resultCount" : 5, "totalResults" : 2 }, "location" : "http://example.com/aeiou", "id" : 6, "statusReasonPhrase" : "statusReasonPhrase", "status" : 0 }

Produces: API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header:

• application/json

Response: CreatedResponse

PUT /projects/{projectId}

Summary: Update the project with the specified ID

Path parameters:

• projectId (required)
  

Consumes: this API call consumes the following media types via the Content-Type request header:

• application/json

Body:

RequestProject

Examples:

• Example data, content-type: application/json
  
  { "headers" : { "key" : [ "headers", "headers" ] }, "pageInfo" : { "startIndex" : 5, "resultCount" : 5, "totalResults" : 2 }, "statusReasonPhrase" : "statusReasonPhrase", "status" : 0 }

Produces: API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header:

• application/json

Response: AbstractRestResponse

DELETE /projects/{projectId}/itemtypes/{itemTypeId}

Summary: Remove an Item Type from a Project

Path parameters:

• itemTypeId (required)
  
• projectId (required)
  

Consumes: this API call consumes the following media types via the Content-Type request header:

• application/json

Examples:

• Example data, content-type: application/json
  
  { "headers" : { "key" : [ "headers", "headers" ] }, "pageInfo" : { "startIndex" : 5, "resultCount" : 5, "totalResults" : 2 }, "statusReasonPhrase" : "statusReasonPhrase", "status" : 0 }

Produces: API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header:

• application/json

Response: AbstractRestResponse

Endpoint relationshiprulesets

The relationshiprulesets endpoint has the following operations:

1. GET /relationshiprulesets/{id}/projects
2. GET /relationshiprulesets
3. GET /relationshiprulesets/{id}

Below is more detail for each of the operations of the relationshiprulesets endpoint.

GET /relationshiprulesets/{id}/projects

Summary: Get Projects that have a given Relationship Rule Set assigned.

Path parameters:

• id (required)
  

Consumes: this API call consumes the following media types via the Content-Type request header:

• application/json

Request headers:

• xJamaDateFieldsWithTime (optional)
  

Query parameters:

• startAt (optional)
  
• maxResults (optional)
  If not set, this defaults to 20. This cannot be larger than 50

Examples:

• Example data, content-type: application/json
  
  { "organizationId" : 5, "projectKey" : "projectKey", "string1" : "string1", "name" : "name", "id" : 6, "mask" : 1 }

Produces: API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header:

• application/json

Response: ProjectPropertyDTO

GET /relationshiprulesets

Summary: Gets all Relationship Rule Sets in the organization

Consumes: this API call consumes the following media types via the Content-Type request header:

• application/json

Request headers:

• xJamaDateFieldsWithTime (optional)
  

Query parameters:

• startAt (optional)
  
• maxResults (optional)
  If not set, this defaults to 20. This cannot be larger than 50

Examples:

• Example data, content-type: application/json
  
  [ { "isExclusive" : true, "name" : "name", "rules" : [ { "forCoverage" : true, "fromItemTypeId" : 2, "relationshipTypeId" : 9, "id" : 5, "toItemTypeId" : 7 }, { "forCoverage" : true, "fromItemTypeId" : 2, "relationshipTypeId" : 9, "id" : 5, "toItemTypeId" : 7 } ], "id" : 0, "mappedProjects" : [ { "organizationId" : 5, "projectKey" : "projectKey", "string1" : "string1", "name" : "name", "id" : 6, "mask" : 1 }, { "organizationId" : 5, "projectKey" : "projectKey", "string1" : "string1", "name" : "name", "id" : 6, "mask" : 1 } ] }, { "isExclusive" : true, "name" : "name", "rules" : [ { "forCoverage" : true, "fromItemTypeId" : 2, "relationshipTypeId" : 9, "id" : 5, "toItemTypeId" : 7 }, { "forCoverage" : true, "fromItemTypeId" : 2, "relationshipTypeId" : 9, "id" : 5, "toItemTypeId" : 7 } ], "id" : 0, "mappedProjects" : [ { "organizationId" : 5, "projectKey" : "projectKey", "string1" : "string1", "name" : "name", "id" : 6, "mask" : 1 }, { "organizationId" : 5, "projectKey" : "projectKey", "string1" : "string1", "name" : "name", "id" : 6, "mask" : 1 } ] } ]

Produces: API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header:

• application/json

Response: array[RelationshipRuleSetDTO]

GET /relationshiprulesets/{id}

Summary: Get a Relationship Rule Set by id

Path parameters:

• id (required)
  

Consumes: this API call consumes the following media types via the Content-Type request header:

• application/json

Request headers:

• xJamaDateFieldsWithTime (optional)
  

Examples:

• Example data, content-type: application/json
  
  { "isExclusive" : true, "name" : "name", "rules" : [ { "forCoverage" : true, "fromItemTypeId" : 2, "relationshipTypeId" : 9, "id" : 5, "toItemTypeId" : 7 }, { "forCoverage" : true, "fromItemTypeId" : 2, "relationshipTypeId" : 9, "id" : 5, "toItemTypeId" : 7 } ], "id" : 0, "mappedProjects" : [ { "organizationId" : 5, "projectKey" : "projectKey", "string1" : "string1", "name" : "name", "id" : 6, "mask" : 1 }, { "organizationId" : 5, "projectKey" : "projectKey", "string1" : "string1", "name" : "name", "id" : 6, "mask" : 1 } ] }

Produces: API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header:

• application/json

Response: RelationshipRuleSetDTO

Endpoint relationships

The relationships endpoint has the following operations:

1. DELETE /relationships/{relationshipId}/suspect
2. POST /relationships
3. DELETE /relationships/{relationshipId}
4. GET /relationships/{relationshipId}
5. GET /relationships
6. PUT /relationships/{relationshipId}

Below is more detail for each of the operations of the relationships endpoint.

DELETE /relationships/{relationshipId}/suspect

Summary: Remove an existing suspect link for the relationship with the specified ID

Path parameters:

• relationshipId (required)
  

Consumes: this API call consumes the following media types via the Content-Type request header:

• application/json

Examples:

• Example data, content-type: application/json
  
  { "headers" : { "key" : [ "headers", "headers" ] }, "pageInfo" : { "startIndex" : 5, "resultCount" : 5, "totalResults" : 2 }, "statusReasonPhrase" : "statusReasonPhrase", "status" : 0 }

Produces: API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header:

• application/json

Response: AbstractRestResponse

POST /relationships

Summary: Create a new relationship

Consumes: this API call consumes the following media types via the Content-Type request header:

• application/json

Body:

RequestRelationship

Examples:

• Example data, content-type: application/json
  
  { "headers" : { "key" : [ "headers", "headers" ] }, "pageInfo" : { "startIndex" : 5, "resultCount" : 5, "totalResults" : 2 }, "location" : "http://example.com/aeiou", "id" : 6, "statusReasonPhrase" : "statusReasonPhrase", "status" : 0 }

Produces: API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header:

• application/json

Response: CreatedResponse

DELETE /relationships/{relationshipId}

Summary: Delete the relationship with the specified ID

Path parameters:

• relationshipId (required)
  

Consumes: this API call consumes the following media types via the Content-Type request header:

• application/json

Examples:

• Example data, content-type: application/json
  
  { "headers" : { "key" : [ "headers", "headers" ] }, "pageInfo" : { "startIndex" : 5, "resultCount" : 5, "totalResults" : 2 }, "statusReasonPhrase" : "statusReasonPhrase", "status" : 0 }

Produces: API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header:

• application/json

Response: AbstractRestResponse

GET /relationships/{relationshipId}

Summary: Get the relationship with the specified ID

Path parameters:

• relationshipId (required)
  

Consumes: this API call consumes the following media types via the Content-Type request header:

• application/json

Request headers:

• xJamaDateFieldsWithTime (optional)
  

Query parameters:

• include (optional)
  Links to include as full objects in the linked map

Examples:

• Example data, content-type: application/json
  
  { "data" : { "relationshipType" : 5, "fromItem" : 6, "id" : 0, "suspect" : true, "toItem" : 1 }, "meta" : { "status" : "OK", "timestamp" : "2000-01-23T04:56:07.000+00:00" }, "links" : { "key" : { "href" : "href", "type" : "type" } }, "linked" : { "key" : { "key" : "{}" } } }

Produces: API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header:

• application/json

Response: RelationshipDataWrapper

GET /relationships

Summary: Get all relationships in the project with the specified ID

Consumes: this API call consumes the following media types via the Content-Type request header:

• application/json

Request headers:

• xJamaDateFieldsWithTime (optional)
  

Query parameters:

• project (required)
  
• startAt (optional)
  
• maxResults (optional)
  If not set, this defaults to 20. This cannot be larger than 50
• include (optional)
  Links to include as full objects in the linked map

Examples:

• Example data, content-type: application/json
  
  { "data" : [ { "relationshipType" : 5, "fromItem" : 6, "id" : 0, "suspect" : true, "toItem" : 1 }, { "relationshipType" : 5, "fromItem" : 6, "id" : 0, "suspect" : true, "toItem" : 1 } ], "meta" : { "pageInfo" : { "startIndex" : 5, "resultCount" : 5, "totalResults" : 2 }, "status" : "OK", "timestamp" : "2000-01-23T04:56:07.000+00:00" }, "links" : { "key" : { "href" : "href", "type" : "type" } }, "linked" : { "key" : { "key" : "{}" } } }

Produces: API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header:

• application/json

Response: RelationshipDataListWrapper

PUT /relationships/{relationshipId}

Summary: Update the relationship with the specified ID

Path parameters:

• relationshipId (required)
  

Consumes: this API call consumes the following media types via the Content-Type request header:

• application/json

Body:

RequestRelationship

Examples:

• Example data, content-type: application/json
  
  { "headers" : { "key" : [ "headers", "headers" ] }, "pageInfo" : { "startIndex" : 5, "resultCount" : 5, "totalResults" : 2 }, "statusReasonPhrase" : "statusReasonPhrase", "status" : 0 }

Produces: API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header:

• application/json

Response: AbstractRestResponse

Endpoint relationshiptypes

The relationshiptypes endpoint has the following operations:

1. GET /relationshiptypes/{id}
2. GET /relationshiptypes

Below is more detail for each of the operations of the relationshiptypes endpoint.

GET /relationshiptypes/{id}

Summary: Get the relationship type with the specified ID

Path parameters:

• id (required)
  

Consumes: this API call consumes the following media types via the Content-Type request header:

• application/json

Request headers:

• xJamaDateFieldsWithTime (optional)
  

Query parameters:

• timestamp (optional)
  Get relationship type at this date and time. Requires ISO8601 formatting (milliseconds or seconds) - \"yyyy-MM-dd'T'HH:mm:ss.SSSZ\" or \"yyyy-MM-dd'T'HH:mm:ssZ\"
• include (optional)
  Links to include as full objects in the linked map

Examples:

• Example data, content-type: application/json
  
  { "data" : { "isDefault" : true, "name" : "name", "id" : 0 }, "meta" : { "status" : "OK", "timestamp" : "2000-01-23T04:56:07.000+00:00" }, "links" : { "key" : { "href" : "href", "type" : "type" } }, "linked" : { "key" : { "key" : "{}" } } }

Produces: API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header:

• application/json

Response: RelationshipTypeDataWrapper

GET /relationshiptypes

Summary: Get all relationship types

Consumes: this API call consumes the following media types via the Content-Type request header:

• application/json

Request headers:

• xJamaDateFieldsWithTime (optional)
  

Query parameters:

• startAt (optional)
  
• maxResults (optional)
  If not set, this defaults to 20. This cannot be larger than 50
• include (optional)
  Links to include as full objects in the linked map

Examples:

• Example data, content-type: application/json
  
  { "data" : [ { "isDefault" : true, "name" : "name", "id" : 0 }, { "isDefault" : true, "name" : "name", "id" : 0 } ], "meta" : { "pageInfo" : { "startIndex" : 5, "resultCount" : 5, "totalResults" : 2 }, "status" : "OK", "timestamp" : "2000-01-23T04:56:07.000+00:00" }, "links" : { "key" : { "href" : "href", "type" : "type" } }, "linked" : { "key" : { "key" : "{}" } } }

Produces: API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header:

• application/json

Response: RelationshipTypeDataListWrapper

Endpoint releases

The releases endpoint has the following operations:

1. POST /releases
2. GET /releases/{releaseId}
3. GET /releases
4. PUT /releases/{releaseId}

Below is more detail for each of the operations of the releases endpoint.

POST /releases

Summary: Create a new release

Consumes: this API call consumes the following media types via the Content-Type request header:

• application/json

Body:

RequestRelease

Examples:

• Example data, content-type: application/json
  
  { "headers" : { "key" : [ "headers", "headers" ] }, "pageInfo" : { "startIndex" : 5, "resultCount" : 5, "totalResults" : 2 }, "location" : "http://example.com/aeiou", "id" : 6, "statusReasonPhrase" : "statusReasonPhrase", "status" : 0 }

Produces: API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header:

• application/json

Response: CreatedResponse

GET /releases/{releaseId}

Summary: Get the release with the specified ID

Path parameters:

• releaseId (required)
  

Consumes: this API call consumes the following media types via the Content-Type request header:

• application/json

Request headers:

• xJamaDateFieldsWithTime (optional)
  

Query parameters:

• include (optional)
  Links to include as full objects in the linked map

Examples:

• Example data, content-type: application/json
  
  { "data" : { "archived" : true, "releaseDate" : "2000-01-23T04:56:07.000+00:00", "name" : "name", "description" : "description", "project" : 6, "active" : true, "id" : 0, "itemCount" : 1 }, "meta" : { "status" : "OK", "timestamp" : "2000-01-23T04:56:07.000+00:00" }, "links" : { "key" : { "href" : "href", "type" : "type" } }, "linked" : { "key" : { "key" : "{}" } } }

Produces: API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header:

• application/json

Response: ReleaseDataWrapper

GET /releases

Summary: Get all releases in the project with the specified ID

Consumes: this API call consumes the following media types via the Content-Type request header:

• application/json

Request headers:

• xJamaDateFieldsWithTime (optional)
  

Query parameters:

• project (required)
  
• startAt (optional)
  
• maxResults (optional)
  If not set, this defaults to 20. This cannot be larger than 50
• include (optional)
  Links to include as full objects in the linked map

Examples:

• Example data, content-type: application/json
  
  { "data" : [ { "archived" : true, "releaseDate" : "2000-01-23T04:56:07.000+00:00", "name" : "name", "description" : "description", "project" : 6, "active" : true, "id" : 0, "itemCount" : 1 }, { "archived" : true, "releaseDate" : "2000-01-23T04:56:07.000+00:00", "name" : "name", "description" : "description", "project" : 6, "active" : true, "id" : 0, "itemCount" : 1 } ], "meta" : { "pageInfo" : { "startIndex" : 5, "resultCount" : 5, "totalResults" : 2 }, "status" : "OK", "timestamp" : "2000-01-23T04:56:07.000+00:00" }, "links" : { "key" : { "href" : "href", "type" : "type" } }, "linked" : { "key" : { "key" : "{}" } } }

Produces: API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header:

• application/json

Response: ReleaseDataListWrapper

PUT /releases/{releaseId}

Summary: Update the release with the specified ID

Path parameters:

• releaseId (required)
  

Consumes: this API call consumes the following media types via the Content-Type request header:

• application/json

Body:

RequestRelease

Examples:

• Example data, content-type: application/json
  
  { "headers" : { "key" : [ "headers", "headers" ] }, "pageInfo" : { "startIndex" : 5, "resultCount" : 5, "totalResults" : 2 }, "statusReasonPhrase" : "statusReasonPhrase", "status" : 0 }

Produces: API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header:

• application/json

Response: AbstractRestResponse

Endpoint system

The system endpoint has the following operations:

1. GET /system/settings/corsdomains
2. POST /system/settings/corsdomains

Below is more detail for each of the operations of the system endpoint.

GET /system/settings/corsdomains

Summary: Get the current CORS domain whitelist

Consumes: this API call consumes the following media types via the Content-Type request header:

• application/json

Request headers:

• xJamaDateFieldsWithTime (optional)
  

Examples:

• Example data, content-type: application/json
  
  { "domains" : [ "domains", "domains" ] }

Produces: API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header:

• application/json

Response: CrossOriginDomainWhiteList

POST /system/settings/corsdomains

Summary: Update CORS domain whitelist

Consumes: this API call consumes the following media types via the Content-Type request header:

• application/json

Body:

CrossOriginDomainWhiteList

Examples:

• Example data, content-type: application/json
  
  { "headers" : { "key" : [ "headers", "headers" ] }, "pageInfo" : { "startIndex" : 5, "resultCount" : 5, "totalResults" : 2 }, "statusReasonPhrase" : "statusReasonPhrase", "status" : 0 }

Produces: API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header:

• application/json

Response: AbstractRestResponse

Endpoint tags

The tags endpoint has the following operations:

1. POST /tags
2. DELETE /tags/{id}
3. GET /tags/{id}/items
4. GET /tags/{id}
5. GET /tags
6. PUT /tags/{id}

Below is more detail for each of the operations of the tags endpoint.

POST /tags

Summary: Create a new tag in the project with the specified ID

Consumes: this API call consumes the following media types via the Content-Type request header:

• application/json

Body:

RequestTag

Examples:

• Example data, content-type: application/json
  
  { "headers" : { "key" : [ "headers", "headers" ] }, "pageInfo" : { "startIndex" : 5, "resultCount" : 5, "totalResults" : 2 }, "location" : "http://example.com/aeiou", "id" : 6, "statusReasonPhrase" : "statusReasonPhrase", "status" : 0 }

Produces: API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header:

• application/json

Response: CreatedResponse

DELETE /tags/{id}

Summary: Delete the tag with the specified ID

Path parameters:

• id (required)
  

Consumes: this API call consumes the following media types via the Content-Type request header:

• application/json

Examples:

• Example data, content-type: application/json
  
  { "headers" : { "key" : [ "headers", "headers" ] }, "pageInfo" : { "startIndex" : 5, "resultCount" : 5, "totalResults" : 2 }, "statusReasonPhrase" : "statusReasonPhrase", "status" : 0 }

Produces: API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header:

• application/json

Response: AbstractRestResponse

GET /tags/{id}/items

Summary: Get all items that have the tag with the specified ID

Path parameters:

• id (required)
  

Consumes: this API call consumes the following media types via the Content-Type request header:

• application/json

Request headers:

• xJamaDateFieldsWithTime (optional)
  

Query parameters:

• startAt (optional)
  
• maxResults (optional)
  If not set, this defaults to 20. This cannot be larger than 50
• include (optional)
  Links to include as full objects in the linked map

Examples:

• Example data, content-type: application/json
  
  { "data" : [ { "itemType" : 1, "globalId" : "globalId", "project" : 6, "resources" : { "key" : { "allowed" : [ "allowed", "allowed" ] } }, "childItemType" : 5, "createdDate" : "2000-01-23T04:56:07.000+00:00", "lastActivityDate" : "2000-01-23T04:56:07.000+00:00", "createdBy" : 5, "documentKey" : "documentKey", "modifiedDate" : "2000-01-23T04:56:07.000+00:00", "lock" : { "lockedBy" : 7, "lastLockedDate" : "2000-01-23T04:56:07.000+00:00", "locked" : true }, "modifiedBy" : 2, "location" : { "sequence" : "sequence", "parent" : { "item" : 4, "project" : 2 }, "sortOrder" : 9, "globalSortOrder" : 3 }, "id" : 0, "fields" : { "key" : "{}" }, "baselinedAppliedCategorySnapshots" : [ { "categoryPathSequence" : "categoryPathSequence", "itemVersionNumberApplied" : 2 }, { "categoryPathSequence" : "categoryPathSequence", "itemVersionNumberApplied" : 2 } ] }, { "itemType" : 1, "globalId" : "globalId", "project" : 6, "resources" : { "key" : { "allowed" : [ "allowed", "allowed" ] } }, "childItemType" : 5, "createdDate" : "2000-01-23T04:56:07.000+00:00", "lastActivityDate" : "2000-01-23T04:56:07.000+00:00", "createdBy" : 5, "documentKey" : "documentKey", "modifiedDate" : "2000-01-23T04:56:07.000+00:00", "lock" : { "lockedBy" : 7, "lastLockedDate" : "2000-01-23T04:56:07.000+00:00", "locked" : true }, "modifiedBy" : 2, "location" : { "sequence" : "sequence", "parent" : { "item" : 4, "project" : 2 }, "sortOrder" : 9, "globalSortOrder" : 3 }, "id" : 0, "fields" : { "key" : "{}" }, "baselinedAppliedCategorySnapshots" : [ { "categoryPathSequence" : "categoryPathSequence", "itemVersionNumberApplied" : 2 }, { "categoryPathSequence" : "categoryPathSequence", "itemVersionNumberApplied" : 2 } ] } ], "meta" : { "pageInfo" : { "startIndex" : 5, "resultCount" : 5, "totalResults" : 2 }, "status" : "OK", "timestamp" : "2000-01-23T04:56:07.000+00:00" }, "links" : { "key" : { "href" : "href", "type" : "type" } }, "linked" : { "key" : { "key" : "{}" } } }

Produces: API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header:

• application/json

Response: ItemDataListWrapper

GET /tags/{id}

Summary: Get the tag with the specified ID

Path parameters:

• id (required)
  

Consumes: this API call consumes the following media types via the Content-Type request header:

• application/json

Request headers:

• xJamaDateFieldsWithTime (optional)
  

Query parameters:

• include (optional)
  Links to include as full objects in the linked map

Examples:

• Example data, content-type: application/json
  
  { "data" : { "name" : "name", "project" : 6, "id" : 0 }, "meta" : { "status" : "OK", "timestamp" : "2000-01-23T04:56:07.000+00:00" }, "links" : { "key" : { "href" : "href", "type" : "type" } }, "linked" : { "key" : { "key" : "{}" } } }

Produces: API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header:

• application/json

Response: TagDataWrapper

GET /tags

Summary: Get all tags for the project with the specified ID

Consumes: this API call consumes the following media types via the Content-Type request header:

• application/json

Request headers:

• xJamaDateFieldsWithTime (optional)
  

Query parameters:

• project (required)
  
• startAt (optional)
  
• maxResults (optional)
  If not set, this defaults to 20. This cannot be larger than 50
• include (optional)
  Links to include as full objects in the linked map

Examples:

• Example data, content-type: application/json
  
  { "data" : [ { "name" : "name", "project" : 6, "id" : 0 }, { "name" : "name", "project" : 6, "id" : 0 } ], "meta" : { "pageInfo" : { "startIndex" : 5, "resultCount" : 5, "totalResults" : 2 }, "status" : "OK", "timestamp" : "2000-01-23T04:56:07.000+00:00" }, "links" : { "key" : { "href" : "href", "type" : "type" } }, "linked" : { "key" : { "key" : "{}" } } }

Produces: API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header:

• application/json

Response: TagDataListWrapper

PUT /tags/{id}

Summary: Update the tag with the specified ID

Path parameters:

• id (required)
  

Consumes: this API call consumes the following media types via the Content-Type request header:

• application/json

Body:

RequestTag

Examples:

• Example data, content-type: application/json
  
  { "headers" : { "key" : [ "headers", "headers" ] }, "pageInfo" : { "startIndex" : 5, "resultCount" : 5, "totalResults" : 2 }, "statusReasonPhrase" : "statusReasonPhrase", "status" : 0 }

Produces: API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header:

• application/json

Response: AbstractRestResponse

Endpoint testcycles

The testcycles endpoint has the following operations:

1. DELETE /testcycles/{testCycleId}
2. GET /testcycles/{testCycleId}
3. GET /testcycles/{testCycleId}/testgroup/{testGroupId}
4. GET /testcycles/{testCycleId}/testruns
5. GET /testcycles/{testCycleId}/versions/{versionNum}
6. GET /testcycles/{testCycleId}/versions/{versionNum}/versioneditem
7. GET /testcycles/{testCycleId}/versions
8. PATCH /testcycles/{testCycleId}
9. PUT /testcycles/{testCycleId}

Below is more detail for each of the operations of the testcycles endpoint.

DELETE /testcycles/{testCycleId}

Summary: Delete the test cycle with the specified ID, including the test runs in the test cycle

Path parameters:

• testCycleId (required)
  

Consumes: this API call consumes the following media types via the Content-Type request header:

• application/json

Examples:

• Example data, content-type: application/json
  
  { "headers" : { "key" : [ "headers", "headers" ] }, "pageInfo" : { "startIndex" : 5, "resultCount" : 5, "totalResults" : 2 }, "statusReasonPhrase" : "statusReasonPhrase", "status" : 0 }

Produces: API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header:

• application/json

Response: AbstractRestResponse

GET /testcycles/{testCycleId}

Summary: Get the test cycle with the specified ID

Path parameters:

• testCycleId (required)
  

Consumes: this API call consumes the following media types via the Content-Type request header:

• application/json

Request headers:

• xJamaDateFieldsWithTime (optional)
  

Query parameters:

• include (optional)
  Links to include as full objects in the linked map

Examples:

• Example data, content-type: application/json
  
  { "data" : { "itemType" : 1, "globalId" : "globalId", "project" : 6, "resources" : { "key" : { "allowed" : [ "allowed", "allowed" ] } }, "createdDate" : "2000-01-23T04:56:07.000+00:00", "lastActivityDate" : "2000-01-23T04:56:07.000+00:00", "createdBy" : 5, "documentKey" : "documentKey", "modifiedDate" : "2000-01-23T04:56:07.000+00:00", "modifiedBy" : 5, "id" : 0, "fields" : { "key" : "{}" }, "baselinedAppliedCategorySnapshots" : [ { "categoryPathSequence" : "categoryPathSequence", "itemVersionNumberApplied" : 2 }, { "categoryPathSequence" : "categoryPathSequence", "itemVersionNumberApplied" : 2 } ] }, "meta" : { "status" : "OK", "timestamp" : "2000-01-23T04:56:07.000+00:00" }, "links" : { "key" : { "href" : "href", "type" : "type" } }, "linked" : { "key" : { "key" : "{}" } } }

Produces: API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header:

• application/json

Response: TestCycleDataWrapper

GET /testcycles/{testCycleId}/testgroup/{testGroupId}

Summary: Get the test cycle test group for the test cycle with the specified ID

Path parameters:

• testGroupId (required)
  Get the test group with the specified ID
• testCycleId (required)
  

Consumes: this API call consumes the following media types via the Content-Type request header:

• application/json

Request headers:

• xJamaDateFieldsWithTime (optional)
  

Query parameters:

• include (optional)
  Links to include as full objects in the linked map

Examples:

• Example data, content-type: application/json
  
  { "data" : { "testCycle" : 1, "testGroup" : 0, "name" : "name", "type" : "type", "assignedTo" : 6 }, "meta" : { "status" : "OK", "timestamp" : "2000-01-23T04:56:07.000+00:00" }, "links" : { "key" : { "href" : "href", "type" : "type" } }, "linked" : { "key" : { "key" : "{}" } } }

Produces: API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header:

• application/json

Response: TestCycleTestGroupDataWrapper

GET /testcycles/{testCycleId}/testruns

Summary: Get all test runs for the test cycle with the specified ID

Path parameters:

• testCycleId (required)
  

Consumes: this API call consumes the following media types via the Content-Type request header:

• application/json

Request headers:

• xJamaDateFieldsWithTime (optional)
  

Query parameters:

• startAt (optional)
  
• maxResults (optional)
  If not set, this defaults to 20. This cannot be larger than 50
• include (optional)
  Links to include as full objects in the linked map

Examples:

• Example data, content-type: application/json
  
  { "data" : [ { "itemType" : 1, "globalId" : "globalId", "project" : 6, "resources" : { "key" : { "allowed" : [ "allowed", "allowed" ] } }, "createdDate" : "2000-01-23T04:56:07.000+00:00", "lastActivityDate" : "2000-01-23T04:56:07.000+00:00", "createdBy" : 5, "documentKey" : "documentKey", "modifiedDate" : "2000-01-23T04:56:07.000+00:00", "testCaseVersionNumber" : 2, "testGroup" : [ 9, 9 ], "sortOrderFromTestGroup" : 7, "modifiedBy" : 5, "id" : 0, "fields" : { "key" : "{}" }, "baselinedAppliedCategorySnapshots" : [ { "categoryPathSequence" : "categoryPathSequence", "itemVersionNumberApplied" : 2 }, { "categoryPathSequence" : "categoryPathSequence", "itemVersionNumberApplied" : 2 } ] }, { "itemType" : 1, "globalId" : "globalId", "project" : 6, "resources" : { "key" : { "allowed" : [ "allowed", "allowed" ] } }, "createdDate" : "2000-01-23T04:56:07.000+00:00", "lastActivityDate" : "2000-01-23T04:56:07.000+00:00", "createdBy" : 5, "documentKey" : "documentKey", "modifiedDate" : "2000-01-23T04:56:07.000+00:00", "testCaseVersionNumber" : 2, "testGroup" : [ 9, 9 ], "sortOrderFromTestGroup" : 7, "modifiedBy" : 5, "id" : 0, "fields" : { "key" : "{}" }, "baselinedAppliedCategorySnapshots" : [ { "categoryPathSequence" : "categoryPathSequence", "itemVersionNumberApplied" : 2 }, { "categoryPathSequence" : "categoryPathSequence", "itemVersionNumberApplied" : 2 } ] } ], "meta" : { "pageInfo" : { "startIndex" : 5, "resultCount" : 5, "totalResults" : 2 }, "status" : "OK", "timestamp" : "2000-01-23T04:56:07.000+00:00" }, "links" : { "key" : { "href" : "href", "type" : "type" } }, "linked" : { "key" : { "key" : "{}" } } }

Produces: API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header:

• application/json

Response: TestRunDataListWrapper

GET /testcycles/{testCycleId}/versions/{versionNum}

Summary: Get the numbered version for the item with the specified ID

Path parameters:

• versionNum (required)
  
• testCycleId (required)
  

Consumes: this API call consumes the following media types via the Content-Type request header:

• application/json

Request headers:

• xJamaDateFieldsWithTime (optional)
  

Query parameters:

• include (optional)
  Links to include as full objects in the linked map

Examples:

• Example data, content-type: application/json
  
  { "data" : { "item" : 6, "createdDate" : "2000-01-23T04:56:07.000+00:00", "versionedItem" : [ 0, 0 ], "createdBy" : 5, "comment" : "comment", "type" : "type", "userName" : "userName", "versionNumber" : 1, "changeDetails" : "changeDetails" }, "meta" : { "status" : "OK", "timestamp" : "2000-01-23T04:56:07.000+00:00" }, "links" : { "key" : { "href" : "href", "type" : "type" } }, "linked" : { "key" : { "key" : "{}" } } }

Produces: API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header:

• application/json

Response: VersionDataWrapper

GET /testcycles/{testCycleId}/versions/{versionNum}/versioneditem

Summary: Get the snapshot of the test cycle at the specified version

Path parameters:

• versionNum (required)
  
• testCycleId (required)
  

Consumes: this API call consumes the following media types via the Content-Type request header:

• application/json

Request headers:

• xJamaDateFieldsWithTime (optional)
  

Query parameters:

• include (optional)
  Links to include as full objects in the linked map

Examples:

• Example data, content-type: application/json
  
  { "data" : { "itemType" : 5, "globalId" : "globalId", "project" : 5, "resources" : { "key" : { "allowed" : [ "allowed", "allowed" ] } }, "version" : 0, "currentVersion" : 6, "createdDate" : "2000-01-23T04:56:07.000+00:00", "lastActivityDate" : "2000-01-23T04:56:07.000+00:00", "createdBy" : 2, "documentKey" : "documentKey", "modifiedDate" : "2000-01-23T04:56:07.000+00:00", "modifiedBy" : 7, "id" : 1, "fields" : { "key" : "{}" }, "baselinedAppliedCategorySnapshots" : [ { "categoryPathSequence" : "categoryPathSequence", "itemVersionNumberApplied" : 2 }, { "categoryPathSequence" : "categoryPathSequence", "itemVersionNumberApplied" : 2 } ] }, "meta" : { "status" : "OK", "timestamp" : "2000-01-23T04:56:07.000+00:00" }, "links" : { "key" : { "href" : "href", "type" : "type" } }, "linked" : { "key" : { "key" : "{}" } } }

Produces: API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header:

• application/json

Response: VersionedTestCycleDataWrapper

GET /testcycles/{testCycleId}/versions

Summary: Get all versions for the item with the specified ID

Path parameters:

• testCycleId (required)
  

Consumes: this API call consumes the following media types via the Content-Type request header:

• application/json

Request headers:

• xJamaDateFieldsWithTime (optional)
  

Query parameters:

• startAt (optional)
  
• maxResults (optional)
  If not set, this defaults to 20. This cannot be larger than 50
• include (optional)
  Links to include as full objects in the linked map

Examples:

• Example data, content-type: application/json
  
  { "data" : [ { "item" : 6, "createdDate" : "2000-01-23T04:56:07.000+00:00", "versionedItem" : [ 0, 0 ], "createdBy" : 5, "comment" : "comment", "type" : "type", "userName" : "userName", "versionNumber" : 1, "changeDetails" : "changeDetails" }, { "item" : 6, "createdDate" : "2000-01-23T04:56:07.000+00:00", "versionedItem" : [ 0, 0 ], "createdBy" : 5, "comment" : "comment", "type" : "type", "userName" : "userName", "versionNumber" : 1, "changeDetails" : "changeDetails" } ], "meta" : { "pageInfo" : { "startIndex" : 5, "resultCount" : 5, "totalResults" : 2 }, "status" : "OK", "timestamp" : "2000-01-23T04:56:07.000+00:00" }, "links" : { "key" : { "href" : "href", "type" : "type" } }, "linked" : { "key" : { "key" : "{}" } } }

Produces: API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header:

• application/json

Response: VersionDataListWrapper

PATCH /testcycles/{testCycleId}

Summary: Update the test cycle with the specified ID, including regenerating the test runs in the test cycle

Path parameters:

• testCycleId (required)
  

Consumes: this API call consumes the following media types via the Content-Type request header:

• application/json

Body:

array[RequestPatchOperation]

Examples:

• Example data, content-type: application/json
  
  { "headers" : { "key" : [ "headers", "headers" ] }, "pageInfo" : { "startIndex" : 5, "resultCount" : 5, "totalResults" : 2 }, "statusReasonPhrase" : "statusReasonPhrase", "status" : 0 }

Produces: API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header:

• application/json

Response: AbstractRestResponse

PUT /testcycles/{testCycleId}

Summary: Update the test cycle with the specified ID, including regenerating the test runs in the test cycle

Path parameters:

• testCycleId (required)
  

Consumes: this API call consumes the following media types via the Content-Type request header:

• application/json

Body:

RequestTestCycle

Examples:

• Example data, content-type: application/json
  
  { "headers" : { "key" : [ "headers", "headers" ] }, "pageInfo" : { "startIndex" : 5, "resultCount" : 5, "totalResults" : 2 }, "statusReasonPhrase" : "statusReasonPhrase", "status" : 0 }

Produces: API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header:

• application/json

Response: AbstractRestResponse

Endpoint testplans

The testplans endpoint has the following operations:

1. POST /testplans/{id}/attachments
2. POST /testplans/{id}/links
3. POST /testplans/{id}/tags
4. POST /testplans/{id}/testgroups
5. POST /testplans/{id}/testcycles
6. POST /testplans
7. DELETE /testplans/{id}/links/{linkId}
8. DELETE /testplans/{id}/testgroups/{testGroupId}/testcases/{testCaseId}
9. DELETE /testplans/{id}/testgroups/{testGroupId}
10. DELETE /testplans/{id}
11. GET /testplans/{id}/activities
12. GET /testplans/{id}/attachments
13. GET /testplans/{id}/downstreamrelated
14. GET /testplans/{id}/downstreamrelationships
15. GET /testplans/{id}/comments
16. GET /testplans/{id}/links
17. GET /testplans/{id}/links/{linkId}
18. GET /testplans/{id}/lock
19. GET /testplans/{id}/tags/{tagId}
20. GET /testplans/{id}/tags
21. GET /testplans/{id}/testgroups/{testGroupId}/testcases/{testCaseId}
22. GET /testplans/{id}/testgroups/{testGroupId}/testcases
23. GET /testplans/{id}/testcycles
24. GET /testplans/{id}/testgroups/{testGroupId}
25. GET /testplans/{id}/testgroups
26. GET /testplans/{id}
27. GET /testplans
28. GET /testplans/{id}/upstreamrelated
29. GET /testplans/{id}/upstreamrelationships
30. GET /testplans/{id}/versions/{versionNum}
31. GET /testplans/{id}/versions/{versionNum}/versioneditem
32. GET /testplans/{id}/versions
33. PATCH /testplans/{id}
34. POST /testplans/{id}/testgroups/{testGroupId}/testcases
35. DELETE /testplans/{id}/attachments/{attachmentId}
36. DELETE /testplans/{id}/tags/{tagId}
37. PUT /testplans/{id}/archived
38. PUT /testplans/{id}/links/{linkId}
39. PUT /testplans/{id}/lock
40. PUT /testplans/{id}/testgroups/{testGroupId}
41. PUT /testplans/{id}

Below is more detail for each of the operations of the testplans endpoint.

POST /testplans/{id}/attachments

Summary: Add an existing attachment to the item with the specified ID

Path parameters:

• id (required)
  

Consumes: this API call consumes the following media types via the Content-Type request header:

• application/json

Body:

RequestItemAttachment

Examples:

• Example data, content-type: application/json
  
  { "headers" : { "key" : [ "headers", "headers" ] }, "pageInfo" : { "startIndex" : 5, "resultCount" : 5, "totalResults" : 2 }, "location" : "http://example.com/aeiou", "id" : 6, "statusReasonPhrase" : "statusReasonPhrase", "status" : 0 }

Produces: API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header:

• application/json

Response: CreatedResponse

POST /testplans/{id}/links

Summary: Create a new link for the item with the specified ID

Path parameters:

• id (required)
  

Consumes: this API call consumes the following media types via the Content-Type request header:

• application/json

Body:

RequestLink

Examples:

• Example data, content-type: application/json
  
  { "headers" : { "key" : [ "headers", "headers" ] }, "pageInfo" : { "startIndex" : 5, "resultCount" : 5, "totalResults" : 2 }, "location" : "http://example.com/aeiou", "id" : 6, "statusReasonPhrase" : "statusReasonPhrase", "status" : 0 }

Produces: API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header:

• application/json

Response: CreatedResponse

POST /testplans/{id}/tags

Summary: Add an existing tag to the item with the specified ID

Path parameters:

• id (required)
  

Consumes: this API call consumes the following media types via the Content-Type request header:

• application/json

Body:

RequestItemTag

Examples:

• Example data, content-type: application/json
  
  { "headers" : { "key" : [ "headers", "headers" ] }, "pageInfo" : { "startIndex" : 5, "resultCount" : 5, "totalResults" : 2 }, "location" : "http://example.com/aeiou", "id" : 6, "statusReasonPhrase" : "statusReasonPhrase", "status" : 0 }

Produces: API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header:

• application/json

Response: CreatedResponse

POST /testplans/{id}/testgroups

Summary: Create a new test group to the test plan with the specified ID

Path parameters:

• id (required)
  

Consumes: this API call consumes the following media types via the Content-Type request header:

• application/json

Body:

RequestTestGroup

Examples:

• Example data, content-type: application/json
  
  { "headers" : { "key" : [ "headers", "headers" ] }, "pageInfo" : { "startIndex" : 5, "resultCount" : 5, "totalResults" : 2 }, "location" : "http://example.com/aeiou", "id" : 6, "statusReasonPhrase" : "statusReasonPhrase", "status" : 0 }

Produces: API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header:

• application/json

Response: CreatedResponse

POST /testplans/{id}/testcycles

Summary: Create a new test cycle

Path parameters:

• id (required)
  

Consumes: this API call consumes the following media types via the Content-Type request header:

• application/json

Body:

RequestTestCycle

Examples:

• Example data, content-type: application/json
  
  { "headers" : { "key" : [ "headers", "headers" ] }, "pageInfo" : { "startIndex" : 5, "resultCount" : 5, "totalResults" : 2 }, "location" : "http://example.com/aeiou", "id" : 6, "statusReasonPhrase" : "statusReasonPhrase", "status" : 0 }

Produces: API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header:

• application/json

Response: CreatedResponse

POST /testplans

Summary: Create a new test plan

Consumes: this API call consumes the following media types via the Content-Type request header:

• application/json

Body:

RequestTestPlan

Examples:

• Example data, content-type: application/json
  
  { "headers" : { "key" : [ "headers", "headers" ] }, "pageInfo" : { "startIndex" : 5, "resultCount" : 5, "totalResults" : 2 }, "location" : "http://example.com/aeiou", "id" : 6, "statusReasonPhrase" : "statusReasonPhrase", "status" : 0 }

Produces: API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header:

• application/json

Response: CreatedResponse

DELETE /testplans/{id}/links/{linkId}

Summary: Delete the link with the specified ID

Path parameters:

• linkId (required)
  
• id (required)
  

Consumes: this API call consumes the following media types via the Content-Type request header:

• application/json

Examples:

• Example data, content-type: application/json
  
  { "headers" : { "key" : [ "headers", "headers" ] }, "pageInfo" : { "startIndex" : 5, "resultCount" : 5, "totalResults" : 2 }, "statusReasonPhrase" : "statusReasonPhrase", "status" : 0 }

Produces: API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header:

• application/json

Response: AbstractRestResponse

DELETE /testplans/{id}/testgroups/{testGroupId}/testcases/{testCaseId}

Summary: Remove an existing test case from the test group

Path parameters:

• testCaseId (required)
  
• testGroupId (required)
  
• id (required)
  

Consumes: this API call consumes the following media types via the Content-Type request header:

• application/json

Examples:

• Example data, content-type: application/json
  
  { "headers" : { "key" : [ "headers", "headers" ] }, "pageInfo" : { "startIndex" : 5, "resultCount" : 5, "totalResults" : 2 }, "statusReasonPhrase" : "statusReasonPhrase", "status" : 0 }

Produces: API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header:

• application/json

Response: AbstractRestResponse

DELETE /testplans/{id}/testgroups/{testGroupId}

Summary: Delete the test group with the specified ID

Path parameters:

• testGroupId (required)
  
• id (required)
  

Consumes: this API call consumes the following media types via the Content-Type request header:

• application/json

Examples:

• Example data, content-type: application/json
  
  { "headers" : { "key" : [ "headers", "headers" ] }, "pageInfo" : { "startIndex" : 5, "resultCount" : 5, "totalResults" : 2 }, "statusReasonPhrase" : "statusReasonPhrase", "status" : 0 }

Produces: API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header:

• application/json

Response: AbstractRestResponse

DELETE /testplans/{id}

Summary: Delete the test plan with the specified ID

Path parameters:

• id (required)
  

Consumes: this API call consumes the following media types via the Content-Type request header:

• application/json

Examples:

• Example data, content-type: application/json
  
  { "headers" : { "key" : [ "headers", "headers" ] }, "pageInfo" : { "startIndex" : 5, "resultCount" : 5, "totalResults" : 2 }, "statusReasonPhrase" : "statusReasonPhrase", "status" : 0 }

Produces: API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header:

• application/json

Response: AbstractRestResponse

GET /testplans/{id}/activities

Summary: Get all activities for the test plan with the specified ID

Path parameters:

• id (required)
  

Consumes: this API call consumes the following media types via the Content-Type request header:

• application/json

Request headers:

• xJamaDateFieldsWithTime (optional)
  

Query parameters:

• startAt (optional)
  
• maxResults (optional)
  If not set, this defaults to 20. This cannot be larger than 50
• include (optional)
  Links to include as full objects in the linked map

Examples:

• Example data, content-type: application/json
  
  { "data" : [ { "date" : "2000-01-23T04:56:07.000+00:00", "item" : 1, "itemType" : 5, "userComment" : "userComment", "action" : "action", "details" : "details", "id" : 0, "eventType" : "CREATE", "userName" : "userName", "user" : 6, "objectType" : "PROJECT" }, { "date" : "2000-01-23T04:56:07.000+00:00", "item" : 1, "itemType" : 5, "userComment" : "userComment", "action" : "action", "details" : "details", "id" : 0, "eventType" : "CREATE", "userName" : "userName", "user" : 6, "objectType" : "PROJECT" } ], "meta" : { "pageInfo" : { "startIndex" : 5, "resultCount" : 5, "totalResults" : 2 }, "status" : "OK", "timestamp" : "2000-01-23T04:56:07.000+00:00" }, "links" : { "key" : { "href" : "href", "type" : "type" } }, "linked" : { "key" : { "key" : "{}" } } }

Produces: API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header:

• application/json

Response: ActivityDataListWrapper

GET /testplans/{id}/attachments

Summary: Get all attachments for the item with the specified ID

Path parameters:

• id (required)
  

Consumes: this API call consumes the following media types via the Content-Type request header:

• application/json

Request headers:

• xJamaDateFieldsWithTime (optional)
  

Query parameters:

• startAt (optional)
  
• maxResults (optional)
  If not set, this defaults to 20. This cannot be larger than 50
• include (optional)
  Links to include as full objects in the linked map

Examples:

• Example data, content-type: application/json
  
  { "data" : [ { "fileName" : "fileName", "itemType" : 5, "globalId" : "globalId", "project" : 1, "resources" : { "key" : { "allowed" : [ "allowed", "allowed" ] } }, "mimeType" : "mimeType", "createdDate" : "2000-01-23T04:56:07.000+00:00", "fileSize" : 0, "lastActivityDate" : "2000-01-23T04:56:07.000+00:00", "createdBy" : 5, "documentKey" : "documentKey", "modifiedDate" : "2000-01-23T04:56:07.000+00:00", "lock" : { "lockedBy" : 7, "lastLockedDate" : "2000-01-23T04:56:07.000+00:00", "locked" : true }, "modifiedBy" : 2, "id" : 6, "fields" : { "key" : "{}" }, "baselinedAppliedCategorySnapshots" : [ { "categoryPathSequence" : "categoryPathSequence", "itemVersionNumberApplied" : 2 }, { "categoryPathSequence" : "categoryPathSequence", "itemVersionNumberApplied" : 2 } ] }, { "fileName" : "fileName", "itemType" : 5, "globalId" : "globalId", "project" : 1, "resources" : { "key" : { "allowed" : [ "allowed", "allowed" ] } }, "mimeType" : "mimeType", "createdDate" : "2000-01-23T04:56:07.000+00:00", "fileSize" : 0, "lastActivityDate" : "2000-01-23T04:56:07.000+00:00", "createdBy" : 5, "documentKey" : "documentKey", "modifiedDate" : "2000-01-23T04:56:07.000+00:00", "lock" : { "lockedBy" : 7, "lastLockedDate" : "2000-01-23T04:56:07.000+00:00", "locked" : true }, "modifiedBy" : 2, "id" : 6, "fields" : { "key" : "{}" }, "baselinedAppliedCategorySnapshots" : [ { "categoryPathSequence" : "categoryPathSequence", "itemVersionNumberApplied" : 2 }, { "categoryPathSequence" : "categoryPathSequence", "itemVersionNumberApplied" : 2 } ] } ], "meta" : { "pageInfo" : { "startIndex" : 5, "resultCount" : 5, "totalResults" : 2 }, "status" : "OK", "timestamp" : "2000-01-23T04:56:07.000+00:00" }, "links" : { "key" : { "href" : "href", "type" : "type" } }, "linked" : { "key" : { "key" : "{}" } } }

Produces: API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header:

• application/json

Response: AttachmentDataListWrapper

GET /testplans/{id}/downstreamrelated

Summary: Get all downstream related items for the test plan with the specified ID

Path parameters:

• id (required)
  

Consumes: this API call consumes the following media types via the Content-Type request header:

• application/json

Request headers:

• xJamaDateFieldsWithTime (optional)
  

Query parameters:

• startAt (optional)
  
• maxResults (optional)
  If not set, this defaults to 20. This cannot be larger than 50
• include (optional)
  Links to include as full objects in the linked map

Examples:

• Example data, content-type: application/json
  
  { "data" : [ { "itemType" : 1, "globalId" : "globalId", "project" : 6, "resources" : { "key" : { "allowed" : [ "allowed", "allowed" ] } }, "createdDate" : "2000-01-23T04:56:07.000+00:00", "lastActivityDate" : "2000-01-23T04:56:07.000+00:00", "createdBy" : 5, "documentKey" : "documentKey", "modifiedDate" : "2000-01-23T04:56:07.000+00:00", "modifiedBy" : 5, "id" : 0, "fields" : { "key" : "{}" }, "baselinedAppliedCategorySnapshots" : [ { "categoryPathSequence" : "categoryPathSequence", "itemVersionNumberApplied" : 2 }, { "categoryPathSequence" : "categoryPathSequence", "itemVersionNumberApplied" : 2 } ] }, { "itemType" : 1, "globalId" : "globalId", "project" : 6, "resources" : { "key" : { "allowed" : [ "allowed", "allowed" ] } }, "createdDate" : "2000-01-23T04:56:07.000+00:00", "lastActivityDate" : "2000-01-23T04:56:07.000+00:00", "createdBy" : 5, "documentKey" : "documentKey", "modifiedDate" : "2000-01-23T04:56:07.000+00:00", "modifiedBy" : 5, "id" : 0, "fields" : { "key" : "{}" }, "baselinedAppliedCategorySnapshots" : [ { "categoryPathSequence" : "categoryPathSequence", "itemVersionNumberApplied" : 2 }, { "categoryPathSequence" : "categoryPathSequence", "itemVersionNumberApplied" : 2 } ] } ], "meta" : { "pageInfo" : { "startIndex" : 5, "resultCount" : 5, "totalResults" : 2 }, "status" : "OK", "timestamp" : "2000-01-23T04:56:07.000+00:00" }, "links" : { "key" : { "href" : "href", "type" : "type" } }, "linked" : { "key" : { "key" : "{}" } } }

Produces: API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header:

• application/json

Response: AbstractItemDataListWrapper

GET /testplans/{id}/downstreamrelationships

Summary: Get all downstream relationships for the test plan with the specified ID

Path parameters:

• id (required)
  

Consumes: this API call consumes the following media types via the Content-Type request header:

• application/json

Request headers:

• xJamaDateFieldsWithTime (optional)
  

Query parameters:

• startAt (optional)
  
• maxResults (optional)
  If not set, this defaults to 20. This cannot be larger than 50
• include (optional)
  Links to include as full objects in the linked map

Examples:

• Example data, content-type: application/json
  
  { "data" : [ { "relationshipType" : 5, "fromItem" : 6, "id" : 0, "suspect" : true, "toItem" : 1 }, { "relationshipType" : 5, "fromItem" : 6, "id" : 0, "suspect" : true, "toItem" : 1 } ], "meta" : { "pageInfo" : { "startIndex" : 5, "resultCount" : 5, "totalResults" : 2 }, "status" : "OK", "timestamp" : "2000-01-23T04:56:07.000+00:00" }, "links" : { "key" : { "href" : "href", "type" : "type" } }, "linked" : { "key" : { "key" : "{}" } } }

Produces: API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header:

• application/json

Response: RelationshipDataListWrapper

GET /testplans/{id}/comments

Summary: Get all comments for the item with the specified ID

Path parameters:

• id (required)
  

Consumes: this API call consumes the following media types via the Content-Type request header:

• application/json

Request headers:

• xJamaDateFieldsWithTime (optional)
  

Query parameters:

• startAt (optional)
  
• maxResults (optional)
  If not set, this defaults to 20. This cannot be larger than 50
• rootCommentsOnly (optional)
  , default value: false
• include (optional)
  Links to include as full objects in the linked map

Examples:

• Example data, content-type: application/json
  
  { "data" : [ { "createdDate" : "2000-01-23T04:56:07.000+00:00", "deleted" : true, "createdBy" : 1, "inReplyTo" : 6, "commentType" : "GENERAL", "modifiedBy" : 5, "location" : { "item" : 5, "project" : 2 }, "id" : 0, "body" : { "text" : "text" }, "status" : "OPEN" }, { "createdDate" : "2000-01-23T04:56:07.000+00:00", "deleted" : true, "createdBy" : 1, "inReplyTo" : 6, "commentType" : "GENERAL", "modifiedBy" : 5, "location" : { "item" : 5, "project" : 2 }, "id" : 0, "body" : { "text" : "text" }, "status" : "OPEN" } ], "meta" : { "pageInfo" : { "startIndex" : 5, "resultCount" : 5, "totalResults" : 2 }, "status" : "OK", "timestamp" : "2000-01-23T04:56:07.000+00:00" }, "links" : { "key" : { "href" : "href", "type" : "type" } }, "linked" : { "key" : { "key" : "{}" } } }

Produces: API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header:

• application/json

Response: CommentDataListWrapper

GET /testplans/{id}/links

Summary: Get all links for the item with the specified ID

Path parameters:

• id (required)
  

Consumes: this API call consumes the following media types via the Content-Type request header:

• application/json

Request headers:

• xJamaDateFieldsWithTime (optional)
  

Query parameters:

• startAt (optional)
  
• maxResults (optional)
  If not set, this defaults to 20. This cannot be larger than 50
• include (optional)
  Links to include as full objects in the linked map

Examples:

• Example data, content-type: application/json
  
  { "data" : [ { "href" : "href", "type" : "type" }, { "href" : "href", "type" : "type" } ], "meta" : { "pageInfo" : { "startIndex" : 5, "resultCount" : 5, "totalResults" : 2 }, "status" : "OK", "timestamp" : "2000-01-23T04:56:07.000+00:00" }, "links" : { "key" : { "href" : "href", "type" : "type" } }, "linked" : { "key" : { "key" : "{}" } } }

Produces: API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header:

• application/json

Response: LinkDataListWrapper

GET /testplans/{id}/links/{linkId}

Summary: Get the link with the specified ID

Path parameters:

• linkId (required)
  
• id (required)
  

Consumes: this API call consumes the following media types via the Content-Type request header:

• application/json

Request headers:

• xJamaDateFieldsWithTime (optional)
  

Query parameters:

• include (optional)
  Links to include as full objects in the linked map

Examples:

• Example data, content-type: application/json
  
  { "data" : { "href" : "href", "type" : "type" }, "meta" : { "status" : "OK", "timestamp" : "2000-01-23T04:56:07.000+00:00" }, "links" : { "key" : { "href" : "href", "type" : "type" } }, "linked" : { "key" : { "key" : "{}" } } }

Produces: API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header:

• application/json

Response: LinkDataWrapper

GET /testplans/{id}/lock

Summary: Get the locked state, last locked date, and last locked by user for the item with the specified ID

Path parameters:

• id (required)
  

Consumes: this API call consumes the following media types via the Content-Type request header:

• application/json

Request headers:

• xJamaDateFieldsWithTime (optional)
  

Query parameters:

• include (optional)
  Links to include as full objects in the linked map

Examples:

• Example data, content-type: application/json
  
  { "data" : { "lockedBy" : 7, "lastLockedDate" : "2000-01-23T04:56:07.000+00:00", "locked" : true }, "meta" : { "status" : "OK", "timestamp" : "2000-01-23T04:56:07.000+00:00" }, "links" : { "key" : { "href" : "href", "type" : "type" } }, "linked" : { "key" : { "key" : "{}" } } }

Produces: API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header:

• application/json

Response: LockDataWrapper