The abstractitems endpoint has the following operations:
GET /abstractitems
GET /abstractitems/{id}
GET /abstractitems/{id}/versions/{versionNum}
GET /abstractitems/{id}/versions/{versionNum}/versioneditem
GET /abstractitems/{id}/versionedrelationships
GET /abstractitems/{id}/versions
Below is more detail for each of the operations of the abstractitems endpoint.
Summary: Search for items, test plans, test cycles, test runs, or attachments
Consumes: this API call consumes the following media types via the
request header:
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)
includeWildcard
(optional)
Filter the search results with the specific 'contains' value, It maximizes your search results based on the variations of the word (e.g \"word\" )
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
request header;
the media type will be conveyed by the response header:
Response:
ItemDataListWrapper
Summary: Get any item, test plan, test cycle, test run, or attachment with the specified ID
Path parameters:
Consumes: this API call consumes the following media types via the
request header:
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
request header;
the media type will be conveyed by the response header:
Response:
AbstractItemDataWrapper
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
request header:
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
request header;
the media type will be conveyed by the response header:
Response:
VersionDataWrapper
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
request header:
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
request header;
the media type will be conveyed by the response header:
Response:
AbstractVersionedItemDataWrapper
Summary: Get all versioned relationships that were associated to the item at the specified time
Path parameters:
Consumes: this API call consumes the following media types via the
request header:
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
request header;
the media type will be conveyed by the response header:
Response:
VersionedRelationshipDataListWrapper
Summary: Get all versions for the item with the specified ID
Path parameters:
Consumes: this API call consumes the following media types via the
request header:
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
request header;
the media type will be conveyed by the response header:
Response:
VersionDataListWrapper
The activities endpoint has the following operations:
GET /activities
GET /activities/{activityId}
GET /activities/adminActivity
GET /activities/{activityId}/affecteditems
POST /activities/{activityId}/restore
Below is more detail for each of the operations of the activities endpoint.
Summary: Get all activities in the project with the specified ID
Consumes: this API call consumes the following media types via the
request header:
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
request header;
the media type will be conveyed by the response header:
Response:
ActivityDataListWrapper
Summary: Get the activity with the specified ID
Path parameters:
Consumes: this API call consumes the following media types via the
request header:
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
request header;
the media type will be conveyed by the response header:
Response:
ActivityDataWrapper
Summary: Get all activities at the admin level
Consumes: this API call consumes the following media types via the
request header:
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
request header;
the media type will be conveyed by the response header:
Response:
AbstractRestResponse
Summary: Get all items affected by the activity with the specified ID
Path parameters:
Consumes: this API call consumes the following media types via the
request header:
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
request header;
the media type will be conveyed by the response header:
Response:
ItemDataListWrapper
Summary: Restore item(s) associated with a delete activity.
Path parameters:
Consumes: this API call consumes the following media types via the
request header:
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
request header;
the media type will be conveyed by the response header:
Response:
AbstractRestResponse
The attachments endpoint has the following operations:
GET /attachments/{attachmentId}/file
GET /attachments/{attachmentId}
GET /attachments/{attachmentId}/comments
GET /attachments/{attachmentId}/lock
GET /attachments/{attachmentId}/versions/{versionNum}
GET /attachments/{attachmentId}/versions/{versionNum}/versioneditem
GET /attachments/{attachmentId}/versions
PUT /attachments/{attachmentId}/lock
PUT /attachments/{attachmentId}/file
Below is more detail for each of the operations of the attachments endpoint.
Summary: Download attachment file from the attachment with the specified ID
Path parameters:
Consumes: this API call consumes the following media types via the
request header:
Request headers:
xJamaDateFieldsWithTime
(optional)
Produces: API call produces the following media types according to the
request header;
the media type will be conveyed by the response header:
Response:
Summary: Get the attachment with the specified ID
Path parameters:
Consumes: this API call consumes the following media types via the
request header:
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
request header;
the media type will be conveyed by the response header:
Response:
AttachmentDataWrapper
Summary: Get all comments for the item with the specified ID
Path parameters:
Consumes: this API call consumes the following media types via the
request header:
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
request header;
the media type will be conveyed by the response header:
Response:
CommentDataListWrapper
Summary: Get the locked state, last locked date, and last locked by user for the item with the specified ID
Path parameters:
Consumes: this API call consumes the following media types via the
request header:
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
request header;
the media type will be conveyed by the response header:
Response:
LockDataWrapper
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
request header:
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
request header;
the media type will be conveyed by the response header:
Response:
VersionDataWrapper
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
request header:
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
request header;
the media type will be conveyed by the response header:
Response:
VersionedAttachmentDataWrapper
Summary: Get all versions for the item with the specified ID
Path parameters:
Consumes: this API call consumes the following media types via the
request header:
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
request header;
the media type will be conveyed by the response header:
Response:
VersionDataListWrapper
Summary: Update the locked state of the item with the specified ID
Path parameters:
Consumes: this API call consumes the following media types via the
request header:
Body:
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
request header;
the media type will be conveyed by the response header:
Response:
AbstractRestResponse
Summary: Upload attachment file to the attachment with the specified ID
Path parameters:
Consumes: this API call consumes the following media types via the
request header:
Body:
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
request header;
the media type will be conveyed by the response header:
Response:
AbstractRestResponse
The baselines endpoint has the following operations:
DELETE /baselines/{baselineId}
GET /baselines/{baselineId}
GET /baselines
GET /baselines/{baselineId}/versioneditems/{itemId}/versionedrelationships
GET /baselines/{baselineId}/reviewlink
GET /baselines/{baselineId}/versioneditems/{itemId}
GET /baselines/{baselineId}/versioneditems
PUT /baselines/{baselineId}
Below is more detail for each of the operations of the baselines endpoint.
Summary: Delete the baseline with the specified ID
Path parameters:
Consumes: this API call consumes the following media types via the
request header:
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
request header;
the media type will be conveyed by the response header:
Response:
AbstractRestResponse
Summary: Get the baseline with the specified ID
Path parameters:
Consumes: this API call consumes the following media types via the
request header:
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
request header;
the media type will be conveyed by the response header:
Response:
BaselineDataWrapper
Summary: Get all baselines in the project with the specified ID
Consumes: this API call consumes the following media types via the
request header:
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
request header;
the media type will be conveyed by the response header:
Response:
BaselineDataListWrapper
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
request header:
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
request header;
the media type will be conveyed by the response header:
Response:
VersionedRelationshipDataListWrapper
Summary: Get related review link
Path parameters:
Consumes: this API call consumes the following media types via the
request header:
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
request header;
the media type will be conveyed by the response header:
Response:
AbstractRestResponse
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
request header:
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
request header;
the media type will be conveyed by the response header:
Response:
BaselineItemDataWrapper
Summary: Get all baseline items in a baseline with the specified ID
Path parameters:
Consumes: this API call consumes the following media types via the
request header:
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
request header;
the media type will be conveyed by the response header:
Response:
BaselineItemDataListWrapper
Summary: Update the baseline with the specified ID
Path parameters:
Consumes: this API call consumes the following media types via the
request header:
Body:
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
request header;
the media type will be conveyed by the response header:
Response:
AbstractRestResponse
The comments endpoint has the following operations:
POST /comments
GET /comments/{id}
GET /comments
GET /comments/{id}/replies
Below is more detail for each of the operations of the comments endpoint.
Summary: Create a new comment
Consumes: this API call consumes the following media types via the
request header:
Body:
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
request header;
the media type will be conveyed by the response header:
Response:
CreatedResponse
Summary: Get the comment with the specified ID
Path parameters:
Consumes: this API call consumes the following media types via the
request header:
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
request header;
the media type will be conveyed by the response header:
Response:
CommentDataWrapper
Summary: Get all comments viewable by the current user
Consumes: this API call consumes the following media types via the
request header:
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
request header;
the media type will be conveyed by the response header:
Response:
CommentDataListWrapper
Summary: Get all reply comments for the comment with the specified ID
Path parameters:
Consumes: this API call consumes the following media types via the
request header:
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
request header;
the media type will be conveyed by the response header:
Response:
CommentDataListWrapper
The files endpoint has the following operations:
GET /files
Below is more detail for each of the operations of the files endpoint.
Summary: Download attachment file from the attachment with the specified Jama URL
Consumes: this API call consumes the following media types via the
request header:
Request headers:
xJamaDateFieldsWithTime
(optional)
Query parameters:
Produces: API call produces the following media types according to the
request header;
the media type will be conveyed by the response header:
application/json
application/octet-stream
Response:
The filters endpoint has the following operations:
GET /filters/{filterId}/count
GET /filters/{filterId}
GET /filters
GET /filters/{filterId}/results
Below is more detail for each of the operations of the filters endpoint.
Summary: Get the count for the filter with the specified ID
Path parameters:
Consumes: this API call consumes the following media types via the
request header:
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
request header;
the media type will be conveyed by the response header:
Response:
ItemDataListWrapper
Summary: Get the filter with the specified ID
Path parameters:
Consumes: this API call consumes the following media types via the
request header:
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
request header;
the media type will be conveyed by the response header:
Response:
FilterDataWrapper
Summary: Get all filters viewable by the current user
Consumes: this API call consumes the following media types via the
request header:
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
request header;
the media type will be conveyed by the response header:
Response:
FilterDataListWrapper
Summary: Get all result items for the filter with the specified ID
Path parameters:
Consumes: this API call consumes the following media types via the
request header:
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
request header;
the media type will be conveyed by the response header:
Response:
ItemDataListWrapper
The items endpoint has the following operations:
POST /items/{id}/attachments
POST /items
POST /items/{id}/links
POST /items/{id}/tags
DELETE /items/{id}/synceditems/{syncedItemId}
POST /items/{id}/synceditems
DELETE /items/{id}
DELETE /items/{id}/links/{linkId}
POST /items/{id}/duplicate
POST /items/{id}/workflowtransitions
GET /items/{id}/activities
GET /items/{id}/attachments
GET /items/{id}/children
GET /items/{id}/downstreamrelated
GET /items/{id}/downstreamrelationships
GET /items/{id}
GET /items/{id}/comments
GET /items/{id}/links
GET /items
GET /items/{id}/links/{linkId}
GET /items/{id}/location
GET /items/{id}/lock
GET /items/{id}/parent
GET /items/{id}/synceditems
GET /items/{id}/synceditems/{syncedItemId}/syncstatus
GET /items/{id}/tags/{tagId}
GET /items/{id}/tags
GET /items/{id}/upstreamrelated
GET /items/{id}/upstreamrelationships
GET /items/{id}/versions/{versionNum}
GET /items/{id}/versionedcategories
GET /items/{id}/versions/{versionNum}/versioneditem
GET /items/{id}/versions
GET /items/{id}/workflowtransitionoptions
PUT /items/treeLocation
PATCH /items/{id}
PATCH /items
PUT /items/{id}
DELETE /items/{id}/attachments/{attachmentId}
DELETE /items/{id}/tags/{tagId}
PUT /items/{id}/links/{linkId}
PUT /items/{id}/location
PUT /items/{id}/lock
Below is more detail for each of the operations of the items endpoint.
Summary: Add an existing attachment to the item with the specified ID
Path parameters:
Consumes: this API call consumes the following media types via the
request header:
Body:
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
request header;
the media type will be conveyed by the response header:
Response:
CreatedResponse
Summary: Create a new item
Consumes: this API call consumes the following media types via the
request header:
Body:
Request headers:
xJamaDateFieldsWithTime
(optional)
Preserves both date and time of any DATETIME field value passed in the body of the request. Must be in ISO8601 format (milliseconds or seconds) - \"yyyy-MM-dd'T'HH:mm:ss.SSSZ\" or \"yyyy-MM-dd'T'HH:mm:ssZ\".
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
request header;
the media type will be conveyed by the response header:
Response:
CreatedResponse
Summary: Create a new link for the item with the specified ID
Path parameters:
Consumes: this API call consumes the following media types via the
request header:
Body:
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
request header;
the media type will be conveyed by the response header:
Response:
CreatedResponse
Summary: Add an existing tag to the item with the specified ID
Path parameters:
Consumes: this API call consumes the following media types via the
request header:
Body:
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
request header;
the media type will be conveyed by the response header:
Response:
CreatedResponse
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
request header:
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
request header;
the media type will be conveyed by the response header:
Response:
AbstractRestResponse
Summary: Add an existing item to the Global ID pool of the item with the specified ID
Path parameters:
Consumes: this API call consumes the following media types via the
request header:
Body:
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
request header;
the media type will be conveyed by the response header:
Response:
CreatedResponse
Summary: Delete the item with the specified ID (item becomes inactive and can be un-deleted if necessary)
Path parameters:
Consumes: this API call consumes the following media types via the
request header:
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
request header;
the media type will be conveyed by the response header:
Response:
AbstractRestResponse
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
request header:
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
request header;
the media type will be conveyed by the response header:
Response:
AbstractRestResponse
Summary: Create a duplicate of item
Copies the name and description fields. Only items without children can be have a duplicate created.
Path parameters:
Consumes: this API call consumes the following media types via the
request header:
Body:
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
request header;
the media type will be conveyed by the response header:
Response:
CreatedResponse
Summary: Executes a workflow transition for the item with the specified ID. Valid transitions can be found at /items/{id}/workflowtransitionoptions
Path parameters:
Consumes: this API call consumes the following media types via the
request header:
Body:
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
request header;
the media type will be conveyed by the response header:
Response:
CreatedResponse
Summary: Get all activities for the item with the specified ID
Path parameters:
Consumes: this API call consumes the following media types via the
request header:
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
request header;
the media type will be conveyed by the response header:
Response:
ActivityDataListWrapper
Summary: Get all attachments for the item with the specified ID
Path parameters:
Consumes: this API call consumes the following media types via the
request header:
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
request header;
the media type will be conveyed by the response header:
Response:
AttachmentDataListWrapper
Summary: Get all children items for the item with the specified ID
Path parameters:
Consumes: this API call consumes the following media types via the
request header:
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
request header;
the media type will be conveyed by the response header:
Response:
ItemDataListWrapper
Summary: Get all downstream related items for the item with the specified ID
Path parameters:
Consumes: this API call consumes the following media types via the
request header:
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
request header;
the media type will be conveyed by the response header:
Response:
ItemDataListWrapper
Summary: Get all downstream relationships for the item with the specified ID
Path parameters:
Consumes: this API call consumes the following media types via the
request header:
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
request header;
the media type will be conveyed by the response header:
Response:
RelationshipDataListWrapper
Summary: Get the item with the specified ID
Path parameters:
Consumes: this API call consumes the following media types via the
request header:
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
request header;
the media type will be conveyed by the response header:
Response:
ItemDataWrapper
Summary: Get all comments for the item with the specified ID
Path parameters:
Consumes: this API call consumes the following media types via the
request header:
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
request header;
the media type will be conveyed by the response header:
Response:
CommentDataListWrapper
Summary: Get all links for the item with the specified ID
Path parameters:
Consumes: this API call consumes the following media types via the
request header:
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
request header;
the media type will be conveyed by the response header:
Response:
LinkDataListWrapper
Summary: Get all items in the project with the specified ID
Consumes: this API call consumes the following media types via the
request header:
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
request header;
the media type will be conveyed by the response header:
Response:
ItemDataListWrapper
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
request header:
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
request header;
the media type will be conveyed by the response header:
Response:
LinkDataWrapper
Summary: Get the location for the item with the specified ID
Path parameters:
Consumes: this API call consumes the following media types via the
request header:
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
request header;
the media type will be conveyed by the response header:
Response:
LocationDataWrapper
Summary: Get the locked state, last locked date, and last locked by user for the item with the specified ID
Path parameters:
Consumes: this API call consumes the following media types via the
request header:
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
request header;
the media type will be conveyed by the response header:
Response:
LockDataWrapper
Summary: Get the parent item for the item with the specified ID
Path parameters:
Consumes: this API call consumes the following media types via the
request header:
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
request header;
the media type will be conveyed by the response header:
Response:
ItemDataWrapper
Summary: Get all synchronized items for the item with the specified ID
Path parameters:
Consumes: this API call consumes the following media types via the
request header:
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
request header;
the media type will be conveyed by the response header:
Response:
ItemDataListWrapper
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
request header:
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
request header;
the media type will be conveyed by the response header:
Response:
SyncStatusDataWrapper
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
request header:
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
request header;
the media type will be conveyed by the response header:
Response:
TagDataWrapper
Summary: Get all tags for the item with the specified ID
Path parameters:
Consumes: this API call consumes the following media types via the
request header:
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
request header;
the media type will be conveyed by the response header:
Response:
TagDataListWrapper
Summary: Get all upstream related items for the item with the specified ID
Path parameters:
Consumes: this API call consumes the following media types via the
request header:
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
request header;
the media type will be conveyed by the response header:
Response:
ItemDataListWrapper
Summary: Get all upstream relationships for the item with the specified ID
Path parameters:
Consumes: this API call consumes the following media types via the
request header:
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
request header;
the media type will be conveyed by the response header:
Response:
RelationshipDataListWrapper
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
request header:
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
request header;
the media type will be conveyed by the response header:
Response:
VersionDataWrapper
Summary: Get all versioned categories for the item with the specified version number
Path parameters:
Consumes: this API call consumes the following media types via the
request header:
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
request header;
the media type will be conveyed by the response header:
Response:
AbstractRestResponse
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
request header:
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
request header;
the media type will be conveyed by the response header:
Response:
VersionedItemDataWrapper
Summary: Get all versions for the item with the specified ID
Path parameters:
Consumes: this API call consumes the following media types via the
request header:
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
request header;
the media type will be conveyed by the response header:
Response:
VersionDataListWrapper
Summary: Get all valid workflow transitions that can be made on the item with the specified ID
Path parameters:
Consumes: this API call consumes the following media types via the
request header:
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
request header;
the media type will be conveyed by the response header:
Response:
WorkflowTransitionDataListWrapper
Summary:
Consumes: this API call consumes the following media types via the
request header:
Body:
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
request header;
the media type will be conveyed by the response header:
Response:
AbstractRestResponse
Summary: Update the item with the specified ID
Path parameters:
Consumes: this API call consumes the following media types via the
request header:
Body:
Request headers:
xJamaDateFieldsWithTime
(optional)
Preserves both date and time of any DATETIME field value passed in the body of the request. Must be in ISO8601 format (milliseconds or seconds) - \"yyyy-MM-dd'T'HH:mm:ss.SSSZ\" or \"yyyy-MM-dd'T'HH:mm:ssZ\".
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
request header;
the media type will be conveyed by the response header:
Response:
AbstractRestResponse
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
request header:
Body:
Request headers:
xJamaDateFieldsWithTime
(optional)
Preserves both date and time of any DATETIME field value passed in the body of the request. Must be in ISO8601 format (milliseconds or seconds) - \"yyyy-MM-dd'T'HH:mm:ss.SSSZ\" or \"yyyy-MM-dd'T'HH:mm:ssZ\".
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
request header;
the media type will be conveyed by the response header:
Response:
ObjectResponse
Response:
BadRequestResponse
Summary: Update the item with the specified ID
Path parameters:
Consumes: this API call consumes the following media types via the
request header:
Body:
Request headers:
xJamaDateFieldsWithTime
(optional)
Preserves both date and time of any DATETIME field value passed in the body of the request. Must be in ISO8601 format (milliseconds or seconds) - \"yyyy-MM-dd'T'HH:mm:ss.SSSZ\" or \"yyyy-MM-dd'T'HH:mm:ssZ\".
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
request header;
the media type will be conveyed by the response header:
Response:
AbstractRestResponse
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
request header:
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
request header;
the media type will be conveyed by the response header:
Response:
AbstractRestResponse
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
request header:
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
request header;
the media type will be conveyed by the response header:
Response:
AbstractRestResponse
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
request header:
Body:
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
request header;
the media type will be conveyed by the response header:
Response:
AbstractRestResponse
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:
Consumes: this API call consumes the following media types via the
request header:
Body:
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
request header;
the media type will be conveyed by the response header:
Response:
AbstractRestResponse
Summary: Update the locked state of the item with the specified ID
Path parameters:
Consumes: this API call consumes the following media types via the
request header:
Body:
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
request header;
the media type will be conveyed by the response header:
Response:
AbstractRestResponse
The itemtypes endpoint has the following operations:
POST /itemtypes/{itemTypeId}/fields
POST /itemtypes
GET /itemtypes/{itemTypeId}
GET /itemtypes
Below is more detail for each of the operations of the itemtypes endpoint.
Summary: Create a new item type field for the item type with the specified ID
Path parameters:
Consumes: this API call consumes the following media types via the
request header:
Body:
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
request header;
the media type will be conveyed by the response header:
Response:
AbstractRestResponse
Summary: Create a new item type
Consumes: this API call consumes the following media types via the
request header:
Body:
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
request header;
the media type will be conveyed by the response header:
Response:
AbstractRestResponse
Summary: Get the item type with the specified ID
Path parameters:
Consumes: this API call consumes the following media types via the
request header:
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
request header;
the media type will be conveyed by the response header:
Response:
ItemTypeDataWrapper
Summary: Get all item types
Consumes: this API call consumes the following media types via the
request header:
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
request header;
the media type will be conveyed by the response header:
Response:
ItemTypeDataListWrapper
The picklistoptions endpoint has the following operations:
GET /picklistoptions/{picklistOptionId}
PUT /picklistoptions/{picklistOptionId}
Below is more detail for each of the operations of the picklistoptions endpoint.
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
request header:
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
request header;
the media type will be conveyed by the response header:
Response:
PickListOptionDataWrapper
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
request header:
Body:
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
request header;
the media type will be conveyed by the response header:
Response:
AbstractRestResponse
The picklists endpoint has the following operations:
POST /picklists/{picklistId}/options
POST /picklists
DELETE /picklists/{picklistId}
GET /picklists/{picklistId}
GET /picklists/{picklistId}/options
GET /picklists
Below is more detail for each of the operations of the picklists endpoint.
Summary: Create a new pick list option for the pick list with the specified ID
Path parameters:
Consumes: this API call consumes the following media types via the
request header:
Body:
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
request header;
the media type will be conveyed by the response header:
Response:
CreatedResponse
Summary: Create a new pick list
Consumes: this API call consumes the following media types via the
request header:
Body:
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
request header;
the media type will be conveyed by the response header:
Response:
AbstractRestResponse
Summary: Delete the pick list
Path parameters:
Consumes: this API call consumes the following media types via the
request header:
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
request header;
the media type will be conveyed by the response header:
Response:
AbstractRestResponse
Summary: Get the pick list with the specified ID
Path parameters:
Consumes: this API call consumes the following media types via the
request header:
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
request header;
the media type will be conveyed by the response header:
Response:
PickListDataWrapper
Summary: Get all pick list options for the pick list with the specified ID
Path parameters:
Consumes: this API call consumes the following media types via the
request header:
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
request header;
the media type will be conveyed by the response header:
Response:
PickListOptionDataListWrapper
Summary: Get all pick lists
Consumes: this API call consumes the following media types via the
request header:
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
request header;
the media type will be conveyed by the response header:
Response:
PickListDataListWrapper
The projects endpoint has the following operations:
PUT /projects/{projectId}/itemtypes/{itemTypeId}
POST /projects
GET /projects/{projectId}/itemtypes
GET /projects/{projectId}
GET /projects
GET /projects/{projectId}/tags
POST /projects/{projectId}/attachments
PUT /projects/{projectId}
DELETE /projects/{projectId}/itemtypes/{itemTypeId}
Below is more detail for each of the operations of the projects endpoint.
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
request header:
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
request header;
the media type will be conveyed by the response header:
Response:
AbstractRestResponse
Summary: Create a new project
Consumes: this API call consumes the following media types via the
request header:
Body:
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
request header;
the media type will be conveyed by the response header:
Response:
CreatedResponse
Summary: Get all item types for the project with the specified ID
Path parameters:
Consumes: this API call consumes the following media types via the
request header:
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
request header;
the media type will be conveyed by the response header:
Response:
ItemTypeDataListWrapper
Summary: Get the project with the specified ID
Path parameters:
Consumes: this API call consumes the following media types via the
request header:
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
request header;
the media type will be conveyed by the response header:
Response:
ProjectDataWrapper
Summary: Get all projects
Consumes: this API call consumes the following media types via the
request header:
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
request header;
the media type will be conveyed by the response header:
Response:
ProjectDataListWrapper
Summary: Get all tags for the project with the specified ID
Path parameters:
Consumes: this API call consumes the following media types via the
request header:
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
request header;
the media type will be conveyed by the response header:
Response:
TagDataListWrapper
Summary: Create a new attachment in the project with the specified ID
Path parameters:
Consumes: this API call consumes the following media types via the
request header:
Body:
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
request header;
the media type will be conveyed by the response header:
Response:
CreatedResponse
Summary: Update the project with the specified ID
Path parameters:
Consumes: this API call consumes the following media types via the
request header:
Body:
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
request header;
the media type will be conveyed by the response header:
Response:
AbstractRestResponse
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
request header:
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
request header;
the media type will be conveyed by the response header:
Response:
AbstractRestResponse
The relationshiprulesets endpoint has the following operations:
GET /relationshiprulesets/{id}/projects
GET /relationshiprulesets
GET /relationshiprulesets/{id}
Below is more detail for each of the operations of the relationshiprulesets endpoint.
Summary: Get Projects that have a given Relationship Rule Set assigned.
Path parameters:
Consumes: this API call consumes the following media types via the
request header:
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",
"active" : true,
"id" : 6,
"mask" : 1
}
Produces: API call produces the following media types according to the
request header;
the media type will be conveyed by the response header:
Response:
ProjectPropertyDTO
Summary: Gets all Relationship Rule Sets in the organization
Consumes: this API call consumes the following media types via the
request header:
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",
"active" : true,
"id" : 6,
"mask" : 1
}, {
"organizationId" : 5,
"projectKey" : "projectKey",
"string1" : "string1",
"name" : "name",
"active" : true,
"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",
"active" : true,
"id" : 6,
"mask" : 1
}, {
"organizationId" : 5,
"projectKey" : "projectKey",
"string1" : "string1",
"name" : "name",
"active" : true,
"id" : 6,
"mask" : 1
} ]
} ]
Produces: API call produces the following media types according to the
request header;
the media type will be conveyed by the response header:
Response:
array[RelationshipRuleSetDTO ]
Summary: Get a Relationship Rule Set by id
Path parameters:
Consumes: this API call consumes the following media types via the
request header:
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",
"active" : true,
"id" : 6,
"mask" : 1
}, {
"organizationId" : 5,
"projectKey" : "projectKey",
"string1" : "string1",
"name" : "name",
"active" : true,
"id" : 6,
"mask" : 1
} ]
}
Produces: API call produces the following media types according to the
request header;
the media type will be conveyed by the response header:
Response:
RelationshipRuleSetDTO
The relationships endpoint has the following operations:
DELETE /relationships/{relationshipId}/suspect
POST /relationships
DELETE /relationships/{relationshipId}
GET /relationships/{relationshipId}
GET /relationships
PUT /relationships/{relationshipId}
Below is more detail for each of the operations of the relationships endpoint.
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
request header:
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
request header;
the media type will be conveyed by the response header:
Response:
AbstractRestResponse
Summary: Create a new relationship
Consumes: this API call consumes the following media types via the
request header:
Body:
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
request header;
the media type will be conveyed by the response header:
Response:
CreatedResponse
Summary: Delete the relationship with the specified ID
Path parameters:
relationshipId
(required)
Consumes: this API call consumes the following media types via the
request header:
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
request header;
the media type will be conveyed by the response header:
Response:
AbstractRestResponse
Summary: Get the relationship with the specified ID
Path parameters:
relationshipId
(required)
Consumes: this API call consumes the following media types via the
request header:
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
request header;
the media type will be conveyed by the response header:
Response:
RelationshipDataWrapper
Summary: Get all relationships in the project with the specified ID
Consumes: this API call consumes the following media types via the
request header:
Request headers:
xJamaDateFieldsWithTime
(optional)
Query parameters:
project
(required)
startAt
(optional)
lastId
(optional)
omitCount
(optional)
, default value: false
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
request header;
the media type will be conveyed by the response header:
Response:
RelationshipDataListWrapper
Summary: Update the relationship with the specified ID
Path parameters:
relationshipId
(required)
Consumes: this API call consumes the following media types via the
request header:
Body:
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
request header;
the media type will be conveyed by the response header:
Response:
AbstractRestResponse
The relationshiptypes endpoint has the following operations:
GET /relationshiptypes/{id}
GET /relationshiptypes
Below is more detail for each of the operations of the relationshiptypes endpoint.
Summary: Get the relationship type with the specified ID
Path parameters:
Consumes: this API call consumes the following media types via the
request header:
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
request header;
the media type will be conveyed by the response header:
Response:
RelationshipTypeDataWrapper
Summary: Get all relationship types
Consumes: this API call consumes the following media types via the
request header:
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
request header;
the media type will be conveyed by the response header:
Response:
RelationshipTypeDataListWrapper
The releases endpoint has the following operations:
POST /releases
GET /releases/{releaseId}
GET /releases
PUT /releases/{releaseId}
Below is more detail for each of the operations of the releases endpoint.
Summary: Create a new release
Consumes: this API call consumes the following media types via the
request header:
Body:
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
request header;
the media type will be conveyed by the response header:
Response:
CreatedResponse
Summary: Get the release with the specified ID
Path parameters:
Consumes: this API call consumes the following media types via the
request header:
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
request header;
the media type will be conveyed by the response header:
Response:
ReleaseDataWrapper
Summary: Get all releases in the project with the specified ID
Consumes: this API call consumes the following media types via the
request header:
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
request header;
the media type will be conveyed by the response header:
Response:
ReleaseDataListWrapper
Summary: Update the release with the specified ID
Path parameters:
Consumes: this API call consumes the following media types via the
request header:
Body:
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
request header;
the media type will be conveyed by the response header:
Response:
AbstractRestResponse
The system endpoint has the following operations:
GET /system/settings/corsdomains
POST /system/settings/corsdomains
Below is more detail for each of the operations of the system endpoint.
Summary: Get the current CORS domain whitelist
Consumes: this API call consumes the following media types via the
request header:
Request headers:
xJamaDateFieldsWithTime
(optional)
Examples:
Produces: API call produces the following media types according to the
request header;
the media type will be conveyed by the response header:
Response:
CrossOriginDomainWhiteList
Summary: Update CORS domain whitelist
Consumes: this API call consumes the following media types via the
request header:
Body:
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
request header;
the media type will be conveyed by the response header:
Response:
AbstractRestResponse
The tags endpoint has the following operations:
POST /tags
DELETE /tags/{id}
GET /tags/{id}/items
GET /tags/{id}
GET /tags
PUT /tags/{id}
Below is more detail for each of the operations of the tags endpoint.
Summary: Create a new tag in the project with the specified ID
Consumes: this API call consumes the following media types via the
request header:
Body:
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
request header;
the media type will be conveyed by the response header:
Response:
CreatedResponse
Summary: Delete the tag with the specified ID
Path parameters:
Consumes: this API call consumes the following media types via the
request header:
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
request header;
the media type will be conveyed by the response header:
Response:
AbstractRestResponse
Summary: Get all items that have the tag with the specified ID
Path parameters:
Consumes: this API call consumes the following media types via the
request header:
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
request header;
the media type will be conveyed by the response header:
Response:
ItemDataListWrapper
Summary: Get the tag with the specified ID
Path parameters:
Consumes: this API call consumes the following media types via the
request header:
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
request header;
the media type will be conveyed by the response header:
Response:
TagDataWrapper
Summary: Get all tags for the project with the specified ID
Consumes: this API call consumes the following media types via the
request header:
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
request header;
the media type will be conveyed by the response header:
Response:
TagDataListWrapper
Summary: Update the tag with the specified ID
Path parameters:
Consumes: this API call consumes the following media types via the
request header:
Body:
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
request header;
the media type will be conveyed by the response header:
Response:
AbstractRestResponse
The testcycles endpoint has the following operations:
DELETE /testcycles/{testCycleId}
GET /testcycles/{testCycleId}
GET /testcycles/{testCycleId}/testgroup/{testGroupId}
GET /testcycles/{testCycleId}/testruns
GET /testcycles/{testCycleId}/versions/{versionNum}
GET /testcycles/{testCycleId}/versions/{versionNum}/versioneditem
GET /testcycles/{testCycleId}/versions
PATCH /testcycles/{testCycleId}
PUT /testcycles/{testCycleId}
Below is more detail for each of the operations of the testcycles endpoint.
Summary: Delete the test cycle with the specified ID, including the test runs in the test cycle
Path parameters:
Consumes: this API call consumes the following media types via the
request header:
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
request header;
the media type will be conveyed by the response header:
Response:
AbstractRestResponse
Summary: Get the test cycle with the specified ID
Path parameters:
Consumes: this API call consumes the following media types via the
request header:
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
request header;
the media type will be conveyed by the response header:
Response:
TestCycleDataWrapper
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
request header:
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
request header;
the media type will be conveyed by the response header:
Response:
TestCycleTestGroupDataWrapper
Summary: Get all test runs for the test cycle with the specified ID
Path parameters:
Consumes: this API call consumes the following media types via the
request header:
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
request header;
the media type will be conveyed by the response header:
Response:
TestRunDataListWrapper
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
request header:
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
request header;
the media type will be conveyed by the response header:
Response:
VersionDataWrapper
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
request header:
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
request header;
the media type will be conveyed by the response header:
Response:
VersionedTestCycleDataWrapper
Summary: Get all versions for the item with the specified ID
Path parameters:
Consumes: this API call consumes the following media types via the
request header:
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
request header;
the media type will be conveyed by the response header:
Response:
VersionDataListWrapper
Summary: Update the test cycle with the specified ID, including regenerating the test runs in the test cycle
Path parameters:
Consumes: this API call consumes the following media types via the
request header:
Body:
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
request header;
the media type will be conveyed by the response header:
Response:
AbstractRestResponse
Summary: Update the test cycle with the specified ID, including regenerating the test runs in the test cycle
Path parameters:
Consumes: this API call consumes the following media types via the
request header:
Body:
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
request header;
the media type will be conveyed by the response header:
Response:
AbstractRestResponse
The testplans endpoint has the following operations:
POST /testplans/{id}/attachments
POST /testplans/{id}/links
POST /testplans/{id}/tags
POST /testplans/{id}/testgroups
POST /testplans/{id}/testcycles
POST /testplans
DELETE /testplans/{id}/links/{linkId}
DELETE /testplans/{id}/testgroups/{testGroupId}/testcases/{testCaseId}
DELETE /testplans/{id}/testgroups/{testGroupId}
DELETE /testplans/{id}
GET /testplans/{id}/activities
GET /testplans/{id}/attachments
GET /testplans/{id}/downstreamrelated
GET /testplans/{id}/downstreamrelationships
GET /testplans/{id}/comments
GET /testplans/{id}/links
GET /testplans/{id}/links/{linkId}
GET /testplans/{id}/lock
GET /testplans/{id}/tags/{tagId}
GET /testplans/{id}/tags
GET /testplans/{id}/testgroups/{testGroupId}/testcases/{testCaseId}
GET /testplans/{id}/testgroups/{testGroupId}/testcases
GET /testplans/{id}/testcycles
GET /testplans/{id}/testgroups/{testGroupId}
GET /testplans/{id}/testgroups
GET /testplans/{id}
GET /testplans
GET /testplans/{id}/upstreamrelated
GET /testplans/{id}/upstreamrelationships
GET /testplans/{id}/versions/{versionNum}
GET /testplans/{id}/versions/{versionNum}/versioneditem
GET /testplans/{id}/versions
PATCH /testplans/{id}
POST /testplans/{id}/testgroups/{testGroupId}/testcases
DELETE /testplans/{id}/attachments/{attachmentId}
DELETE /testplans/{id}/tags/{tagId}
PUT /testplans/{id}/archived
PUT /testplans/{id}/links/{linkId}
PUT /testplans/{id}/lock
PUT /testplans/{id}/testgroups/{testGroupId}
PUT /testplans/{id}
Below is more detail for each of the operations of the testplans endpoint.
Summary: Add an existing attachment to the item with the specified ID
Path parameters:
Consumes: this API call consumes the following media types via the
request header:
Body:
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
request header;
the media type will be conveyed by the response header:
Response:
CreatedResponse
Summary: Create a new link for the item with the specified ID
Path parameters:
Consumes: this API call consumes the following media types via the
request header:
Body:
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
request header;
the media type will be conveyed by the response header:
Response:
CreatedResponse
Summary: Add an existing tag to the item with the specified ID
Path parameters:
Consumes: this API call consumes the following media types via the
request header:
Body:
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
request header;
the media type will be conveyed by the response header:
Response:
CreatedResponse
Summary: Create a new test group to the test plan with the specified ID
Path parameters:
Consumes: this API call consumes the following media types via the
request header:
Body:
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
request header;
the media type will be conveyed by the response header:
Response:
CreatedResponse
Summary: Create a new test cycle
Path parameters:
Consumes: this API call consumes the following media types via the
request header:
Body:
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
request header;
the media type will be conveyed by the response header:
Response:
CreatedResponse
Summary: Create a new test plan
Consumes: this API call consumes the following media types via the
request header:
Body:
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
request header;
the media type will be conveyed by the response header:
Response:
CreatedResponse
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
request header:
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
request header;
the media type will be conveyed by the response header:
Response:
AbstractRestResponse
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
request header:
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
request header;
the media type will be conveyed by the response header:
Response:
AbstractRestResponse
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
request header:
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
request header;
the media type will be conveyed by the response header:
Response:
AbstractRestResponse
Summary: Delete the test plan with the specified ID
Path parameters:
Consumes: this API call consumes the following media types via the
request header:
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
request header;
the media type will be conveyed by the response header:
Response:
AbstractRestResponse
Summary: Get all activities for the test plan with the specified ID
Path parameters:
Consumes: this API call consumes the following media types via the
request header:
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
request header;
the media type will be conveyed by the response header:
Response:
ActivityDataListWrapper
Summary: Get all attachments for the item with the specified ID
Path parameters:
Consumes: this API call consumes the following media types via the
request header:
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
request header;
the media type will be conveyed by the response header:
Response:
AttachmentDataListWrapper
Summary: Get all downstream related items for the test plan with the specified ID
Path parameters:
Consumes: this API call consumes the following media types via the
request header:
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
request header;
the media type will be conveyed by the response header:
Response:
AbstractItemDataListWrapper
Summary: Get all downstream relationships for the test plan with the specified ID
Path parameters:
Consumes: this API call consumes the following media types via the
request header:
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
request header;
the media type will be conveyed by the response header:
Response:
RelationshipDataListWrapper
Summary: Get all comments for the item with the specified ID
Path parameters:
Consumes: this API call consumes the following media types via the
request header:
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
request header;
the media type will be conveyed by the response header:
Response:
CommentDataListWrapper
Summary: Get all links for the item with the specified ID
Path parameters:
Consumes: this API call consumes the following media types via the
request header:
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
request header;
the media type will be conveyed by the response header:
Response:
LinkDataListWrapper
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
request header:
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
request header;
the media type will be conveyed by the response header:
Response:
LinkDataWrapper
Summary: Get the locked state, last locked date, and last locked by user for the item with the specified ID
Path parameters:
Consumes: this API call consumes the following media types via the
request header:
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
request header;
the media type will be conveyed by the response header:
Response:
LockDataWrapper
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
request header:
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
request header;
the media type will be conveyed by the response header:
Response:
TagDataWrapper
Summary: Get all tags for the item with the specified ID
Path parameters:
Consumes: this API call consumes the following media types via the
request header:
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
request header;
the media type will be conveyed by the response header:
Response:
TagDataListWrapper
Summary: Get the test case with the specified ID
Path parameters:
testCaseId
(required)
testGroupId
(required)
id
(required)
Consumes: this API call consumes the following media types via the
request header:
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
request header;
the media type will be conveyed by the response header:
Response:
ItemDataWrapper
Summary: Get all test cases associated with the test group with the specified ID
Path parameters:
testGroupId
(required)
id
(required)
Consumes: this API call consumes the following media types via the
request header:
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
request header;
the media type will be conveyed by the response header:
Response:
ItemDataListWrapper
Summary: Get all test cycles for the test plan with the specified ID
Path parameters:
Consumes: this API call consumes the following media types via the
request header:
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
request header;
the media type will be conveyed by the response header:
Response:
TestCycleDataListWrapper
Summary: Get the test group with the specified ID
Path parameters:
testGroupId
(required)
id
(required)
Consumes: this API call consumes the following media types via the
request header:
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",
"id" : 0,
"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
request header;
the media type will be conveyed by the response header:
Response:
TestGroupDataWrapper
Summary: Get all test groups for the test plan with the specified ID
Path parameters:
Consumes: this API call consumes the following media types via the
request header:
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",
"id" : 0,
"assignedTo" : 6
}, {
"name" : "name",
"id" : 0,
"assignedTo" : 6
} ],
"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
request header;
the media type will be conveyed by the response header:
Response:
TestGroupDataListWrapper
Summary: Get the test plan with the specified ID
Path parameters:
Consumes: this API call consumes the following media types via the
request header:
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" ]
}
},
"archived" : true,
"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
request header;
the media type will be conveyed by the response header:
Response:
TestPlanDataWrapper
Summary: Get all test plans in the project with the specified ID
Consumes: this API call consumes the following media types via the
request header:
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" : [ {
"itemType" : 1,
"globalId" : "globalId",
"project" : 6,
"resources" : {
"key" : {
"allowed" : [ "allowed", "allowed" ]
}
},
"archived" : true,
"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" ]
}
},
"archived" : true,
"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
request header;
the media type will be conveyed by the response header:
Response:
TestPlanDataListWrapper
Summary: Get all upstream related items for the test plan with the specified ID
Path parameters:
Consumes: this API call consumes the following media types via the
request header:
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
request header;
the media type will be conveyed by the response header:
Response:
AbstractItemDataListWrapper
Summary: Get all upstream relationships for the test plan with the specified ID
Path parameters:
Consumes: this API call consumes the following media types via the
request header:
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
request header;
the media type will be conveyed by the response header:
Response:
RelationshipDataListWrapper
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
request header:
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
request header;
the media type will be conveyed by the response header:
Response:
VersionDataWrapper
Summary: Get the snapshot of the test plan at the specified version
Path parameters:
versionNum
(required)
id
(required)
Consumes: this API call consumes the following media types via the
request header:
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,
"archived" : true,
"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
request header;
the media type will be conveyed by the response header:
Response:
VersionedTestPlanDataWrapper
Summary: Get all versions for the item with the specified ID
Path parameters:
Consumes: this API call consumes the following media types via the
request header:
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
request header;
the media type will be conveyed by the response header:
Response:
VersionDataListWrapper
Summary: Update the test plan with the specified ID
Path parameters:
Consumes: this API call consumes the following media types via the
request header:
Body:
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
request header;
the media type will be conveyed by the response header:
Response:
AbstractRestResponse
Summary: Add an existing test case to the test group with the specified ID
Path parameters:
testGroupId
(required)
id
(required)
Consumes: this API call consumes the following media types via the
request header:
Body:
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
request header;
the media type will be conveyed by the response header:
Response:
CreatedResponse
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
request header:
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
request header;
the media type will be conveyed by the response header:
Response:
AbstractRestResponse
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
request header:
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
request header;
the media type will be conveyed by the response header:
Response:
AbstractRestResponse
Summary: Update the archived status of the test plan
Path parameters:
Consumes: this API call consumes the following media types via the
request header:
Body:
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
request header;
the media type will be conveyed by the response header:
Response:
AbstractRestResponse
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
request header:
Body:
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
request header;
the media type will be conveyed by the response header:
Response:
AbstractRestResponse
Summary: Update the locked state of the item with the specified ID
Path parameters:
Consumes: this API call consumes the following media types via the
request header:
Body:
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
request header;
the media type will be conveyed by the response header:
Response:
AbstractRestResponse
Summary: Update the test group with the specified ID
Path parameters:
testGroupId
(required)
id
(required)
Consumes: this API call consumes the following media types via the
request header:
Body:
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
request header;
the media type will be conveyed by the response header:
Response:
AbstractRestResponse
Summary: Update the test plan with the specified ID
Path parameters:
Consumes: this API call consumes the following media types via the
request header:
Body:
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
request header;
the media type will be conveyed by the response header:
Response:
AbstractRestResponse
The testruns endpoint has the following operations:
POST /testruns/{id}/attachments
POST /testruns/{id}/links
POST /testruns/{id}/tags
DELETE /testruns/{id}/links/{linkId}
DELETE /testruns/{id}
GET /testruns/{id}/activities
GET /testruns/{id}/attachments
GET /testruns/{id}/downstreamrelated
GET /testruns/{id}/downstreamrelationships
GET /testruns/{id}/comments
GET /testruns/{id}/links
GET /testruns/{id}/links/{linkId}
GET /testruns/{id}/lock
GET /testruns/{id}/tags/{tagId}
GET /testruns/{id}/tags
GET /testruns/{id}
GET /testruns
GET /testruns/{id}/upstreamrelated
GET /testruns/{id}/upstreamrelationships
GET /testruns/{id}/versions/{versionNum}
GET /testruns/{id}/versions/{versionNum}/versioneditem
GET /testruns/{id}/versions
POST /testruns/{id}/updatedtestcase
PATCH /testruns/{id}
DELETE /testruns/{id}/attachments/{attachmentId}
DELETE /testruns/{id}/tags/{tagId}
PUT /testruns/{id}/links/{linkId}
PUT /testruns/{id}/lock
PUT /testruns/{id}
Below is more detail for each of the operations of the testruns endpoint.
Summary: Add an existing attachment to the item with the specified ID
Path parameters:
Consumes: this API call consumes the following media types via the
request header:
Body:
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
request header;
the media type will be conveyed by the response header:
Response:
CreatedResponse
Summary: Create a new link for the item with the specified ID
Path parameters:
Consumes: this API call consumes the following media types via the
request header:
Body:
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
request header;
the media type will be conveyed by the response header:
Response:
CreatedResponse
Summary: Add an existing tag to the item with the specified ID
Path parameters:
Consumes: this API call consumes the following media types via the
request header:
Body:
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
request header;
the media type will be conveyed by the response header:
Response:
CreatedResponse
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
request header:
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
request header;
the media type will be conveyed by the response header:
Response:
AbstractRestResponse
Summary: Delete the test run with the specified ID
Path parameters:
Consumes: this API call consumes the following media types via the
request header:
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
request header;
the media type will be conveyed by the response header:
Response:
AbstractRestResponse
Summary: Get all activities for the test run with the specified ID
Path parameters:
Consumes: this API call consumes the following media types via the
request header:
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
request header;
the media type will be conveyed by the response header:
Response:
ActivityDataListWrapper
Summary: Get all attachments for the item with the specified ID
Path parameters:
Consumes: this API call consumes the following media types via the
request header:
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
request header;
the media type will be conveyed by the response header:
Response:
AttachmentDataListWrapper
Summary: Get all downstream related items for the test run with the specified ID
Path parameters:
Consumes: this API call consumes the following media types via the
request header:
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
request header;
the media type will be conveyed by the response header:
Response:
AbstractItemDataListWrapper
Summary: Get all downstream relationships for the test run with the specified ID
Path parameters:
Consumes: this API call consumes the following media types via the
request header:
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
request header;
the media type will be conveyed by the response header:
Response:
RelationshipDataListWrapper
Summary: Get all comments for the item with the specified ID
Path parameters:
Consumes: this API call consumes the following media types via the
request header:
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
request header;
the media type will be conveyed by the response header:
Response:
CommentDataListWrapper
Summary: Get all links for the item with the specified ID
Path parameters:
Consumes: this API call consumes the following media types via the
request header:
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
request header;
the media type will be conveyed by the response header:
Response:
LinkDataListWrapper
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
request header:
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
request header;
the media type will be conveyed by the response header:
Response:
LinkDataWrapper
Summary: Get the locked state, last locked date, and last locked by user for the item with the specified ID
Path parameters:
Consumes: this API call consumes the following media types via the
request header:
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
request header;
the media type will be conveyed by the response header:
Response:
LockDataWrapper
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
request header:
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
request header;
the media type will be conveyed by the response header:
Response:
TagDataWrapper
Summary: Get all tags for the item with the specified ID
Path parameters:
Consumes: this API call consumes the following media types via the
request header:
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
request header;
the media type will be conveyed by the response header:
Response:
TagDataListWrapper
Summary: Get the test run with the specified ID
Path parameters:
Consumes: this API call consumes the following media types via the
request header:
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",
"testCaseVersionNumber" : 2,
"testGroup" : [ 9, 9 ],
"sortOrderFromTestGroup" : 7,
"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
request header;
the media type will be conveyed by the response header:
Response:
TestRunDataWrapper
Summary: Search for test runs associated with test cases, test plans, an test cycles
Must include at least one query parameter from testCycle, testCase, or testPlan
Consumes: this API call consumes the following media types via the
request header:
Request headers:
xJamaDateFieldsWithTime
(optional)
Query parameters:
testCycle
(optional)
Filter by test runs in test cycle id
testCase
(optional)
Filter by test runs from test case id
testPlan
(optional)
Filter by test runs in test plan id
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 'testCycle.desc'). If not set, this defaults to 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" ]
}
},
"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
request header;
the media type will be conveyed by the response header:
Response:
TestRunDataListWrapper
Summary: Get all upstream related items for the test run with the specified ID
Path parameters:
Consumes: this API call consumes the following media types via the
request header:
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
request header;
the media type will be conveyed by the response header:
Response:
AbstractItemDataListWrapper
Summary: Get all upstream relationships for the test run with the specified ID
Path parameters:
Consumes: this API call consumes the following media types via the
request header:
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
request header;
the media type will be conveyed by the response header:
Response:
RelationshipDataListWrapper
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
request header:
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
request header;
the media type will be conveyed by the response header:
Response:
VersionDataWrapper
Summary: Get the snapshot of the test run at the specified version
Path parameters:
versionNum
(required)
id
(required)
Consumes: this API call consumes the following media types via the
request header:
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",
"testCaseVersionNumber" : 9,
"testGroup" : [ 2, 2 ],
"sortOrderFromTestGroup" : 3,
"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
request header;
the media type will be conveyed by the response header:
Response:
VersionedTestRunDataWrapper
Summary: Get all versions for the item with the specified ID
Path parameters:
Consumes: this API call consumes the following media types via the
request header:
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
request header;
the media type will be conveyed by the response header:
Response:
VersionDataListWrapper
Summary: Delete the current test run and then create a new test run based on the latest test case version.
Path parameters:
Consumes: this API call consumes the following media types via the
request header:
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
request header;
the media type will be conveyed by the response header:
Response:
CreatedResponse
Summary: Update the execution results for the test run with the specified ID
Path parameters:
Consumes: this API call consumes the following media types via the
request header:
Body:
Request headers:
xJamaDateFieldsWithTime
(optional)
When updating testrun, required to preserve existing executionDate field's full datetime info. With this set, if passing in new executionDate value, must be in ISO8601 format (milliseconds or seconds) - \"yyyy-MM-dd'T'HH:mm:ss.SSSZ\" or \"yyyy-MM-dd'T'HH:mm:ssZ\".
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
request header;
the media type will be conveyed by the response header:
Response:
AbstractRestResponse
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
request header:
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
request header;
the media type will be conveyed by the response header:
Response:
AbstractRestResponse
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
request header:
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
request header;
the media type will be conveyed by the response header:
Response:
AbstractRestResponse
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
request header:
Body:
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
request header;
the media type will be conveyed by the response header:
Response:
AbstractRestResponse
Summary: Update the locked state of the item with the specified ID
Path parameters:
Consumes: this API call consumes the following media types via the
request header:
Body:
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
request header;
the media type will be conveyed by the response header:
Response:
AbstractRestResponse
Summary: Update the execution results for the test run with the specified ID
Path parameters:
Consumes: this API call consumes the following media types via the
request header:
Body:
Request headers:
xJamaDateFieldsWithTime
(optional)
When updating testrun, required to preserve existing executionDate field's full datetime info. With this set, if passing in new executionDate value, must be in ISO8601 format (milliseconds or seconds) - \"yyyy-MM-dd'T'HH:mm:ss.SSSZ\" or \"yyyy-MM-dd'T'HH:mm:ssZ\".
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
request header;
the media type will be conveyed by the response header:
Response:
AbstractRestResponse
The usergroups endpoint has the following operations:
POST /usergroups
POST /usergroups/{id}/users
DELETE /usergroups/{id}
GET /usergroups/{id}
GET /usergroups/{id}/users
GET /usergroups
DELETE /usergroups/{id}/users/{userId}
PUT /usergroups/{id}
Below is more detail for each of the operations of the usergroups endpoint.
Summary: Create a new user group
Consumes: this API call consumes the following media types via the
request header:
Body:
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
request header;
the media type will be conveyed by the response header:
Response:
CreatedResponse
Summary: Add an existing user to the user group with the specified ID
Path parameters:
Consumes: this API call consumes the following media types via the
request header:
Body:
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
request header;
the media type will be conveyed by the response header:
Response:
CreatedResponse
Summary: Delete the user group with the specified ID
Path parameters:
Consumes: this API call consumes the following media types via the
request header:
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
request header;
the media type will be conveyed by the response header:
Response:
AbstractRestResponse
Summary: Get the user group with the specified ID
Path parameters:
Consumes: this API call consumes the following media types via the
request header:
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" : {
"uid" : "uid",
"name" : "name",
"description" : "description",
"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
request header;
the media type will be conveyed by the response header:
Response:
UserGroupDataWrapper
Summary: Get all users for the user group with the specified ID
Path parameters:
Consumes: this API call consumes the following media types via the
request header:
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" : [ {
"lastName" : "lastName",
"avatarUrl" : "avatarUrl",
"active" : true,
"customData" : [ {
"name" : "name",
"value" : "value"
}, {
"name" : "name",
"value" : "value"
} ],
"title" : "title",
"firstName" : "firstName",
"licenseType" : "NAMED",
"uid" : "uid",
"phone" : "phone",
"location" : "location",
"id" : 0,
"authenticationType" : {
"name" : "name",
"id" : 6
},
"email" : "email",
"username" : "username"
}, {
"lastName" : "lastName",
"avatarUrl" : "avatarUrl",
"active" : true,
"customData" : [ {
"name" : "name",
"value" : "value"
}, {
"name" : "name",
"value" : "value"
} ],
"title" : "title",
"firstName" : "firstName",
"licenseType" : "NAMED",
"uid" : "uid",
"phone" : "phone",
"location" : "location",
"id" : 0,
"authenticationType" : {
"name" : "name",
"id" : 6
},
"email" : "email",
"username" : "username"
} ],
"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
request header;
the media type will be conveyed by the response header:
Response:
UserDataListWrapper
Summary: Get all user groups
Consumes: this API call consumes the following media types via the
request header:
Request headers:
xJamaDateFieldsWithTime
(optional)
Query parameters:
project
(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" : [ {
"uid" : "uid",
"name" : "name",
"description" : "description",
"project" : 6,
"id" : 0
}, {
"uid" : "uid",
"name" : "name",
"description" : "description",
"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
request header;
the media type will be conveyed by the response header:
Response:
UserGroupDataListWrapper
Summary: Remove an existing user from the user group with the specified ID
Path parameters:
userId
(required)
id
(required)
Consumes: this API call consumes the following media types via the
request header:
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
request header;
the media type will be conveyed by the response header:
Response:
AbstractRestResponse
Summary: Update the user group with the specified ID
Path parameters:
Consumes: this API call consumes the following media types via the
request header:
Body:
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
request header;
the media type will be conveyed by the response header:
Response:
AbstractRestResponse
The users endpoint has the following operations:
POST /users
GET /users/current
GET /users/{userId}/customData
GET /users/current/favoritefilters
GET /users/{userId}
GET /users
PUT /users/{userId}
PUT /users/{userId}/active
PUT /users/{userId}/customData
Below is more detail for each of the operations of the users endpoint.
Summary: Create a new user
Consumes: this API call consumes the following media types via the
request header:
Body:
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
request header;
the media type will be conveyed by the response header:
Response:
CreatedResponse
Summary: Gets the current user
Consumes: this API call consumes the following media types via the
request header:
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" : {
"lastName" : "lastName",
"avatarUrl" : "avatarUrl",
"active" : true,
"customData" : [ {
"name" : "name",
"value" : "value"
}, {
"name" : "name",
"value" : "value"
} ],
"title" : "title",
"firstName" : "firstName",
"licenseType" : "NAMED",
"uid" : "uid",
"phone" : "phone",
"location" : "location",
"id" : 0,
"authenticationType" : {
"name" : "name",
"id" : 6
},
"email" : "email",
"username" : "username"
},
"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
request header;
the media type will be conveyed by the response header:
Response:
UserDataWrapper
Summary: Get all custom data for the user with the specified ID
Path parameters:
Consumes: this API call consumes the following media types via the
request header:
Examples:
Example data, content-type: application/json
{
"data" : [ {
"name" : "name",
"value" : "value"
}, {
"name" : "name",
"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
request header;
the media type will be conveyed by the response header:
Response:
UserCustomDataDataListWrapper
Summary: Gets the current user's favorite filters
Consumes: this API call consumes the following media types via the
request header:
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" : [ {
"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
request header;
the media type will be conveyed by the response header:
Response:
FilterDataListWrapper
Summary: Get the user with the specified ID
Path parameters:
Consumes: this API call consumes the following media types via the
request header:
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" : {
"lastName" : "lastName",
"avatarUrl" : "avatarUrl",
"active" : true,
"customData" : [ {
"name" : "name",
"value" : "value"
}, {
"name" : "name",
"value" : "value"
} ],
"title" : "title",
"firstName" : "firstName",
"licenseType" : "NAMED",
"uid" : "uid",
"phone" : "phone",
"location" : "location",
"id" : 0,
"authenticationType" : {
"name" : "name",
"id" : 6
},
"email" : "email",
"username" : "username"
},
"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
request header;
the media type will be conveyed by the response header:
Response:
UserDataWrapper
Summary: Get all users
Consumes: this API call consumes the following media types via the
request header:
Request headers:
xJamaDateFieldsWithTime
(optional)
Query parameters:
project
(optional)
username
(optional)
email
(optional)
firstName
(optional)
lastName
(optional)
licenseType
(optional)
includeInactive
(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" : [ {
"lastName" : "lastName",
"avatarUrl" : "avatarUrl",
"active" : true,
"customData" : [ {
"name" : "name",
"value" : "value"
}, {
"name" : "name",
"value" : "value"
} ],
"title" : "title",
"firstName" : "firstName",
"licenseType" : "NAMED",
"uid" : "uid",
"phone" : "phone",
"location" : "location",
"id" : 0,
"authenticationType" : {
"name" : "name",
"id" : 6
},
"email" : "email",
"username" : "username"
}, {
"lastName" : "lastName",
"avatarUrl" : "avatarUrl",
"active" : true,
"customData" : [ {
"name" : "name",
"value" : "value"
}, {
"name" : "name",
"value" : "value"
} ],
"title" : "title",
"firstName" : "firstName",
"licenseType" : "NAMED",
"uid" : "uid",
"phone" : "phone",
"location" : "location",
"id" : 0,
"authenticationType" : {
"name" : "name",
"id" : 6
},
"email" : "email",
"username" : "username"
} ],
"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
request header;
the media type will be conveyed by the response header:
Response:
UserDataListWrapper
Summary: Update the user with the specified ID
Path parameters:
Consumes: this API call consumes the following media types via the
request header:
Body:
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
request header;
the media type will be conveyed by the response header:
Response:
AbstractRestResponse
Summary: Update the active status for the user with the specified ID
Path parameters:
Consumes: this API call consumes the following media types via the
request header:
Body:
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
request header;
the media type will be conveyed by the response header:
Response:
AbstractRestResponse
Summary: Update the custom data for the user with the specified ID
Path parameters:
Consumes: this API call consumes the following media types via the
request header:
Body:
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
request header;
the media type will be conveyed by the response header:
Response:
AbstractRestResponse
Name
Required
Type
Notes
id
required
Integer
documentKey
required
String
globalId
required
String
project
required
Integer
ID of a project
itemType
required
Integer
ID of an item type
createdDate
required
Date
modifiedDate
required
Date
lastActivityDate
required
Date
createdBy
required
Integer
ID of a user
modifiedBy
required
Integer
ID of a user
baselinedAppliedCategorySnapshots
required
array[BaselinedAppliedCategorySnapshotInfo]
A list of baselined applied category snapshots
resources
required
map[String, AllowedResource]
A set of resources and allowed permissions
fields
required
map[String, Object]
A map of field names to field values e.g. {\"name\":\"Sample Item\", \"status\": 292, \"release\": 2, \"assigned\": 23}
Name
Required
Type
Notes
data
required
array[AbstractItem]
links
required
map[String, Link]
linked
required
map[String, map[String, Object]]
meta
required
MetaListWrapper
Name
Required
Type
Notes
data
required
AbstractItem
links
required
map[String, Link]
linked
required
map[String, map[String, Object]]
meta
required
MetaWrapper
Name
Required
Type
Notes
status
required
Integer
statusReasonPhrase
required
String
pageInfo
required
PageInfo
headers
required
map[String, array[String]]
Name
Required
Type
Notes
version
required
Integer
id
required
Integer
currentVersion
required
Integer
Currently active version of the versioned item. If no version is active, currentVersion will not be returned.
type
required
String
Name
Required
Type
Notes
data
required
AbstractVersionedItem
links
required
map[String, Link]
linked
required
map[String, map[String, Object]]
meta
required
MetaWrapper
Name
Required
Type
Notes
id
required
Integer
date
required
Date
details
required
String
action
required
String
user
required
Integer
ID of a user
userName
required
String
userComment
required
String
item
required
Integer
ID of an item
itemType
required
Integer
ID of an item type
eventType
required
String
objectType
required
String
Name
Required
Type
Notes
data
required
array[Activity]
links
required
map[String, Link]
linked
required
map[String, map[String, Object]]
meta
required
MetaListWrapper
Name
Required
Type
Notes
data
required
Activity
links
required
map[String, Link]
linked
required
map[String, map[String, Object]]
meta
required
MetaWrapper
Name
Required
Type
Notes
allowed
required
array[String]
Name
Required
Type
Notes
lock
required
Lock
fileName
required
String
mimeType
required
String
fileSize
required
Integer
id
required
Integer
documentKey
required
String
globalId
required
String
project
required
Integer
ID of a project
itemType
required
Integer
ID of an item type
createdDate
required
Date
modifiedDate
required
Date
lastActivityDate
required
Date
createdBy
required
Integer
ID of a user
modifiedBy
required
Integer
ID of a user
baselinedAppliedCategorySnapshots
required
array[BaselinedAppliedCategorySnapshotInfo]
A list of baselined applied category snapshots
resources
required
map[String, AllowedResource]
A set of resources and allowed permissions
fields
required
map[String, Object]
A map of field names to field values e.g. {\"name\":\"Sample Item\", \"status\": 292, \"release\": 2, \"assigned\": 23}
Name
Required
Type
Notes
data
required
array[Attachment]
links
required
map[String, Link]
linked
required
map[String, map[String, Object]]
meta
required
MetaListWrapper
Name
Required
Type
Notes
data
required
Attachment
links
required
map[String, Link]
linked
required
map[String, map[String, Object]]
meta
required
MetaWrapper
Name
Required
Type
Notes
id
required
Integer
name
required
String
Name
Required
Type
Notes
status
required
Integer
statusReasonPhrase
required
String
pageInfo
required
PageInfo
headers
required
map[String, array[String]]
message
required
String
exception
required
Exception
Name
Required
Type
Notes
id
required
Integer
baselineKey
required
String
Key of the baseline
name
required
String
description
required
String
createdDate
required
Date
createdBy
required
Integer
ID of a user
project
required
Integer
ID of a project
origin
required
BaselineOrigin
sourceName
required
String
Name of the source that the baseline is part of
source
required
Integer
ID of the source that the baseline is part of
sourceKey
required
String
Key of the source that the baseline is part of
baselinePickListOption
required
Object
Info about baseline picklist option
signed
required
Boolean
Is true when the baseline has a signature
type
required
String
Name
Required
Type
Notes
data
required
array[Baseline]
links
required
map[String, Link]
linked
required
map[String, map[String, Object]]
meta
required
MetaListWrapper
Name
Required
Type
Notes
data
required
Baseline
links
required
map[String, Link]
linked
required
map[String, map[String, Object]]
meta
required
MetaWrapper
Name
Required
Type
Notes
version
required
Integer
currentVersion
required
Integer
Currently active version of the versioned item. If no version is active, currentVersion will not be returned.
baseline
required
Integer
ID of a baseline
baselineLocation
required
BaselineLocation
type
required
String
id
required
Integer
documentKey
required
String
globalId
required
String
project
required
Integer
ID of a project
itemType
required
Integer
ID of an item type
childItemType
required
Integer
ID of an item type
createdDate
required
Date
modifiedDate
required
Date
lastActivityDate
required
Date
createdBy
required
Integer
ID of a user
modifiedBy
required
Integer
ID of a user
baselinedAppliedCategorySnapshots
required
array[BaselinedAppliedCategorySnapshotInfo]
A list of baselined applied category snapshots
resources
required
map[String, AllowedResource]
A set of resources and allowed permissions
fields
required
map[String, Object]
A map of field names to field values e.g. {\"name\":\"Sample Item\", \"status\": 292, \"release\": 2, \"assigned\": 23}
Name
Required
Type
Notes
data
required
array[BaselineItem]
links
required
map[String, Link]
linked
required
map[String, map[String, Object]]
meta
required
MetaListWrapper
Name
Required
Type
Notes
data
required
BaselineItem
links
required
map[String, Link]
linked
required
map[String, map[String, Object]]
meta
required
MetaWrapper
Name
Required
Type
Notes
sequence
required
String
parent
required
BaselineParent
Name
Required
Type
Notes
project
required
Integer
ID of a user
item
required
Integer
ID of an item
filter
required
Integer
ID of a filter
release
required
Integer
ID of a release
simplefilter
required
Integer
ID of a simplefilter
testCycle
required
Integer
ID of a test cycle
testPlan
required
Integer
ID of a test plan
Name
Required
Type
Notes
item
required
array[Integer]
Item ID and version number for an item
project
required
Integer
ID of a project
Name
Required
Type
Notes
categoryPathSequence
required
String
itemVersionNumberApplied
required
Integer
Name
Required
Type
Notes
contentDisposition
required
ContentDisposition
entity
required
Object
headers
required
map[String, array[String]]
mediaType
required
MediaType
messageBodyWorkers
required
MessageBodyWorkers
parent
required
MultiPart
providers
required
Providers
parameterizedHeaders
required
map[String, array[ParameterizedHeader]]
Name
Required
Type
Notes
totalChildren
required
Integer
totalMissing
required
Integer
totalOutOfSync
required
Integer
Name
Required
Type
Notes
id
required
Integer
inReplyTo
required
Integer
ID of a comment
createdDate
required
Date
createdBy
required
Integer
ID of a user
modifiedBy
required
Integer
ID of a user
deleted
required
Boolean
status
required
String
body
required
CommentBody
commentType
required
String
location
required
CommentLocation
Name
Required
Type
Notes
text
required
String
Name
Required
Type
Notes
data
required
array[Comment]
links
required
map[String, Link]
linked
required
map[String, map[String, Object]]
meta
required
MetaListWrapper
Name
Required
Type
Notes
data
required
Comment
links
required
map[String, Link]
linked
required
map[String, map[String, Object]]
meta
required
MetaWrapper
Name
Required
Type
Notes
item
required
Integer
ID of an item
project
required
Integer
ID of a project
Name
Required
Type
Notes
type
required
String
parameters
required
map[String, String]
fileName
required
String
creationDate
required
Date
modificationDate
required
Date
readDate
required
Date
size
required
Long
Name
Required
Type
Notes
status
required
Integer
statusReasonPhrase
required
String
pageInfo
required
PageInfo
headers
required
map[String, array[String]]
location
required
String
id
required
Integer
Name
Required
Type
Notes
domains
required
array[String]
Name
Required
Type
Notes
itemId
required
Integer
databaseValue
required
Object
calculatedValue
required
Object
Name
Required
Type
Notes
numberItemsChecked
required
Integer
numberChecksFailed
required
Integer
failures
required
array[DerivedDataFailure]
Name
Required
Type
Notes
reportType
required
String
generatedDate
required
Date
derivedDataHealthDetails
required
DerivedDataHealthDetailsReport
Name
Required
Type
Notes
data
required
DerivedDataHealthReport
links
required
map[String, Link]
linked
required
map[String, map[String, Object]]
meta
required
MetaWrapper
Name
Required
Type
Notes
includeTags
required
Boolean
includeAttachments
required
Boolean
includeLinks
required
Boolean
Name
Required
Type
Notes
cause
required
Throwable
stackTrace
required
array[StackTraceElement]
message
required
String
suppressed
required
array[Throwable]
localizedMessage
required
String
Name
Required
Type
Notes
id
required
Integer
name
required
String
author
required
Integer
ID of a user
projectScope
required
String
specifiedProject
required
Integer
ID of a project
filterQuery
required
FilterQuery
public
required
Boolean
Name
Required
Type
Notes
data
required
array[Filter]
links
required
map[String, Link]
linked
required
map[String, map[String, Object]]
meta
required
MetaListWrapper
Name
Required
Type
Notes
data
required
Filter
links
required
map[String, Link]
linked
required
map[String, map[String, Object]]
meta
required
MetaWrapper
Name
Required
Type
Notes
id
required
Integer
name
required
String
display
required
String
fieldDataType
required
String
Name
Required
Type
Notes
direction
required
String
field
required
FilterField
Name
Required
Type
Notes
name
required
String
rule
required
FilterRule
orderRules
required
array[FilterOrderRule]
Name
Required
Type
Notes
field
required
FilterField
operator
required
String
values
required
array[String]
itemType
required
Integer
ID of an item type
subQuery
required
FilterQuery
rules
required
array[FilterRule]
Name
Required
Type
Notes
contentDisposition
required
ContentDisposition
entity
required
Object
headers
required
map[String, array[String]]
mediaType
required
MediaType
messageBodyWorkers
required
MessageBodyWorkers
parent
required
MultiPart
providers
required
Providers
formDataContentDisposition
required
FormDataContentDisposition
simple
required
Boolean
name
required
String
value
required
String
parameterizedHeaders
required
map[String, array[ParameterizedHeader]]
Name
Required
Type
Notes
type
required
String
parameters
required
map[String, String]
fileName
required
String
creationDate
required
Date
modificationDate
required
Date
readDate
required
Date
size
required
Long
name
required
String
Name
Required
Type
Notes
contentDisposition
required
ContentDisposition
entity
required
Object
headers
required
map[String, array[String]]
mediaType
required
MediaType
messageBodyWorkers
required
MessageBodyWorkers
parent
required
MultiPart
providers
required
Providers
bodyParts
required
array[BodyPart]
fields
required
map[String, array[FormDataBodyPart]]
parameterizedHeaders
required
map[String, array[ParameterizedHeader]]
Name
Required
Type
Notes
id
required
Integer
documentKey
required
String
globalId
required
String
project
required
Integer
ID of a project
itemType
required
Integer
ID of an item type
childItemType
required
Integer
ID of an item type
createdDate
required
Date
modifiedDate
required
Date
lastActivityDate
required
Date
createdBy
required
Integer
ID of a user
modifiedBy
required
Integer
ID of a user
lock
required
Lock
location
required
Location
baselinedAppliedCategorySnapshots
required
array[BaselinedAppliedCategorySnapshotInfo]
A list of baselined applied category snapshots
resources
required
map[String, AllowedResource]
A set of resources and allowed permissions
fields
required
map[String, Object]
A map of field names to field values e.g. {\"name\":\"Sample Item\", \"status\": 292, \"release\": 2, \"assigned\": 23}
Name
Required
Type
Notes
data
required
array[Item]
links
required
map[String, Link]
linked
required
map[String, map[String, Object]]
meta
required
MetaListWrapper
Name
Required
Type
Notes
data
required
Item
links
required
map[String, Link]
linked
required
map[String, map[String, Object]]
meta
required
MetaWrapper
Name
Required
Type
Notes
id
required
Integer
typeKey
required
String
display
required
String
displayPlural
required
String
description
required
String
image
required
String
category
required
String
widgets
required
array[ItemTypeWidget]
fields
required
array[ItemTypeField]
system
required
Boolean
Name
Required
Type
Notes
data
required
array[ItemType]
links
required
map[String, Link]
linked
required
map[String, map[String, Object]]
meta
required
MetaListWrapper
Name
Required
Type
Notes
data
required
ItemType
links
required
map[String, Link]
linked
required
map[String, map[String, Object]]
meta
required
MetaWrapper
Name
Required
Type
Notes
id
required
Integer
name
required
String
label
required
String
fieldType
required
String
readOnly
required
Boolean
readOnlyAllowApiOverwrite
required
Boolean
required
required
Boolean
triggerSuspect
required
Boolean
synchronize
required
Boolean
pickList
required
Integer
ID of a pick list
textType
required
String
itemType
required
Integer
ID of an item type
Name
Required
Type
Notes
name
required
String
synchronize
required
Boolean
Name
Required
Type
Notes
type
required
String
href
required
String
Name
Required
Type
Notes
data
required
array[Link]
links
required
map[String, Link]
linked
required
map[String, map[String, Object]]
meta
required
MetaListWrapper
Name
Required
Type
Notes
data
required
Link
links
required
map[String, Link]
linked
required
map[String, map[String, Object]]
meta
required
MetaWrapper
Name
Required
Type
Notes
sortOrder
required
Integer
globalSortOrder
required
Integer
The relative position of an item within its project. Deprecated. Use sequence instead.
sequence
required
String
parent
required
Parent
Name
Required
Type
Notes
data
required
Location
links
required
map[String, Link]
linked
required
map[String, map[String, Object]]
meta
required
MetaWrapper
Name
Required
Type
Notes
locked
required
Boolean
lastLockedDate
required
Date
lockedBy
required
Integer
ID of a user
Name
Required
Type
Notes
data
required
Lock
links
required
map[String, Link]
linked
required
map[String, map[String, Object]]
meta
required
MetaWrapper
Name
Required
Type
Notes
type
required
String
subtype
required
String
parameters
required
map[String, String]
wildcardType
required
Boolean
wildcardSubtype
required
Boolean
Name
Required
Type
Notes
pageInfo
required
PageInfo
status
required
String
timestamp
required
Date
Name
Required
Type
Notes
status
required
String
timestamp
required
Date
Name
Required
Type
Notes
contentDisposition
required
ContentDisposition
entity
required
Object
headers
required
map[String, array[String]]
mediaType
required
MediaType
messageBodyWorkers
required
MessageBodyWorkers
parent
required
MultiPart
providers
required
Providers
bodyParts
required
array[BodyPart]
parameterizedHeaders
required
map[String, array[ParameterizedHeader]]
Name
Required
Type
Notes
status
required
Integer
statusReasonPhrase
required
String
pageInfo
required
PageInfo
headers
required
map[String, array[String]]
linked
required
map[String, map[String, Object]]
type
required
String
payload
required
Object
Name
Required
Type
Notes
startIndex
required
Integer
resultCount
required
Integer
totalResults
required
Integer
Name
Required
Type
Notes
value
required
String
parameters
required
map[String, String]
Name
Required
Type
Notes
project
required
Integer
ID of a project
item
required
Integer
ID of an item
Name
Required
Type
Notes
id
required
Integer
name
required
String
description
required
String
type
required
String
Name
Required
Type
Notes
data
required
array[PickList]
links
required
map[String, Link]
linked
required
map[String, map[String, Object]]
meta
required
MetaListWrapper
Name
Required
Type
Notes
data
required
PickList
links
required
map[String, Link]
linked
required
map[String, map[String, Object]]
meta
required
MetaWrapper
Name
Required
Type
Notes
pickList
required
Integer
ID of a pick list
id
required
Integer
name
required
String
description
required
String
value
required
String
default
required
Boolean
active
required
Boolean
archived
required
Boolean
color
required
String
sortOrder
required
Integer
Name
Required
Type
Notes
data
required
array[PickListOption]
links
required
map[String, Link]
linked
required
map[String, map[String, Object]]
meta
required
MetaListWrapper
Name
Required
Type
Notes
data
required
PickListOption
links
required
map[String, Link]
linked
required
map[String, map[String, Object]]
meta
required
MetaWrapper
Name
Required
Type
Notes
id
required
Integer
projectKey
required
String
parent
required
Integer
ID of a project
isFolder
required
Boolean
createdDate
required
Date
modifiedDate
required
Date
createdBy
required
Integer
ID of a user
modifiedBy
required
Integer
ID of a user
fields
required
map[String, Object]
Name
Required
Type
Notes
data
required
array[Project]
links
required
map[String, Link]
linked
required
map[String, map[String, Object]]
meta
required
MetaListWrapper
Name
Required
Type
Notes
data
required
Project
links
required
map[String, Link]
linked
required
map[String, map[String, Object]]
meta
required
MetaWrapper
Name
Required
Type
Notes
id
required
Integer
projectKey
required
String
name
required
String
string1
required
String
mask
required
Integer
organizationId
required
Integer
active
required
Boolean
Name
Required
Type
Notes
id
required
Integer
fromItem
required
Integer
ID of an item
toItem
required
Integer
ID of an item
relationshipType
required
Integer
ID of a relationship type
suspect
required
Boolean
Name
Required
Type
Notes
data
required
array[Relationship]
links
required
map[String, Link]
linked
required
map[String, map[String, Object]]
meta
required
MetaListWrapper
Name
Required
Type
Notes
data
required
Relationship
links
required
map[String, Link]
linked
required
map[String, map[String, Object]]
meta
required
MetaWrapper
Name
Required
Type
Notes
id
required
Integer
fromItemTypeId
required
Integer
toItemTypeId
required
Integer
forCoverage
required
Boolean
relationshipTypeId
required
Integer
Name
Required
Type
Notes
id
required
Integer
name
required
String
isExclusive
required
Boolean
mappedProjects
required
array[ProjectPropertyDTO]
rules
required
array[RelationshipRuleDTO]
Name
Required
Type
Notes
id
required
Integer
name
required
String
isDefault
required
Boolean
Name
Required
Type
Notes
data
required
array[RelationshipType]
links
required
map[String, Link]
linked
required
map[String, map[String, Object]]
meta
required
MetaListWrapper
Name
Required
Type
Notes
data
required
RelationshipType
links
required
map[String, Link]
linked
required
map[String, map[String, Object]]
meta
required
MetaWrapper
Name
Required
Type
Notes
id
required
Integer
name
required
String
description
required
String
project
required
Integer
ID of a project
releaseDate
required
Date
active
required
Boolean
archived
required
Boolean
itemCount
required
Integer
Name
Required
Type
Notes
data
required
array[Release]
links
required
map[String, Link]
linked
required
map[String, map[String, Object]]
meta
required
MetaListWrapper
Name
Required
Type
Notes
data
required
Release
links
required
map[String, Link]
linked
required
map[String, map[String, Object]]
meta
required
MetaWrapper
Name
Required
Type
Notes
active
required
Boolean
Name
Required
Type
Notes
archived
required
Boolean
Name
Required
Type
Notes
fields
required
map[String, Object]
A map of field names to field values e.g. {\"name\":\"Sample Item\", \"status\": 292, \"release\": 2, \"assigned\": 23}
Name
Required
Type
Notes
source
required
Integer
ID of the source that the baseline is part of
baselineOriginType
required
String
The origin of items type
baselineOriginId
required
Integer
The origin of items ID
name
required
String
Name of the baseline
description
required
String
Description of the baseline
baselineStatusPickListOption
required
Integer
The baseline status pick list option
Name
Required
Type
Notes
inReplyTo
required
Integer
ID of a comment
body
required
RequestCommentBody
commentType
required
String
location
required
RequestCommentLocation
Name
Required
Type
Notes
text
required
String
Name
Required
Type
Notes
item
required
Integer
ID of an item
project
required
Integer
ID of a project
Name
Required
Type
Notes
reportType
required
String
repair
required
Boolean
Name
Required
Type
Notes
user
required
Integer
Name
Required
Type
Notes
globalId
required
String
Must use override if you want to set this value on POST.
project
required
Integer
Only required when creating a new item (POST).
itemType
required
Integer
ID of an item type
childItemType
required
Integer
ID of an item type
location
required
RequestLocation
fields
required
map[String, Object]
A map of field names to field values e.g. {\"name\":\"Sample Item\", \"status\": 292, \"release\": 2, \"assigned\": 23}
Name
Required
Type
Notes
attachment
required
Integer
Name
Required
Type
Notes
item
required
Integer
ID of a item
Name
Required
Type
Notes
tag
required
Integer
Name
Required
Type
Notes
typeKey
required
String
display
required
String
displayPlural
required
String
description
required
String
image
required
String
category
required
String
Used to set the Category of the Item Type if it has special behavior.
widgets
required
array[RequestItemTypeWidget]
Name
Required
Type
Notes
name
required
String
label
required
String
fieldType
required
String
readOnly
required
Boolean
readOnlyAllowApiOverwrite
required
Boolean
required
required
Boolean
triggerSuspect
required
Boolean
synchronize
required
Boolean
pickList
required
Integer
textType
required
String
Name
Required
Type
Notes
name
required
String
synchronize
required
Boolean
Name
Required
Type
Notes
items
required
array[Integer]
The list of IDs of the items to modify
operations
required
array[RequestPatchOperation]
The list of RequestPatchOperation to apply to the items
Name
Required
Type
Notes
url
required
String
description
required
String
Name
Required
Type
Notes
parent
required
RequestParent
This can point to either a project or a parent item at which this item is located, not both.
Name
Required
Type
Notes
locked
required
Boolean
Name
Required
Type
Notes
parent
required
RequestMoveParent
Name
Required
Type
Notes
project
required
Integer
ID of an project
Name
Required
Type
Notes
item
required
Integer
ID of an item. If this is included, the item of this payload will be located at this parent item. If this is not included, the item will be located at the root of the project.
project
required
Integer
ID of an project. If this is included, the item of this payload will be located at the root of the project, and a parent item cannot be specified. This value will be inferred by the \"project\" property at the root of the payload when a parent location is not specified.
Name
Required
Type
Notes
op
required
String
The specific operation to be applied
path
required
String
The JSON pointer that indicates the property to modify (Accepted format: /fields/<field-name>)
value
required
Object
The new value to be set on the property indicated by the 'path'. Not required for 'remove' operations. Date fields only accept ISO-8601 format (ex. 2011-12-03)
Name
Required
Type
Notes
name
required
String
description
required
String
The picklist's description
type
required
Integer
ID for picklist type, should either 0, 1, 2 and 3 for standard picklist or 4 for lookup matrix picklist
Name
Required
Type
Notes
description
required
String
name
required
String
value
required
String
color
required
String
sortOrder
required
Integer
default
required
Boolean
Name
Required
Type
Notes
projectKey
required
String
Not Required if isFolder is true
isFolder
required
Boolean
parent
required
Integer
parent project
fields
required
map[String, Object]
A map of field names to field values e.g. {\"name\":\"Sample Project\", \"status\": 292, \"release\": 2, \"projectManager\": 23}
Name
Required
Type
Notes
fromItem
required
Integer
toItem
required
Integer
relationshipType
required
Integer
Relationships will be created with the default type when providing a null or invalid relationship type
Name
Required
Type
Notes
name
required
String
description
required
String
releaseDate
required
String
project
required
Integer
Name
Required
Type
Notes
name
required
String
project
required
Integer
Only required on tag creation (POST)
Name
Required
Type
Notes
fields
required
map[String, Object]
A map of field names to field values e.g. {\"name\":\"Sample Item\", \"startDate\": \"2015-01-01\", \"endDate\": \"2015-01-15\"} Note: RequestTestCycle requires name, startDate, and endDate. startDate and endDate are formatted with 'yyyy-mm-dd'
testRunGenerationConfig
required
TestRunGenerationConfig
Settings for how test runs will be generated in this test cycle
Name
Required
Type
Notes
name
required
String
assignedTo
required
Integer
ID of a user
Name
Required
Type
Notes
testCase
required
Integer
Name
Required
Type
Notes
project
required
Integer
Only required when creating a new test plan (POST).
fields
required
map[String, Object]
A map of field names to field values e.g. {\"name\":\"Sample Item\", \"status\": 292, \"release\": 2, \"assigned\": 23}
Name
Required
Type
Notes
fields
required
map[String, Object]
A map of field names to field values e.g. {\"name\":\"Sample Item\", \"status\": 292, \"release\": 2, \"assigned\": 23}
Name
Required
Type
Notes
transitionId
required
String
comment
required
String
Name
Required
Type
Notes
username
required
String
Required when creating a new user (POST). Optional on update (PUT)
password
required
String
Required when creating a new user (POST). Not valid on update (PUT)
firstName
required
String
Required when creating a new user (POST). Optional on update (PUT)
lastName
required
String
Required when creating a new user (POST). Optional on update (PUT)
email
required
String
Required when creating a new user (POST). Optional on update (PUT)
phone
required
String
title
required
String
location
required
String
licenseType
required
String
Required when creating a new user (POST). Optional on update (PUT)
authenticationType
required
AuthenticationType
Required when creating a new or update user (POST or PUT), when the authentication mode is Basic+IdP
customData
required
array[RequestUserCustomData]
Name
Required
Type
Notes
name
required
String
Required when updating user custom data (PUT).
value
required
String
Required when updating user custom data (PUT).
Name
Required
Type
Notes
name
required
String
description
required
String
project
required
Integer
Name
Required
Type
Notes
classLoaderName
required
String
moduleName
required
String
moduleVersion
required
String
methodName
required
String
fileName
required
String
lineNumber
required
Integer
className
required
String
nativeMethod
required
Boolean
Name
Required
Type
Notes
inSync
required
Boolean
collectionSummary
required
CollectionSummary
Name
Required
Type
Notes
data
required
SyncStatus
links
required
map[String, Link]
linked
required
map[String, map[String, Object]]
meta
required
MetaWrapper
Name
Required
Type
Notes
id
required
Integer
name
required
String
project
required
Integer
ID of a project
Name
Required
Type
Notes
data
required
array[Tag]
links
required
map[String, Link]
linked
required
map[String, map[String, Object]]
meta
required
MetaListWrapper
Name
Required
Type
Notes
data
required
Tag
links
required
map[String, Link]
linked
required
map[String, map[String, Object]]
meta
required
MetaWrapper
Name
Required
Type
Notes
id
required
Integer
documentKey
required
String
globalId
required
String
project
required
Integer
ID of a project
itemType
required
Integer
ID of an item type
createdDate
required
Date
modifiedDate
required
Date
lastActivityDate
required
Date
createdBy
required
Integer
ID of a user
modifiedBy
required
Integer
ID of a user
baselinedAppliedCategorySnapshots
required
array[BaselinedAppliedCategorySnapshotInfo]
A list of baselined applied category snapshots
resources
required
map[String, AllowedResource]
A set of resources and allowed permissions
fields
required
map[String, Object]
A map of field names to field values e.g. {\"name\":\"Sample Item\", \"status\": 292, \"release\": 2, \"assigned\": 23}
Name
Required
Type
Notes
data
required
array[TestCycle]
links
required
map[String, Link]
linked
required
map[String, map[String, Object]]
meta
required
MetaListWrapper
Name
Required
Type
Notes
data
required
TestCycle
links
required
map[String, Link]
linked
required
map[String, map[String, Object]]
meta
required
MetaWrapper
Name
Required
Type
Notes
testGroup
required
Integer
name
required
String
assignedTo
required
Integer
ID of a user
testCycle
required
Integer
type
required
String
Name
Required
Type
Notes
data
required
TestCycleTestGroup
links
required
map[String, Link]
linked
required
map[String, map[String, Object]]
meta
required
MetaWrapper
Name
Required
Type
Notes
id
required
Integer
name
required
String
assignedTo
required
Integer
ID of a user
Name
Required
Type
Notes
data
required
array[TestGroup]
links
required
map[String, Link]
linked
required
map[String, map[String, Object]]
meta
required
MetaListWrapper
Name
Required
Type
Notes
data
required
TestGroup
links
required
map[String, Link]
linked
required
map[String, map[String, Object]]
meta
required
MetaWrapper
Name
Required
Type
Notes
id
required
Integer
documentKey
required
String
globalId
required
String
project
required
Integer
ID of a project
itemType
required
Integer
ID of an item type
createdDate
required
Date
modifiedDate
required
Date
lastActivityDate
required
Date
createdBy
required
Integer
ID of a user
modifiedBy
required
Integer
ID of a user
baselinedAppliedCategorySnapshots
required
array[BaselinedAppliedCategorySnapshotInfo]
A list of baselined applied category snapshots
resources
required
map[String, AllowedResource]
A set of resources and allowed permissions
fields
required
map[String, Object]
A map of field names to field values e.g. {\"name\":\"Sample Item\", \"status\": 292, \"release\": 2, \"assigned\": 23}
archived
required
Boolean
Name
Required
Type
Notes
data
required
array[TestPlan]
links
required
map[String, Link]
linked
required
map[String, map[String, Object]]
meta
required
MetaListWrapper
Name
Required
Type
Notes
data
required
TestPlan
links
required
map[String, Link]
linked
required
map[String, map[String, Object]]
meta
required
MetaWrapper
Name
Required
Type
Notes
id
required
Integer
documentKey
required
String
globalId
required
String
project
required
Integer
ID of a project
itemType
required
Integer
ID of an item type
createdDate
required
Date
modifiedDate
required
Date
lastActivityDate
required
Date
createdBy
required
Integer
ID of a user
modifiedBy
required
Integer
ID of a user
testCaseVersionNumber
required
Integer
The version of the test case at the time of test run creation
sortOrderFromTestGroup
required
Integer
The sort order within the test group at the time of test cycle creation
testGroup
required
array[Integer]
ID of a test cycle and ID of a test group
baselinedAppliedCategorySnapshots
required
array[BaselinedAppliedCategorySnapshotInfo]
A list of baselined applied category snapshots
resources
required
map[String, AllowedResource]
A set of resources and allowed permissions
fields
required
map[String, Object]
A map of field names to field values e.g. {\"name\":\"Sample Item\", \"status\": 292, \"release\": 2, \"assigned\": 23}
Name
Required
Type
Notes
data
required
array[TestRun]
links
required
map[String, Link]
linked
required
map[String, map[String, Object]]
meta
required
MetaListWrapper
Name
Required
Type
Notes
data
required
TestRun
links
required
map[String, Link]
linked
required
map[String, map[String, Object]]
meta
required
MetaWrapper
Name
Required
Type
Notes
testGroupsToInclude
required
array[Integer]
The Test Group IDs of the Test Groups from which you would like to generate Test Runs. Do not specify anything to include all groups.
testRunStatusesToInclude
required
array[String]
Only valid after generating the first Test Cycle, you may choose to only generate Test Runs that were a specified status in the previous cycle. Do not specify anything to include all statuses
Name
Required
Type
Notes
cause
required
Throwable
stackTrace
required
array[StackTraceElement]
message
required
String
suppressed
required
array[Throwable]
localizedMessage
required
String
Name
Required
Type
Notes
itemIds
required
array[Integer]
parentItemId
required
Integer
insertBeforeItemId
required
Integer
Name
Required
Type
Notes
id
required
Integer
username
required
String
firstName
required
String
lastName
required
String
email
required
String
phone
required
String
title
required
String
location
required
String
licenseType
required
String
avatarUrl
required
String
active
required
Boolean
authenticationType
required
AuthenticationType
uid
required
String
customData
required
array[UserCustomData]
Name
Required
Type
Notes
name
required
String
value
required
String
Name
Required
Type
Notes
data
required
array[UserCustomData]
links
required
map[String, Link]
linked
required
map[String, map[String, Object]]
meta
required
MetaListWrapper
Name
Required
Type
Notes
data
required
array[User]
links
required
map[String, Link]
linked
required
map[String, map[String, Object]]
meta
required
MetaListWrapper
Name
Required
Type
Notes
data
required
User
links
required
map[String, Link]
linked
required
map[String, map[String, Object]]
meta
required
MetaWrapper
Name
Required
Type
Notes
id
required
Integer
uid
required
String
name
required
String
description
required
String
project
required
Integer
ID of a project
Name
Required
Type
Notes
data
required
array[UserGroup]
links
required
map[String, Link]
linked
required
map[String, map[String, Object]]
meta
required
MetaListWrapper
Name
Required
Type
Notes
data
required
UserGroup
links
required
map[String, Link]
linked
required
map[String, map[String, Object]]
meta
required
MetaWrapper
Name
Required
Type
Notes
versionedItem
required
array[Integer]
Item ID and version number for a versioned item
type
required
String
item
required
Integer
ID of an item
versionNumber
required
Integer
changeDetails
required
String
comment
required
String
createdDate
required
Date
createdBy
required
Integer
ID of a user
userName
required
String
Name
Required
Type
Notes
data
required
array[Version]
links
required
map[String, Link]
linked
required
map[String, map[String, Object]]
meta
required
MetaListWrapper
Name
Required
Type
Notes
data
required
Version
links
required
map[String, Link]
linked
required
map[String, map[String, Object]]
meta
required
MetaWrapper
Name
Required
Type
Notes
lock
required
Lock
fileName
required
String
mimeType
required
String
fileSize
required
Integer
version
required
Integer
currentVersion
required
Integer
Currently active version of the versioned item. If no version is active, currentVersion will not be returned.
id
required
Integer
documentKey
required
String
globalId
required
String
project
required
Integer
ID of a project
itemType
required
Integer
ID of an item type
createdDate
required
Date
modifiedDate
required
Date
lastActivityDate
required
Date
createdBy
required
Integer
ID of a user
modifiedBy
required
Integer
ID of a user
baselinedAppliedCategorySnapshots
required
array[BaselinedAppliedCategorySnapshotInfo]
A list of baselined applied category snapshots
resources
required
map[String, AllowedResource]
A set of resources and allowed permissions
fields
required
map[String, Object]
A map of field names to field values e.g. {\"name\":\"Sample Item\", \"status\": 292, \"release\": 2, \"assigned\": 23}
Name
Required
Type
Notes
data
required
VersionedAttachment
links
required
map[String, Link]
linked
required
map[String, map[String, Object]]
meta
required
MetaWrapper
Name
Required
Type
Notes
version
required
Integer
currentVersion
required
Integer
Currently active version of the versioned item. If no version is active, currentVersion will not be returned.
id
required
Integer
documentKey
required
String
globalId
required
String
project
required
Integer
ID of a project
itemType
required
Integer
ID of an item type
childItemType
required
Integer
ID of an item type
createdDate
required
Date
modifiedDate
required
Date
lastActivityDate
required
Date
createdBy
required
Integer
ID of a user
modifiedBy
required
Integer
ID of a user
baselinedAppliedCategorySnapshots
required
array[BaselinedAppliedCategorySnapshotInfo]
A list of baselined applied category snapshots
resources
required
map[String, AllowedResource]
A set of resources and allowed permissions
fields
required
map[String, Object]
A map of field names to field values e.g. {\"name\":\"Sample Item\", \"status\": 292, \"release\": 2, \"assigned\": 23}
Name
Required
Type
Notes
data
required
VersionedItem
links
required
map[String, Link]
linked
required
map[String, map[String, Object]]
meta
required
MetaWrapper
Name
Required
Type
Notes
id
required
Integer
fromItem
required
array[Integer]
ID of a version
toItem
required
array[Integer]
ID of a version
suspect
required
Boolean
relationshipType
required
array[Object]
ID of a relationship type
Name
Required
Type
Notes
data
required
array[VersionedRelationship]
links
required
map[String, Link]
linked
required
map[String, map[String, Object]]
meta
required
MetaListWrapper
Name
Required
Type
Notes
version
required
Integer
currentVersion
required
Integer
Currently active version of the versioned item. If no version is active, currentVersion will not be returned.
id
required
Integer
documentKey
required
String
globalId
required
String
project
required
Integer
ID of a project
itemType
required
Integer
ID of an item type
createdDate
required
Date
modifiedDate
required
Date
lastActivityDate
required
Date
createdBy
required
Integer
ID of a user
modifiedBy
required
Integer
ID of a user
baselinedAppliedCategorySnapshots
required
array[BaselinedAppliedCategorySnapshotInfo]
A list of baselined applied category snapshots
resources
required
map[String, AllowedResource]
A set of resources and allowed permissions
fields
required
map[String, Object]
A map of field names to field values e.g. {\"name\":\"Sample Item\", \"status\": 292, \"release\": 2, \"assigned\": 23}
Name
Required
Type
Notes
data
required
VersionedTestCycle
links
required
map[String, Link]
linked
required
map[String, map[String, Object]]
meta
required
MetaWrapper
Name
Required
Type
Notes
version
required
Integer
currentVersion
required
Integer
Currently active version of the versioned item. If no version is active, currentVersion will not be returned.
id
required
Integer
documentKey
required
String
globalId
required
String
project
required
Integer
ID of a project
itemType
required
Integer
ID of an item type
createdDate
required
Date
modifiedDate
required
Date
lastActivityDate
required
Date
createdBy
required
Integer
ID of a user
modifiedBy
required
Integer
ID of a user
baselinedAppliedCategorySnapshots
required
array[BaselinedAppliedCategorySnapshotInfo]
A list of baselined applied category snapshots
resources
required
map[String, AllowedResource]
A set of resources and allowed permissions
fields
required
map[String, Object]
A map of field names to field values e.g. {\"name\":\"Sample Item\", \"status\": 292, \"release\": 2, \"assigned\": 23}
archived
required
Boolean
Name
Required
Type
Notes
data
required
VersionedTestPlan
links
required
map[String, Link]
linked
required
map[String, map[String, Object]]
meta
required
MetaWrapper
Name
Required
Type
Notes
version
required
Integer
currentVersion
required
Integer
Currently active version of the versioned item. If no version is active, currentVersion will not be returned.
id
required
Integer
documentKey
required
String
globalId
required
String
project
required
Integer
ID of a project
itemType
required
Integer
ID of an item type
createdDate
required
Date
modifiedDate
required
Date
lastActivityDate
required
Date
createdBy
required
Integer
ID of a user
modifiedBy
required
Integer
ID of a user
testCaseVersionNumber
required
Integer
The version of the test case at the time of test run creation
sortOrderFromTestGroup
required
Integer
The sort order within the test group at the time of test cycle creation
testGroup
required
array[Integer]
ID of a test cycle and ID of a test group
baselinedAppliedCategorySnapshots
required
array[BaselinedAppliedCategorySnapshotInfo]
A list of baselined applied category snapshots
resources
required
map[String, AllowedResource]
A set of resources and allowed permissions
fields
required
map[String, Object]
A map of field names to field values e.g. {\"name\":\"Sample Item\", \"status\": 292, \"release\": 2, \"assigned\": 23}
Name
Required
Type
Notes
data
required
VersionedTestRun
links
required
map[String, Link]
linked
required
map[String, map[String, Object]]
meta
required
MetaWrapper
Name
Required
Type
Notes
workKey
required
String
jobName
required
String
inProgress
required
Boolean
isFailed
required
Boolean
workSteps
required
array[WorkStepStatus]
returnValue
required
String
Name
Required
Type
Notes
data
required
WorkStatus
links
required
map[String, Link]
linked
required
map[String, map[String, Object]]
meta
required
MetaWrapper
Name
Required
Type
Notes
stepName
required
String
completedWork
required
Integer
totalWork
required
Integer
Name
Required
Type
Notes
id
required
String
action
required
String
newStatus
required
Integer
ID of a pick list option
Name
Required
Type
Notes
data
required
array[WorkflowTransition]
links
required
map[String, Link]
linked
required
map[String, map[String, Object]]
meta
required
MetaListWrapper
© 2015 Jama Software | 135 SW Taylor Suite 200, Portland, Oregon, 97204