Contents
Endpoints
Endpoint abstractitems
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.
GET /abstractitems
Summary: Search for items, test plans, test cycles, test runs, or attachments
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” : 6,
“globalId” : “globalId”,
“project” : 1,
“resources” : {
“key” : {
“allowed” : [ “allowed”, “allowed” ]
}
},
“version” : 7,
“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”
}
}
}
Produces: API call produces the following media types according to the
Accept request header;
the media type will be conveyed by the Content-Type response header:
- application/json
Response:
AbstractItemDataWrapper
GET /abstractitems/{id}
Summary: Get any item, test plan, test cycle, test run, or attachment with the specified ID
Path parameters:
- id
(required)
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” : 6,
“globalId” : “globalId”,
“project” : 1,
“resources” : {
“key” : {
“allowed” : [ “allowed”, “allowed” ]
}
},
“version” : 7,
“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”
}
}
}
Produces: API call produces the following media types according to the
Accept request header;
the media type will be conveyed by the Content-Type response header:
- application/json
Response:
AbstractItemDataWrapper
GET /abstractitems/{id}/versions/{versionNum}
Summary: Get the numbered version for the item with the specified ID
Path parameters:
- versionNum
(required)
- id
(required)
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” : 0,
“createdDate” : “2000-01-23T04:56:07.000+00:00”,
“versionedItem” : {
“id” : 2,
“value” : { },
“object” : {
“id” : 1,
“type” : “type”,
“version” : 5,
“currentVersion” : 5
}
},
“createdBy” : 7,
“comment” : “comment”,
“userName” : “userName”,
“type” : “type”,
“versionNumber” : 6,
“changeDetails” : “changeDetails”
},
“meta” : {
“status” : “OK”,
“timestamp” : “2000-01-23T04:56:07.000+00:00”
},
“links” : {
“key” : {
“href” : “href”,
“type” : “type”
}
}
}
Produces: API call produces the following media types according to the
Accept request header;
the media type will be conveyed by the Content-Type response header:
- application/json
Response:
VersionDataWrapper
GET /abstractitems/{id}/versions/{versionNum}/versioneditem
Summary: Get the snapshot of the item at the specified version
Path parameters:
- versionNum
(required)
- id
(required)
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” : 6,
“fileName” : “fileName”,
“globalId” : “globalId”,
“project” : 1,
“resources” : {
“key” : {
“allowed” : [ “allowed”, “allowed” ]
}
},
“mimeType” : “mimeType”,
“version” : 2,
“currentVersion” : 3,
“createdDate” : “2000-01-23T04:56:07.000+00:00”,
“lastActivityDate” : “2000-01-23T04:56:07.000+00:00”,
“createdBy” : 5,
“fileSize” : 9,
“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” : 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”
}
}
}
Produces: API call produces the following media types according to the
Accept request header;
the media type will be conveyed by the Content-Type response header:
- application/json
Response:
VersionedAttachmentDataWrapper
GET /abstractitems/{id}/versionedrelationships
Summary: Get all versioned relationships that were associated to the item at the specified time
Path parameters:
- id
(required)
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” : 5,
“fromItem” : 6,
“id” : 0,
“suspect” : true,
“toItem” : 1
}, {
“relationshipType” : 5,
“fromItem” : 6,
“id” : 0,
“suspect” : true,
“toItem” : 1
} ],
“meta” : {
“pageInfo” : {
“startIndex” : 0,
“resultCount” : 6,
“totalResults” : 1
},
“status” : “OK”,
“timestamp” : “2000-01-23T04:56:07.000+00:00”
},
“links” : {
“key” : {
“href” : “href”,
“type” : “type”
}
}
}
Produces: API call produces the following media types according to the
Accept request header;
the media type will be conveyed by the Content-Type response header:
- application/json
Response:
RelationshipDataListWrapper
GET /abstractitems/{id}/versions
Summary: Get all versions for the item with the specified ID
Path parameters:
- id
(required)
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” : 0,
“createdDate” : “2000-01-23T04:56:07.000+00:00”,
“versionedItem” : {
“id” : 2,
“value” : { },
“object” : {
“id” : 1,
“type” : “type”,
“version” : 5,
“currentVersion” : 5
}
},
“createdBy” : 7,
“comment” : “comment”,
“userName” : “userName”,
“type” : “type”,
“versionNumber” : 6,
“changeDetails” : “changeDetails”
}, {
“item” : 0,
“createdDate” : “2000-01-23T04:56:07.000+00:00”,
“versionedItem” : {
“id” : 2,
“value” : { },
“object” : {
“id” : 1,
“type” : “type”,
“version” : 5,
“currentVersion” : 5
}
},
“createdBy” : 7,
“comment” : “comment”,
“userName” : “userName”,
“type” : “type”,
“versionNumber” : 6,
“changeDetails” : “changeDetails”
} ],
“meta” : {
“pageInfo” : {
“startIndex” : 0,
“resultCount” : 6,
“totalResults” : 1
},
“status” : “OK”,
“timestamp” : “2000-01-23T04:56:07.000+00:00”
},
“links” : {
“key” : {
“href” : “href”,
“type” : “type”
}
}
}
Produces: API call produces the following media types according to the
Accept request header;
the media type will be conveyed by the Content-Type response header:
- application/json
Response:
VersionDataListWrapper
Endpoint activities
The activities endpoint has the following operations:
- 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.
GET /activities
Summary: Get all activities in the project with the specified ID
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” : 6,
“itemType” : 5,
“userComment” : “userComment”,
“action” : “action”,
“details” : “details”,
“id” : 0,
“eventType” : “CREATE”,
“userName” : “userName”,
“user” : 1,
“objectType” : “PROJECT”
}, {
“date” : “2000-01-23T04:56:07.000+00:00”,
“item” : 6,
“itemType” : 5,
“userComment” : “userComment”,
“action” : “action”,
“details” : “details”,
“id” : 0,
“eventType” : “CREATE”,
“userName” : “userName”,
“user” : 1,
“objectType” : “PROJECT”
} ],
“meta” : {
“pageInfo” : {
“startIndex” : 0,
“resultCount” : 6,
“totalResults” : 1
},
“status” : “OK”,
“timestamp” : “2000-01-23T04:56:07.000+00:00”
},
“links” : {
“key” : {
“href” : “href”,
“type” : “type”
}
}
}
Produces: API call produces the following media types according to the
Accept request header;
the media type will be conveyed by the Content-Type response header:
- application/json
Response:
ActivityDataListWrapper
GET /activities/{activityId}
Summary: Get the activity with the specified ID
Path parameters:
- activityId
(required)
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” : 6,
“itemType” : 5,
“userComment” : “userComment”,
“action” : “action”,
“details” : “details”,
“id” : 0,
“eventType” : “CREATE”,
“userName” : “userName”,
“user” : 1,
“objectType” : “PROJECT”
},
“meta” : {
“status” : “OK”,
“timestamp” : “2000-01-23T04:56:07.000+00:00”
},
“links” : {
“key” : {
“href” : “href”,
“type” : “type”
}
}
}
Produces: API call produces the following media types according to the
Accept request header;
the media type will be conveyed by the Content-Type response header:
- application/json
Response:
ActivityDataWrapper
GET /activities/adminActivity
Summary: Get all activities at the admin level
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
{
“data” : [ {
“date” : “2000-01-23T04:56:07.000+00:00”,
“item” : 6,
“itemType” : 5,
“userComment” : “userComment”,
“action” : “action”,
“details” : “details”,
“id” : 0,
“eventType” : “CREATE”,
“userName” : “userName”,
“user” : 1,
“objectType” : “PROJECT”
}, {
“date” : “2000-01-23T04:56:07.000+00:00”,
“item” : 6,
“itemType” : 5,
“userComment” : “userComment”,
“action” : “action”,
“details” : “details”,
“id” : 0,
“eventType” : “CREATE”,
“userName” : “userName”,
“user” : 1,
“objectType” : “PROJECT”
} ],
“meta” : {
“pageInfo” : {
“startIndex” : 0,
“resultCount” : 6,
“totalResults” : 1
},
“status” : “OK”,
“timestamp” : “2000-01-23T04:56:07.000+00:00”
},
“links” : {
“key” : {
“href” : “href”,
“type” : “type”
}
}
}
Produces: API call produces the following media types according to the
Accept request header;
the media type will be conveyed by the Content-Type response header:
- application/json
Response:
ActivityDataListWrapper
GET /activities/{activityId}/affecteditems
Summary: Get all items affected by the activity with the specified ID
Path parameters:
- activityId
(required)
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” : 6,
“globalId” : “globalId”,
“project” : 1,
“resources” : {
“key” : {
“allowed” : [ “allowed”, “allowed” ]
}
},
“childItemType” : 4,
“version” : 2,
“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” : 5,
“location” : {
“sequence” : “sequence”,
“parent” : {
“item” : 2,
“project” : 3
},
“sortOrder” : 7,
“globalSortOrder” : 9
},
“id” : 0,
“fields” : {
“key” : { }
},
“baselinedAppliedCategorySnapshots” : [ {
“categoryPathSequence” : “categoryPathSequence”,
“itemVersionNumberApplied” : 2
}, {
“categoryPathSequence” : “categoryPathSequence”,
“itemVersionNumberApplied” : 2
} ]
}, {
“itemType” : 6,
“globalId” : “globalId”,
“project” : 1,
“resources” : {
“key” : {
“allowed” : [ “allowed”, “allowed” ]
}
},
“childItemType” : 4,
“version” : 2,
“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” : 5,
“location” : {
“sequence” : “sequence”,
“parent” : {
“item” : 2,
“project” : 3
},
“sortOrder” : 7,
“globalSortOrder” : 9
},
“id” : 0,
“fields” : {
“key” : { }
},
“baselinedAppliedCategorySnapshots” : [ {
“categoryPathSequence” : “categoryPathSequence”,
“itemVersionNumberApplied” : 2
}, {
“categoryPathSequence” : “categoryPathSequence”,
“itemVersionNumberApplied” : 2
} ]
} ],
“meta” : {
“pageInfo” : {
“startIndex” : 0,
“resultCount” : 6,
“totalResults” : 1
},
“status” : “OK”,
“timestamp” : “2000-01-23T04:56:07.000+00:00”
},
“links” : {
“key” : {
“href” : “href”,
“type” : “type”
}
}
}
Produces: API call produces the following media types according to the
Accept request header;
the media type will be conveyed by the Content-Type response header:
- application/json
Response:
ItemDataListWrapper
POST /activities/{activityId}/restore
Summary: Restore item(s) associated with a delete activity.
Path parameters:
- activityId
(required)
Examples:
- Example data, content-type: application/json
{
“meta” : {
“status” : “OK”,
“timestamp” : “2000-01-23T04:56:07.000+00:00”
}
}
Produces: API call produces the following media types according to the
Accept request header;
the media type will be conveyed by the Content-Type response header:
- application/json
Response:
OkResponseDataWraper
Endpoint attachments
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.
GET /attachments/{attachmentId}/file
Summary: Download attachment file from the attachment with the specified ID
Path parameters:
- attachmentId
(required)
Request headers:
- xJamaDateFieldsWithTime
(optional)
Produces: API call produces the following media types according to the
Accept request header;
the media type will be conveyed by the Content-Type response header:
- application/octet-stream
GET /attachments/{attachmentId}
Summary: Get the attachment with the specified ID
Path parameters:
- attachmentId
(required)
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” : 6,
“globalId” : “globalId”,
“project” : 1,
“resources” : {
“key” : {
“allowed” : [ “allowed”, “allowed” ]
}
},
“childItemType” : 4,
“version” : 2,
“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” : 5,
“location” : {
“sequence” : “sequence”,
“parent” : {
“item” : 2,
“project” : 3
},
“sortOrder” : 7,
“globalSortOrder” : 9
},
“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”
}
}
}
Produces: API call produces the following media types according to the
Accept request header;
the media type will be conveyed by the Content-Type response header:
- application/json
Response:
ItemDataWrapper
GET /attachments/{attachmentId}/comments
Summary: Get all comments for the item with the specified ID
Path parameters:
- attachmentId
(required)
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” : 0,
“resultCount” : 6,
“totalResults” : 1
},
“status” : “OK”,
“timestamp” : “2000-01-23T04:56:07.000+00:00”
},
“links” : {
“key” : {
“href” : “href”,
“type” : “type”
}
}
}
Produces: API call produces the following media types according to the
Accept request header;
the media type will be conveyed by the Content-Type response header:
- application/json
Response:
CommentDataListWrapper
GET /attachments/{attachmentId}/lock
Summary: Get the locked state, last locked date, and last locked by user for the item with the specified ID
Path parameters:
- attachmentId
(required)
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”
}
}
}
Produces: API call produces the following media types according to the
Accept request header;
the media type will be conveyed by the Content-Type response header:
- application/json
Response:
LockDataWrapper
GET /attachments/{attachmentId}/versions/{versionNum}
Summary: Get the numbered version for the item with the specified ID
Path parameters:
- versionNum
(required)
- attachmentId
(required)
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” : 0,
“createdDate” : “2000-01-23T04:56:07.000+00:00”,
“versionedItem” : {
“id” : 2,
“value” : { },
“object” : {
“id” : 1,
“type” : “type”,
“version” : 5,
“currentVersion” : 5
}
},
“createdBy” : 7,
“comment” : “comment”,
“userName” : “userName”,
“type” : “type”,
“versionNumber” : 6,
“changeDetails” : “changeDetails”
},
“meta” : {
“status” : “OK”,
“timestamp” : “2000-01-23T04:56:07.000+00:00”
},
“links” : {
“key” : {
“href” : “href”,
“type” : “type”
}
}
}
Produces: API call produces the following media types according to the
Accept request header;
the media type will be conveyed by the Content-Type response header:
- application/json
Response:
VersionDataWrapper
GET /attachments/{attachmentId}/versions/{versionNum}/versioneditem
Summary: Get the snapshot of the attachment at the specified version
Path parameters:
- versionNum
(required)
- attachmentId
(required)
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” : 6,
“fileName” : “fileName”,
“globalId” : “globalId”,
“project” : 1,
“resources” : {
“key” : {
“allowed” : [ “allowed”, “allowed” ]
}
},
“mimeType” : “mimeType”,
“version” : 2,
“currentVersion” : 3,
“createdDate” : “2000-01-23T04:56:07.000+00:00”,
“lastActivityDate” : “2000-01-23T04:56:07.000+00:00”,
“createdBy” : 5,
“fileSize” : 9,
“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” : 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”
}
}
}
Produces: API call produces the following media types according to the
Accept request header;
the media type will be conveyed by the Content-Type response header:
- application/json
Response:
VersionedAttachmentDataWrapper
GET /attachments/{attachmentId}/versions
Summary: Get all versions for the item with the specified ID
Path parameters:
- attachmentId
(required)
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” : 0,
“createdDate” : “2000-01-23T04:56:07.000+00:00”,
“versionedItem” : {
“id” : 2,
“value” : { },
“object” : {
“id” : 1,
“type” : “type”,
“version” : 5,
“currentVersion” : 5
}
},
“createdBy” : 7,
“comment” : “comment”,
“userName” : “userName”,
“type” : “type”,
“versionNumber” : 6,
“changeDetails” : “changeDetails”
}, {
“item” : 0,
“createdDate” : “2000-01-23T04:56:07.000+00:00”,
“versionedItem” : {
“id” : 2,
“value” : { },
“object” : {
“id” : 1,
“type” : “type”,
“version” : 5,
“currentVersion” : 5
}
},
“createdBy” : 7,
“comment” : “comment”,
“userName” : “userName”,
“type” : “type”,
“versionNumber” : 6,
“changeDetails” : “changeDetails”
} ],
“meta” : {
“pageInfo” : {
“startIndex” : 0,
“resultCount” : 6,
“totalResults” : 1
},
“status” : “OK”,
“timestamp” : “2000-01-23T04:56:07.000+00:00”
},
“links” : {
“key” : {
“href” : “href”,
“type” : “type”
}
}
}
Produces: API call produces the following media types according to the
Accept request header;
the media type will be conveyed by the Content-Type response header:
- application/json
Response:
VersionDataListWrapper
PUT /attachments/{attachmentId}/lock
Summary: Update the locked state of the item with the specified ID
Path parameters:
- attachmentId
(required)
Consumes: this API call consumes the following media types via the
Content-Type request header:
- application/json
Body:
Examples:
- Example data, content-type: application/json
{
“meta” : {
“status” : “OK”,
“timestamp” : “2000-01-23T04:56:07.000+00:00”
}
}
Produces: API call produces the following media types according to the
Accept request header;
the media type will be conveyed by the Content-Type response header:
- application/json
Response:
OkResponseDataWraper
PUT /attachments/{attachmentId}/file
Summary: Upload attachment file to the attachment with the specified ID
Path parameters:
- attachmentId
(required)
Consumes: this API call consumes the following media types via the
Content-Type request header:
- multipart/form-data
Examples:
- Example data, content-type: application/json
{
“meta” : {
“status” : “OK”,
“timestamp” : “2000-01-23T04:56:07.000+00:00”
}
}
Produces: API call produces the following media types according to the
Accept request header;
the media type will be conveyed by the Content-Type response header:
- application/json
Response:
OkResponseDataWraper
Endpoint baselines
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.
DELETE /baselines/{baselineId}
Summary: Delete the baseline with the specified ID
Path parameters:
- baselineId
(required)
GET /baselines/{baselineId}
Summary: Get the baseline with the specified ID
Path parameters:
- baselineId
(required)
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,
“simpleFilter” : {
“id” : 4,
“type” : “type”
},
“project” : 5
},
“description” : “description”,
“project” : 1,
“signed” : true,
“source” : 7,
“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”
}
}
}
Produces: API call produces the following media types according to the
Accept request header;
the media type will be conveyed by the Content-Type response header:
- application/json
Response:
BaselineDataWrapper
GET /baselines
Summary: Get all baselines in the project with the specified ID
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,
“simpleFilter” : {
“id” : 4,
“type” : “type”
},
“project” : 5
},
“description” : “description”,
“project” : 1,
“signed” : true,
“source” : 7,
“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,
“simpleFilter” : {
“id” : 4,
“type” : “type”
},
“project” : 5
},
“description” : “description”,
“project” : 1,
“signed” : true,
“source” : 7,
“type” : “type”,
“createdDate” : “2000-01-23T04:56:07.000+00:00”,
“createdBy” : 6,
“name” : “name”,
“id” : 0,
“sourceName” : “sourceName”,
“baselinePickListOption” : { }
} ],
“meta” : {
“pageInfo” : {
“startIndex” : 0,
“resultCount” : 6,
“totalResults” : 1
},
“status” : “OK”,
“timestamp” : “2000-01-23T04:56:07.000+00:00”
},
“links” : {
“key” : {
“href” : “href”,
“type” : “type”
}
}
}
Produces: API call produces the following media types according to the
Accept request header;
the media type will be conveyed by the Content-Type response header:
- application/json
Response:
BaselineDataListWrapper
GET /baselines/{baselineId}/versioneditems/{itemId}/versionedrelationships
Summary: Get all versioned relationships for the item in the baseline
Path parameters:
- itemId
(required)
- baselineId
(required)
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” : 0,
“resultCount” : 6,
“totalResults” : 1
},
“status” : “OK”,
“timestamp” : “2000-01-23T04:56:07.000+00:00”
},
“links” : {
“key” : {
“href” : “href”,
“type” : “type”
}
}
}
Produces: API call produces the following media types according to the
Accept request header;
the media type will be conveyed by the Content-Type response header:
- application/json
Response:
RelationshipDataListWrapper
GET /baselines/{baselineId}/reviewlink
Summary: Get related review link
Path parameters:
- baselineId
(required)
Examples:
- Example data, content-type: application/json
{
“data” : {
“revisionId” : 0,
“deleted” : true,
“reviewKey” : “reviewKey”,
“readAccess” : true,
“reviewName” : “reviewName”,
“url” : “url”
},
“meta” : {
“status” : “OK”,
“timestamp” : “2000-01-23T04:56:07.000+00:00”
}
}
Produces: API call produces the following media types according to the
Accept request header;
the media type will be conveyed by the Content-Type response header:
- application/json
Response:
BaselineReviewLinkDataWrapper
GET /baselines/{baselineId}/versioneditems/{itemId}
Summary: Get the baseline item with the specified ID in a baseline with the specified ID
Path parameters:
- itemId
(required)
- baselineId
(required)
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” : 6,
“globalId” : “globalId”,
“project” : 1,
“resources” : {
“key” : {
“allowed” : [ “allowed”, “allowed” ]
}
},
“baseline” : 3,
“childItemType” : 7,
“version” : 2,
“currentVersion” : 9,
“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
} ],
“baselineLocation” : {
“sequence” : “sequence”,
“parent” : {
“VersionedItem” : {
“id” : 1,
“value” : { },
“object” : {
“itemType” : 4,
“globalId” : “globalId”,
“project” : 7,
“resources” : { },
“childItemType” : 6,
“version” : 1,
“currentVersion” : 7,
“createdDate” : “2000-01-23T04:56:07.000+00:00”,
“lastActivityDate” : “2000-01-23T04:56:07.000+00:00”,
“createdBy” : 1,
“documentKey” : “documentKey”,
“modifiedDate” : “2000-01-23T04:56:07.000+00:00”,
“modifiedBy” : 1,
“id” : 2,
“fields” : {
“key” : { }
},
“baselinedAppliedCategorySnapshots” : [ null, null ]
}
},
“project” : 4
}
}
},
“meta” : {
“status” : “OK”,
“timestamp” : “2000-01-23T04:56:07.000+00:00”
},
“links” : {
“key” : {
“href” : “href”,
“type” : “type”
}
}
}
Produces: API call produces the following media types according to the
Accept request header;
the media type will be conveyed by the Content-Type response header:
- application/json
Response:
BaselineItemDataWrapper
GET /baselines/{baselineId}/versioneditems
Summary: Get all baseline items in a baseline with the specified ID
Path parameters:
- baselineId
(required)
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” : 6,
“globalId” : “globalId”,
“project” : 1,
“resources” : {
“key” : {
“allowed” : [ “allowed”, “allowed” ]
}
},
“baseline” : 3,
“childItemType” : 7,
“version” : 2,
“currentVersion” : 9,
“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
} ],
“baselineLocation” : {
“sequence” : “sequence”,
“parent” : {
“VersionedItem” : {
“id” : 1,
“value” : { },
“object” : {
“itemType” : 4,
“globalId” : “globalId”,
“project” : 7,
“resources” : { },
“childItemType” : 6,
“version” : 1,
“currentVersion” : 7,
“createdDate” : “2000-01-23T04:56:07.000+00:00”,
“lastActivityDate” : “2000-01-23T04:56:07.000+00:00”,
“createdBy” : 1,
“documentKey” : “documentKey”,
“modifiedDate” : “2000-01-23T04:56:07.000+00:00”,
“modifiedBy” : 1,
“id” : 2,
“fields” : {
“key” : { }
},
“baselinedAppliedCategorySnapshots” : [ null, null ]
}
},
“project” : 4
}
}
}, {
“itemType” : 6,
“globalId” : “globalId”,
“project” : 1,
“resources” : {
“key” : {
“allowed” : [ “allowed”, “allowed” ]
}
},
“baseline” : 3,
“childItemType” : 7,
“version” : 2,
“currentVersion” : 9,
“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
} ],
“baselineLocation” : {
“sequence” : “sequence”,
“parent” : {
“VersionedItem” : {
“id” : 1,
“value” : { },
“object” : {
“itemType” : 4,
“globalId” : “globalId”,
“project” : 7,
“resources” : { },
“childItemType” : 6,
“version” : 1,
“currentVersion” : 7,
“createdDate” : “2000-01-23T04:56:07.000+00:00”,
“lastActivityDate” : “2000-01-23T04:56:07.000+00:00”,
“createdBy” : 1,
“documentKey” : “documentKey”,
“modifiedDate” : “2000-01-23T04:56:07.000+00:00”,
“modifiedBy” : 1,
“id” : 2,
“fields” : {
“key” : { }
},
“baselinedAppliedCategorySnapshots” : [ null, null ]
}
},
“project” : 4
}
}
} ],
“meta” : {
“pageInfo” : {
“startIndex” : 0,
“resultCount” : 6,
“totalResults” : 1
},
“status” : “OK”,
“timestamp” : “2000-01-23T04:56:07.000+00:00”
},
“links” : {
“key” : {
“href” : “href”,
“type” : “type”
}
}
}
Produces: API call produces the following media types according to the
Accept request header;
the media type will be conveyed by the Content-Type response header:
- application/json
Response:
BaselineItemDataListWrapper
PUT /baselines/{baselineId}
Summary: Update the baseline with the specified ID
Path parameters:
- baselineId
(required)
Consumes: this API call consumes the following media types via the
Content-Type request header:
- application/json
Body:
Examples:
- Example data, content-type: application/json
{
“meta” : {
“status” : “OK”,
“timestamp” : “2000-01-23T04:56:07.000+00:00”
}
}
Produces: API call produces the following media types according to the
Accept request header;
the media type will be conveyed by the Content-Type response header:
- application/json
Response:
OkResponseDataWraper
Endpoint categories
The categories endpoint has the following operations:
Below is more detail for each of the operations of the categories endpoint.
POST /categories
Summary: Create CategoryPath
Create CategoryPath by string path
Consumes: this API call consumes the following media types via the
Content-Type request header:
- application/json
Body:
Examples:
- Example data, content-type: application/json
{
“data” : 0,
“meta” : {
“status” : “OK”,
“timestamp” : “2000-01-23T04:56:07.000+00:00”
}
}
Produces: API call produces the following media types according to the
Accept request header;
the media type will be conveyed by the Content-Type response header:
- application/json
Response:
CreatedResponseSimpleDataWrapper
Response:
BadRequestResponseDataWrapper
Response:
ConflictErrorResponseDataWrapper
PUT /categories/{categoryPathId}/visibility
Summary: Update category visibility
Path parameters:
- categoryPathId
(required)
Consumes: this API call consumes the following media types via the
Content-Type request header:
- application/json
Body:
Examples:
- Example data, content-type: application/json
{
“meta” : {
“status” : “OK”,
“timestamp” : “2000-01-23T04:56:07.000+00:00”
}
}
Produces: API call produces the following media types according to the
Accept request header;
the media type will be conveyed by the Content-Type response header:
- application/json
Response:
OkResponseDataWraper
GET /categories
Summary: Get all category paths by name (and/or) project id
Query parameters:
- categoryName
(optional) - startAt
(optional), default value: 0
- maxResults
(optional), default value: 50
- projectId
(optional), default value: 0
Examples:
- Example data, content-type: application/json
{
“data” : [ { }, { } ],
“meta” : {
“pageInfo” : {
“startIndex” : 0,
“resultCount” : 6,
“totalResults” : 1
},
“status” : “OK”,
“timestamp” : “2000-01-23T04:56:07.000+00:00”
},
“links” : {
“key” : {
“href” : “href”,
“type” : “type”
}
}
}
Produces: API call produces the following media types according to the
Accept request header;
the media type will be conveyed by the Content-Type response header:
- application/json
Response:
CategoryResponseDataWrapper
Endpoint comments
The comments endpoint has the following operations:
Below is more detail for each of the operations of the comments endpoint.
POST /comments
Summary: Create a new comment
Consumes: this API call consumes the following media types via the
Content-Type request header:
- application/json
Body:
Examples:
- Example data, content-type: application/json
{
“meta” : {
“location” : “location”,
“id” : 0,
“status” : “OK”,
“timestamp” : “2000-01-23T04:56:07.000+00:00”
}
}
Produces: API call produces the following media types according to the
Accept request header;
the media type will be conveyed by the Content-Type response header:
- application/json
Response:
CreatedResponseDataWrapper
GET /comments/{id}
Summary: Get the comment with the specified ID
Path parameters:
- id
(required)
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”
}
}
}
Produces: API call produces the following media types according to the
Accept request header;
the media type will be conveyed by the Content-Type response header:
- application/json
Response:
CommentDataWrapper
GET /comments
Summary: Get all comments viewable by the current user
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” : 0,
“resultCount” : 6,
“totalResults” : 1
},
“status” : “OK”,
“timestamp” : “2000-01-23T04:56:07.000+00:00”
},
“links” : {
“key” : {
“href” : “href”,
“type” : “type”
}
}
}
Produces: API call produces the following media types according to the
Accept request header;
the media type will be conveyed by the Content-Type response header:
- application/json
Response:
CommentDataListWrapper
GET /comments/{id}/replies
Summary: Get all reply comments for the comment with the specified ID
Path parameters:
- id
(required)
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” : 0,
“resultCount” : 6,
“totalResults” : 1
},
“status” : “OK”,
“timestamp” : “2000-01-23T04:56:07.000+00:00”
},
“links” : {
“key” : {
“href” : “href”,
“type” : “type”
}
}
}
Produces: API call produces the following media types according to the
Accept request header;
the media type will be conveyed by the Content-Type response header:
- application/json
Response:
CommentDataListWrapper
Endpoint files
The files endpoint has the following operations:
Below is more detail for each of the operations of the files endpoint.
GET /files
Summary: Download attachment file from the attachment with the specified Jama URL
Request headers:
- xJamaDateFieldsWithTime
(optional)
Query parameters:
- url
(required)
Produces: API call produces the following media types according to the
Accept request header;
the media type will be conveyed by the Content-Type response header:
- application/octet-stream
Endpoint filters
The filters endpoint has the following operations:
Below is more detail for each of the operations of the filters endpoint.
GET /filters/{filterId}/count
Summary: Get the count for the filter with the specified ID
Path parameters:
- filterId
(required)
Examples:
- Example data, content-type: application/json
{
“data” : 0,
“meta” : {
“status” : “OK”,
“timestamp” : “2000-01-23T04:56:07.000+00:00”
},
“links” : {
“key” : {
“href” : “href”,
“type” : “type”
}
}
}
Produces: API call produces the following media types according to the
Accept request header;
the media type will be conveyed by the Content-Type response header:
- application/json
Response:
ObjectResponseDataWrapper
GET /filters/{filterId}
Summary: Get the filter with the specified ID
Path parameters:
- filterId
(required)
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”,
“type” : “filters”,
“filterQuery” : {
“orderRules” : [ {
“direction” : “ASC”
}, {
“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”
}
}
}
Produces: API call produces the following media types according to the
Accept request header;
the media type will be conveyed by the Content-Type response header:
- application/json
Response:
FilterDataWrapper
GET /filters
Summary: Get all filters viewable by the current user
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”,
“type” : “filters”,
“filterQuery” : {
“orderRules” : [ {
“direction” : “ASC”
}, {
“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”,
“type” : “filters”,
“filterQuery” : {
“orderRules” : [ {
“direction” : “ASC”
}, {
“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” : 0,
“resultCount” : 6,
“totalResults” : 1
},
“status” : “OK”,
“timestamp” : “2000-01-23T04:56:07.000+00:00”
},
“links” : {
“key” : {
“href” : “href”,
“type” : “type”
}
}
}
Produces: API call produces the following media types according to the
Accept request header;
the media type will be conveyed by the Content-Type response header:
- application/json
Response:
FilterDataListWrapper
GET /filters/{filterId}/results
Summary: Get all result items for the filter with the specified ID
Path parameters:
- filterId
(required)
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” : 6,
“globalId” : “globalId”,
“project” : 1,
“resources” : {
“key” : {
“allowed” : [ “allowed”, “allowed” ]
}
},
“childItemType” : 4,
“version” : 2,
“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” : 5,
“location” : {
“sequence” : “sequence”,
“parent” : {
“item” : 2,
“project” : 3
},
“sortOrder” : 7,
“globalSortOrder” : 9
},
“id” : 0,
“fields” : {
“key” : { }
},
“baselinedAppliedCategorySnapshots” : [ {
“categoryPathSequence” : “categoryPathSequence”,
“itemVersionNumberApplied” : 2
}, {
“categoryPathSequence” : “categoryPathSequence”,
“itemVersionNumberApplied” : 2
} ]
}, {
“itemType” : 6,
“globalId” : “globalId”,
“project” : 1,
“resources” : {
“key” : {
“allowed” : [ “allowed”, “allowed” ]
}
},
“childItemType” : 4,
“version” : 2,
“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” : 5,
“location” : {
“sequence” : “sequence”,
“parent” : {
“item” : 2,
“project” : 3
},
“sortOrder” : 7,
“globalSortOrder” : 9
},
“id” : 0,
“fields” : {
“key” : { }
},
“baselinedAppliedCategorySnapshots” : [ {
“categoryPathSequence” : “categoryPathSequence”,
“itemVersionNumberApplied” : 2
}, {
“categoryPathSequence” : “categoryPathSequence”,
“itemVersionNumberApplied” : 2
} ]
} ],
“meta” : {
“pageInfo” : {
“startIndex” : 0,
“resultCount” : 6,
“totalResults” : 1
},
“status” : “OK”,
“timestamp” : “2000-01-23T04:56:07.000+00:00”
},
“links” : {
“key” : {
“href” : “href”,
“type” : “type”
}
}
}
Produces: API call produces the following media types according to the
Accept request header;
the media type will be conveyed by the Content-Type response header:
- application/json
Response:
ItemDataListWrapper
Endpoint items
The items endpoint has the following operations:
- POST /items/{id}/attachments
- POST /items
- POST /items/{id}/links
- POST /items/{id}/tags
- POST /items/{id}/categories
- 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}/baselinedcategories
- GET /items/{id}/categories
- 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}
- DELETE /items/{id}/categories
- 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.
POST /items/{id}/attachments
Summary: Add an existing attachment to the item with the specified ID
Path parameters:
- id
(required)
Consumes: this API call consumes the following media types via the
Content-Type request header:
- application/json
Body:
Examples:
- Example data, content-type: application/json
{
“meta” : {
“location” : “location”,
“id” : 0,
“status” : “OK”,
“timestamp” : “2000-01-23T04:56:07.000+00:00”
}
}
Produces: API call produces the following media types according to the
Accept request header;
the media type will be conveyed by the Content-Type response header:
- application/json
Response:
CreatedResponseDataWrapper
POST /items
Summary: Create a new item
Consumes: this API call consumes the following media types via the
Content-Type request header:
- application/json
Body:
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
{
“meta” : {
“location” : “location”,
“id” : 0,
“status” : “OK”,
“timestamp” : “2000-01-23T04:56:07.000+00:00”
}
}
Produces: API call produces the following media types according to the
Accept request header;
the media type will be conveyed by the Content-Type response header:
- application/json
Response:
CreatedResponseDataWrapper
POST /items/{id}/links
Summary: Create a new link for the item with the specified ID
Path parameters:
- id
(required)
Consumes: this API call consumes the following media types via the
Content-Type request header:
- application/json
Body:
Examples:
- Example data, content-type: application/json
{
“meta” : {
“location” : “location”,
“id” : 0,
“status” : “OK”,
“timestamp” : “2000-01-23T04:56:07.000+00:00”
}
}
Produces: API call produces the following media types according to the
Accept request header;
the media type will be conveyed by the Content-Type response header:
- application/json
Response:
CreatedResponseDataWrapper
POST /items/{id}/tags
Summary: Add an existing tag to the item with the specified ID
Path parameters:
- id
(required)
Consumes: this API call consumes the following media types via the
Content-Type request header:
- application/json
Body:
Examples:
- Example data, content-type: application/json
{
“meta” : {
“location” : “location”,
“id” : 0,
“status” : “OK”,
“timestamp” : “2000-01-23T04:56:07.000+00:00”
}
}
Produces: API call produces the following media types according to the
Accept request header;
the media type will be conveyed by the Content-Type response header:
- application/json
Response:
CreatedResponseDataWrapper
POST /items/{id}/categories
Summary: Apply categories to an item
Path parameters:
- id
(required)
Consumes: this API call consumes the following media types via the
Content-Type request header:
- application/json
Body:
Examples:
- Example data, content-type: application/json
{
“meta” : {
“status” : “OK”,
“timestamp” : “2000-01-23T04:56:07.000+00:00”
}
}
Produces: API call produces the following media types according to the
Accept request header;
the media type will be conveyed by the Content-Type response header:
- application/json
Response:
OkResponseDataWraper
DELETE /items/{id}/synceditems/{syncedItemId}
Summary: Remove an existing item from the Global ID pool of the item with the specified ID (break sync)
Path parameters:
- syncedItemId
(required)
- id
(required)
POST /items/{id}/synceditems
Summary: Add an existing item to the Global ID pool of the item with the specified ID
Path parameters:
- id
(required)
Consumes: this API call consumes the following media types via the
Content-Type request header:
- application/json
Body:
Examples:
- Example data, content-type: application/json
{
“meta” : {
“location” : “location”,
“id” : 0,
“status” : “OK”,
“timestamp” : “2000-01-23T04:56:07.000+00:00”
}
}
Produces: API call produces the following media types according to the
Accept request header;
the media type will be conveyed by the Content-Type response header:
- application/json
Response:
CreatedResponseDataWrapper
DELETE /items/{id}
Summary: Delete the item with the specified ID (item becomes inactive and can be un-deleted if necessary)
Path parameters:
- id
(required)
DELETE /items/{id}/links/{linkId}
Summary: Delete the link with the specified ID
Path parameters:
- linkId
(required)
- id
(required)
POST /items/{id}/duplicate
Summary: Create a duplicate of item
Copies the name and description fields. Only items without children can be have a duplicate created.
Path parameters:
- id
(required)
Consumes: this API call consumes the following media types via the
Content-Type request header:
- application/json
Body:
Examples:
- Example data, content-type: application/json
{
“meta” : {
“location” : “location”,
“id” : 0,
“status” : “OK”,
“timestamp” : “2000-01-23T04:56:07.000+00:00”
}
}
Produces: API call produces the following media types according to the
Accept request header;
the media type will be conveyed by the Content-Type response header:
- application/json
Response:
CreatedResponseDataWrapper
POST /items/{id}/workflowtransitions
Summary: Executes a workflow transition for the item with the specified ID. Valid transitions can be found at /items/{id}/workflowtransitionoptions
Path parameters:
- id
(required)
Consumes: this API call consumes the following media types via the
Content-Type request header:
- application/json
Body:
Examples:
- Example data, content-type: application/json
{
“meta” : {
“status” : “OK”,
“timestamp” : “2000-01-23T04:56:07.000+00:00”
}
}
Produces: API call produces the following media types according to the
Accept request header;
the media type will be conveyed by the Content-Type response header:
- application/json
Response:
CreatedResponseSimpleMetaDataWrapper
GET /items/{id}/activities
Summary: Get all activities for the item with the specified ID
Path parameters:
- id
(required)
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” : 6,
“itemType” : 5,
“userComment” : “userComment”,
“action” : “action”,
“details” : “details”,
“id” : 0,
“eventType” : “CREATE”,
“userName” : “userName”,
“user” : 1,
“objectType” : “PROJECT”
}, {
“date” : “2000-01-23T04:56:07.000+00:00”,
“item” : 6,
“itemType” : 5,
“userComment” : “userComment”,
“action” : “action”,
“details” : “details”,
“id” : 0,
“eventType” : “CREATE”,
“userName” : “userName”,
“user” : 1,
“objectType” : “PROJECT”
} ],
“meta” : {
“pageInfo” : {
“startIndex” : 0,
“resultCount” : 6,
“totalResults” : 1
},
“status” : “OK”,
“timestamp” : “2000-01-23T04:56:07.000+00:00”
},
“links” : {
“key” : {
“href” : “href”,
“type” : “type”
}
}
}
Produces: API call produces the following media types according to the
Accept request header;
the media type will be conveyed by the Content-Type response header:
- application/json
Response:
ActivityDataListWrapper
GET /items/{id}/attachments
Summary: Get all attachments for the item with the specified ID
Path parameters:
- id
(required)
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”,
“attachmentTypeId” : 8,
“description” : “description”,
“project” : {
“parent” : 7,
“projectType” : {
“components” : “components”,
“scopeId” : 0,
“description” : “description”,
“xmlToString” : “xmlToString”,
“organizationId” : 3,
“createdDate” : “2000-01-23T04:56:07.000+00:00”,
“createdBy” : 6,
“newObject” : true,
“name” : “name”,
“defaultDisplay” : “defaultDisplay”,
“modifiedDate” : “2000-01-23T04:56:07.000+00:00”,
“defaultPrefix” : “defaultPrefix”,
“defaultDisplayPlural” : “defaultDisplayPlural”,
“modifiedBy” : 8,
“id” : 4,
“refId” : 2,
“scopeByType” : “SYSTEM”
},
“description” : “description”,
“flag2” : true,
“flag1” : true,
“organizationId” : 4,
“projectKey” : “projectKey”,
“string3” : “string3”,
“string4” : “string4”,
“string1” : “string1”,
“newObject” : true,
“string2” : “string2”,
“modifiedBy” : 8,
“id” : 6,
“user1” : {
“lastName” : “lastName”,
“active” : true,
“customData” : [ {
“name” : “name”,
“value” : “value”
}, {
“name” : “name”,
“value” : “value”
} ],
“title” : “title”,
“type” : “users”,
“firstName” : “firstName”,
“licenseType” : “NAMED”,
“uid” : “uid”,
“phone” : “phone”,
“location” : “location”,
“id” : 9,
“authenticationType” : {
“name” : “name”,
“id” : 3
},
“email” : “email”,
“username” : “username”
},
“active” : true,
“date2” : “2000-01-23T04:56:07.000+00:00”,
“xmlToString” : “xmlToString”,
“date1” : “2000-01-23T04:56:07.000+00:00”,
“defaultDashboard” : {
“scopeId” : 5,
“xmlToString” : “xmlToString”,
“dashboardName” : “dashboardName”,
“layout” : “SINGLE_COLUMN”,
“organizationId” : 7,
“createdDate” : “2000-01-23T04:56:07.000+00:00”,
“createdBy” : 0,
“newObject” : true,
“modifiedDate” : “2000-01-23T04:56:07.000+00:00”,
“modifiedBy” : 9,
“id” : 0,
“refId” : 4,
“portletInstances” : [ {
“organizationId” : 9,
“location” : “location”,
“portlet” : “FILTER_RESULTS”,
“id” : 7,
“properties” : {
“key” : “properties”
}
}, {
“organizationId” : 9,
“location” : “location”,
“portlet” : “FILTER_RESULTS”,
“id” : 7,
“properties” : {
“key” : “properties”
}
} ],
“scopeByType” : “SYSTEM”
},
“lookup1” : {
“image” : “image”,
“color” : “color”,
“dataValue” : “dataValue”,
“description” : “description”,
“active” : true,
“lookupType” : {
“lookups” : [ null, null ],
“scopeId” : 6,
“description” : “description”,
“active” : true,
“xmlToString” : “xmlToString”,
“type” : 2,
“organizationId” : 1,
“createdDate” : “2000-01-23T04:56:07.000+00:00”,
“createdBy” : 7,
“newObject” : true,
“name” : “name”,
“modifiedDate” : “2000-01-23T04:56:07.000+00:00”,
“modifiedBy” : 1,
“id” : 1,
“refId” : 7,
“category” : 4,
“scopeByType” : “SYSTEM”
},
“xmlToString” : “xmlToString”,
“organizationId” : 9,
“archived” : true,
“isDefault” : true,
“createdDate” : “2000-01-23T04:56:07.000+00:00”,
“createdBy” : 4,
“newObject” : true,
“sortOrder” : 1,
“name” : “name”,
“modifiedDate” : “2000-01-23T04:56:07.000+00:00”,
“infotip” : “infotip”,
“modifiedBy” : 5,
“id” : 9
},
“isFolder” : true,
“createdDate” : “2000-01-23T04:56:07.000+00:00”,
“text3” : “text3”,
“createdBy” : 1,
“text1” : “text1”,
“text2” : “text2”,
“name” : “name”,
“modifiedDate” : “2000-01-23T04:56:07.000+00:00”,
“relationshipRuleSet” : {
“organizationId” : 4,
“isExclusive” : true,
“name” : “name”,
“rules” : [ {
“organizationId” : 4,
“forCoverage” : true,
“relationshipType” : {
“image” : “image”,
“scopeId” : 6,
“showNote” : true,
“description” : “description”,
“active” : true,
“showStatus” : true,
“xmlToString” : “xmlToString”,
“organizationId” : 3,
“isDefault” : true,
“createdDate” : “2000-01-23T04:56:07.000+00:00”,
“createdBy” : 8,
“newObject” : true,
“sortOrder” : 6,
“name” : “name”,
“modifiedDate” : “2000-01-23T04:56:07.000+00:00”,
“modifiedBy” : 9,
“id” : 6,
“refId” : 1,
“scopeByType” : “SYSTEM”
},
“fromDocType” : {
“image” : “image”,
“workflowFieldId” : 2,
“display” : “display”,
“description” : “description”,
“active” : true,
“xmlToString” : “xmlToString”,
“documentTypeKey” : “documentTypeKey”,
“organizationId” : 0,
“documentTypeFields” : [ {
“documentField” : {
“isDerived” : true,
“scopeId” : 0,
“userConfigurable” : true,
“custom” : true,
“dataType” : “INTEGER”,
“description” : “description”,
“readOnly” : true,
“xmlToString” : “xmlToString”,
“editXtype” : “editXtype”,
“organizationId” : 7,
“createdDate” : “2000-01-23T04:56:07.000+00:00”,
“formXtype” : “formXtype”,
“createdBy” : 6,
“newObject” : true,
“name” : “name”,
“modifiedDate” : “2000-01-23T04:56:07.000+00:00”,
“modifiedBy” : 3,
“id” : 3,
“refId” : 7,
“category” : 5,
“gridXtype” : “gridXtype”,
“scopeByType” : “SYSTEM”,
“fieldType” : 6
},
“description” : “description”,
“defaultTemplateId” : 0,
“isSynchronizeField” : true,
“required” : true,
“controlStyle” : “controlStyle”,
“organizationId” : 3,
“newObject” : true,
“infotip” : “infotip”,
“modifiedBy” : 8,
“id” : 7,
“readOnlyAllowApiOverwrite” : true,
“shouldVersion” : true,
“readOnly” : true,
“lookupTypeId” : 6,
“label” : “label”,
“xmlToString” : “xmlToString”,
“createdDate” : “2000-01-23T04:56:07.000+00:00”,
“controlType” : “TEXTAREA”,
“isReqAdvisorEnabled” : true,
“createdBy” : 4,
“sortOrder” : 6,
“modifiedDate” : “2000-01-23T04:56:07.000+00:00”,
“isInherited” : true,
“triggerSuspect” : true
}, {
“documentField” : {
“isDerived” : true,
“scopeId” : 0,
“userConfigurable” : true,
“custom” : true,
“dataType” : “INTEGER”,
“description” : “description”,
“readOnly” : true,
“xmlToString” : “xmlToString”,
“editXtype” : “editXtype”,
“organizationId” : 7,
“createdDate” : “2000-01-23T04:56:07.000+00:00”,
“formXtype” : “formXtype”,
“createdBy” : 6,
“newObject” : true,
“name” : “name”,
“modifiedDate” : “2000-01-23T04:56:07.000+00:00”,
“modifiedBy” : 3,
“id” : 3,
“refId” : 7,
“category” : 5,
“gridXtype” : “gridXtype”,
“scopeByType” : “SYSTEM”,
“fieldType” : 6
},
“description” : “description”,
“defaultTemplateId” : 0,
“isSynchronizeField” : true,
“required” : true,
“controlStyle” : “controlStyle”,
“organizationId” : 3,
“newObject” : true,
“infotip” : “infotip”,
“modifiedBy” : 8,
“id” : 7,
“readOnlyAllowApiOverwrite” : true,
“shouldVersion” : true,
“readOnly” : true,
“lookupTypeId” : 6,
“label” : “label”,
“xmlToString” : “xmlToString”,
“createdDate” : “2000-01-23T04:56:07.000+00:00”,
“controlType” : “TEXTAREA”,
“isReqAdvisorEnabled” : true,
“createdBy” : 4,
“sortOrder” : 6,
“modifiedDate” : “2000-01-23T04:56:07.000+00:00”,
“isInherited” : true,
“triggerSuspect” : true
} ],
“createdDate” : “2000-01-23T04:56:07.000+00:00”,
“createdBy” : 5,
“newObject” : true,
“modifiedDate” : “2000-01-23T04:56:07.000+00:00”,
“hasCustomImage” : true,
“modifiedBy” : 3,
“id” : 4,
“category” : “CORE”,
“documentTypeFacets” : [ {
“organizationId” : 7,
“isSyncedFacet” : true,
“id” : 3,
“facet” : “ACTIVITIES”
}, {
“organizationId” : 7,
“isSyncedFacet” : true,
“id” : 3,
“facet” : “ACTIVITIES”
} ],
“displayPlural” : “displayPlural”
},
“id” : 6
}, {
“organizationId” : 4,
“forCoverage” : true,
“relationshipType” : {
“image” : “image”,
“scopeId” : 6,
“showNote” : true,
“description” : “description”,
“active” : true,
“showStatus” : true,
“xmlToString” : “xmlToString”,
“organizationId” : 3,
“isDefault” : true,
“createdDate” : “2000-01-23T04:56:07.000+00:00”,
“createdBy” : 8,
“newObject” : true,
“sortOrder” : 6,
“name” : “name”,
“modifiedDate” : “2000-01-23T04:56:07.000+00:00”,
“modifiedBy” : 9,
“id” : 6,
“refId” : 1,
“scopeByType” : “SYSTEM”
},
“fromDocType” : {
“image” : “image”,
“workflowFieldId” : 2,
“display” : “display”,
“description” : “description”,
“active” : true,
“xmlToString” : “xmlToString”,
“documentTypeKey” : “documentTypeKey”,
“organizationId” : 0,
“documentTypeFields” : [ {
“documentField” : {
“isDerived” : true,
“scopeId” : 0,
“userConfigurable” : true,
“custom” : true,
“dataType” : “INTEGER”,
“description” : “description”,
“readOnly” : true,
“xmlToString” : “xmlToString”,
“editXtype” : “editXtype”,
“organizationId” : 7,
“createdDate” : “2000-01-23T04:56:07.000+00:00”,
“formXtype” : “formXtype”,
“createdBy” : 6,
“newObject” : true,
“name” : “name”,
“modifiedDate” : “2000-01-23T04:56:07.000+00:00”,
“modifiedBy” : 3,
“id” : 3,
“refId” : 7,
“category” : 5,
“gridXtype” : “gridXtype”,
“scopeByType” : “SYSTEM”,
“fieldType” : 6
},
“description” : “description”,
“defaultTemplateId” : 0,
“isSynchronizeField” : true,
“required” : true,
“controlStyle” : “controlStyle”,
“organizationId” : 3,
“newObject” : true,
“infotip” : “infotip”,
“modifiedBy” : 8,
“id” : 7,
“readOnlyAllowApiOverwrite” : true,
“shouldVersion” : true,
“readOnly” : true,
“lookupTypeId” : 6,
“label” : “label”,
“xmlToString” : “xmlToString”,
“createdDate” : “2000-01-23T04:56:07.000+00:00”,
“controlType” : “TEXTAREA”,
“isReqAdvisorEnabled” : true,
“createdBy” : 4,
“sortOrder” : 6,
“modifiedDate” : “2000-01-23T04:56:07.000+00:00”,
“isInherited” : true,
“triggerSuspect” : true
}, {
“documentField” : {
“isDerived” : true,
“scopeId” : 0,
“userConfigurable” : true,
“custom” : true,
“dataType” : “INTEGER”,
“description” : “description”,
“readOnly” : true,
“xmlToString” : “xmlToString”,
“editXtype” : “editXtype”,
“organizationId” : 7,
“createdDate” : “2000-01-23T04:56:07.000+00:00”,
“formXtype” : “formXtype”,
“createdBy” : 6,
“newObject” : true,
“name” : “name”,
“modifiedDate” : “2000-01-23T04:56:07.000+00:00”,
“modifiedBy” : 3,
“id” : 3,
“refId” : 7,
“category” : 5,
“gridXtype” : “gridXtype”,
“scopeByType” : “SYSTEM”,
“fieldType” : 6
},
“description” : “description”,
“defaultTemplateId” : 0,
“isSynchronizeField” : true,
“required” : true,
“controlStyle” : “controlStyle”,
“organizationId” : 3,
“newObject” : true,
“infotip” : “infotip”,
“modifiedBy” : 8,
“id” : 7,
“readOnlyAllowApiOverwrite” : true,
“shouldVersion” : true,
“readOnly” : true,
“lookupTypeId” : 6,
“label” : “label”,
“xmlToString” : “xmlToString”,
“createdDate” : “2000-01-23T04:56:07.000+00:00”,
“controlType” : “TEXTAREA”,
“isReqAdvisorEnabled” : true,
“createdBy” : 4,
“sortOrder” : 6,
“modifiedDate” : “2000-01-23T04:56:07.000+00:00”,
“isInherited” : true,
“triggerSuspect” : true
} ],
“createdDate” : “2000-01-23T04:56:07.000+00:00”,
“createdBy” : 5,
“newObject” : true,
“modifiedDate” : “2000-01-23T04:56:07.000+00:00”,
“hasCustomImage” : true,
“modifiedBy” : 3,
“id” : 4,
“category” : “CORE”,
“documentTypeFacets” : [ {
“organizationId” : 7,
“isSyncedFacet” : true,
“id” : 3,
“facet” : “ACTIVITIES”
}, {
“organizationId” : 7,
“isSyncedFacet” : true,
“id” : 3,
“facet” : “ACTIVITIES”
} ],
“displayPlural” : “displayPlural”
},
“id” : 6
} ],
“id” : 1
}
},
“diagramGraphXml” : “diagramGraphXml”,
“xmlToString” : “xmlToString”,
“organizationId” : 0,
“system” : true,
“createdDate” : “2000-01-23T04:56:07.000+00:00”,
“fileSize” : 0,
“diagramHeight” : 1,
“createdBy” : 3,
“newObject” : true,
“organization” : {
“redirectUrl” : “redirectUrl”,
“licenseMessage” : 6,
“description” : “description”,
“xmlToString” : “xmlToString”,
“organizationId” : 2,
“baseUrl” : “baseUrl”,
“createdDate” : “2000-01-23T04:56:07.000+00:00”,
“createdBy” : 1,
“newObject” : true,
“name” : “name”,
“modifiedDate” : “2000-01-23T04:56:07.000+00:00”,
“closed” : true,
“subdomain” : “subdomain”,
“modifiedBy” : 5,
“returnEmail” : “returnEmail”,
“id” : 5
},
“diagramImageXml” : “diagramImageXml”,
“modifiedDate” : “2000-01-23T04:56:07.000+00:00”,
“modifiedBy” : 9,
“id” : 8,
“diagramWidth” : 9
}, {
“fileName” : “fileName”,
“attachmentTypeId” : 8,
“description” : “description”,
“project” : {
“parent” : 7,
“projectType” : {
“components” : “components”,
“scopeId” : 0,
“description” : “description”,
“xmlToString” : “xmlToString”,
“organizationId” : 3,
“createdDate” : “2000-01-23T04:56:07.000+00:00”,
“createdBy” : 6,
“newObject” : true,
“name” : “name”,
“defaultDisplay” : “defaultDisplay”,
“modifiedDate” : “2000-01-23T04:56:07.000+00:00”,
“defaultPrefix” : “defaultPrefix”,
“defaultDisplayPlural” : “defaultDisplayPlural”,
“modifiedBy” : 8,
“id” : 4,
“refId” : 2,
“scopeByType” : “SYSTEM”
},
“description” : “description”,
“flag2” : true,
“flag1” : true,
“organizationId” : 4,
“projectKey” : “projectKey”,
“string3” : “string3”,
“string4” : “string4”,
“string1” : “string1”,
“newObject” : true,
“string2” : “string2”,
“modifiedBy” : 8,
“id” : 6,
“user1” : {
“lastName” : “lastName”,
“active” : true,
“customData” : [ {
“name” : “name”,
“value” : “value”
}, {
“name” : “name”,
“value” : “value”
} ],
“title” : “title”,
“type” : “users”,
“firstName” : “firstName”,
“licenseType” : “NAMED”,
“uid” : “uid”,
“phone” : “phone”,
“location” : “location”,
“id” : 9,
“authenticationType” : {
“name” : “name”,
“id” : 3
},
“email” : “email”,
“username” : “username”
},
“active” : true,
“date2” : “2000-01-23T04:56:07.000+00:00”,
“xmlToString” : “xmlToString”,
“date1” : “2000-01-23T04:56:07.000+00:00”,
“defaultDashboard” : {
“scopeId” : 5,
“xmlToString” : “xmlToString”,
“dashboardName” : “dashboardName”,
“layout” : “SINGLE_COLUMN”,
“organizationId” : 7,
“createdDate” : “2000-01-23T04:56:07.000+00:00”,
“createdBy” : 0,
“newObject” : true,
“modifiedDate” : “2000-01-23T04:56:07.000+00:00”,
“modifiedBy” : 9,
“id” : 0,
“refId” : 4,
“portletInstances” : [ {
“organizationId” : 9,
“location” : “location”,
“portlet” : “FILTER_RESULTS”,
“id” : 7,
“properties” : {
“key” : “properties”
}
}, {
“organizationId” : 9,
“location” : “location”,
“portlet” : “FILTER_RESULTS”,
“id” : 7,
“properties” : {
“key” : “properties”
}
} ],
“scopeByType” : “SYSTEM”
},
“lookup1” : {
“image” : “image”,
“color” : “color”,
“dataValue” : “dataValue”,
“description” : “description”,
“active” : true,
“lookupType” : {
“lookups” : [ null, null ],
“scopeId” : 6,
“description” : “description”,
“active” : true,
“xmlToString” : “xmlToString”,
“type” : 2,
“organizationId” : 1,
“createdDate” : “2000-01-23T04:56:07.000+00:00”,
“createdBy” : 7,
“newObject” : true,
“name” : “name”,
“modifiedDate” : “2000-01-23T04:56:07.000+00:00”,
“modifiedBy” : 1,
“id” : 1,
“refId” : 7,
“category” : 4,
“scopeByType” : “SYSTEM”
},
“xmlToString” : “xmlToString”,
“organizationId” : 9,
“archived” : true,
“isDefault” : true,
“createdDate” : “2000-01-23T04:56:07.000+00:00”,
“createdBy” : 4,
“newObject” : true,
“sortOrder” : 1,
“name” : “name”,
“modifiedDate” : “2000-01-23T04:56:07.000+00:00”,
“infotip” : “infotip”,
“modifiedBy” : 5,
“id” : 9
},
“isFolder” : true,
“createdDate” : “2000-01-23T04:56:07.000+00:00”,
“text3” : “text3”,
“createdBy” : 1,
“text1” : “text1”,
“text2” : “text2”,
“name” : “name”,
“modifiedDate” : “2000-01-23T04:56:07.000+00:00”,
“relationshipRuleSet” : {
“organizationId” : 4,
“isExclusive” : true,
“name” : “name”,
“rules” : [ {
“organizationId” : 4,
“forCoverage” : true,
“relationshipType” : {
“image” : “image”,
“scopeId” : 6,
“showNote” : true,
“description” : “description”,
“active” : true,
“showStatus” : true,
“xmlToString” : “xmlToString”,
“organizationId” : 3,
“isDefault” : true,
“createdDate” : “2000-01-23T04:56:07.000+00:00”,
“createdBy” : 8,
“newObject” : true,
“sortOrder” : 6,
“name” : “name”,
“modifiedDate” : “2000-01-23T04:56:07.000+00:00”,
“modifiedBy” : 9,
“id” : 6,
“refId” : 1,
“scopeByType” : “SYSTEM”
},
“fromDocType” : {
“image” : “image”,
“workflowFieldId” : 2,
“display” : “display”,
“description” : “description”,
“active” : true,
“xmlToString” : “xmlToString”,
“documentTypeKey” : “documentTypeKey”,
“organizationId” : 0,
“documentTypeFields” : [ {
“documentField” : {
“isDerived” : true,
“scopeId” : 0,
“userConfigurable” : true,
“custom” : true,
“dataType” : “INTEGER”,
“description” : “description”,
“readOnly” : true,
“xmlToString” : “xmlToString”,
“editXtype” : “editXtype”,
“organizationId” : 7,
“createdDate” : “2000-01-23T04:56:07.000+00:00”,
“formXtype” : “formXtype”,
“createdBy” : 6,
“newObject” : true,
“name” : “name”,
“modifiedDate” : “2000-01-23T04:56:07.000+00:00”,
“modifiedBy” : 3,
“id” : 3,
“refId” : 7,
“category” : 5,
“gridXtype” : “gridXtype”,
“scopeByType” : “SYSTEM”,
“fieldType” : 6
},
“description” : “description”,
“defaultTemplateId” : 0,
“isSynchronizeField” : true,
“required” : true,
“controlStyle” : “controlStyle”,
“organizationId” : 3,
“newObject” : true,
“infotip” : “infotip”,
“modifiedBy” : 8,
“id” : 7,
“readOnlyAllowApiOverwrite” : true,
“shouldVersion” : true,
“readOnly” : true,
“lookupTypeId” : 6,
“label” : “label”,
“xmlToString” : “xmlToString”,
“createdDate” : “2000-01-23T04:56:07.000+00:00”,
“controlType” : “TEXTAREA”,
“isReqAdvisorEnabled” : true,
“createdBy” : 4,
“sortOrder” : 6,
“modifiedDate” : “2000-01-23T04:56:07.000+00:00”,
“isInherited” : true,
“triggerSuspect” : true
}, {
“documentField” : {
“isDerived” : true,
“scopeId” : 0,
“userConfigurable” : true,
“custom” : true,
“dataType” : “INTEGER”,
“description” : “description”,
“readOnly” : true,
“xmlToString” : “xmlToString”,
“editXtype” : “editXtype”,
“organizationId” : 7,
“createdDate” : “2000-01-23T04:56:07.000+00:00”,
“formXtype” : “formXtype”,
“createdBy” : 6,
“newObject” : true,
“name” : “name”,
“modifiedDate” : “2000-01-23T04:56:07.000+00:00”,
“modifiedBy” : 3,
“id” : 3,
“refId” : 7,
“category” : 5,
“gridXtype” : “gridXtype”,
“scopeByType” : “SYSTEM”,
“fieldType” : 6
},
“description” : “description”,
“defaultTemplateId” : 0,
“isSynchronizeField” : true,
“required” : true,
“controlStyle” : “controlStyle”,
“organizationId” : 3,
“newObject” : true,
“infotip” : “infotip”,
“modifiedBy” : 8,
“id” : 7,
“readOnlyAllowApiOverwrite” : true,
“shouldVersion” : true,
“readOnly” : true,
“lookupTypeId” : 6,
“label” : “label”,
“xmlToString” : “xmlToString”,
“createdDate” : “2000-01-23T04:56:07.000+00:00”,
“controlType” : “TEXTAREA”,
“isReqAdvisorEnabled” : true,
“createdBy” : 4,
“sortOrder” : 6,
“modifiedDate” : “2000-01-23T04:56:07.000+00:00”,
“isInherited” : true,
“triggerSuspect” : true
} ],
“createdDate” : “2000-01-23T04:56:07.000+00:00”,
“createdBy” : 5,
“newObject” : true,
“modifiedDate” : “2000-01-23T04:56:07.000+00:00”,
“hasCustomImage” : true,
“modifiedBy” : 3,
“id” : 4,
“category” : “CORE”,
“documentTypeFacets” : [ {
“organizationId” : 7,
“isSyncedFacet” : true,
“id” : 3,
“facet” : “ACTIVITIES”
}, {
“organizationId” : 7,
“isSyncedFacet” : true,
“id” : 3,
“facet” : “ACTIVITIES”
} ],
“displayPlural” : “displayPlural”
},
“id” : 6
}, {
“organizationId” : 4,
“forCoverage” : true,
“relationshipType” : {
“image” : “image”,
“scopeId” : 6,
“showNote” : true,
“description” : “description”,
“active” : true,
“showStatus” : true,
“xmlToString” : “xmlToString”,
“organizationId” : 3,
“isDefault” : true,
“createdDate” : “2000-01-23T04:56:07.000+00:00”,
“createdBy” : 8,
“newObject” : true,
“sortOrder” : 6,
“name” : “name”,
“modifiedDate” : “2000-01-23T04:56:07.000+00:00”,
“modifiedBy” : 9,
“id” : 6,
“refId” : 1,
“scopeByType” : “SYSTEM”
},
“fromDocType” : {
“image” : “image”,
“workflowFieldId” : 2,
“display” : “display”,
“description” : “description”,
“active” : true,
“xmlToString” : “xmlToString”,
“documentTypeKey” : “documentTypeKey”,
“organizationId” : 0,
“documentTypeFields” : [ {
“documentField” : {
“isDerived” : true,
“scopeId” : 0,
“userConfigurable” : true,
“custom” : true,
“dataType” : “INTEGER”,
“description” : “description”,
“readOnly” : true,
“xmlToString” : “xmlToString”,
“editXtype” : “editXtype”,
“organizationId” : 7,
“createdDate” : “2000-01-23T04:56:07.000+00:00”,
“formXtype” : “formXtype”,
“createdBy” : 6,
“newObject” : true,
“name” : “name”,
“modifiedDate” : “2000-01-23T04:56:07.000+00:00”,
“modifiedBy” : 3,
“id” : 3,
“refId” : 7,
“category” : 5,
“gridXtype” : “gridXtype”,
“scopeByType” : “SYSTEM”,
“fieldType” : 6
},
“description” : “description”,
“defaultTemplateId” : 0,
“isSynchronizeField” : true,
“required” : true,
“controlStyle” : “controlStyle”,
“organizationId” : 3,
“newObject” : true,
“infotip” : “infotip”,
“modifiedBy” : 8,
“id” : 7,
“readOnlyAllowApiOverwrite” : true,
“shouldVersion” : true,
“readOnly” : true,
“lookupTypeId” : 6,
“label” : “label”,
“xmlToString” : “xmlToString”,
“createdDate” : “2000-01-23T04:56:07.000+00:00”,
“controlType” : “TEXTAREA”,
“isReqAdvisorEnabled” : true,
“createdBy” : 4,
“sortOrder” : 6,
“modifiedDate” : “2000-01-23T04:56:07.000+00:00”,
“isInherited” : true,
“triggerSuspect” : true
}, {
“documentField” : {
“isDerived” : true,
“scopeId” : 0,
“userConfigurable” : true,
“custom” : true,
“dataType” : “INTEGER”,
“description” : “description”,
“readOnly” : true,
“xmlToString” : “xmlToString”,
“editXtype” : “editXtype”,
“organizationId” : 7,
“createdDate” : “2000-01-23T04:56:07.000+00:00”,
“formXtype” : “formXtype”,
“createdBy” : 6,
“newObject” : true,
“name” : “name”,
“modifiedDate” : “2000-01-23T04:56:07.000+00:00”,
“modifiedBy” : 3,
“id” : 3,
“refId” : 7,
“category” : 5,
“gridXtype” : “gridXtype”,
“scopeByType” : “SYSTEM”,
“fieldType” : 6
},
“description” : “description”,
“defaultTemplateId” : 0,
“isSynchronizeField” : true,
“required” : true,
“controlStyle” : “controlStyle”,
“organizationId” : 3,
“newObject” : true,
“infotip” : “infotip”,
“modifiedBy” : 8,
“id” : 7,
“readOnlyAllowApiOverwrite” : true,
“shouldVersion” : true,
“readOnly” : true,
“lookupTypeId” : 6,
“label” : “label”,
“xmlToString” : “xmlToString”,
“createdDate” : “2000-01-23T04:56:07.000+00:00”,
“controlType” : “TEXTAREA”,
“isReqAdvisorEnabled” : true,
“createdBy” : 4,
“sortOrder” : 6,
“modifiedDate” : “2000-01-23T04:56:07.000+00:00”,
“isInherited” : true,
“triggerSuspect” : true
} ],
“createdDate” : “2000-01-23T04:56:07.000+00:00”,
“createdBy” : 5,
“newObject” : true,
“modifiedDate” : “2000-01-23T04:56:07.000+00:00”,
“hasCustomImage” : true,
“modifiedBy” : 3,
“id” : 4,
“category” : “CORE”,
“documentTypeFacets” : [ {
“organizationId” : 7,
“isSyncedFacet” : true,
“id” : 3,
“facet” : “ACTIVITIES”
}, {
“organizationId” : 7,
“isSyncedFacet” : true,
“id” : 3,
“facet” : “ACTIVITIES”
} ],
“displayPlural” : “displayPlural”
},
“id” : 6
} ],
“id” : 1
}
},
“diagramGraphXml” : “diagramGraphXml”,
“xmlToString” : “xmlToString”,
“organizationId” : 0,
“system” : true,
“createdDate” : “2000-01-23T04:56:07.000+00:00”,
“fileSize” : 0,
“diagramHeight” : 1,
“createdBy” : 3,
“newObject” : true,
“organization” : {
“redirectUrl” : “redirectUrl”,
“licenseMessage” : 6,
“description” : “description”,
“xmlToString” : “xmlToString”,
“organizationId” : 2,
“baseUrl” : “baseUrl”,
“createdDate” : “2000-01-23T04:56:07.000+00:00”,
“createdBy” : 1,
“newObject” : true,
“name” : “name”,
“modifiedDate” : “2000-01-23T04:56:07.000+00:00”,
“closed” : true,
“subdomain” : “subdomain”,
“modifiedBy” : 5,
“returnEmail” : “returnEmail”,
“id” : 5
},
“diagramImageXml” : “diagramImageXml”,
“modifiedDate” : “2000-01-23T04:56:07.000+00:00”,
“modifiedBy” : 9,
“id” : 8,
“diagramWidth” : 9
} ],
“meta” : {
“pageInfo” : {
“startIndex” : 0,
“resultCount” : 6,
“totalResults” : 1
},
“status” : “OK”,
“timestamp” : “2000-01-23T04:56:07.000+00:00”
},
“links” : {
“key” : {
“href” : “href”,
“type” : “type”
}
}
}
Produces: API call produces the following media types according to the
Accept request header;
the media type will be conveyed by the Content-Type response header:
- application/json
Response:
AttachmentDataListWrapper
GET /items/{id}/baselinedcategories
Summary: Get all categories for the item associated with a specific baseline
Path parameters:
- id
(required)
Query parameters:
- baselineId
(required)
Examples:
- Example data, content-type: application/json
{
“data” : [ {
“itemVersionIdUnapplied” : 1,
“categoryPathName” : “categoryPathName”,
“pathIdsToRoot” : [ “pathIdsToRoot”, “pathIdsToRoot” ],
“itemVersionIdApplied” : 6,
“categoryPathId” : 0,
“qtip” : “qtip”
}, {
“itemVersionIdUnapplied” : 1,
“categoryPathName” : “categoryPathName”,
“pathIdsToRoot” : [ “pathIdsToRoot”, “pathIdsToRoot” ],
“itemVersionIdApplied” : 6,
“categoryPathId” : 0,
“qtip” : “qtip”
} ],
“meta” : {
“pageInfo” : {
“startIndex” : 0,
“resultCount” : 6,
“totalResults” : 1
},
“status” : “OK”,
“timestamp” : “2000-01-23T04:56:07.000+00:00”
},
“links” : {
“key” : {
“href” : “href”,
“type” : “type”
}
}
}
Produces: API call produces the following media types according to the
Accept request header;
the media type will be conveyed by the Content-Type response header:
- application/json
Response:
CategoryPathInfoDataWrapper
GET /items/{id}/categories
Summary: Retrieve all categories for an item
Path parameters:
- id
(required)
Query parameters:
- startAt
(optional) - maxResults
(optional)
Examples:
- Example data, content-type: application/json
{
“data” : [ {
“itemVersionIdUnapplied” : 1,
“categoryPathName” : “categoryPathName”,
“pathIdsToRoot” : [ “pathIdsToRoot”, “pathIdsToRoot” ],
“itemVersionIdApplied” : 6,
“categoryPathId” : 0,
“qtip” : “qtip”
}, {
“itemVersionIdUnapplied” : 1,
“categoryPathName” : “categoryPathName”,
“pathIdsToRoot” : [ “pathIdsToRoot”, “pathIdsToRoot” ],
“itemVersionIdApplied” : 6,
“categoryPathId” : 0,
“qtip” : “qtip”
} ],
“meta” : {
“pageInfo” : {
“startIndex” : 0,
“resultCount” : 6,
“totalResults” : 1
},
“status” : “OK”,
“timestamp” : “2000-01-23T04:56:07.000+00:00”
},
“links” : {
“key” : {
“href” : “href”,
“type” : “type”
}
}
}
Produces: API call produces the following media types according to the
Accept request header;
the media type will be conveyed by the Content-Type response header:
- application/json
Response:
ItemCategoryDataListWrapper
GET /items/{id}/children
Summary: Get all children items for the item with the specified ID
Path parameters:
- id
(required)
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” : 6,
“globalId” : “globalId”,
“project” : 1,
“resources” : {
“key” : {
“allowed” : [ “allowed”, “allowed” ]
}
},
“childItemType” : 4,
“version” : 2,
“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” : 5,
“location” : {
“sequence” : “sequence”,
“parent” : {
“item” : 2,
“project” : 3
},
“sortOrder” : 7,
“globalSortOrder” : 9
},
“id” : 0,
“fields” : {
“key” : { }
},
“baselinedAppliedCategorySnapshots” : [ {
“categoryPathSequence” : “categoryPathSequence”,
“itemVersionNumberApplied” : 2
}, {
“categoryPathSequence” : “categoryPathSequence”,
“itemVersionNumberApplied” : 2
} ]
}, {
“itemType” : 6,
“globalId” : “globalId”,
“project” : 1,
“resources” : {
“key” : {
“allowed” : [ “allowed”, “allowed” ]
}
},
“childItemType” : 4,
“version” : 2,
“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” : 5,
“location” : {
“sequence” : “sequence”,
“parent” : {
“item” : 2,
“project” : 3
},
“sortOrder” : 7,
“globalSortOrder” : 9
},
“id” : 0,
“fields” : {
“key” : { }
},
“baselinedAppliedCategorySnapshots” : [ {
“categoryPathSequence” : “categoryPathSequence”,
“itemVersionNumberApplied” : 2
}, {
“categoryPathSequence” : “categoryPathSequence”,
“itemVersionNumberApplied” : 2
} ]
} ],
“meta” : {
“pageInfo” : {
“startIndex” : 0,
“resultCount” : 6,
“totalResults” : 1
},
“status” : “OK”,
“timestamp” : “2000-01-23T04:56:07.000+00:00”
},
“links” : {
“key” : {
“href” : “href”,
“type” : “type”
}
}
}
Produces: API call produces the following media types according to the
Accept request header;
the media type will be conveyed by the Content-Type response header:
- application/json
Response:
ItemDataListWrapper
GET /items/{id}/downstreamrelated
Summary: Get all downstream related items for the item with the specified ID
Path parameters:
- id
(required)
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” : 6,
“globalId” : “globalId”,
“project” : 1,
“resources” : {
“key” : {
“allowed” : [ “allowed”, “allowed” ]
}
},
“childItemType” : 4,
“version” : 2,
“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” : 5,
“location” : {
“sequence” : “sequence”,
“parent” : {
“item” : 2,
“project” : 3
},
“sortOrder” : 7,
“globalSortOrder” : 9
},
“id” : 0,
“fields” : {
“key” : { }
},
“baselinedAppliedCategorySnapshots” : [ {
“categoryPathSequence” : “categoryPathSequence”,
“itemVersionNumberApplied” : 2
}, {
“categoryPathSequence” : “categoryPathSequence”,
“itemVersionNumberApplied” : 2
} ]
}, {
“itemType” : 6,
“globalId” : “globalId”,
“project” : 1,
“resources” : {
“key” : {
“allowed” : [ “allowed”, “allowed” ]
}
},
“childItemType” : 4,
“version” : 2,
“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” : 5,
“location” : {
“sequence” : “sequence”,
“parent” : {
“item” : 2,
“project” : 3
},
“sortOrder” : 7,
“globalSortOrder” : 9
},
“id” : 0,
“fields” : {
“key” : { }
},
“baselinedAppliedCategorySnapshots” : [ {
“categoryPathSequence” : “categoryPathSequence”,
“itemVersionNumberApplied” : 2
}, {
“categoryPathSequence” : “categoryPathSequence”,
“itemVersionNumberApplied” : 2
} ]
} ],
“meta” : {
“pageInfo” : {
“startIndex” : 0,
“resultCount” : 6,
“totalResults” : 1
},
“status” : “OK”,
“timestamp” : “2000-01-23T04:56:07.000+00:00”
},
“links” : {
“key” : {
“href” : “href”,
“type” : “type”
}
}
}
Produces: API call produces the following media types according to the
Accept request header;
the media type will be conveyed by the Content-Type response header:
- application/json
Response:
ItemDataListWrapper
GET /items/{id}/downstreamrelationships
Summary: Get all downstream relationships for the item with the specified ID
Path parameters:
- id
(required)
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” : 0,
“resultCount” : 6,
“totalResults” : 1
},
“status” : “OK”,
“timestamp” : “2000-01-23T04:56:07.000+00:00”
},
“links” : {
“key” : {
“href” : “href”,
“type” : “type”
}
}
}
Produces: API call produces the following media types according to the
Accept request header;
the media type will be conveyed by the Content-Type response header:
- application/json
Response:
RelationshipDataListWrapper
GET /items/{id}
Summary: Get the item with the specified ID
Path parameters:
- id
(required)
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” : 6,
“globalId” : “globalId”,
“project” : 1,
“resources” : {
“key” : {
“allowed” : [ “allowed”, “allowed” ]
}
},
“childItemType” : 4,
“version” : 2,
“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” : 5,
“location” : {
“sequence” : “sequence”,
“parent” : {
“item” : 2,
“project” : 3
},
“sortOrder” : 7,
“globalSortOrder” : 9
},
“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”
}
}
}
Produces: API call produces the following media types according to the
Accept request header;
the media type will be conveyed by the Content-Type response header:
- application/json
Response:
ItemDataWrapper
GET /items/{id}/comments
Summary: Get all comments for the item with the specified ID
Path parameters:
- id
(required)
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” : 0,
“resultCount” : 6,
“totalResults” : 1
},
“status” : “OK”,
“timestamp” : “2000-01-23T04:56:07.000+00:00”
},
“links” : {
“key” : {
“href” : “href”,
“type” : “type”
}
}
}
Produces: API call produces the following media types according to the
Accept request header;
the media type will be conveyed by the Content-Type response header:
- application/json
Response:
CommentDataListWrapper
GET /items/{id}/links
Summary: Get all links for the item with the specified ID
Path parameters:
- id
(required)
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” : 0,
“resultCount” : 6,
“totalResults” : 1
},
“status” : “OK”,
“timestamp” : “2000-01-23T04:56:07.000+00:00”
},
“links” : { }
}
Produces: API call produces the following media types according to the
Accept request header;
the media type will be conveyed by the Content-Type response header:
- application/json
Response:
LinkDataListWrapper
GET /items
Summary: Get all items in the project with the specified ID
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” : 6,
“globalId” : “globalId”,
“project” : 1,
“resources” : {
“key” : {
“allowed” : [ “allowed”, “allowed” ]
}
},
“childItemType” : 4,
“version” : 2,
“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” : 5,
“location” : {
“sequence” : “sequence”,
“parent” : {
“item” : 2,
“project” : 3
},
“sortOrder” : 7,
“globalSortOrder” : 9
},
“id” : 0,
“fields” : {
“key” : { }
},
“baselinedAppliedCategorySnapshots” : [ {
“categoryPathSequence” : “categoryPathSequence”,
“itemVersionNumberApplied” : 2
}, {
“categoryPathSequence” : “categoryPathSequence”,
“itemVersionNumberApplied” : 2
} ]
}, {
“itemType” : 6,
“globalId” : “globalId”,
“project” : 1,
“resources” : {
“key” : {
“allowed” : [ “allowed”, “allowed” ]
}
},
“childItemType” : 4,
“version” : 2,
“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” : 5,
“location” : {
“sequence” : “sequence”,
“parent” : {
“item” : 2,
“project” : 3
},
“sortOrder” : 7,
“globalSortOrder” : 9
},
“id” : 0,
“fields” : {
“key” : { }
},
“baselinedAppliedCategorySnapshots” : [ {
“categoryPathSequence” : “categoryPathSequence”,
“itemVersionNumberApplied” : 2
}, {
“categoryPathSequence” : “categoryPathSequence”,
“itemVersionNumberApplied” : 2
} ]
} ],
“meta” : {
“pageInfo” : {
“startIndex” : 0,
“resultCount” : 6,
“totalResults” : 1
},
“status” : “OK”,
“timestamp” : “2000-01-23T04:56:07.000+00:00”
},
“links” : {
“key” : {
“href” : “href”,
“type” : “type”
}
}
}
Produces: API call produces the following media types according to the
Accept request header;
the media type will be conveyed by the Content-Type response header:
- application/json
Response:
ItemDataListWrapper
GET /items/{id}/links/{linkId}
Summary: Get the link with the specified ID
Path parameters:
- linkId
(required)
- id
(required)
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” : { }
}
Produces: API call produces the following media types according to the
Accept request header;
the media type will be conveyed by the Content-Type response header:
- application/json
Response:
LinkDataWrapper
GET /items/{id}/location
Summary: Get the location for the item with the specified ID
Path parameters:
- id
(required)
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” : 2,
“project” : 3
},
“sortOrder” : 7,
“globalSortOrder” : 9
},
“meta” : {
“status” : “OK”,
“timestamp” : “2000-01-23T04:56:07.000+00:00”
},
“links” : {
“key” : {
“href” : “href”,
“type” : “type”
}
}
}
Produces: API call produces the following media types according to the
Accept request header;
the media type will be conveyed by the Content-Type response header:
- application/json
Response:
LocationDataWrapper
GET /items/{id}/lock
Summary: Get the locked state, last locked date, and last locked by user for the item with the specified ID
Path parameters:
- id
(required)
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”
}
}
}
Produces: API call produces the following media types according to the
Accept request header;
the media type will be conveyed by the Content-Type response header:
- application/json
Response:
LockDataWrapper
GET /items/{id}/parent
Summary: Get the parent item for the item with the specified ID
Path parameters:
- id
(required)
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” : 6,
“globalId” : “globalId”,
“project” : 1,
“resources” : {
“key” : {
“allowed” : [ “allowed”, “allowed” ]
}
},
“childItemType” : 4,
“version” : 2,
“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” : 5,
“location” : {
“sequence” : “sequence”,
“parent” : {
“item” : 2,
“project” : 3
},
“sortOrder” : 7,
“globalSortOrder” : 9
},
“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”
}
}
}
Produces: API call produces the following media types according to the
Accept request header;
the media type will be conveyed by the Content-Type response header:
- application/json
Response:
ItemDataWrapper
GET /items/{id}/synceditems
Summary: Get all synchronized items for the item with the specified ID
Path parameters:
- id
(required)
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” : 6,
“globalId” : “globalId”,
“project” : 1,
“resources” : {
“key” : {
“allowed” : [ “allowed”, “allowed” ]
}
},
“childItemType” : 4,
“version” : 2,
“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” : 5,
“location” : {
“sequence” : “sequence”,
“parent” : {
“item” : 2,
“project” : 3
},
“sortOrder” : 7,
“globalSortOrder” : 9
},
“id” : 0,
“fields” : {
“key” : { }
},
“baselinedAppliedCategorySnapshots” : [ {
“categoryPathSequence” : “categoryPathSequence”,
“itemVersionNumberApplied” : 2
}, {
“categoryPathSequence” : “categoryPathSequence”,
“itemVersionNumberApplied” : 2
} ]
}, {
“itemType” : 6,
“globalId” : “globalId”,
“project” : 1,
“resources” : {
“key” : {
“allowed” : [ “allowed”, “allowed” ]
}
},
“childItemType” : 4,
“version” : 2,
“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” : 5,
“location” : {
“sequence” : “sequence”,
“parent” : {
“item” : 2,
“project” : 3
},
“sortOrder” : 7,
“globalSortOrder” : 9
},
“id” : 0,
“fields” : {
“key” : { }
},
“baselinedAppliedCategorySnapshots” : [ {
“categoryPathSequence” : “categoryPathSequence”,
“itemVersionNumberApplied” : 2
}, {
“categoryPathSequence” : “categoryPathSequence”,
“itemVersionNumberApplied” : 2
} ]
} ],
“meta” : {
“pageInfo” : {
“startIndex” : 0,
“resultCount” : 6,
“totalResults” : 1
},
“status” : “OK”,
“timestamp” : “2000-01-23T04:56:07.000+00:00”
},
“links” : {
“key” : {
“href” : “href”,
“type” : “type”
}
}
}
Produces: API call produces the following media types according to the
Accept request header;
the media type will be conveyed by the Content-Type response header:
- application/json
Response:
ItemDataListWrapper
GET /items/{id}/synceditems/{syncedItemId}/syncstatus
Summary: Get the sync status for the synced item with the specified ID
Path parameters:
- syncedItemId
(required)
- id
(required)
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”
}
}
}
Produces: API call produces the following media types according to the
Accept request header;
the media type will be conveyed by the Content-Type response header:
- application/json
Response:
SyncStatusDataWrapper
GET /items/{id}/tags/{tagId}
Summary: Get the tag with the specified ID
Path parameters:
- tagId
(required)
- id
(required)
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”
}
}
}
Produces: API call produces the following media types according to the
Accept request header;
the media type will be conveyed by the Content-Type response header:
- application/json
Response:
TagDataWrapper
GET /items/{id}/tags
Summary: Get all tags for the item with the specified ID
Path parameters:
- id
(required)
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” : 0,
“resultCount” : 6,
“totalResults” : 1
},
“status” : “OK”,
“timestamp” : “2000-01-23T04:56:07.000+00:00”
},
“links” : {
“key” : {
“href” : “href”,
“type” : “type”
}
}
}
Produces: API call produces the following media types according to the
Accept request header;
the media type will be conveyed by the Content-Type response header:
- application/json
Response:
TagDataListWrapper
GET /items/{id}/upstreamrelated
Summary: Get all upstream related items for the item with the specified ID
Path parameters:
- id
(required)
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” : 6,
“globalId” : “globalId”,
“project” : 1,
“resources” : {
“key” : {
“allowed” : [ “allowed”, “allowed” ]
}
},
“childItemType” : 4,
“version” : 2,
“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” : 5,
“location” : {
“sequence” : “sequence”,
“parent” : {
“item” : 2,
“project” : 3
},
“sortOrder” : 7,
“globalSortOrder” : 9
},
“id” : 0,
“fields” : {
“key” : { }
},
“baselinedAppliedCategorySnapshots” : [ {
“categoryPathSequence” : “categoryPathSequence”,
“itemVersionNumberApplied” : 2
}, {
“categoryPathSequence” : “categoryPathSequence”,
“itemVersionNumberApplied” : 2
} ]
}, {
“itemType” : 6,
“globalId” : “globalId”,
“project” : 1,
“resources” : {
“key” : {
“allowed” : [ “allowed”, “allowed” ]
}
},
“childItemType” : 4,
“version” : 2,
“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” : 5,
“location” : {
“sequence” : “sequence”,
“parent” : {
“item” : 2,
“project” : 3
},
“sortOrder” : 7,
“globalSortOrder” : 9
},
“id” : 0,
“fields” : {
“key” : { }
},
“baselinedAppliedCategorySnapshots” : [ {
“categoryPathSequence” : “categoryPathSequence”,
“itemVersionNumberApplied” : 2
}, {
“categoryPathSequence” : “categoryPathSequence”,
“itemVersionNumberApplied” : 2
} ]
} ],
“meta” : {
“pageInfo” : {
“startIndex” : 0,
“resultCount” : 6,
“totalResults” : 1
},
“status” : “OK”,
“timestamp” : “2000-01-23T04:56:07.000+00:00”
},
“links” : {
“key” : {
“href” : “href”,
“type” : “type”
}
}
}
Produces: API call produces the following media types according to the
Accept request header;
the media type will be conveyed by the Content-Type response header:
- application/json
Response:
ItemDataListWrapper
GET /items/{id}/upstreamrelationships
Summary: Get all upstream relationships for the item with the specified ID
Path parameters:
- id
(required)
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” : 0,
“resultCount” : 6,
“totalResults” : 1
},
“status” : “OK”,
“timestamp” : “2000-01-23T04:56:07.000+00:00”
},
“links” : {
“key” : {
“href” : “href”,
“type” : “type”
}
}
}
Produces: API call produces the following media types according to the
Accept request header;
the media type will be conveyed by the Content-Type response header:
- application/json
Response:
RelationshipDataListWrapper
GET /items/{id}/versions/{versionNum}
Summary: Get the numbered version for the item with the specified ID
Path parameters:
- versionNum
(required)
- id
(required)
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” : 0,
“createdDate” : “2000-01-23T04:56:07.000+00:00”,
“versionedItem” : {
“id” : 2,
“value” : { },
“object” : {
“id” : 1,
“type” : “type”,
“version” : 5,
“currentVersion” : 5
}
},
“createdBy” : 7,
“comment” : “comment”,
“userName” : “userName”,
“type” : “type”,
“versionNumber” : 6,
“changeDetails” : “changeDetails”
},
“meta” : {
“status” : “OK”,
“timestamp” : “2000-01-23T04:56:07.000+00:00”
},
“links” : {
“key” : {
“href” : “href”,
“type” : “type”
}
}
}
Produces: API call produces the following media types according to the
Accept request header;
the media type will be conveyed by the Content-Type response header:
- application/json
Response:
VersionDataWrapper
GET /items/{id}/versionedcategories
Summary: Get all versioned categories for the item with the specified version number
Path parameters:
- id
(required)
Query parameters:
- versionNumber
(required)
- startAt
(optional), default value: 0
- maxResults
(optional), default value: 50
Examples:
- Example data, content-type: application/json
{
“data” : {
“itemType” : 6,
“globalId” : “globalId”,
“project” : 1,
“resources” : {
“key” : {
“allowed” : [ “allowed”, “allowed” ]
}
},
“version” : 7,
“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”
}
}
}
Produces: API call produces the following media types according to the
Accept request header;
the media type will be conveyed by the Content-Type response header:
- application/json
Response:
AbstractItemDataWrapper
GET /items/{id}/versions/{versionNum}/versioneditem
Summary: Get the snapshot of the item at the specified version
Path parameters:
- versionNum
(required)
- id
(required)
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” : 6,
“fileName” : “fileName”,
“globalId” : “globalId”,
“project” : 1,
“resources” : {
“key” : {
“allowed” : [ “allowed”, “allowed” ]
}
},
“mimeType” : “mimeType”,
“version” : 2,
“currentVersion” : 3,
“createdDate” : “2000-01-23T04:56:07.000+00:00”,
“lastActivityDate” : “2000-01-23T04:56:07.000+00:00”,
“createdBy” : 5,
“fileSize” : 9,
“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” : 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”
}
}
}
Produces: API call produces the following media types according to the
Accept request header;
the media type will be conveyed by the Content-Type response header:
- application/json
Response:
VersionedAttachmentDataWrapper
GET /items/{id}/versions
Summary: Get all versions for the item with the specified ID
Path parameters:
- id
(required)
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” : 0,
“createdDate” : “2000-01-23T04:56:07.000+00:00”,
“versionedItem” : {
“id” : 2,
“value” : { },
“object” : {
“id” : 1,
“type” : “type”,
“version” : 5,
“currentVersion” : 5
}
},
“createdBy” : 7,
“comment” : “comment”,
“userName” : “userName”,
“type” : “type”,
“versionNumber” : 6,
“changeDetails” : “changeDetails”
}, {
“item” : 0,
“createdDate” : “2000-01-23T04:56:07.000+00:00”,
“versionedItem” : {
“id” : 2,
“value” : { },
“object” : {
“id” : 1,
“type” : “type”,
“version” : 5,
“currentVersion” : 5
}
},
“createdBy” : 7,
“comment” : “comment”,
“userName” : “userName”,
“type” : “type”,
“versionNumber” : 6,
“changeDetails” : “changeDetails”
} ],
“meta” : {
“pageInfo” : {
“startIndex” : 0,
“resultCount” : 6,
“totalResults” : 1
},
“status” : “OK”,
“timestamp” : “2000-01-23T04:56:07.000+00:00”
},
“links” : {
“key” : {
“href” : “href”,
“type” : “type”
}
}
}
Produces: API call produces the following media types according to the
Accept request header;
the media type will be conveyed by the Content-Type response header:
- application/json
Response:
VersionDataListWrapper
GET /items/{id}/workflowtransitionoptions
Summary: Get all valid workflow transitions that can be made on the item with the specified ID
Path parameters:
- id
(required)
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” : 0,
“resultCount” : 6,
“totalResults” : 1
},
“status” : “OK”,
“timestamp” : “2000-01-23T04:56:07.000+00:00”
},
“links” : {
“key” : {
“href” : “href”,
“type” : “type”
}
}
}
Produces: API call produces the following media types according to the
Accept request header;
the media type will be conveyed by the Content-Type response header:
- application/json
Response:
WorkflowTransitionDataListWrapper
PUT /items/treeLocation
Summary:
Consumes: this API call consumes the following media types via the
Content-Type request header:
- application/json
Body:
Examples:
- Example data, content-type: application/json
{
“meta” : {
“status” : “OK”,
“timestamp” : “2000-01-23T04:56:07.000+00:00”
}
}
Produces: API call produces the following media types according to the
Accept request header;
the media type will be conveyed by the Content-Type response header:
- application/json
Response:
OkResponseDataWraper
PATCH /items/{id}
Summary: Update the item with the specified ID
Path parameters:
- id
(required)
Consumes: this API call consumes the following media types via the
Content-Type request header:
- application/json
Body:
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
{
“meta” : {
“status” : “OK”,
“timestamp” : “2000-01-23T04:56:07.000+00:00”
}
}
Produces: API call produces the following media types according to the
Accept request header;
the media type will be conveyed by the Content-Type response header:
- application/json
Response:
OkResponseDataWraper
PATCH /items
Summary: Update the items with the specified ID as an asynchronous request (a successful response signifies that the work was started and a work identifier is given. This identifier will be used in a future feature)
Consumes: this API call consumes the following media types via the
Content-Type request header:
- application/json
Body:
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
{
“data” : {
“workKey” : “workKey”,
“message” : “message”
},
“meta” : {
“status” : “OK”,
“timestamp” : “2000-01-23T04:56:07.000+00:00”
}
}
Produces: API call produces the following media types according to the
Accept request header;
the media type will be conveyed by the Content-Type response header:
- application/json
Response:
DocumentsPatchResultDataWrapper
PUT /items/{id}
Summary: Update the item with the specified ID
Path parameters:
- id
(required)
Consumes: this API call consumes the following media types via the
Content-Type request header:
- application/json
Body:
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
{
“meta” : {
“status” : “OK”,
“timestamp” : “2000-01-23T04:56:07.000+00:00”
}
}
Produces: API call produces the following media types according to the
Accept request header;
the media type will be conveyed by the Content-Type response header:
- application/json
Response:
OkResponseDataWraper
DELETE /items/{id}/attachments/{attachmentId}
Summary: Remove an existing attachment from the item
Path parameters:
- attachmentId
(required)
- id
(required)
DELETE /items/{id}/tags/{tagId}
Summary: Remove an existing tag from the item with the specified ID
Path parameters:
- tagId
(required)
- id
(required)
DELETE /items/{id}/categories
Summary: Unapply categories from an item
Path parameters:
- id
(required)
Consumes: this API call consumes the following media types via the
Content-Type request header:
- application/json
Body:
Examples:
- Example data, content-type: application/json
{
“meta” : {
“status” : “OK”,
“timestamp” : “2000-01-23T04:56:07.000+00:00”
}
}
Produces: API call produces the following media types according to the
Accept request header;
the media type will be conveyed by the Content-Type response header:
- application/json
Response:
OkResponseDataWraper
PUT /items/{id}/links/{linkId}
Summary: Update the link with the specified ID
Path parameters:
- linkId
(required)
- id
(required)
Consumes: this API call consumes the following media types via the
Content-Type request header:
- application/json
Body:
Examples:
- Example data, content-type: application/json
{
“meta” : {
“status” : “OK”,
“timestamp” : “2000-01-23T04:56:07.000+00:00”
}
}
Produces: API call produces the following media types according to the
Accept request header;
the media type will be conveyed by the Content-Type response header:
- application/json
Response:
OkResponseDataWraper
PUT /items/{id}/location
Summary: Update the location for the item with the specified ID as an asynchronous request (a successful response signifies that the work was started and a work identifier is given. This identifier will be used in a future feature). Any child items are moved along with this item. Note that this currently only supports moving items between projects
Path parameters:
- id
(required)
Consumes: this API call consumes the following media types via the
Content-Type request header:
- application/json
Body:
Examples:
- Example data, content-type: application/json
{
“meta” : {
“location” : “location”,
“workId” : “workId”,
“status” : “OK”,
“timestamp” : “2000-01-23T04:56:07.000+00:00”
}
}
Produces: API call produces the following media types according to the
Accept request header;
the media type will be conveyed by the Content-Type response header:
- application/json
Response:
AcceptedResponseDataWrapper
PUT /items/{id}/lock
Summary: Update the locked state of the item with the specified ID
Path parameters:
- id
(required)
Consumes: this API call consumes the following media types via the
Content-Type request header:
- application/json
Body:
Examples:
- Example data, content-type: application/json
{
“meta” : {
“status” : “OK”,
“timestamp” : “2000-01-23T04:56:07.000+00:00”
}
}
Produces: API call produces the following media types according to the
Accept request header;
the media type will be conveyed by the Content-Type response header:
- application/json
Response:
OkResponseDataWraper
Endpoint itemtypes
The itemtypes endpoint has the following operations:
Below is more detail for each of the operations of the itemtypes endpoint.
POST /itemtypes/{itemTypeId}/fields
Summary: Create a new item type field for the item type with the specified ID
Path parameters:
- itemTypeId
(required)
Consumes: this API call consumes the following media types via the
Content-Type request header:
- application/json
Body:
Examples:
- Example data, content-type: application/json
{
“meta” : {
“status” : “OK”,
“timestamp” : “2000-01-23T04:56:07.000+00:00”
}
}
Produces: API call produces the following media types according to the
Accept request header;
the media type will be conveyed by the Content-Type response header:
- application/json
Response:
OkResponseDataWraper
POST /itemtypes
Summary: Create a new item type
Consumes: this API call consumes the following media types via the
Content-Type request header:
- application/json
Body:
Examples:
- Example data, content-type: application/json
{
“data” : 0,
“meta” : {
“status” : “OK”,
“timestamp” : “2000-01-23T04:56:07.000+00:00”
}
}
Produces: API call produces the following media types according to the
Accept request header;
the media type will be conveyed by the Content-Type response header:
- application/json
Response:
CreatedResponseSimpleDataWrapper
GET /itemtypes/{itemTypeId}
Summary: Get the item type with the specified ID
Path parameters:
- itemTypeId
(required)
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,
“readOnly” : true,
“textType” : “TEXTAREA”,
“label” : “label”,
“defaultTemplateId” : 5,
“required” : true,
“controlStyle” : “controlStyle”,
“reqAdvisorEnabled” : true,
“pickList” : 1,
“name” : “name”,
“infotip” : “infotip”,
“isInherited” : true,
“id” : 6,
“fieldType” : “INTEGER”,
“triggerSuspect” : true,
“synchronize” : true
}, {
“readOnlyAllowApiOverwrite” : true,
“itemType” : 5,
“readOnly” : true,
“textType” : “TEXTAREA”,
“label” : “label”,
“defaultTemplateId” : 5,
“required” : true,
“controlStyle” : “controlStyle”,
“reqAdvisorEnabled” : true,
“pickList” : 1,
“name” : “name”,
“infotip” : “infotip”,
“isInherited” : true,
“id” : 6,
“fieldType” : “INTEGER”,
“triggerSuspect” : true,
“synchronize” : true
} ],
“displayPlural” : “displayPlural”
},
“meta” : {
“status” : “OK”,
“timestamp” : “2000-01-23T04:56:07.000+00:00”
},
“links” : {
“key” : {
“href” : “href”,
“type” : “type”
}
}
}
Produces: API call produces the following media types according to the
Accept request header;
the media type will be conveyed by the Content-Type response header:
- application/json
Response:
ItemTypeDataWrapper
GET /itemtypes
Summary: Get all item types
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,
“readOnly” : true,
“textType” : “TEXTAREA”,
“label” : “label”,
“defaultTemplateId” : 5,
“required” : true,
“controlStyle” : “controlStyle”,
“reqAdvisorEnabled” : true,
“pickList” : 1,
“name” : “name”,
“infotip” : “infotip”,
“isInherited” : true,
“id” : 6,
“fieldType” : “INTEGER”,
“triggerSuspect” : true,
“synchronize” : true
}, {
“readOnlyAllowApiOverwrite” : true,
“itemType” : 5,
“readOnly” : true,
“textType” : “TEXTAREA”,
“label” : “label”,
“defaultTemplateId” : 5,
“required” : true,
“controlStyle” : “controlStyle”,
“reqAdvisorEnabled” : true,
“pickList” : 1,
“name” : “name”,
“infotip” : “infotip”,
“isInherited” : true,
“id” : 6,
“fieldType” : “INTEGER”,
“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,
“readOnly” : true,
“textType” : “TEXTAREA”,
“label” : “label”,
“defaultTemplateId” : 5,
“required” : true,
“controlStyle” : “controlStyle”,
“reqAdvisorEnabled” : true,
“pickList” : 1,
“name” : “name”,
“infotip” : “infotip”,
“isInherited” : true,
“id” : 6,
“fieldType” : “INTEGER”,
“triggerSuspect” : true,
“synchronize” : true
}, {
“readOnlyAllowApiOverwrite” : true,
“itemType” : 5,
“readOnly” : true,
“textType” : “TEXTAREA”,
“label” : “label”,
“defaultTemplateId” : 5,
“required” : true,
“controlStyle” : “controlStyle”,
“reqAdvisorEnabled” : true,
“pickList” : 1,
“name” : “name”,
“infotip” : “infotip”,
“isInherited” : true,
“id” : 6,
“fieldType” : “INTEGER”,
“triggerSuspect” : true,
“synchronize” : true
} ],
“displayPlural” : “displayPlural”
} ],
“meta” : {
“pageInfo” : {
“startIndex” : 0,
“resultCount” : 6,
“totalResults” : 1
},
“status” : “OK”,
“timestamp” : “2000-01-23T04:56:07.000+00:00”
},
“links” : {
“key” : {
“href” : “href”,
“type” : “type”
}
}
}
Produces: API call produces the following media types according to the
Accept request header;
the media type will be conveyed by the Content-Type response header:
- application/json
Response:
ItemTypeDataListWrapper
Endpoint picklistoptions
The picklistoptions endpoint has the following operations:
Below is more detail for each of the operations of the picklistoptions endpoint.
GET /picklistoptions/{picklistOptionId}
Summary: Get the pick list option with the specified ID
Path parameters:
- picklistOptionId
(required)
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” : 1,
“sortOrder” : 6,
“name” : “name”,
“description” : “description”,
“active” : true,
“infotip” : “infotip”,
“id” : 0,
“value” : “value”
},
“meta” : {
“status” : “OK”,
“timestamp” : “2000-01-23T04:56:07.000+00:00”
},
“links” : {
“key” : {
“href” : “href”,
“type” : “type”
}
}
}
Produces: API call produces the following media types according to the
Accept request header;
the media type will be conveyed by the Content-Type response header:
- application/json
Response:
PickListOptionDataWrapper
PUT /picklistoptions/{picklistOptionId}
Summary: Update the pick list option with the specified ID
Path parameters:
- picklistOptionId
(required)
Consumes: this API call consumes the following media types via the
Content-Type request header:
- application/json
Body:
Examples:
- Example data, content-type: application/json
{
“meta” : {
“status” : “OK”,
“timestamp” : “2000-01-23T04:56:07.000+00:00”
}
}
Produces: API call produces the following media types according to the
Accept request header;
the media type will be conveyed by the Content-Type response header:
- application/json
Response:
OkResponseDataWraper
Endpoint picklists
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.
POST /picklists/{picklistId}/options
Summary: Create a new pick list option for the pick list with the specified ID
Path parameters:
- picklistId
(required)
Consumes: this API call consumes the following media types via the
Content-Type request header:
- application/json
Body:
Examples:
- Example data, content-type: application/json
{
“meta” : {
“location” : “location”,
“id” : 0,
“status” : “OK”,
“timestamp” : “2000-01-23T04:56:07.000+00:00”
}
}
Produces: API call produces the following media types according to the
Accept request header;
the media type will be conveyed by the Content-Type response header:
- application/json
Response:
CreatedResponseDataWrapper
POST /picklists
Summary: Create a new pick list
Consumes: this API call consumes the following media types via the
Content-Type request header:
- application/json
Body:
Examples:
- Example data, content-type: application/json
{
“meta” : {
“location” : “location”,
“id” : 0,
“status” : “OK”,
“timestamp” : “2000-01-23T04:56:07.000+00:00”
}
}
Produces: API call produces the following media types according to the
Accept request header;
the media type will be conveyed by the Content-Type response header:
- application/json
Response:
CreatedResponseDataWrapper
DELETE /picklists/{picklistId}
Summary: Delete the pick list
Path parameters:
- picklistId
(required)
GET /picklists/{picklistId}
Summary: Get the pick list with the specified ID
Path parameters:
- picklistId
(required)
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
},
“meta” : {
“status” : “OK”,
“timestamp” : “2000-01-23T04:56:07.000+00:00”
},
“links” : {
“key” : {
“href” : “href”,
“type” : “type”
}
}
}
Produces: API call produces the following media types according to the
Accept request header;
the media type will be conveyed by the Content-Type response header:
- application/json
Response:
PickListDataWrapper
GET /picklists/{picklistId}/options
Summary: Get all pick list options for the pick list with the specified ID
Path parameters:
- picklistId
(required)
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” : 1,
“sortOrder” : 6,
“name” : “name”,
“description” : “description”,
“active” : true,
“infotip” : “infotip”,
“id” : 0,
“value” : “value”
}, {
“archived” : true,
“default” : true,
“color” : “color”,
“pickList” : 1,
“sortOrder” : 6,
“name” : “name”,
“description” : “description”,
“active” : true,
“infotip” : “infotip”,
“id” : 0,
“value” : “value”
} ],
“meta” : {
“pageInfo” : {
“startIndex” : 0,
“resultCount” : 6,
“totalResults” : 1
},
“status” : “OK”,
“timestamp” : “2000-01-23T04:56:07.000+00:00”
},
“links” : {
“key” : {
“href” : “href”,
“type” : “type”
}
}
}
Produces: API call produces the following media types according to the
Accept request header;
the media type will be conveyed by the Content-Type response header:
- application/json
Response:
PickListOptionDataListWrapper
GET /picklists
Summary: Get all pick lists
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
}, {
“name” : “name”,
“description” : “description”,
“id” : 0
} ],
“meta” : {
“pageInfo” : {
“startIndex” : 0,
“resultCount” : 6,
“totalResults” : 1
},
“status” : “OK”,
“timestamp” : “2000-01-23T04:56:07.000+00:00”
},
“links” : {
“key” : {
“href” : “href”,
“type” : “type”
}
}
}
Produces: API call produces the following media types according to the
Accept request header;
the media type will be conveyed by the Content-Type response header:
- application/json
Response:
PickListDataListWrapper
Endpoint projects
The projects endpoint has the following operations:
- 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.
PUT /projects/{projectId}/itemtypes/{itemTypeId}
Summary: Add an Item Type to a Project
Path parameters:
- itemTypeId
(required)
- projectId
(required)
Examples:
- Example data, content-type: application/json
{
“status” : “OK”,
“timestamp” : “2000-01-23T04:56:07.000+00:00”
}
Produces: API call produces the following media types according to the
Accept request header;
the media type will be conveyed by the Content-Type response header:
- application/json
Response:
MetaWrapper
POST /projects
Summary: Create a new project
Consumes: this API call consumes the following media types via the
Content-Type request header:
- application/json
Body:
Examples:
- Example data, content-type: application/json
{
“status” : “OK”,
“timestamp” : “2000-01-23T04:56:07.000+00:00”
}
Produces: API call produces the following media types according to the
Accept request header;
the media type will be conveyed by the Content-Type response header:
- application/json
Response:
MetaWrapper
GET /projects/{projectId}/itemtypes
Summary: Get all item types for the project with the specified ID
Path parameters:
- projectId
(required)
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,
“readOnly” : true,
“textType” : “TEXTAREA”,
“label” : “label”,
“defaultTemplateId” : 5,
“required” : true,
“controlStyle” : “controlStyle”,
“reqAdvisorEnabled” : true,
“pickList” : 1,
“name” : “name”,
“infotip” : “infotip”,
“isInherited” : true,
“id” : 6,
“fieldType” : “INTEGER”,
“triggerSuspect” : true,
“synchronize” : true
}, {
“readOnlyAllowApiOverwrite” : true,
“itemType” : 5,
“readOnly” : true,
“textType” : “TEXTAREA”,
“label” : “label”,
“defaultTemplateId” : 5,
“required” : true,
“controlStyle” : “controlStyle”,
“reqAdvisorEnabled” : true,
“pickList” : 1,
“name” : “name”,
“infotip” : “infotip”,
“isInherited” : true,
“id” : 6,
“fieldType” : “INTEGER”,
“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,
“readOnly” : true,
“textType” : “TEXTAREA”,
“label” : “label”,
“defaultTemplateId” : 5,
“required” : true,
“controlStyle” : “controlStyle”,
“reqAdvisorEnabled” : true,
“pickList” : 1,
“name” : “name”,
“infotip” : “infotip”,
“isInherited” : true,
“id” : 6,
“fieldType” : “INTEGER”,
“triggerSuspect” : true,
“synchronize” : true
}, {
“readOnlyAllowApiOverwrite” : true,
“itemType” : 5,
“readOnly” : true,
“textType” : “TEXTAREA”,
“label” : “label”,
“defaultTemplateId” : 5,
“required” : true,
“controlStyle” : “controlStyle”,
“reqAdvisorEnabled” : true,
“pickList” : 1,
“name” : “name”,
“infotip” : “infotip”,
“isInherited” : true,
“id” : 6,
“fieldType” : “INTEGER”,
“triggerSuspect” : true,
“synchronize” : true
} ],
“displayPlural” : “displayPlural”
} ],
“meta” : {
“pageInfo” : {
“startIndex” : 0,
“resultCount” : 6,
“totalResults” : 1
},
“status” : “OK”,
“timestamp” : “2000-01-23T04:56:07.000+00:00”
},
“links” : {
“key” : {
“href” : “href”,
“type” : “type”
}
}
}
Produces: API call produces the following media types according to the
Accept request header;
the media type will be conveyed by the Content-Type response header:
- application/json
Response:
ItemTypeDataListWrapper
GET /projects/{projectId}
Summary: Get the project with the specified ID
Path parameters:
- projectId
(required)
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” : 7,
“projectType” : {
“components” : “components”,
“scopeId” : 0,
“description” : “description”,
“xmlToString” : “xmlToString”,
“organizationId” : 3,
“createdDate” : “2000-01-23T04:56:07.000+00:00”,
“createdBy” : 6,
“newObject” : true,
“name” : “name”,
“defaultDisplay” : “defaultDisplay”,
“modifiedDate” : “2000-01-23T04:56:07.000+00:00”,
“defaultPrefix” : “defaultPrefix”,
“defaultDisplayPlural” : “defaultDisplayPlural”,
“modifiedBy” : 8,
“id” : 4,
“refId” : 2,
“scopeByType” : “SYSTEM”
},
“description” : “description”,
“flag2” : true,
“flag1” : true,
“organizationId” : 4,
“projectKey” : “projectKey”,
“string3” : “string3”,
“string4” : “string4”,
“string1” : “string1”,
“newObject” : true,
“string2” : “string2”,
“modifiedBy” : 8,
“id” : 6,
“user1” : {
“lastName” : “lastName”,
“active” : true,
“customData” : [ {
“name” : “name”,
“value” : “value”
}, {
“name” : “name”,
“value” : “value”
} ],
“title” : “title”,
“type” : “users”,
“firstName” : “firstName”,
“licenseType” : “NAMED”,
“uid” : “uid”,
“phone” : “phone”,
“location” : “location”,
“id” : 9,
“authenticationType” : {
“name” : “name”,
“id” : 3
},
“email” : “email”,
“username” : “username”
},
“active” : true,
“date2” : “2000-01-23T04:56:07.000+00:00”,
“xmlToString” : “xmlToString”,
“date1” : “2000-01-23T04:56:07.000+00:00”,
“defaultDashboard” : {
“scopeId” : 5,
“xmlToString” : “xmlToString”,
“dashboardName” : “dashboardName”,
“layout” : “SINGLE_COLUMN”,
“organizationId” : 7,
“createdDate” : “2000-01-23T04:56:07.000+00:00”,
“createdBy” : 0,
“newObject” : true,
“modifiedDate” : “2000-01-23T04:56:07.000+00:00”,
“modifiedBy” : 9,
“id” : 0,
“refId” : 4,
“portletInstances” : [ {
“organizationId” : 9,
“location” : “location”,
“portlet” : “FILTER_RESULTS”,
“id” : 7,
“properties” : {
“key” : “properties”
}
}, {
“organizationId” : 9,
“location” : “location”,
“portlet” : “FILTER_RESULTS”,
“id” : 7,
“properties” : {
“key” : “properties”
}
} ],
“scopeByType” : “SYSTEM”
},
“lookup1” : {
“image” : “image”,
“color” : “color”,
“dataValue” : “dataValue”,
“description” : “description”,
“active” : true,
“lookupType” : {
“lookups” : [ null, null ],
“scopeId” : 6,
“description” : “description”,
“active” : true,
“xmlToString” : “xmlToString”,
“type” : 2,
“organizationId” : 1,
“createdDate” : “2000-01-23T04:56:07.000+00:00”,
“createdBy” : 7,
“newObject” : true,
“name” : “name”,
“modifiedDate” : “2000-01-23T04:56:07.000+00:00”,
“modifiedBy” : 1,
“id” : 1,
“refId” : 7,
“category” : 4,
“scopeByType” : “SYSTEM”
},
“xmlToString” : “xmlToString”,
“organizationId” : 9,
“archived” : true,
“isDefault” : true,
“createdDate” : “2000-01-23T04:56:07.000+00:00”,
“createdBy” : 4,
“newObject” : true,
“sortOrder” : 1,
“name” : “name”,
“modifiedDate” : “2000-01-23T04:56:07.000+00:00”,
“infotip” : “infotip”,
“modifiedBy” : 5,
“id” : 9
},
“isFolder” : true,
“createdDate” : “2000-01-23T04:56:07.000+00:00”,
“text3” : “text3”,
“createdBy” : 1,
“text1” : “text1”,
“text2” : “text2”,
“name” : “name”,
“modifiedDate” : “2000-01-23T04:56:07.000+00:00”,
“relationshipRuleSet” : {
“organizationId” : 4,
“isExclusive” : true,
“name” : “name”,
“rules” : [ {
“organizationId” : 4,
“forCoverage” : true,
“relationshipType” : {
“image” : “image”,
“scopeId” : 6,
“showNote” : true,
“description” : “description”,
“active” : true,
“showStatus” : true,
“xmlToString” : “xmlToString”,
“organizationId” : 3,
“isDefault” : true,
“createdDate” : “2000-01-23T04:56:07.000+00:00”,
“createdBy” : 8,
“newObject” : true,
“sortOrder” : 6,
“name” : “name”,
“modifiedDate” : “2000-01-23T04:56:07.000+00:00”,
“modifiedBy” : 9,
“id” : 6,
“refId” : 1,
“scopeByType” : “SYSTEM”
},
“fromDocType” : {
“image” : “image”,
“workflowFieldId” : 2,
“display” : “display”,
“description” : “description”,
“active” : true,
“xmlToString” : “xmlToString”,
“documentTypeKey” : “documentTypeKey”,
“organizationId” : 0,
“documentTypeFields” : [ {
“documentField” : {
“isDerived” : true,
“scopeId” : 0,
“userConfigurable” : true,
“custom” : true,
“dataType” : “INTEGER”,
“description” : “description”,
“readOnly” : true,
“xmlToString” : “xmlToString”,
“editXtype” : “editXtype”,
“organizationId” : 7,
“createdDate” : “2000-01-23T04:56:07.000+00:00”,
“formXtype” : “formXtype”,
“createdBy” : 6,
“newObject” : true,
“name” : “name”,
“modifiedDate” : “2000-01-23T04:56:07.000+00:00”,
“modifiedBy” : 3,
“id” : 3,
“refId” : 7,
“category” : 5,
“gridXtype” : “gridXtype”,
“scopeByType” : “SYSTEM”,
“fieldType” : 6
},
“description” : “description”,
“defaultTemplateId” : 0,
“isSynchronizeField” : true,
“required” : true,
“controlStyle” : “controlStyle”,
“organizationId” : 3,
“newObject” : true,
“infotip” : “infotip”,
“modifiedBy” : 8,
“id” : 7,
“readOnlyAllowApiOverwrite” : true,
“shouldVersion” : true,
“readOnly” : true,
“lookupTypeId” : 6,
“label” : “label”,
“xmlToString” : “xmlToString”,
“createdDate” : “2000-01-23T04:56:07.000+00:00”,
“controlType” : “TEXTAREA”,
“isReqAdvisorEnabled” : true,
“createdBy” : 4,
“sortOrder” : 6,
“modifiedDate” : “2000-01-23T04:56:07.000+00:00”,
“isInherited” : true,
“triggerSuspect” : true
}, {
“documentField” : {
“isDerived” : true,
“scopeId” : 0,
“userConfigurable” : true,
“custom” : true,
“dataType” : “INTEGER”,
“description” : “description”,
“readOnly” : true,
“xmlToString” : “xmlToString”,
“editXtype” : “editXtype”,
“organizationId” : 7,
“createdDate” : “2000-01-23T04:56:07.000+00:00”,
“formXtype” : “formXtype”,
“createdBy” : 6,
“newObject” : true,
“name” : “name”,
“modifiedDate” : “2000-01-23T04:56:07.000+00:00”,
“modifiedBy” : 3,
“id” : 3,
“refId” : 7,
“category” : 5,
“gridXtype” : “gridXtype”,
“scopeByType” : “SYSTEM”,
“fieldType” : 6
},
“description” : “description”,
“defaultTemplateId” : 0,
“isSynchronizeField” : true,
“required” : true,
“controlStyle” : “controlStyle”,
“organizationId” : 3,
“newObject” : true,
“infotip” : “infotip”,
“modifiedBy” : 8,
“id” : 7,
“readOnlyAllowApiOverwrite” : true,
“shouldVersion” : true,
“readOnly” : true,
“lookupTypeId” : 6,
“label” : “label”,
“xmlToString” : “xmlToString”,
“createdDate” : “2000-01-23T04:56:07.000+00:00”,
“controlType” : “TEXTAREA”,
“isReqAdvisorEnabled” : true,
“createdBy” : 4,
“sortOrder” : 6,
“modifiedDate” : “2000-01-23T04:56:07.000+00:00”,
“isInherited” : true,
“triggerSuspect” : true
} ],
“createdDate” : “2000-01-23T04:56:07.000+00:00”,
“createdBy” : 5,
“newObject” : true,
“modifiedDate” : “2000-01-23T04:56:07.000+00:00”,
“hasCustomImage” : true,
“modifiedBy” : 3,
“id” : 4,
“category” : “CORE”,
“documentTypeFacets” : [ {
“organizationId” : 7,
“isSyncedFacet” : true,
“id” : 3,
“facet” : “ACTIVITIES”
}, {
“organizationId” : 7,
“isSyncedFacet” : true,
“id” : 3,
“facet” : “ACTIVITIES”
} ],
“displayPlural” : “displayPlural”
},
“id” : 6
}, {
“organizationId” : 4,
“forCoverage” : true,
“relationshipType” : {
“image” : “image”,
“scopeId” : 6,
“showNote” : true,
“description” : “description”,
“active” : true,
“showStatus” : true,
“xmlToString” : “xmlToString”,
“organizationId” : 3,
“isDefault” : true,
“createdDate” : “2000-01-23T04:56:07.000+00:00”,
“createdBy” : 8,
“newObject” : true,
“sortOrder” : 6,
“name” : “name”,
“modifiedDate” : “2000-01-23T04:56:07.000+00:00”,
“modifiedBy” : 9,
“id” : 6,
“refId” : 1,
“scopeByType” : “SYSTEM”
},
“fromDocType” : {
“image” : “image”,
“workflowFieldId” : 2,
“display” : “display”,
“description” : “description”,
“active” : true,
“xmlToString” : “xmlToString”,
“documentTypeKey” : “documentTypeKey”,
“organizationId” : 0,
“documentTypeFields” : [ {
“documentField” : {
“isDerived” : true,
“scopeId” : 0,
“userConfigurable” : true,
“custom” : true,
“dataType” : “INTEGER”,
“description” : “description”,
“readOnly” : true,
“xmlToString” : “xmlToString”,
“editXtype” : “editXtype”,
“organizationId” : 7,
“createdDate” : “2000-01-23T04:56:07.000+00:00”,
“formXtype” : “formXtype”,
“createdBy” : 6,
“newObject” : true,
“name” : “name”,
“modifiedDate” : “2000-01-23T04:56:07.000+00:00”,
“modifiedBy” : 3,
“id” : 3,
“refId” : 7,
“category” : 5,
“gridXtype” : “gridXtype”,
“scopeByType” : “SYSTEM”,
“fieldType” : 6
},
“description” : “description”,
“defaultTemplateId” : 0,
“isSynchronizeField” : true,
“required” : true,
“controlStyle” : “controlStyle”,
“organizationId” : 3,
“newObject” : true,
“infotip” : “infotip”,
“modifiedBy” : 8,
“id” : 7,
“readOnlyAllowApiOverwrite” : true,
“shouldVersion” : true,
“readOnly” : true,
“lookupTypeId” : 6,
“label” : “label”,
“xmlToString” : “xmlToString”,
“createdDate” : “2000-01-23T04:56:07.000+00:00”,
“controlType” : “TEXTAREA”,
“isReqAdvisorEnabled” : true,
“createdBy” : 4,
“sortOrder” : 6,
“modifiedDate” : “2000-01-23T04:56:07.000+00:00”,
“isInherited” : true,
“triggerSuspect” : true
}, {
“documentField” : {
“isDerived” : true,
“scopeId” : 0,
“userConfigurable” : true,
“custom” : true,
“dataType” : “INTEGER”,
“description” : “description”,
“readOnly” : true,
“xmlToString” : “xmlToString”,
“editXtype” : “editXtype”,
“organizationId” : 7,
“createdDate” : “2000-01-23T04:56:07.000+00:00”,
“formXtype” : “formXtype”,
“createdBy” : 6,
“newObject” : true,
“name” : “name”,
“modifiedDate” : “2000-01-23T04:56:07.000+00:00”,
“modifiedBy” : 3,
“id” : 3,
“refId” : 7,
“category” : 5,
“gridXtype” : “gridXtype”,
“scopeByType” : “SYSTEM”,
“fieldType” : 6
},
“description” : “description”,
“defaultTemplateId” : 0,
“isSynchronizeField” : true,
“required” : true,
“controlStyle” : “controlStyle”,
“organizationId” : 3,
“newObject” : true,
“infotip” : “infotip”,
“modifiedBy” : 8,
“id” : 7,
“readOnlyAllowApiOverwrite” : true,
“shouldVersion” : true,
“readOnly” : true,
“lookupTypeId” : 6,
“label” : “label”,
“xmlToString” : “xmlToString”,
“createdDate” : “2000-01-23T04:56:07.000+00:00”,
“controlType” : “TEXTAREA”,
“isReqAdvisorEnabled” : true,
“createdBy” : 4,
“sortOrder” : 6,
“modifiedDate” : “2000-01-23T04:56:07.000+00:00”,
“isInherited” : true,
“triggerSuspect” : true
} ],
“createdDate” : “2000-01-23T04:56:07.000+00:00”,
“createdBy” : 5,
“newObject” : true,
“modifiedDate” : “2000-01-23T04:56:07.000+00:00”,
“hasCustomImage” : true,
“modifiedBy” : 3,
“id” : 4,
“category” : “CORE”,
“documentTypeFacets” : [ {
“organizationId” : 7,
“isSyncedFacet” : true,
“id” : 3,
“facet” : “ACTIVITIES”
}, {
“organizationId” : 7,
“isSyncedFacet” : true,
“id” : 3,
“facet” : “ACTIVITIES”
} ],
“displayPlural” : “displayPlural”
},
“id” : 6
} ],
“id” : 1
}
},
“meta” : {
“status” : “OK”,
“timestamp” : “2000-01-23T04:56:07.000+00:00”
},
“links” : {
“key” : {
“href” : “href”,
“type” : “type”
}
}
}
Produces: API call produces the following media types according to the
Accept request header;
the media type will be conveyed by the Content-Type response header:
- application/json
Response:
ProjectDataWrapper
GET /projects
Summary: Get all projects
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” : 7,
“projectType” : {
“components” : “components”,
“scopeId” : 0,
“description” : “description”,
“xmlToString” : “xmlToString”,
“organizationId” : 3,
“createdDate” : “2000-01-23T04:56:07.000+00:00”,
“createdBy” : 6,
“newObject” : true,
“name” : “name”,
“defaultDisplay” : “defaultDisplay”,
“modifiedDate” : “2000-01-23T04:56:07.000+00:00”,
“defaultPrefix” : “defaultPrefix”,
“defaultDisplayPlural” : “defaultDisplayPlural”,
“modifiedBy” : 8,
“id” : 4,
“refId” : 2,
“scopeByType” : “SYSTEM”
},
“description” : “description”,
“flag2” : true,
“flag1” : true,
“organizationId” : 4,
“projectKey” : “projectKey”,
“string3” : “string3”,
“string4” : “string4”,
“string1” : “string1”,
“newObject” : true,
“string2” : “string2”,
“modifiedBy” : 8,
“id” : 6,
“user1” : {
“lastName” : “lastName”,
“active” : true,
“customData” : [ {
“name” : “name”,
“value” : “value”
}, {
“name” : “name”,
“value” : “value”
} ],
“title” : “title”,
“type” : “users”,
“firstName” : “firstName”,
“licenseType” : “NAMED”,
“uid” : “uid”,
“phone” : “phone”,
“location” : “location”,
“id” : 9,
“authenticationType” : {
“name” : “name”,
“id” : 3
},
“email” : “email”,
“username” : “username”
},
“active” : true,
“date2” : “2000-01-23T04:56:07.000+00:00”,
“xmlToString” : “xmlToString”,
“date1” : “2000-01-23T04:56:07.000+00:00”,
“defaultDashboard” : {
“scopeId” : 5,
“xmlToString” : “xmlToString”,
“dashboardName” : “dashboardName”,
“layout” : “SINGLE_COLUMN”,
“organizationId” : 7,
“createdDate” : “2000-01-23T04:56:07.000+00:00”,
“createdBy” : 0,
“newObject” : true,
“modifiedDate” : “2000-01-23T04:56:07.000+00:00”,
“modifiedBy” : 9,
“id” : 0,
“refId” : 4,
“portletInstances” : [ {
“organizationId” : 9,
“location” : “location”,
“portlet” : “FILTER_RESULTS”,
“id” : 7,
“properties” : {
“key” : “properties”
}
}, {
“organizationId” : 9,
“location” : “location”,
“portlet” : “FILTER_RESULTS”,
“id” : 7,
“properties” : {
“key” : “properties”
}
} ],
“scopeByType” : “SYSTEM”
},
“lookup1” : {
“image” : “image”,
“color” : “color”,
“dataValue” : “dataValue”,
“description” : “description”,
“active” : true,
“lookupType” : {
“lookups” : [ null, null ],
“scopeId” : 6,
“description” : “description”,
“active” : true,
“xmlToString” : “xmlToString”,
“type” : 2,
“organizationId” : 1,
“createdDate” : “2000-01-23T04:56:07.000+00:00”,
“createdBy” : 7,
“newObject” : true,
“name” : “name”,
“modifiedDate” : “2000-01-23T04:56:07.000+00:00”,
“modifiedBy” : 1,
“id” : 1,
“refId” : 7,
“category” : 4,
“scopeByType” : “SYSTEM”
},
“xmlToString” : “xmlToString”,
“organizationId” : 9,
“archived” : true,
“isDefault” : true,
“createdDate” : “2000-01-23T04:56:07.000+00:00”,
“createdBy” : 4,
“newObject” : true,
“sortOrder” : 1,
“name” : “name”,
“modifiedDate” : “2000-01-23T04:56:07.000+00:00”,
“infotip” : “infotip”,
“modifiedBy” : 5,
“id” : 9
},
“isFolder” : true,
“createdDate” : “2000-01-23T04:56:07.000+00:00”,
“text3” : “text3”,
“createdBy” : 1,
“text1” : “text1”,
“text2” : “text2”,
“name” : “name”,
“modifiedDate” : “2000-01-23T04:56:07.000+00:00”,
“relationshipRuleSet” : {
“organizationId” : 4,
“isExclusive” : true,
“name” : “name”,
“rules” : [ {
“organizationId” : 4,
“forCoverage” : true,
“relationshipType” : {
“image” : “image”,
“scopeId” : 6,
“showNote” : true,
“description” : “description”,
“active” : true,
“showStatus” : true,
“xmlToString” : “xmlToString”,
“organizationId” : 3,
“isDefault” : true,
“createdDate” : “2000-01-23T04:56:07.000+00:00”,
“createdBy” : 8,
“newObject” : true,
“sortOrder” : 6,
“name” : “name”,
“modifiedDate” : “2000-01-23T04:56:07.000+00:00”,
“modifiedBy” : 9,
“id” : 6,
“refId” : 1,
“scopeByType” : “SYSTEM”
},
“fromDocType” : {
“image” : “image”,
“workflowFieldId” : 2,
“display” : “display”,
“description” : “description”,
“active” : true,
“xmlToString” : “xmlToString”,
“documentTypeKey” : “documentTypeKey”,
“organizationId” : 0,
“documentTypeFields” : [ {
“documentField” : {
“isDerived” : true,
“scopeId” : 0,
“userConfigurable” : true,
“custom” : true,
“dataType” : “INTEGER”,
“description” : “description”,
“readOnly” : true,
“xmlToString” : “xmlToString”,
“editXtype” : “editXtype”,
“organizationId” : 7,
“createdDate” : “2000-01-23T04:56:07.000+00:00”,
“formXtype” : “formXtype”,
“createdBy” : 6,
“newObject” : true,
“name” : “name”,
“modifiedDate” : “2000-01-23T04:56:07.000+00:00”,
“modifiedBy” : 3,
“id” : 3,
“refId” : 7,
“category” : 5,
“gridXtype” : “gridXtype”,
“scopeByType” : “SYSTEM”,
“fieldType” : 6
},
“description” : “description”,
“defaultTemplateId” : 0,
“isSynchronizeField” : true,
“required” : true,
“controlStyle” : “controlStyle”,
“organizationId” : 3,
“newObject” : true,
“infotip” : “infotip”,
“modifiedBy” : 8,
“id” : 7,
“readOnlyAllowApiOverwrite” : true,
“shouldVersion” : true,
“readOnly” : true,
“lookupTypeId” : 6,
“label” : “label”,
“xmlToString” : “xmlToString”,
“createdDate” : “2000-01-23T04:56:07.000+00:00”,
“controlType” : “TEXTAREA”,
“isReqAdvisorEnabled” : true,
“createdBy” : 4,
“sortOrder” : 6,
“modifiedDate” : “2000-01-23T04:56:07.000+00:00”,
“isInherited” : true,
“triggerSuspect” : true
}, {
“documentField” : {
“isDerived” : true,
“scopeId” : 0,
“userConfigurable” : true,
“custom” : true,
“dataType” : “INTEGER”,
“description” : “description”,
“readOnly” : true,
“xmlToString” : “xmlToString”,
“editXtype” : “editXtype”,
“organizationId” : 7,
“createdDate” : “2000-01-23T04:56:07.000+00:00”,
“formXtype” : “formXtype”,
“createdBy” : 6,
“newObject” : true,
“name” : “name”,
“modifiedDate” : “2000-01-23T04:56:07.000+00:00”,
“modifiedBy” : 3,
“id” : 3,
“refId” : 7,
“category” : 5,
“gridXtype” : “gridXtype”,
“scopeByType” : “SYSTEM”,
“fieldType” : 6
},
“description” : “description”,
“defaultTemplateId” : 0,
“isSynchronizeField” : true,
“required” : true,
“controlStyle” : “controlStyle”,
“organizationId” : 3,
“newObject” : true,
“infotip” : “infotip”,
“modifiedBy” : 8,
“id” : 7,
“readOnlyAllowApiOverwrite” : true,
“shouldVersion” : true,
“readOnly” : true,
“lookupTypeId” : 6,
“label” : “label”,
“xmlToString” : “xmlToString”,
“createdDate” : “2000-01-23T04:56:07.000+00:00”,
“controlType” : “TEXTAREA”,
“isReqAdvisorEnabled” : true,
“createdBy” : 4,
“sortOrder” : 6,
“modifiedDate” : “2000-01-23T04:56:07.000+00:00”,
“isInherited” : true,
“triggerSuspect” : true
} ],
“createdDate” : “2000-01-23T04:56:07.000+00:00”,
“createdBy” : 5,
“newObject” : true,
“modifiedDate” : “2000-01-23T04:56:07.000+00:00”,
“hasCustomImage” : true,
“modifiedBy” : 3,
“id” : 4,
“category” : “CORE”,
“documentTypeFacets” : [ {
“organizationId” : 7,
“isSyncedFacet” : true,
“id” : 3,
“facet” : “ACTIVITIES”
}, {
“organizationId” : 7,
“isSyncedFacet” : true,
“id” : 3,
“facet” : “ACTIVITIES”
} ],
“displayPlural” : “displayPlural”
},
“id” : 6
}, {
“organizationId” : 4,
“forCoverage” : true,
“relationshipType” : {
“image” : “image”,
“scopeId” : 6,
“showNote” : true,
“description” : “description”,
“active” : true,
“showStatus” : true,
“xmlToString” : “xmlToString”,
“organizationId” : 3,
“isDefault” : true,
“createdDate” : “2000-01-23T04:56:07.000+00:00”,
“createdBy” : 8,
“newObject” : true,
“sortOrder” : 6,
“name” : “name”,
“modifiedDate” : “2000-01-23T04:56:07.000+00:00”,
“modifiedBy” : 9,
“id” : 6,
“refId” : 1,
“scopeByType” : “SYSTEM”
},
“fromDocType” : {
“image” : “image”,
“workflowFieldId” : 2,
“display” : “display”,
“description” : “description”,
“active” : true,
“xmlToString” : “xmlToString”,
“documentTypeKey” : “documentTypeKey”,
“organizationId” : 0,
“documentTypeFields” : [ {
“documentField” : {
“isDerived” : true,
“scopeId” : 0,
“userConfigurable” : true,
“custom” : true,
“dataType” : “INTEGER”,
“description” : “description”,
“readOnly” : true,
“xmlToString” : “xmlToString”,
“editXtype” : “editXtype”,
“organizationId” : 7,
“createdDate” : “2000-01-23T04:56:07.000+00:00”,
“formXtype” : “formXtype”,
“createdBy” : 6,
“newObject” : true,
“name” : “name”,
“modifiedDate” : “2000-01-23T04:56:07.000+00:00”,
“modifiedBy” : 3,
“id” : 3,
“refId” : 7,
“category” : 5,
“gridXtype” : “gridXtype”,
“scopeByType” : “SYSTEM”,
“fieldType” : 6
},
“description” : “description”,
“defaultTemplateId” : 0,
“isSynchronizeField” : true,
“required” : true,
“controlStyle” : “controlStyle”,
“organizationId” : 3,
“newObject” : true,
“infotip” : “infotip”,
“modifiedBy” : 8,
“id” : 7,
“readOnlyAllowApiOverwrite” : true,
“shouldVersion” : true,
“readOnly” : true,
“lookupTypeId” : 6,
“label” : “label”,
“xmlToString” : “xmlToString”,
“createdDate” : “2000-01-23T04:56:07.000+00:00”,
“controlType” : “TEXTAREA”,
“isReqAdvisorEnabled” : true,
“createdBy” : 4,
“sortOrder” : 6,
“modifiedDate” : “2000-01-23T04:56:07.000+00:00”,
“isInherited” : true,
“triggerSuspect” : true
}, {
“documentField” : {
“isDerived” : true,
“scopeId” : 0,
“userConfigurable” : true,
“custom” : true,
“dataType” : “INTEGER”,
“description” : “description”,
“readOnly” : true,
“xmlToString” : “xmlToString”,
“editXtype” : “editXtype”,
“organizationId” : 7,
“createdDate” : “2000-01-23T04:56:07.000+00:00”,
“formXtype” : “formXtype”,
“createdBy” : 6,
“newObject” : true,
“name” : “name”,
“modifiedDate” : “2000-01-23T04:56:07.000+00:00”,
“modifiedBy” : 3,
“id” : 3,
“refId” : 7,
“category” : 5,
“gridXtype” : “gridXtype”,
“scopeByType” : “SYSTEM”,
“fieldType” : 6
},
“description” : “description”,
“defaultTemplateId” : 0,
“isSynchronizeField” : true,
“required” : true,
“controlStyle” : “controlStyle”,
“organizationId” : 3,
“newObject” : true,
“infotip” : “infotip”,
“modifiedBy” : 8,
“id” : 7,
“readOnlyAllowApiOverwrite” : true,
“shouldVersion” : true,
“readOnly” : true,
“lookupTypeId” : 6,
“label” : “label”,
“xmlToString” : “xmlToString”,
“createdDate” : “2000-01-23T04:56:07.000+00:00”,
“controlType” : “TEXTAREA”,
“isReqAdvisorEnabled” : true,
“createdBy” : 4,
“sortOrder” : 6,
“modifiedDate” : “2000-01-23T04:56:07.000+00:00”,
“isInherited” : true,
“triggerSuspect” : true
} ],
“createdDate” : “2000-01-23T04:56:07.000+00:00”,
“createdBy” : 5,
“newObject” : true,
“modifiedDate” : “2000-01-23T04:56:07.000+00:00”,
“hasCustomImage” : true,
“modifiedBy” : 3,
“id” : 4,
“category” : “CORE”,
“documentTypeFacets” : [ {
“organizationId” : 7,
“isSyncedFacet” : true,
“id” : 3,
“facet” : “ACTIVITIES”
}, {
“organizationId” : 7,
“isSyncedFacet” : true,
“id” : 3,
“facet” : “ACTIVITIES”
} ],
“displayPlural” : “displayPlural”
},
“id” : 6
} ],
“id” : 1
}
}, {
“parent” : 7,
“projectType” : {
“components” : “components”,
“scopeId” : 0,
“description” : “description”,
“xmlToString” : “xmlToString”,
“organizationId” : 3,
“createdDate” : “2000-01-23T04:56:07.000+00:00”,
“createdBy” : 6,
“newObject” : true,
“name” : “name”,
“defaultDisplay” : “defaultDisplay”,
“modifiedDate” : “2000-01-23T04:56:07.000+00:00”,
“defaultPrefix” : “defaultPrefix”,
“defaultDisplayPlural” : “defaultDisplayPlural”,
“modifiedBy” : 8,
“id” : 4,
“refId” : 2,
“scopeByType” : “SYSTEM”
},
“description” : “description”,
“flag2” : true,
“flag1” : true,
“organizationId” : 4,
“projectKey” : “projectKey”,
“string3” : “string3”,
“string4” : “string4”,
“string1” : “string1”,
“newObject” : true,
“string2” : “string2”,
“modifiedBy” : 8,
“id” : 6,
“user1” : {
“lastName” : “lastName”,
“active” : true,
“customData” : [ {
“name” : “name”,
“value” : “value”
}, {
“name” : “name”,
“value” : “value”
} ],
“title” : “title”,
“type” : “users”,
“firstName” : “firstName”,
“licenseType” : “NAMED”,
“uid” : “uid”,
“phone” : “phone”,
“location” : “location”,
“id” : 9,
“authenticationType” : {
“name” : “name”,
“id” : 3
},
“email” : “email”,
“username” : “username”
},
“active” : true,
“date2” : “2000-01-23T04:56:07.000+00:00”,
“xmlToString” : “xmlToString”,
“date1” : “2000-01-23T04:56:07.000+00:00”,
“defaultDashboard” : {
“scopeId” : 5,
“xmlToString” : “xmlToString”,
“dashboardName” : “dashboardName”,
“layout” : “SINGLE_COLUMN”,
“organizationId” : 7,
“createdDate” : “2000-01-23T04:56:07.000+00:00”,
“createdBy” : 0,
“newObject” : true,
“modifiedDate” : “2000-01-23T04:56:07.000+00:00”,
“modifiedBy” : 9,
“id” : 0,
“refId” : 4,
“portletInstances” : [ {
“organizationId” : 9,
“location” : “location”,
“portlet” : “FILTER_RESULTS”,
“id” : 7,
“properties” : {
“key” : “properties”
}
}, {
“organizationId” : 9,
“location” : “location”,
“portlet” : “FILTER_RESULTS”,
“id” : 7,
“properties” : {
“key” : “properties”
}
} ],
“scopeByType” : “SYSTEM”
},
“lookup1” : {
“image” : “image”,
“color” : “color”,
“dataValue” : “dataValue”,
“description” : “description”,
“active” : true,
“lookupType” : {
“lookups” : [ null, null ],
“scopeId” : 6,
“description” : “description”,
“active” : true,
“xmlToString” : “xmlToString”,
“type” : 2,
“organizationId” : 1,
“createdDate” : “2000-01-23T04:56:07.000+00:00”,
“createdBy” : 7,
“newObject” : true,
“name” : “name”,
“modifiedDate” : “2000-01-23T04:56:07.000+00:00”,
“modifiedBy” : 1,
“id” : 1,
“refId” : 7,
“category” : 4,
“scopeByType” : “SYSTEM”
},
“xmlToString” : “xmlToString”,
“organizationId” : 9,
“archived” : true,
“isDefault” : true,
“createdDate” : “2000-01-23T04:56:07.000+00:00”,
“createdBy” : 4,
“newObject” : true,
“sortOrder” : 1,
“name” : “name”,
“modifiedDate” : “2000-01-23T04:56:07.000+00:00”,
“infotip” : “infotip”,
“modifiedBy” : 5,
“id” : 9
},
“isFolder” : true,
“createdDate” : “2000-01-23T04:56:07.000+00:00”,
“text3” : “text3”,
“createdBy” : 1,
“text1” : “text1”,
“text2” : “text2”,
“name” : “name”,
“modifiedDate” : “2000-01-23T04:56:07.000+00:00”,
“relationshipRuleSet” : {
“organizationId” : 4,
“isExclusive” : true,
“name” : “name”,
“rules” : [ {
“organizationId” : 4,
“forCoverage” : true,
“relationshipType” : {
“image” : “image”,
“scopeId” : 6,
“showNote” : true,
“description” : “description”,
“active” : true,
“showStatus” : true,
“xmlToString” : “xmlToString”,
“organizationId” : 3,
“isDefault” : true,
“createdDate” : “2000-01-23T04:56:07.000+00:00”,
“createdBy” : 8,
“newObject” : true,
“sortOrder” : 6,
“name” : “name”,
“modifiedDate” : “2000-01-23T04:56:07.000+00:00”,
“modifiedBy” : 9,
“id” : 6,
“refId” : 1,
“scopeByType” : “SYSTEM”
},
“fromDocType” : {
“image” : “image”,
“workflowFieldId” : 2,
“display” : “display”,
“description” : “description”,
“active” : true,
“xmlToString” : “xmlToString”,
“documentTypeKey” : “documentTypeKey”,
“organizationId” : 0,
“documentTypeFields” : [ {
“documentField” : {
“isDerived” : true,
“scopeId” : 0,
“userConfigurable” : true,
“custom” : true,
“dataType” : “INTEGER”,
“description” : “description”,
“readOnly” : true,
“xmlToString” : “xmlToString”,
“editXtype” : “editXtype”,
“organizationId” : 7,
“createdDate” : “2000-01-23T04:56:07.000+00:00”,
“formXtype” : “formXtype”,
“createdBy” : 6,
“newObject” : true,
“name” : “name”,
“modifiedDate” : “2000-01-23T04:56:07.000+00:00”,
“modifiedBy” : 3,
“id” : 3,
“refId” : 7,
“category” : 5,
“gridXtype” : “gridXtype”,
“scopeByType” : “SYSTEM”,
“fieldType” : 6
},
“description” : “description”,
“defaultTemplateId” : 0,
“isSynchronizeField” : true,
“required” : true,
“controlStyle” : “controlStyle”,
“organizationId” : 3,
“newObject” : true,
“infotip” : “infotip”,
“modifiedBy” : 8,
“id” : 7,
“readOnlyAllowApiOverwrite” : true,
“shouldVersion” : true,
“readOnly” : true,
“lookupTypeId” : 6,
“label” : “label”,
“xmlToString” : “xmlToString”,
“createdDate” : “2000-01-23T04:56:07.000+00:00”,
“controlType” : “TEXTAREA”,
“isReqAdvisorEnabled” : true,
“createdBy” : 4,
“sortOrder” : 6,
“modifiedDate” : “2000-01-23T04:56:07.000+00:00”,
“isInherited” : true,
“triggerSuspect” : true
}, {
“documentField” : {
“isDerived” : true,
“scopeId” : 0,
“userConfigurable” : true,
“custom” : true,
“dataType” : “INTEGER”,
“description” : “description”,
“readOnly” : true,
“xmlToString” : “xmlToString”,
“editXtype” : “editXtype”,
“organizationId” : 7,
“createdDate” : “2000-01-23T04:56:07.000+00:00”,
“formXtype” : “formXtype”,
“createdBy” : 6,
“newObject” : true,
“name” : “name”,
“modifiedDate” : “2000-01-23T04:56:07.000+00:00”,
“modifiedBy” : 3,
“id” : 3,
“refId” : 7,
“category” : 5,
“gridXtype” : “gridXtype”,
“scopeByType” : “SYSTEM”,
“fieldType” : 6
},
“description” : “description”,
“defaultTemplateId” : 0,
“isSynchronizeField” : true,
“required” : true,
“controlStyle” : “controlStyle”,
“organizationId” : 3,
“newObject” : true,
“infotip” : “infotip”,
“modifiedBy” : 8,
“id” : 7,
“readOnlyAllowApiOverwrite” : true,
“shouldVersion” : true,
“readOnly” : true,
“lookupTypeId” : 6,
“label” : “label”,
“xmlToString” : “xmlToString”,
“createdDate” : “2000-01-23T04:56:07.000+00:00”,
“controlType” : “TEXTAREA”,
“isReqAdvisorEnabled” : true,
“createdBy” : 4,
“sortOrder” : 6,
“modifiedDate” : “2000-01-23T04:56:07.000+00:00”,
“isInherited” : true,
“triggerSuspect” : true
} ],
“createdDate” : “2000-01-23T04:56:07.000+00:00”,
“createdBy” : 5,
“newObject” : true,
“modifiedDate” : “2000-01-23T04:56:07.000+00:00”,
“hasCustomImage” : true,
“modifiedBy” : 3,
“id” : 4,
“category” : “CORE”,
“documentTypeFacets” : [ {
“organizationId” : 7,
“isSyncedFacet” : true,
“id” : 3,
“facet” : “ACTIVITIES”
}, {
“organizationId” : 7,
“isSyncedFacet” : true,
“id” : 3,
“facet” : “ACTIVITIES”
} ],
“displayPlural” : “displayPlural”
},
“id” : 6
}, {
“organizationId” : 4,
“forCoverage” : true,
“relationshipType” : {
“image” : “image”,
“scopeId” : 6,
“showNote” : true,
“description” : “description”,
“active” : true,
“showStatus” : true,
“xmlToString” : “xmlToString”,
“organizationId” : 3,
“isDefault” : true,
“createdDate” : “2000-01-23T04:56:07.000+00:00”,
“createdBy” : 8,
“newObject” : true,
“sortOrder” : 6,
“name” : “name”,
“modifiedDate” : “2000-01-23T04:56:07.000+00:00”,
“modifiedBy” : 9,
“id” : 6,
“refId” : 1,
“scopeByType” : “SYSTEM”
},
“fromDocType” : {
“image” : “image”,
“workflowFieldId” : 2,
“display” : “display”,
“description” : “description”,
“active” : true,
“xmlToString” : “xmlToString”,
“documentTypeKey” : “documentTypeKey”,
“organizationId” : 0,
“documentTypeFields” : [ {
“documentField” : {
“isDerived” : true,
“scopeId” : 0,
“userConfigurable” : true,
“custom” : true,
“dataType” : “INTEGER”,
“description” : “description”,
“readOnly” : true,
“xmlToString” : “xmlToString”,
“editXtype” : “editXtype”,
“organizationId” : 7,
“createdDate” : “2000-01-23T04:56:07.000+00:00”,
“formXtype” : “formXtype”,
“createdBy” : 6,
“newObject” : true,
“name” : “name”,
“modifiedDate” : “2000-01-23T04:56:07.000+00:00”,
“modifiedBy” : 3,
“id” : 3,
“refId” : 7,
“category” : 5,
“gridXtype” : “gridXtype”,
“scopeByType” : “SYSTEM”,
“fieldType” : 6
},
“description” : “description”,
“defaultTemplateId” : 0,
“isSynchronizeField” : true,
“required” : true,
“controlStyle” : “controlStyle”,
“organizationId” : 3,
“newObject” : true,
“infotip” : “infotip”,
“modifiedBy” : 8,
“id” : 7,
“readOnlyAllowApiOverwrite” : true,
“shouldVersion” : true,
“readOnly” : true,
“lookupTypeId” : 6,
“label” : “label”,
“xmlToString” : “xmlToString”,
“createdDate” : “2000-01-23T04:56:07.000+00:00”,
“controlType” : “TEXTAREA”,
“isReqAdvisorEnabled” : true,
“createdBy” : 4,
“sortOrder” : 6,
“modifiedDate” : “2000-01-23T04:56:07.000+00:00”,
“isInherited” : true,
“triggerSuspect” : true
}, {
“documentField” : {
“isDerived” : true,
“scopeId” : 0,
“userConfigurable” : true,
“custom” : true,
“dataType” : “INTEGER”,
“description” : “description”,
“readOnly” : true,
“xmlToString” : “xmlToString”,
“editXtype” : “editXtype”,
“organizationId” : 7,
“createdDate” : “2000-01-23T04:56:07.000+00:00”,
“formXtype” : “formXtype”,
“createdBy” : 6,
“newObject” : true,
“name” : “name”,
“modifiedDate” : “2000-01-23T04:56:07.000+00:00”,
“modifiedBy” : 3,
“id” : 3,
“refId” : 7,
“category” : 5,
“gridXtype” : “gridXtype”,
“scopeByType” : “SYSTEM”,
“fieldType” : 6
},
“description” : “description”,
“defaultTemplateId” : 0,
“isSynchronizeField” : true,
“required” : true,
“controlStyle” : “controlStyle”,
“organizationId” : 3,
“newObject” : true,
“infotip” : “infotip”,
“modifiedBy” : 8,
“id” : 7,
“readOnlyAllowApiOverwrite” : true,
“shouldVersion” : true,
“readOnly” : true,
“lookupTypeId” : 6,
“label” : “label”,
“xmlToString” : “xmlToString”,
“createdDate” : “2000-01-23T04:56:07.000+00:00”,
“controlType” : “TEXTAREA”,
“isReqAdvisorEnabled” : true,
“createdBy” : 4,
“sortOrder” : 6,
“modifiedDate” : “2000-01-23T04:56:07.000+00:00”,
“isInherited” : true,
“triggerSuspect” : true
} ],
“createdDate” : “2000-01-23T04:56:07.000+00:00”,
“createdBy” : 5,
“newObject” : true,
“modifiedDate” : “2000-01-23T04:56:07.000+00:00”,
“hasCustomImage” : true,
“modifiedBy” : 3,
“id” : 4,
“category” : “CORE”,
“documentTypeFacets” : [ {
“organizationId” : 7,
“isSyncedFacet” : true,
“id” : 3,
“facet” : “ACTIVITIES”
}, {
“organizationId” : 7,
“isSyncedFacet” : true,
“id” : 3,
“facet” : “ACTIVITIES”
} ],
“displayPlural” : “displayPlural”
},
“id” : 6
} ],
“id” : 1
}
} ],
“meta” : {
“pageInfo” : {
“startIndex” : 0,
“resultCount” : 6,
“totalResults” : 1
},
“status” : “OK”,
“timestamp” : “2000-01-23T04:56:07.000+00:00”
},
“links” : {
“key” : {
“href” : “href”,
“type” : “type”
}
}
}
Produces: API call produces the following media types according to the
Accept request header;
the media type will be conveyed by the Content-Type response header:
- application/json
Response:
ProjectDataListWrapper
GET /projects/{projectId}/tags
Summary: Get all tags for the project with the specified ID
Path parameters:
- projectId
(required)
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” : 0,
“resultCount” : 6,
“totalResults” : 1
},
“status” : “OK”,
“timestamp” : “2000-01-23T04:56:07.000+00:00”
},
“links” : {
“key” : {
“href” : “href”,
“type” : “type”
}
}
}
Produces: API call produces the following media types according to the
Accept request header;
the media type will be conveyed by the Content-Type response header:
- application/json
Response:
TagDataListWrapper
POST /projects/{projectId}/attachments
Summary: Create a new attachment in the project with the specified ID
Path parameters:
- projectId
(required)
Consumes: this API call consumes the following media types via the
Content-Type request header:
- application/json
Body:
Examples:
- Example data, content-type: application/json
{
“meta” : {
“location” : “location”,
“id” : 0,
“status” : “OK”,
“timestamp” : “2000-01-23T04:56:07.000+00:00”
}
}
Produces: API call produces the following media types according to the
Accept request header;
the media type will be conveyed by the Content-Type response header:
- application/json
Response:
CreatedResponseDataWrapper
PUT /projects/{projectId}
Summary: Update the project with the specified ID
Path parameters:
- projectId
(required)
Consumes: this API call consumes the following media types via the
Content-Type request header:
- application/json
Body:
Examples:
- Example data, content-type: application/json
{
“status” : “OK”,
“timestamp” : “2000-01-23T04:56:07.000+00:00”
}
Produces: API call produces the following media types according to the
Accept request header;
the media type will be conveyed by the Content-Type response header:
- application/json
Response:
MetaWrapper
DELETE /projects/{projectId}/itemtypes/{itemTypeId}
Summary: Remove an Item Type from a Project
Path parameters:
- itemTypeId
(required)
- projectId
(required)
Endpoint relationshiprulesets
The relationshiprulesets endpoint has the following operations:
Below is more detail for each of the operations of the relationshiprulesets endpoint.
GET /relationshiprulesets/{id}/projects
Summary: Get Projects that have a given Relationship Rule Set assigned.
Path parameters:
- id
(required)
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
{
“data” : [ {
“relationshipType” : 5,
“fromItem” : 6,
“id” : 0,
“suspect” : true,
“toItem” : 1
}, {
“relationshipType” : 5,
“fromItem” : 6,
“id” : 0,
“suspect” : true,
“toItem” : 1
} ],
“meta” : {
“pageInfo” : {
“startIndex” : 0,
“resultCount” : 6,
“totalResults” : 1
},
“status” : “OK”,
“timestamp” : “2000-01-23T04:56:07.000+00:00”
},
“links” : {
“key” : {
“href” : “href”,
“type” : “type”
}
}
}
Produces: API call produces the following media types according to the
Accept request header;
the media type will be conveyed by the Content-Type response header:
- application/json
Response:
RelationshipDataListWrapper
GET /relationshiprulesets
Summary: Gets all Relationship Rule Sets in the organization
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
{
“data” : [ {
“relationshipType” : 5,
“fromItem” : 6,
“id” : 0,
“suspect” : true,
“toItem” : 1
}, {
“relationshipType” : 5,
“fromItem” : 6,
“id” : 0,
“suspect” : true,
“toItem” : 1
} ],
“meta” : {
“pageInfo” : {
“startIndex” : 0,
“resultCount” : 6,
“totalResults” : 1
},
“status” : “OK”,
“timestamp” : “2000-01-23T04:56:07.000+00:00”
},
“links” : {
“key” : {
“href” : “href”,
“type” : “type”
}
}
}
Produces: API call produces the following media types according to the
Accept request header;
the media type will be conveyed by the Content-Type response header:
- application/json
Response:
RelationshipDataListWrapper
GET /relationshiprulesets/{id}
Summary: Get a Relationship Rule Set by id
Path parameters:
- id
(required)
Request headers:
- xJamaDateFieldsWithTime
(optional)
Examples:
- Example data, content-type: application/json
{
“data” : { },
“meta” : {
“status” : “OK”,
“timestamp” : “2000-01-23T04:56:07.000+00:00”
}
}
Produces: API call produces the following media types according to the
Accept request header;
the media type will be conveyed by the Content-Type response header:
- application/json
Response:
SimpleDataWrapper
Endpoint relationships
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.
DELETE /relationships/{relationshipId}/suspect
Summary: Remove an existing suspect link for the relationship with the specified ID
Path parameters:
- relationshipId
(required)
POST /relationships
Summary: Create a new relationship
Consumes: this API call consumes the following media types via the
Content-Type request header:
- application/json
Body:
Examples:
- Example data, content-type: application/json
{
“meta” : {
“location” : “location”,
“id” : 0,
“status” : “OK”,
“timestamp” : “2000-01-23T04:56:07.000+00:00”
}
}
Produces: API call produces the following media types according to the
Accept request header;
the media type will be conveyed by the Content-Type response header:
- application/json
Response:
CreatedResponseDataWrapper
DELETE /relationships/{relationshipId}
Summary: Delete the relationship with the specified ID
Path parameters:
- relationshipId
(required)
GET /relationships/{relationshipId}
Summary: Get the relationship with the specified ID
Path parameters:
- relationshipId
(required)
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”
}
}
}
Produces: API call produces the following media types according to the
Accept request header;
the media type will be conveyed by the Content-Type response header:
- application/json
Response:
RelationshipDataWrapper
GET /relationships
Summary: Get all relationships in the project with the specified ID
Request headers:
- xJamaDateFieldsWithTime
(optional)
Query parameters:
- project
(required)
- startAt
(optional) - lastId
(required)
- 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” : 0,
“resultCount” : 6,
“totalResults” : 1
},
“status” : “OK”,
“timestamp” : “2000-01-23T04:56:07.000+00:00”
},
“links” : {
“key” : {
“href” : “href”,
“type” : “type”
}
}
}
Produces: API call produces the following media types according to the
Accept request header;
the media type will be conveyed by the Content-Type response header:
- application/json
Response:
RelationshipDataListWrapper
PUT /relationships/{relationshipId}
Summary: Update the relationship with the specified ID
Path parameters:
- relationshipId
(required)
Consumes: this API call consumes the following media types via the
Content-Type request header:
- application/json
Body:
Examples:
- Example data, content-type: application/json
{
“meta” : {
“status” : “OK”,
“timestamp” : “2000-01-23T04:56:07.000+00:00”
}
}
Produces: API call produces the following media types according to the
Accept request header;
the media type will be conveyed by the Content-Type response header:
- application/json
Response:
OkResponseDataWraper
Endpoint relationshiptypes
The relationshiptypes endpoint has the following operations:
Below is more detail for each of the operations of the relationshiptypes endpoint.
GET /relationshiptypes/{id}
Summary: Get the relationship type with the specified ID
Path parameters:
- id
(required)
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” : {
“image” : “image”,
“scopeId” : 6,
“showNote” : true,
“description” : “description”,
“active” : true,
“showStatus” : true,
“xmlToString” : “xmlToString”,
“organizationId” : 3,
“isDefault” : true,
“createdDate” : “2000-01-23T04:56:07.000+00:00”,
“createdBy” : 8,
“newObject” : true,
“sortOrder” : 6,
“name” : “name”,
“modifiedDate” : “2000-01-23T04:56:07.000+00:00”,
“modifiedBy” : 9,
“id” : 6,
“refId” : 1,
“scopeByType” : “SYSTEM”
},
“meta” : {
“status” : “OK”,
“timestamp” : “2000-01-23T04:56:07.000+00:00”
},
“links” : {
“key” : {
“href” : “href”,
“type” : “type”
}
}
}
Produces: API call produces the following media types according to the
Accept request header;
the media type will be conveyed by the Content-Type response header:
- application/json
Response:
RelationshipTypeDataWrapper
GET /relationshiptypes
Summary: Get all relationship types
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”,
“scopeId” : 6,
“showNote” : true,
“description” : “description”,
“active” : true,
“showStatus” : true,
“xmlToString” : “xmlToString”,
“organizationId” : 3,
“isDefault” : true,
“createdDate” : “2000-01-23T04:56:07.000+00:00”,
“createdBy” : 8,
“newObject” : true,
“sortOrder” : 6,
“name” : “name”,
“modifiedDate” : “2000-01-23T04:56:07.000+00:00”,
“modifiedBy” : 9,
“id” : 6,
“refId” : 1,
“scopeByType” : “SYSTEM”
}, {
“image” : “image”,
“scopeId” : 6,
“showNote” : true,
“description” : “description”,
“active” : true,
“showStatus” : true,
“xmlToString” : “xmlToString”,
“organizationId” : 3,
“isDefault” : true,
“createdDate” : “2000-01-23T04:56:07.000+00:00”,
“createdBy” : 8,
“newObject” : true,
“sortOrder” : 6,
“name” : “name”,
“modifiedDate” : “2000-01-23T04:56:07.000+00:00”,
“modifiedBy” : 9,
“id” : 6,
“refId” : 1,
“scopeByType” : “SYSTEM”
} ],
“meta” : {
“pageInfo” : {
“startIndex” : 0,
“resultCount” : 6,
“totalResults” : 1
},
“status” : “OK”,
“timestamp” : “2000-01-23T04:56:07.000+00:00”
},
“links” : {
“key” : {
“href” : “href”,
“type” : “type”
}
}
}
Produces: API call produces the following media types according to the
Accept request header;
the media type will be conveyed by the Content-Type response header:
- application/json
Response:
RelationshipTypeDataListWrapper
Endpoint releases
The releases endpoint has the following operations:
Below is more detail for each of the operations of the releases endpoint.
POST /releases
Summary: Create a new release
Consumes: this API call consumes the following media types via the
Content-Type request header:
- application/json
Body:
Examples:
- Example data, content-type: application/json
{
“meta” : {
“location” : “location”,
“id” : 0,
“status” : “OK”,
“timestamp” : “2000-01-23T04:56:07.000+00:00”
}
}
Produces: API call produces the following media types according to the
Accept request header;
the media type will be conveyed by the Content-Type response header:
- application/json
Response:
CreatedResponseDataWrapper
GET /releases/{releaseId}
Summary: Get the release with the specified ID
Path parameters:
- releaseId
(required)
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”
}
}
}
Produces: API call produces the following media types according to the
Accept request header;
the media type will be conveyed by the Content-Type response header:
- application/json
Response:
ReleaseDataWrapper
GET /releases
Summary: Get all releases in the project with the specified ID
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” : 0,
“resultCount” : 6,
“totalResults” : 1
},
“status” : “OK”,
“timestamp” : “2000-01-23T04:56:07.000+00:00”
},
“links” : {
“key” : {
“href” : “href”,
“type” : “type”
}
}
}
Produces: API call produces the following media types according to the
Accept request header;
the media type will be conveyed by the Content-Type response header:
- application/json
Response:
ReleaseDataListWrapper
PUT /releases/{releaseId}
Summary: Update the release with the specified ID
Path parameters:
- releaseId
(required)
Consumes: this API call consumes the following media types via the
Content-Type request header:
- application/json
Body:
Examples:
- Example data, content-type: application/json
{
“status” : “OK”,
“timestamp” : “2000-01-23T04:56:07.000+00:00”
}
Produces: API call produces the following media types according to the
Accept request header;
the media type will be conveyed by the Content-Type response header:
- application/json
Response:
MetaWrapper
Endpoint system
The system endpoint has the following operations:
Below is more detail for each of the operations of the system endpoint.
GET /system/settings/corsdomains
Summary: Get the current CORS domain whitelist
Request headers:
- xJamaDateFieldsWithTime
(optional)
Examples:
- Example data, content-type: application/json
{
“data” : {
“domains” : [ “domains”, “domains” ]
},
“meta” : {
“status” : “OK”,
“timestamp” : “2000-01-23T04:56:07.000+00:00”
},
“links” : {
“key” : {
“href” : “href”,
“type” : “type”
}
}
}
Produces: API call produces the following media types according to the
Accept request header;
the media type will be conveyed by the Content-Type response header:
- application/json
Response:
SystemDataWrapper
POST /system/settings/corsdomains
Summary: Update CORS domain whitelist
Consumes: this API call consumes the following media types via the
Content-Type request header:
- application/json
Body:
Examples:
- Example data, content-type: application/json
{
“status” : “OK”,
“timestamp” : “2000-01-23T04:56:07.000+00:00”
}
Produces: API call produces the following media types according to the
Accept request header;
the media type will be conveyed by the Content-Type response header:
- application/json
Response:
MetaWrapper
Endpoint tags
The tags endpoint has the following operations:
Below is more detail for each of the operations of the tags endpoint.
POST /tags
Summary: Create a new tag in the project with the specified ID
Consumes: this API call consumes the following media types via the
Content-Type request header:
- application/json
Body:
Examples:
- Example data, content-type: application/json
{
“meta” : {
“location” : “location”,
“id” : 0,
“status” : “OK”,
“timestamp” : “2000-01-23T04:56:07.000+00:00”
}
}
Produces: API call produces the following media types according to the
Accept request header;
the media type will be conveyed by the Content-Type response header:
- application/json
Response:
CreatedResponseDataWrapper
DELETE /tags/{id}
Summary: Delete the tag with the specified ID
Path parameters:
- id
(required)
GET /tags/{id}/items
Summary: Get all items that have the tag with the specified ID
Path parameters:
- id
(required)
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” : 6,
“globalId” : “globalId”,
“project” : 1,
“resources” : {
“key” : {
“allowed” : [ “allowed”, “allowed” ]
}
},
“childItemType” : 4,
“version” : 2,
“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” : 5,
“location” : {
“sequence” : “sequence”,
“parent” : {
“item” : 2,
“project” : 3
},
“sortOrder” : 7,
“globalSortOrder” : 9
},
“id” : 0,
“fields” : {
“key” : { }
},
“baselinedAppliedCategorySnapshots” : [ {
“categoryPathSequence” : “categoryPathSequence”,
“itemVersionNumberApplied” : 2
}, {
“categoryPathSequence” : “categoryPathSequence”,
“itemVersionNumberApplied” : 2
} ]
}, {
“itemType” : 6,
“globalId” : “globalId”,
“project” : 1,
“resources” : {
“key” : {
“allowed” : [ “allowed”, “allowed” ]
}
},
“childItemType” : 4,
“version” : 2,
“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” : 5,
“location” : {
“sequence” : “sequence”,
“parent” : {
“item” : 2,
“project” : 3
},
“sortOrder” : 7,
“globalSortOrder” : 9
},
“id” : 0,
“fields” : {
“key” : { }
},
“baselinedAppliedCategorySnapshots” : [ {
“categoryPathSequence” : “categoryPathSequence”,
“itemVersionNumberApplied” : 2
}, {
“categoryPathSequence” : “categoryPathSequence”,
“itemVersionNumberApplied” : 2
} ]
} ],
“meta” : {
“pageInfo” : {
“startIndex” : 0,
“resultCount” : 6,
“totalResults” : 1
},
“status” : “OK”,
“timestamp” : “2000-01-23T04:56:07.000+00:00”
},
“links” : {
“key” : {
“href” : “href”,
“type” : “type”
}
}
}
Produces: API call produces the following media types according to the
Accept request header;
the media type will be conveyed by the Content-Type response header:
- application/json
Response:
ItemDataListWrapper
GET /tags/{id}
Summary: Get the tag with the specified ID
Path parameters:
- id
(required)
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”
}
}
}
Produces: API call produces the following media types according to the
Accept request header;
the media type will be conveyed by the Content-Type response header:
- application/json
Response:
TagDataWrapper
GET /tags
Summary: Get all tags for the project with the specified ID
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” : 0,
“resultCount” : 6,
“totalResults” : 1
},
“status” : “OK”,
“timestamp” : “2000-01-23T04:56:07.000+00:00”
},
“links” : {
“key” : {
“href” : “href”,
“type” : “type”
}
}
}
Produces: API call produces the following media types according to the
Accept request header;
the media type will be conveyed by the Content-Type response header:
- application/json
Response:
TagDataListWrapper
PUT /tags/{id}
Summary: Update the tag with the specified ID
Path parameters:
- id
(required)
Consumes: this API call consumes the following media types via the
Content-Type request header:
- application/json
Body:
Examples:
- Example data, content-type: application/json
{
“status” : “OK”,
“timestamp” : “2000-01-23T04:56:07.000+00:00”
}
Produces: API call produces the following media types according to the
Accept request header;
the media type will be conveyed by the Content-Type response header:
- application/json
Response:
MetaWrapper
Endpoint testcycles
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.
DELETE /testcycles/{testCycleId}
Summary: Delete the test cycle with the specified ID, including the test runs in the test cycle
Path parameters:
- testCycleId
(required)
GET /testcycles/{testCycleId}
Summary: Get the test cycle with the specified ID
Path parameters:
- testCycleId
(required)
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” : 6,
“globalId” : “globalId”,
“project” : 1,
“resources” : {
“key” : {
“allowed” : [ “allowed”, “allowed” ]
}
},
“version” : 2,
“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”
}
}
}
Produces: API call produces the following media types according to the
Accept request header;
the media type will be conveyed by the Content-Type response header:
- application/json
Response:
TestCycleDataWrapper
GET /testcycles/{testCycleId}/testgroup/{testGroupId}
Summary: Get the test cycle test group for the test cycle with the specified ID
Path parameters:
- testGroupId
(required)
Get the test group with the specified ID
- testCycleId
(required)
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,
“name” : “name”,
“testGroup” : 6,
“type” : “type”,
“assignedTo” : 0
},
“meta” : {
“status” : “OK”,
“timestamp” : “2000-01-23T04:56:07.000+00:00”
},
“links” : {
“key” : {
“href” : “href”,
“type” : “type”
}
},
“linked” : {
“key” : {
“key” : { }
}
}
}
Produces: API call produces the following media types according to the
Accept request header;
the media type will be conveyed by the Content-Type response header:
- application/json
Response:
TestCycleTestGroupDataWrapper
GET /testcycles/{testCycleId}/testruns
Summary: Get all test runs for the test cycle with the specified ID
Path parameters:
- testCycleId
(required)
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” : 6,
“TestCycleTestGroup” : {
“id” : 2,
“value” : { },
“object” : {
“testCycle” : 1,
“name” : “name”,
“testGroup” : 6,
“type” : “type”,
“assignedTo” : 0
}
},
“testCaseCurrentVersionNumber” : 9,
“globalId” : “globalId”,
“project” : 1,
“resources” : {
“key” : {
“allowed” : [ “allowed”, “allowed” ]
}
},
“version” : 2,
“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” : 7,
“sortOrderFromTestGroup” : 3,
“modifiedBy” : 5,
“id” : 0,
“fields” : {
“key” : { }
},
“baselinedAppliedCategorySnapshots” : [ {
“categoryPathSequence” : “categoryPathSequence”,
“itemVersionNumberApplied” : 2
}, {
“categoryPathSequence” : “categoryPathSequence”,
“itemVersionNumberApplied” : 2
} ]
}, {
“itemType” : 6,
“TestCycleTestGroup” : {
“id” : 2,
“value” : { },
“object” : {
“testCycle” : 1,
“name” : “name”,
“testGroup” : 6,
“type” : “type”,
“assignedTo” : 0
}
},
“testCaseCurrentVersionNumber” : 9,
“globalId” : “globalId”,
“project” : 1,
“resources” : {
“key” : {
“allowed” : [ “allowed”, “allowed” ]
}
},
“version” : 2,
“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” : 7,
“sortOrderFromTestGroup” : 3,
“modifiedBy” : 5,
“id” : 0,
“fields” : {
“key” : { }
},
“baselinedAppliedCategorySnapshots” : [ {
“categoryPathSequence” : “categoryPathSequence”,
“itemVersionNumberApplied” : 2
}, {
“categoryPathSequence” : “categoryPathSequence”,
“itemVersionNumberApplied” : 2
} ]
} ],
“meta” : {
“pageInfo” : {
“startIndex” : 0,
“resultCount” : 6,
“totalResults” : 1
},
“status” : “OK”,
“timestamp” : “2000-01-23T04:56:07.000+00:00”
},
“links” : {
“key” : {
“href” : “href”,
“type” : “type”
}
}
}
Produces: API call produces the following media types according to the
Accept request header;
the media type will be conveyed by the Content-Type response header:
- application/json
Response:
TestRunDataListWrapper
GET /testcycles/{testCycleId}/versions/{versionNum}
Summary: Get the numbered version for the item with the specified ID
Path parameters:
- versionNum
(required)
- testCycleId
(required)
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” : 0,
“createdDate” : “2000-01-23T04:56:07.000+00:00”,
“versionedItem” : {
“id” : 2,
“value” : { },
“object” : {
“id” : 1,
“type” : “type”,
“version” : 5,
“currentVersion” : 5
}
},
“createdBy” : 7,
“comment” : “comment”,
“userName” : “userName”,
“type” : “type”,
“versionNumber” : 6,
“changeDetails” : “changeDetails”
},
“meta” : {
“status” : “OK”,
“timestamp” : “2000-01-23T04:56:07.000+00:00”
},
“links” : {
“key” : {
“href” : “href”,
“type” : “type”
}
}
}
Produces: API call produces the following media types according to the
Accept request header;
the media type will be conveyed by the Content-Type response header:
- application/json
Response:
VersionDataWrapper
GET /testcycles/{testCycleId}/versions/{versionNum}/versioneditem
Summary: Get the snapshot of the test cycle at the specified version
Path parameters:
- versionNum
(required)
- testCycleId
(required)
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” : 6,
“fileName” : “fileName”,
“globalId” : “globalId”,
“project” : 1,
“resources” : {
“key” : {
“allowed” : [ “allowed”, “allowed” ]
}
},
“mimeType” : “mimeType”,
“version” : 2,
“currentVersion” : 3,
“createdDate” : “2000-01-23T04:56:07.000+00:00”,
“lastActivityDate” : “2000-01-23T04:56:07.000+00:00”,
“createdBy” : 5,
“fileSize” : 9,
“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” : 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”
}
}
}
Produces: API call produces the following media types according to the
Accept request header;
the media type will be conveyed by the Content-Type response header:
- application/json
Response:
VersionedAttachmentDataWrapper
GET /testcycles/{testCycleId}/versions
Summary: Get all versions for the item with the specified ID
Path parameters:
- testCycleId
(required)
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” : 0,
“createdDate” : “2000-01-23T04:56:07.000+00:00”,
“versionedItem” : {
“id” : 2,
“value” : { },
“object” : {
“id” : 1,
“type” : “type”,
“version” : 5,
“currentVersion” : 5
}
},
“createdBy” : 7,
“comment” : “comment”,
“userName” : “userName”,
“type” : “type”,
“versionNumber” : 6,
“changeDetails” : “changeDetails”
}, {
“item” : 0,
“createdDate” : “2000-01-23T04:56:07.000+00:00”,
“versionedItem” : {
“id” : 2,
“value” : { },
“object” : {
“id” : 1,
“type” : “type”,
“version” : 5,
“currentVersion” : 5
}
},
“createdBy” : 7,
“comment” : “comment”,
“userName” : “userName”,
“type” : “type”,
“versionNumber” : 6,
“changeDetails” : “changeDetails”
} ],
“meta” : {
“pageInfo” : {
“startIndex” : 0,
“resultCount” : 6,
“totalResults” : 1
},
“status” : “OK”,
“timestamp” : “2000-01-23T04:56:07.000+00:00”
},
“links” : {
“key” : {
“href” : “href”,
“type” : “type”
}
}
}
Produces: API call produces the following media types according to the
Accept request header;
the media type will be conveyed by the Content-Type response header:
- application/json
Response:
VersionDataListWrapper
PATCH /testcycles/{testCycleId}
Summary: Update the test cycle with the specified ID. Test runs will be synced based on the actual selected test groups and test run statuses. Some test runs may be removed or added during sync.
Path parameters:
- testCycleId
(required)
Consumes: this API call consumes the following media types via the
Content-Type request header:
- application/json
Body:
Examples:
- Example data, content-type: application/json
{
“status” : “OK”,
“timestamp” : “2000-01-23T04:56:07.000+00:00”
}
Produces: API call produces the following media types according to the
Accept request header;
the media type will be conveyed by the Content-Type response header:
- application/json
Response:
MetaWrapper
PUT /testcycles/{testCycleId}
Summary: Update the test cycle with the specified ID. Test runs will be synced based on the actual selected test groups and test run statuses. Some test runs may be removed or added during sync.
Path parameters:
- testCycleId
(required)
Consumes: this API call consumes the following media types via the
Content-Type request header:
- application/json
Body:
Examples:
- Example data, content-type: application/json
{
“status” : “OK”,
“timestamp” : “2000-01-23T04:56:07.000+00:00”
}
Produces: API call produces the following media types according to the
Accept request header;
the media type will be conveyed by the Content-Type response header:
- application/json
Response:
MetaWrapper
Endpoint testplans
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.
POST /testplans/{id}/attachments
Summary: Add an existing attachment to the item with the specified ID
Path parameters:
- id
(required)
Consumes: this API call consumes the following media types via the
Content-Type request header:
- application/json
Body:
Examples:
- Example data, content-type: application/json
{
“meta” : {
“location” : “location”,
“id” : 0,
“status” : “OK”,
“timestamp” : “2000-01-23T04:56:07.000+00:00”
}
}
Produces: API call produces the following media types according to the
Accept request header;
the media type will be conveyed by the Content-Type response header:
- application/json
Response:
CreatedResponseDataWrapper
POST /testplans/{id}/links
Summary: Create a new link for the item with the specified ID
Path parameters:
- id
(required)
Consumes: this API call consumes the following media types via the
Content-Type request header:
- application/json
Body:
Examples:
- Example data, content-type: application/json
{
“meta” : {
“location” : “location”,
“id” : 0,
“status” : “OK”,
“timestamp” : “2000-01-23T04:56:07.000+00:00”
}
}
Produces: API call produces the following media types according to the
Accept request header;
the media type will be conveyed by the Content-Type response header:
- application/json
Response:
CreatedResponseDataWrapper
POST /testplans/{id}/tags
Summary: Add an existing tag to the item with the specified ID
Path parameters:
- id
(required)
Consumes: this API call consumes the following media types via the
Content-Type request header:
- application/json
Body:
Examples:
- Example data, content-type: application/json
{
“meta” : {
“location” : “location”,
“id” : 0,
“status” : “OK”,
“timestamp” : “2000-01-23T04:56:07.000+00:00”
}
}
Produces: API call produces the following media types according to the
Accept request header;
the media type will be conveyed by the Content-Type response header:
- application/json
Response:
CreatedResponseDataWrapper
POST /testplans/{id}/testgroups
Summary: Create a new test group to the test plan with the specified ID
Path parameters:
- id
(required)
Consumes: this API call consumes the following media types via the
Content-Type request header:
- application/json
Body:
Examples:
- Example data, content-type: application/json
{
“meta” : {
“location” : “location”,
“id” : 0,
“status” : “OK”,
“timestamp” : “2000-01-23T04:56:07.000+00:00”
}
}
Produces: API call produces the following media types according to the
Accept request header;
the media type will be conveyed by the Content-Type response header:
- application/json
Response:
CreatedResponseDataWrapper
POST /testplans/{id}/testcycles
Summary: Create a new test cycle
Path parameters:
- id
(required)
Consumes: this API call consumes the following media types via the
Content-Type request header:
- application/json
Body:
Examples:
- Example data, content-type: application/json
{
“meta” : {
“location” : “location”,
“id” : 0,
“status” : “OK”,
“timestamp” : “2000-01-23T04:56:07.000+00:00”
}
}
Produces: API call produces the following media types according to the
Accept request header;
the media type will be conveyed by the Content-Type response header:
- application/json
Response:
CreatedResponseDataWrapper
POST /testplans
Summary: Create a new test plan
Consumes: this API call consumes the following media types via the
Content-Type request header:
- application/json
Body:
Examples:
- Example data, content-type: application/json
{
“meta” : {
“location” : “location”,
“id” : 0,
“status” : “OK”,
“timestamp” : “2000-01-23T04:56:07.000+00:00”
}
}
Produces: API call produces the following media types according to the
Accept request header;
the media type will be conveyed by the Content-Type response header:
- application/json
Response:
CreatedResponseDataWrapper
DELETE /testplans/{id}/links/{linkId}
Summary: Delete the link with the specified ID
Path parameters:
- linkId
(required)
- id
(required)
DELETE /testplans/{id}/testgroups/{testGroupId}/testcases/{testCaseId}
Summary: Remove an existing test case from the test group
Path parameters:
- testCaseId
(required)
- testGroupId
(required)
- id
(required)
DELETE /testplans/{id}/testgroups/{testGroupId}
Summary: Delete the test group with the specified ID
Path parameters:
- testGroupId
(required)
- id
(required)
DELETE /testplans/{id}
Summary: Delete the test plan with the specified ID
Path parameters:
- id
(required)
GET /testplans/{id}/activities
Summary: Get all activities for the test plan with the specified ID
Path parameters:
- id
(required)
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” : 6,
“itemType” : 5,
“userComment” : “userComment”,
“action” : “action”,
“details” : “details”,
“id” : 0,
“eventType” : “CREATE”,
“userName” : “userName”,
“user” : 1,
“objectType” : “PROJECT”
}, {
“date” : “2000-01-23T04:56:07.000+00:00”,
“item” : 6,
“itemType” : 5,
“userComment” : “userComment”,
“action” : “action”,
“details” : “details”,
“id” : 0,
“eventType” : “CREATE”,
“userName” : “userName”,
“user” : 1,
“objectType” : “PROJECT”
} ],
“meta” : {
“pageInfo” : {
“startIndex” : 0,
“resultCount” : 6,
“totalResults” : 1
},
“status” : “OK”,
“timestamp” : “2000-01-23T04:56:07.000+00:00”
},
“links” : {
“key” : {
“href” : “href”,
“type” : “type”
}
}
}
Produces: API call produces the following media types according to the
Accept request header;
the media type will be conveyed by the Content-Type response header:
- application/json
Response:
ActivityDataListWrapper
GET /testplans/{id}/attachments
Summary: Get all attachments for the item with the specified ID
Path parameters:
- id
(required)
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”,
“attachmentTypeId” : 8,
“description” : “description”,
“project” : {
“parent” : 7,
“projectType” : {
“components” : “components”,
“scopeId” : 0,
“description” : “description”,
“xmlToString” : “xmlToString”,
“organizationId” : 3,
“createdDate” : “2000-01-23T04:56:07.000+00:00”,
“createdBy” : 6,
“newObject” : true,
“name” : “name”,
“defaultDisplay” : “defaultDisplay”,
“modifiedDate” : “2000-01-23T04:56:07.000+00:00”,
“defaultPrefix” : “defaultPrefix”,
“defaultDisplayPlural” : “defaultDisplayPlural”,
“modifiedBy” : 8,
“id” : 4,
“refId” : 2,
“scopeByType” : “SYSTEM”
},
“description” : “description”,
“flag2” : true,
“flag1” : true,
“organizationId” : 4,
“projectKey” : “projectKey”,
“string3” : “string3”,
“string4” : “string4”,
“string1” : “string1”,
“newObject” : true,
“string2” : “string2”,
“modifiedBy” : 8,
“id” : 6,
“user1” : {
“lastName” : “lastName”,
“active” : true,
“customData” : [ {
“name” : “name”,
“value” : “value”
}, {
“name” : “name”,
“value” : “value”
} ],
“title” : “title”,
“type” : “users”,
“firstName” : “firstName”,
“licenseType” : “NAMED”,
“uid” : “uid”,
“phone” : “phone”,
“location” : “location”,
“id” : 9,
“authenticationType” : {
“name” : “name”,
“id” : 3
},
“email” : “email”,
“username” : “username”
},
“active” : true,
“date2” : “2000-01-23T04:56:07.000+00:00”,
“xmlToString” : “xmlToString”,
“date1” : “2000-01-23T04:56:07.000+00:00”,
“defaultDashboard” : {
“scopeId” : 5,
“xmlToString” : “xmlToString”,
“dashboardName” : “dashboardName”,
“layout” : “SINGLE_COLUMN”,
“organizationId” : 7,
“createdDate” : “2000-01-23T04:56:07.000+00:00”,
“createdBy” : 0,
“newObject” : true,
“modifiedDate” : “2000-01-23T04:56:07.000+00:00”,
“modifiedBy” : 9,
“id” : 0,
“refId” : 4,
“portletInstances” : [ {
“organizationId” : 9,
“location” : “location”,
“portlet” : “FILTER_RESULTS”,
“id” : 7,
“properties” : {
“key” : “properties”
}
}, {
“organizationId” : 9,
“location” : “location”,
“portlet” : “FILTER_RESULTS”,
“id” : 7,
“properties” : {
“key” : “properties”
}
} ],
“scopeByType” : “SYSTEM”
},
“lookup1” : {
“image” : “image”,
“color” : “color”,
“dataValue” : “dataValue”,
“description” : “description”,
“active” : true,
“lookupType” : {
“lookups” : [ null, null ],
“scopeId” : 6,
“description” : “description”,
“active” : true,
“xmlToString” : “xmlToString”,
“type” : 2,
“organizationId” : 1,
“createdDate” : “2000-01-23T04:56:07.000+00:00”,
“createdBy” : 7,
“newObject” : true,
“name” : “name”,
“modifiedDate” : “2000-01-23T04:56:07.000+00:00”,
“modifiedBy” : 1,
“id” : 1,
“refId” : 7,
“category” : 4,
“scopeByType” : “SYSTEM”
},
“xmlToString” : “xmlToString”,
“organizationId” : 9,
“archived” : true,
“isDefault” : true,
“createdDate” : “2000-01-23T04:56:07.000+00:00”,
“createdBy” : 4,
“newObject” : true,
“sortOrder” : 1,
“name” : “name”,
“modifiedDate” : “2000-01-23T04:56:07.000+00:00”,
“infotip” : “infotip”,
“modifiedBy” : 5,
“id” : 9
},
“isFolder” : true,
“createdDate” : “2000-01-23T04:56:07.000+00:00”,
“text3” : “text3”,
“createdBy” : 1,
“text1” : “text1”,
“text2” : “text2”,
“name” : “name”,
“modifiedDate” : “2000-01-23T04:56:07.000+00:00”,
“relationshipRuleSet” : {
“organizationId” : 4,
“isExclusive” : true,
“name” : “name”,
“rules” : [ {
“organizationId” : 4,
“forCoverage” : true,
“relationshipType” : {
“image” : “image”,
“scopeId” : 6,
“showNote” : true,
“description” : “description”,
“active” : true,
“showStatus” : true,
“xmlToString” : “xmlToString”,
“organizationId” : 3,
“isDefault” : true,
“createdDate” : “2000-01-23T04:56:07.000+00:00”,
“createdBy” : 8,
“newObject” : true,
“sortOrder” : 6,
“name” : “name”,
“modifiedDate” : “2000-01-23T04:56:07.000+00:00”,
“modifiedBy” : 9,
“id” : 6,
“refId” : 1,
“scopeByType” : “SYSTEM”
},
“fromDocType” : {
“image” : “image”,
“workflowFieldId” : 2,
“display” : “display”,
“description” : “description”,
“active” : true,
“xmlToString” : “xmlToString”,
“documentTypeKey” : “documentTypeKey”,
“organizationId” : 0,
“documentTypeFields” : [ {
“documentField” : {
“isDerived” : true,
“scopeId” : 0,
“userConfigurable” : true,
“custom” : true,
“dataType” : “INTEGER”,
“description” : “description”,
“readOnly” : true,
“xmlToString” : “xmlToString”,
“editXtype” : “editXtype”,
“organizationId” : 7,
“createdDate” : “2000-01-23T04:56:07.000+00:00”,
“formXtype” : “formXtype”,
“createdBy” : 6,
“newObject” : true,
“name” : “name”,
“modifiedDate” : “2000-01-23T04:56:07.000+00:00”,
“modifiedBy” : 3,
“id” : 3,
“refId” : 7,
“category” : 5,
“gridXtype” : “gridXtype”,
“scopeByType” : “SYSTEM”,
“fieldType” : 6
},
“description” : “description”,
“defaultTemplateId” : 0,
“isSynchronizeField” : true,
“required” : true,
“controlStyle” : “controlStyle”,
“organizationId” : 3,
“newObject” : true,
“infotip” : “infotip”,
“modifiedBy” : 8,
“id” : 7,
“readOnlyAllowApiOverwrite” : true,
“shouldVersion” : true,
“readOnly” : true,
“lookupTypeId” : 6,
“label” : “label”,
“xmlToString” : “xmlToString”,
“createdDate” : “2000-01-23T04:56:07.000+00:00”,
“controlType” : “TEXTAREA”,
“isReqAdvisorEnabled” : true,
“createdBy” : 4,
“sortOrder” : 6,
“modifiedDate” : “2000-01-23T04:56:07.000+00:00”,
“isInherited” : true,
“triggerSuspect” : true
}, {
“documentField” : {
“isDerived” : true,
“scopeId” : 0,
“userConfigurable” : true,
“custom” : true,
“dataType” : “INTEGER”,
“description” : “description”,
“readOnly” : true,
“xmlToString” : “xmlToString”,
“editXtype” : “editXtype”,
“organizationId” : 7,
“createdDate” : “2000-01-23T04:56:07.000+00:00”,
“formXtype” : “formXtype”,
“createdBy” : 6,
“newObject” : true,
“name” : “name”,
“modifiedDate” : “2000-01-23T04:56:07.000+00:00”,
“modifiedBy” : 3,
“id” : 3,
“refId” : 7,
“category” : 5,
“gridXtype” : “gridXtype”,
“scopeByType” : “SYSTEM”,
“fieldType” : 6
},
“description” : “description”,
“defaultTemplateId” : 0,
“isSynchronizeField” : true,
“required” : true,
“controlStyle” : “controlStyle”,
“organizationId” : 3,
“newObject” : true,
“infotip” : “infotip”,
“modifiedBy” : 8,
“id” : 7,
“readOnlyAllowApiOverwrite” : true,
“shouldVersion” : true,
“readOnly” : true,
“lookupTypeId” : 6,
“label” : “label”,
“xmlToString” : “xmlToString”,
“createdDate” : “2000-01-23T04:56:07.000+00:00”,
“controlType” : “TEXTAREA”,
“isReqAdvisorEnabled” : true,
“createdBy” : 4,
“sortOrder” : 6,
“modifiedDate” : “2000-01-23T04:56:07.000+00:00”,
“isInherited” : true,
“triggerSuspect” : true
} ],
“createdDate” : “2000-01-23T04:56:07.000+00:00”,
“createdBy” : 5,
“newObject” : true,
“modifiedDate” : “2000-01-23T04:56:07.000+00:00”,
“hasCustomImage” : true,
“modifiedBy” : 3,
“id” : 4,
“category” : “CORE”,
“documentTypeFacets” : [ {
“organizationId” : 7,
“isSyncedFacet” : true,
“id” : 3,
“facet” : “ACTIVITIES”
}, {
“organizationId” : 7,
“isSyncedFacet” : true,
“id” : 3,
“facet” : “ACTIVITIES”
} ],
“displayPlural” : “displayPlural”
},
“id” : 6
}, {
“organizationId” : 4,
“forCoverage” : true,
“relationshipType” : {
“image” : “image”,
“scopeId” : 6,
“showNote” : true,
“description” : “description”,
“active” : true,
“showStatus” : true,
“xmlToString” : “xmlToString”,
“organizationId” : 3,
“isDefault” : true,
“createdDate” : “2000-01-23T04:56:07.000+00:00”,
“createdBy” : 8,
“newObject” : true,
“sortOrder” : 6,
“name” : “name”,
“modifiedDate” : “2000-01-23T04:56:07.000+00:00”,
“modifiedBy” : 9,
“id” : 6,
“refId” : 1,
“scopeByType” : “SYSTEM”
},
“fromDocType” : {
“image” : “image”,
“workflowFieldId” : 2,
“display” : “display”,
“description” : “description”,
“active” : true,
“xmlToString” : “xmlToString”,
“documentTypeKey” : “documentTypeKey”,
“organizationId” : 0,
“documentTypeFields” : [ {
“documentField” : {
“isDerived” : true,
“scopeId” : 0,
“userConfigurable” : true,
“custom” : true,
“dataType” : “INTEGER”,
“description” : “description”,
“readOnly” : true,
“xmlToString” : “xmlToString”,
“editXtype” : “editXtype”,
“organizationId” : 7,
“createdDate” : “2000-01-23T04:56:07.000+00:00”,
“formXtype” : “formXtype”,
“createdBy” : 6,
“newObject” : true,
“name” : “name”,
“modifiedDate” : “2000-01-23T04:56:07.000+00:00”,
“modifiedBy” : 3,
“id” : 3,
“refId” : 7,
“category” : 5,
“gridXtype” : “gridXtype”,
“scopeByType” : “SYSTEM”,
“fieldType” : 6
},
“description” : “description”,
“defaultTemplateId” : 0,
“isSynchronizeField” : true,
“required” : true,
“controlStyle” : “controlStyle”,
“organizationId” : 3,
“newObject” : true,
“infotip” : “infotip”,
“modifiedBy” : 8,
“id” : 7,
“readOnlyAllowApiOverwrite” : true,
“shouldVersion” : true,
“readOnly” : true,
“lookupTypeId” : 6,
“label” : “label”,
“xmlToString” : “xmlToString”,
“createdDate” : “2000-01-23T04:56:07.000+00:00”,
“controlType” : “TEXTAREA”,
“isReqAdvisorEnabled” : true,
“createdBy” : 4,
“sortOrder” : 6,
“modifiedDate” : “2000-01-23T04:56:07.000+00:00”,
“isInherited” : true,
“triggerSuspect” : true
}, {
“documentField” : {
“isDerived” : true,
“scopeId” : 0,
“userConfigurable” : true,
“custom” : true,
“dataType” : “INTEGER”,
“description” : “description”,
“readOnly” : true,
“xmlToString” : “xmlToString”,
“editXtype” : “editXtype”,
“organizationId” : 7,
“createdDate” : “2000-01-23T04:56:07.000+00:00”,
“formXtype” : “formXtype”,
“createdBy” : 6,
“newObject” : true,
“name” : “name”,
“modifiedDate” : “2000-01-23T04:56:07.000+00:00”,
“modifiedBy” : 3,
“id” : 3,
“refId” : 7,
“category” : 5,
“gridXtype” : “gridXtype”,
“scopeByType” : “SYSTEM”,
“fieldType” : 6
},
“description” : “description”,
“defaultTemplateId” : 0,
“isSynchronizeField” : true,
“required” : true,
“controlStyle” : “controlStyle”,
“organizationId” : 3,
“newObject” : true,
“infotip” : “infotip”,
“modifiedBy” : 8,
“id” : 7,
“readOnlyAllowApiOverwrite” : true,
“shouldVersion” : true,
“readOnly” : true,
“lookupTypeId” : 6,
“label” : “label”,
“xmlToString” : “xmlToString”,
“createdDate” : “2000-01-23T04:56:07.000+00:00”,
“controlType” : “TEXTAREA”,
“isReqAdvisorEnabled” : true,
“createdBy” : 4,
“sortOrder” : 6,
“modifiedDate” : “2000-01-23T04:56:07.000+00:00”,
“isInherited” : true,
“triggerSuspect” : true
} ],
“createdDate” : “2000-01-23T04:56:07.000+00:00”,
“createdBy” : 5,
“newObject” : true,
“modifiedDate” : “2000-01-23T04:56:07.000+00:00”,
“hasCustomImage” : true,
“modifiedBy” : 3,
“id” : 4,
“category” : “CORE”,
“documentTypeFacets” : [ {
“organizationId” : 7,
“isSyncedFacet” : true,
“id” : 3,
“facet” : “ACTIVITIES”
}, {
“organizationId” : 7,
“isSyncedFacet” : true,
“id” : 3,
“facet” : “ACTIVITIES”
} ],
“displayPlural” : “displayPlural”
},
“id” : 6
} ],
“id” : 1
}
},
“diagramGraphXml” : “diagramGraphXml”,
“xmlToString” : “xmlToString”,
“organizationId” : 0,
“system” : true,
“createdDate” : “2000-01-23T04:56:07.000+00:00”,
“fileSize” : 0,
“diagramHeight” : 1,
“createdBy” : 3,
“newObject” : true,
“organization” : {
“redirectUrl” : “redirectUrl”,
“licenseMessage” : 6,
“description” : “description”,
“xmlToString” : “xmlToString”,
“organizationId” : 2,
“baseUrl” : “baseUrl”,
“createdDate” : “2000-01-23T04:56:07.000+00:00”,
“createdBy” : 1,
“newObject” : true,
“name” : “name”,
“modifiedDate” : “2000-01-23T04:56:07.000+00:00”,
“closed” : true,
“subdomain” : “subdomain”,
“modifiedBy” : 5,
“returnEmail” : “returnEmail”,
“id” : 5
},
“diagramImageXml” : “diagramImageXml”,
“modifiedDate” : “2000-01-23T04:56:07.000+00:00”,
“modifiedBy” : 9,
“id” : 8,
“diagramWidth” : 9
}, {
“fileName” : “fileName”,
“attachmentTypeId” : 8,
“description” : “description”,
“project” : {
“parent” : 7,
“projectType” : {
“components” : “components”,
“scopeId” : 0,
“description” : “description”,
“xmlToString” : “xmlToString”,
“organizationId” : 3,
“createdDate” : “2000-01-23T04:56:07.000+00:00”,
“createdBy” : 6,
“newObject” : true,
“name” : “name”,
“defaultDisplay” : “defaultDisplay”,
“modifiedDate” : “2000-01-23T04:56:07.000+00:00”,
“defaultPrefix” : “defaultPrefix”,
“defaultDisplayPlural” : “defaultDisplayPlural”,
“modifiedBy” : 8,
“id” : 4,
“refId” : 2,
“scopeByType” : “SYSTEM”
},
“description” : “description”,
“flag2” : true,
“flag1” : true,
“organizationId” : 4,
“projectKey” : “projectKey”,
“string3” : “string3”,
“string4” : “string4”,
“string1” : “string1”,
“newObject” : true,
“string2” : “string2”,
“modifiedBy” : 8,
“id” : 6,
“user1” : {
“lastName” : “lastName”,
“active” : true,
“customData” : [ {
“name” : “name”,
“value” : “value”
}, {
“name” : “name”,
“value” : “value”
} ],
“title” : “title”,
“type” : “users”,
“firstName” : “firstName”,
“licenseType” : “NAMED”,
“uid” : “uid”,
“phone” : “phone”,
“location” : “location”,
“id” : 9,
“authenticationType” : {
“name” : “name”,
“id” : 3
},
“email” : “email”,
“username” : “username”
},
“active” : true,
“date2” : “2000-01-23T04:56:07.000+00:00”,
“xmlToString” : “xmlToString”,
“date1” : “2000-01-23T04:56:07.000+00:00”,
“defaultDashboard” : {
“scopeId” : 5,
“xmlToString” : “xmlToString”,
“dashboardName” : “dashboardName”,
“layout” : “SINGLE_COLUMN”,
“organizationId” : 7,
“createdDate” : “2000-01-23T04:56:07.000+00:00”,
“createdBy” : 0,
“newObject” : true,
“modifiedDate” : “2000-01-23T04:56:07.000+00:00”,
“modifiedBy” : 9,
“id” : 0,
“refId” : 4,
“portletInstances” : [ {
“organizationId” : 9,
“location” : “location”,
“portlet” : “FILTER_RESULTS”,
“id” : 7,
“properties” : {
“key” : “properties”
}
}, {
“organizationId” : 9,
“location” : “location”,
“portlet” : “FILTER_RESULTS”,
“id” : 7,
“properties” : {
“key” : “properties”
}
} ],
“scopeByType” : “SYSTEM”
},
“lookup1” : {
“image” : “image”,
“color” : “color”,
“dataValue” : “dataValue”,
“description” : “description”,
“active” : true,
“lookupType” : {
“lookups” : [ null, null ],
“scopeId” : 6,
“description” : “description”,
“active” : true,
“xmlToString” : “xmlToString”,
“type” : 2,
“organizationId” : 1,
“createdDate” : “2000-01-23T04:56:07.000+00:00”,
“createdBy” : 7,
“newObject” : true,
“name” : “name”,
“modifiedDate” : “2000-01-23T04:56:07.000+00:00”,
“modifiedBy” : 1,
“id” : 1,
“refId” : 7,
“category” : 4,
“scopeByType” : “SYSTEM”
},
“xmlToString” : “xmlToString”,
“organizationId” : 9,
“archived” : true,
“isDefault” : true,
“createdDate” : “2000-01-23T04:56:07.000+00:00”,
“createdBy” : 4,
“newObject” : true,
“sortOrder” : 1,
“name” : “name”,
“modifiedDate” : “2000-01-23T04:56:07.000+00:00”,
“infotip” : “infotip”,
“modifiedBy” : 5,
“id” : 9
},
“isFolder” : true,
“createdDate” : “2000-01-23T04:56:07.000+00:00”,
“text3” : “text3”,
“createdBy” : 1,
“text1” : “text1”,
“text2” : “text2”,
“name” : “name”,
“modifiedDate” : “2000-01-23T04:56:07.000+00:00”,
“relationshipRuleSet” : {
“organizationId” : 4,
“isExclusive” : true,
“name” : “name”,
“rules” : [ {
“organizationId” : 4,
“forCoverage” : true,
“relationshipType” : {
“image” : “image”,
“scopeId” : 6,
“showNote” : true,
“description” : “description”,
“active” : true,
“showStatus” : true,
“xmlToString” : “xmlToString”,
“organizationId” : 3,
“isDefault” : true,
“createdDate” : “2000-01-23T04:56:07.000+00:00”,
“createdBy” : 8,
“newObject” : true,
“sortOrder” : 6,
“name” : “name”,
“modifiedDate” : “2000-01-23T04:56:07.000+00:00”,
“modifiedBy” : 9,
“id” : 6,
“refId” : 1,
“scopeByType” : “SYSTEM”
},
“fromDocType” : {
“image” : “image”,
“workflowFieldId” : 2,
“display” : “display”,
“description” : “description”,
“active” : true,
“xmlToString” : “xmlToString”,
“documentTypeKey” : “documentTypeKey”,
“organizationId” : 0,
“documentTypeFields” : [ {
“documentField” : {
“isDerived” : true,
“scopeId” : 0,
“userConfigurable” : true,
“custom” : true,
“dataType” : “INTEGER”,
“description” : “description”,
“readOnly” : true,
“xmlToString” : “xmlToString”,
“editXtype” : “editXtype”,
“organizationId” : 7,
“createdDate” : “2000-01-23T04:56:07.000+00:00”,
“formXtype” : “formXtype”,
“createdBy” : 6,
“newObject” : true,
“name” : “name”,
“modifiedDate” : “2000-01-23T04:56:07.000+00:00”,
“modifiedBy” : 3,
“id” : 3,
“refId” : 7,
“category” : 5,
“gridXtype” : “gridXtype”,
“scopeByType” : “SYSTEM”,
“fieldType” : 6
},
“description” : “description”,
“defaultTemplateId” : 0,
“isSynchronizeField” : true,
“required” : true,
“controlStyle” : “controlStyle”,
“organizationId” : 3,
“newObject” : true,
“infotip” : “infotip”,
“modifiedBy” : 8,
“id” : 7,
“readOnlyAllowApiOverwrite” : true,
“shouldVersion” : true,
“readOnly” : true,
“lookupTypeId” : 6,
“label” : “label”,
“xmlToString” : “xmlToString”,
“createdDate” : “2000-01-23T04:56:07.000+00:00”,
“controlType” : “TEXTAREA”,
“isReqAdvisorEnabled” : true,
“createdBy” : 4,
“sortOrder” : 6,
“modifiedDate” : “2000-01-23T04:56:07.000+00:00”,
“isInherited” : true,
“triggerSuspect” : true
}, {
“documentField” : {
“isDerived” : true,
“scopeId” : 0,
“userConfigurable” : true,
“custom” : true,
“dataType” : “INTEGER”,
“description” : “description”,
“readOnly” : true,
“xmlToString” : “xmlToString”,
“editXtype” : “editXtype”,
“organizationId” : 7,
“createdDate” : “2000-01-23T04:56:07.000+00:00”,
“formXtype” : “formXtype”,
“createdBy” : 6,
“newObject” : true,
“name” : “name”,
“modifiedDate” : “2000-01-23T04:56:07.000+00:00”,
“modifiedBy” : 3,
“id” : 3,
“refId” : 7,
“category” : 5,
“gridXtype” : “gridXtype”,
“scopeByType” : “SYSTEM”,
“fieldType” : 6
},
“description” : “description”,
“defaultTemplateId” : 0,
“isSynchronizeField” : true,
“required” : true,
“controlStyle” : “controlStyle”,
“organizationId” : 3,
“newObject” : true,
“infotip” : “infotip”,
“modifiedBy” : 8,
“id” : 7,
“readOnlyAllowApiOverwrite” : true,
“shouldVersion” : true,
“readOnly” : true,
“lookupTypeId” : 6,
“label” : “label”,
“xmlToString” : “xmlToString”,
“createdDate” : “2000-01-23T04:56:07.000+00:00”,
“controlType” : “TEXTAREA”,
“isReqAdvisorEnabled” : true,
“createdBy” : 4,
“sortOrder” : 6,
“modifiedDate” : “2000-01-23T04:56:07.000+00:00”,
“isInherited” : true,
“triggerSuspect” : true
} ],
“createdDate” : “2000-01-23T04:56:07.000+00:00”,
“createdBy” : 5,
“newObject” : true,
“modifiedDate” : “2000-01-23T04:56:07.000+00:00”,
“hasCustomImage” : true,
“modifiedBy” : 3,
“id” : 4,
“category” : “CORE”,
“documentTypeFacets” : [ {
“organizationId” : 7,
“isSyncedFacet” : true,
“id” : 3,
“facet” : “ACTIVITIES”
}, {
“organizationId” : 7,
“isSyncedFacet” : true,
“id” : 3,
“facet” : “ACTIVITIES”
} ],
“displayPlural” : “displayPlural”
},
“id” : 6
}, {
“organizationId” : 4,
“forCoverage” : true,
“relationshipType” : {
“image” : “image”,
“scopeId” : 6,
“showNote” : true,
“description” : “description”,
“active” : true,
“showStatus” : true,
“xmlToString” : “xmlToString”,
“organizationId” : 3,
“isDefault” : true,
“createdDate” : “2000-01-23T04:56:07.000+00:00”,
“createdBy” : 8,
“newObject” : true,
“sortOrder” : 6,
“name” : “name”,
“modifiedDate” : “2000-01-23T04:56:07.000+00:00”,
“modifiedBy” : 9,
“id” : 6,
“refId” : 1,
“scopeByType” : “SYSTEM”
},
“fromDocType” : {
“image” : “image”,
“workflowFieldId” : 2,
“display” : “display”,
“description” : “description”,
“active” : true,
“xmlToString” : “xmlToString”,
“documentTypeKey” : “documentTypeKey”,
“organizationId” : 0,
“documentTypeFields” : [ {
“documentField” : {
“isDerived” : true,
“scopeId” : 0,
“userConfigurable” : true,
“custom” : true,
“dataType” : “INTEGER”,
“description” : “description”,
“readOnly” : true,
“xmlToString” : “xmlToString”,
“editXtype” : “editXtype”,
“organizationId” : 7,
“createdDate” : “2000-01-23T04:56:07.000+00:00”,
“formXtype” : “formXtype”,
“createdBy” : 6,
“newObject” : true,
“name” : “name”,
“modifiedDate” : “2000-01-23T04:56:07.000+00:00”,
“modifiedBy” : 3,
“id” : 3,
“refId” : 7,
“category” : 5,
“gridXtype” : “gridXtype”,
“scopeByType” : “SYSTEM”,
“fieldType” : 6
},
“description” : “description”,
“defaultTemplateId” : 0,
“isSynchronizeField” : true,
“required” : true,
“controlStyle” : “controlStyle”,
“organizationId” : 3,
“newObject” : true,
“infotip” : “infotip”,
“modifiedBy” : 8,
“id” : 7,
“readOnlyAllowApiOverwrite” : true,
“shouldVersion” : true,
“readOnly” : true,
“lookupTypeId” : 6,
“label” : “label”,
“xmlToString” : “xmlToString”,
“createdDate” : “2000-01-23T04:56:07.000+00:00”,
“controlType” : “TEXTAREA”,
“isReqAdvisorEnabled” : true,
“createdBy” : 4,
“sortOrder” : 6,
“modifiedDate” : “2000-01-23T04:56:07.000+00:00”,
“isInherited” : true,
“triggerSuspect” : true
}, {
“documentField” : {
“isDerived” : true,
“scopeId” : 0,
“userConfigurable” : true,
“custom” : true,
“dataType” : “INTEGER”,
“description” : “description”,
“readOnly” : true,
“xmlToString” : “xmlToString”,
“editXtype” : “editXtype”,
“organizationId” : 7,
“createdDate” : “2000-01-23T04:56:07.000+00:00”,
“formXtype” : “formXtype”,
“createdBy” : 6,
“newObject” : true,
“name” : “name”,
“modifiedDate” : “2000-01-23T04:56:07.000+00:00”,
“modifiedBy” : 3,
“id” : 3,
“refId” : 7,
“category” : 5,
“gridXtype” : “gridXtype”,
“scopeByType” : “SYSTEM”,
“fieldType” : 6
},
“description” : “description”,
“defaultTemplateId” : 0,
“isSynchronizeField” : true,
“required” : true,
“controlStyle” : “controlStyle”,
“organizationId” : 3,
“newObject” : true,
“infotip” : “infotip”,
“modifiedBy” : 8,
“id” : 7,
“readOnlyAllowApiOverwrite” : true,
“shouldVersion” : true,
“readOnly” : true,
“lookupTypeId” : 6,
“label” : “label”,
“xmlToString” : “xmlToString”,
“createdDate” : “2000-01-23T04:56:07.000+00:00”,
“controlType” : “TEXTAREA”,
“isReqAdvisorEnabled” : true,
“createdBy” : 4,
“sortOrder” : 6,
“modifiedDate” : “2000-01-23T04:56:07.000+00:00”,
“isInherited” : true,
“triggerSuspect” : true
} ],
“createdDate” : “2000-01-23T04:56:07.000+00:00”,
“createdBy” : 5,
“newObject” : true,
“modifiedDate” : “2000-01-23T04:56:07.000+00:00”,
“hasCustomImage” : true,
“modifiedBy” : 3,
“id” : 4,
“category” : “CORE”,
“documentTypeFacets” : [ {
“organizationId” : 7,
“isSyncedFacet” : true,
“id” : 3,
“facet” : “ACTIVITIES”
}, {
“organizationId” : 7,
“isSyncedFacet” : true,
“id” : 3,
“facet” : “ACTIVITIES”
} ],
“displayPlural” : “displayPlural”
},
“id” : 6
} ],
“id” : 1
}
},
“diagramGraphXml” : “diagramGraphXml”,
“xmlToString” : “xmlToString”,
“organizationId” : 0,
“system” : true,
“createdDate” : “2000-01-23T04:56:07.000+00:00”,
“fileSize” : 0,
“diagramHeight” : 1,
“createdBy” : 3,
“newObject” : true,
“organization” : {
“redirectUrl” : “redirectUrl”,
“licenseMessage” : 6,
“description” : “description”,
“xmlToString” : “xmlToString”,
“organizationId” : 2,
“baseUrl” : “baseUrl”,
“createdDate” : “2000-01-23T04:56:07.000+00:00”,
“createdBy” : 1,
“newObject” : true,
“name” : “name”,
“modifiedDate” : “2000-01-23T04:56:07.000+00:00”,
“closed” : true,
“subdomain” : “subdomain”,
“modifiedBy” : 5,
“returnEmail” : “returnEmail”,
“id” : 5
},
“diagramImageXml” : “diagramImageXml”,
“modifiedDate” : “2000-01-23T04:56:07.000+00:00”,
“modifiedBy” : 9,
“id” : 8,
“diagramWidth” : 9
} ],
“meta” : {
“pageInfo” : {
“startIndex” : 0,
“resultCount” : 6,
“totalResults” : 1
},
“status” : “OK”,
“timestamp” : “2000-01-23T04:56:07.000+00:00”
},
“links” : {
“key” : {
“href” : “href”,
“type” : “type”
}
}
}
Produces: API call produces the following media types according to the
Accept request header;
the media type will be conveyed by the Content-Type response header:
- application/json
Response:
AttachmentDataListWrapper
GET /testplans/{id}/downstreamrelated
Summary: Get all downstream related items for the test plan with the specified ID
Path parameters:
- id
(required)
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” : 6,
“globalId” : “globalId”,
“project” : 1,
“resources” : {
“key” : {
“allowed” : [ “allowed”, “allowed” ]
}
},
“version” : 7,
“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” : 6,
“globalId” : “globalId”,
“project” : 1,
“resources” : {
“key” : {
“allowed” : [ “allowed”, “allowed” ]
}
},
“version” : 7,
“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” : 0,
“resultCount” : 6,
“totalResults” : 1
},
“status” : “OK”,
“timestamp” : “2000-01-23T04:56:07.000+00:00”
},
“links” : {
“key” : {
“href” : “href”,
“type” : “type”
}
}
}
Produces: API call produces the following media types according to the
Accept request header;
the media type will be conveyed by the Content-Type response header:
- application/json
Response:
AbstractItemDataListWrapper
GET /testplans/{id}/downstreamrelationships
Summary: Get all downstream relationships for the test plan with the specified ID
Path parameters:
- id
(required)
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” : 0,
“resultCount” : 6,
“totalResults” : 1
},
“status” : “OK”,
“timestamp” : “2000-01-23T04:56:07.000+00:00”
},
“links” : {
“key” : {
“href” : “href”,
“type” : “type”
}
}
}
Produces: API call produces the following media types according to the
Accept request header;
the media type will be conveyed by the Content-Type response header:
- application/json
Response:
RelationshipDataListWrapper
GET /testplans/{id}/comments
Summary: Get all comments for the item with the specified ID
Path parameters:
- id
(required)
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” : 0,
“resultCount” : 6,
“totalResults” : 1
},
“status” : “OK”,
“timestamp” : “2000-01-23T04:56:07.000+00:00”
},
“links” : {
“key” : {
“href” : “href”,
“type” : “type”
}
}
}
Produces: API call produces the following media types according to the
Accept request header;
the media type will be conveyed by the Content-Type response header:
- application/json
Response:
CommentDataListWrapper
GET /testplans/{id}/links
Summary: Get all links for the item with the specified ID
Path parameters:
- id
(required)
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” : 0,
“resultCount” : 6,
“totalResults” : 1
},
“status” : “OK”,
“timestamp” : “2000-01-23T04:56:07.000+00:00”
},
“links” : { }
}
Produces: API call produces the following media types according to the
Accept request header;
the media type will be conveyed by the Content-Type response header:
- application/json
Response:
LinkDataListWrapper
GET /testplans/{id}/links/{linkId}
Summary: Get the link with the specified ID
Path parameters:
- linkId
(required)
- id
(required)
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” : { }
}
Produces: API call produces the following media types according to the
Accept request header;
the media type will be conveyed by the Content-Type response header:
- application/json
Response:
LinkDataWrapper
GET /testplans/{id}/lock
Summary: Get the locked state, last locked date, and last locked by user for the item with the specified ID
Path parameters:
- id
(required)
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”
}
}
}
Produces: API call produces the following media types according to the
Accept request header;
the media type will be conveyed by the Content-Type response header:
- application/json
Response:
LockDataWrapper
GET /testplans/{id}/tags/{tagId}
Summary: Get the tag with the specified ID
Path parameters:
- tagId
(required)
- id
(required)
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”
}
}
}
Produces: API call produces the following media types according to the
Accept request header;
the media type will be conveyed by the Content-Type response header:
- application/json
Response:
TagDataWrapper
GET /testplans/{id}/tags
Summary: Get all tags for the item with the specified ID
Path parameters:
- id
(required)
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” : 0,
“resultCount” : 6,
“totalResults” : 1
},
“status” : “OK”,
“timestamp” : “2000-01-23T04:56:07.000+00:00”
},
“links” : {
“key” : {
“href” : “href”,
“type” : “type”
}
}
}
Produces: API call produces the following media types according to the
Accept request header;
the media type will be conveyed by the Content-Type response header:
- application/json
Response:
TagDataListWrapper
GET /testplans/{id}/testgroups/{testGroupId}/testcases/{testCaseId}
Summary: Get the test case with the specified ID
Path parameters:
- testCaseId
(required)
- testGroupId
(required)
- id
(required)
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” : 6,
“globalId” : “globalId”,
“project” : 1,
“resources” : {
“key” : {
“allowed” : [ “allowed”, “allowed” ]
}
},
“childItemType” : 4,
“version” : 2,
“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” : 5,
“location” : {
“sequence” : “sequence”,
“parent” : {
“item” : 2,
“project” : 3
},
“sortOrder” : 7,
“globalSortOrder” : 9
},
“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”
}
}
}
Produces: API call produces the following media types according to the
Accept request header;
the media type will be conveyed by the Content-Type response header:
- application/json
Response:
ItemDataWrapper
GET /testplans/{id}/testgroups/{testGroupId}/testcases
Summary: Get all test cases associated with the test group with the specified ID
Path parameters:
- testGroupId
(required)
- id
(required)
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” : 6,
“globalId” : “globalId”,
“project” : 1,
“resources” : {
“key” : {
“allowed” : [ “allowed”, “allowed” ]
}
},
“childItemType” : 4,
“version” : 2,
“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” : 5,
“location” : {
“sequence” : “sequence”,
“parent” : {
“item” : 2,
“project” : 3
},
“sortOrder” : 7,
“globalSortOrder” : 9
},
“id” : 0,
“fields” : {
“key” : { }
},
“baselinedAppliedCategorySnapshots” : [ {
“categoryPathSequence” : “categoryPathSequence”,
“itemVersionNumberApplied” : 2
}, {
“categoryPathSequence” : “categoryPathSequence”,
“itemVersionNumberApplied” : 2
} ]
}, {
“itemType” : 6,
“globalId” : “globalId”,
“project” : 1,
“resources” : {
“key” : {
“allowed” : [ “allowed”, “allowed” ]
}
},
“childItemType” : 4,
“version” : 2,
“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” : 5,
“location” : {
“sequence” : “sequence”,
“parent” : {
“item” : 2,
“project” : 3
},
“sortOrder” : 7,
“globalSortOrder” : 9
},
“id” : 0,
“fields” : {
“key” : { }
},
“baselinedAppliedCategorySnapshots” : [ {
“categoryPathSequence” : “categoryPathSequence”,
“itemVersionNumberApplied” : 2
}, {
“categoryPathSequence” : “categoryPathSequence”,
“itemVersionNumberApplied” : 2
} ]
} ],
“meta” : {
“pageInfo” : {
“startIndex” : 0,
“resultCount” : 6,
“totalResults” : 1
},
“status” : “OK”,
“timestamp” : “2000-01-23T04:56:07.000+00:00”
},
“links” : {
“key” : {
“href” : “href”,
“type” : “type”
}
}
}
Produces: API call produces the following media types according to the
Accept request header;
the media type will be conveyed by the Content-Type response header:
- application/json
Response:
ItemDataListWrapper
GET /testplans/{id}/testcycles
Summary: Get all test cycles for the test plan with the specified ID
Path parameters:
- id
(required)
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” : 6,
“globalId” : “globalId”,
“project” : 1,
“resources” : {
“key” : {
“allowed” : [ “allowed”, “allowed” ]
}
},
“version” : 2,
“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” : 6,
“globalId” : “globalId”,
“project” : 1,
“resources” : {
“key” : {
“allowed” : [ “allowed”, “allowed” ]
}
},
“version” : 2,
“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” : 0,
“resultCount” : 6,
“totalResults” : 1
},
“status” : “OK”,
“timestamp” : “2000-01-23T04:56:07.000+00:00”
},
“links” : {
“key” : {
“href” : “href”,
“type” : “type”
}
}
}
Produces: API call produces the following media types according to the
Accept request header;
the media type will be conveyed by the Content-Type response header:
- application/json
Response:
TestCycleDataListWrapper
GET /testplans/{id}/testgroups/{testGroupId}
Summary: Get the test group with the specified ID
Path parameters:
- testGroupId
(required)
- id
(required)
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”
}
}
}
Produces: API call produces the following media types according to the
Accept request header;
the media type will be conveyed by the Content-Type response header:
- application/json
Response:
TestGroupDataWrapper
GET /testplans/{id}/testgroups
Summary: Get all test groups for the test plan with the specified ID
Path parameters:
- id
(required)
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” : 0,
“resultCount” : 6,
“totalResults” : 1
},
“status” : “OK”,
“timestamp” : “2000-01-23T04:56:07.000+00:00”
},
“links” : {
“key” : {
“href” : “href”,
“type” : “type”
}
}
}
Produces: API call produces the following media types according to the
Accept request header;
the media type will be conveyed by the Content-Type response header:
- application/json
Response:
TestGroupDataListWrapper
GET /testplans/{id}
Summary: Get the test plan with the specified ID
Path parameters:
- id
(required)
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” : 6,
“globalId” : “globalId”,
“project” : 1,
“resources” : {
“key” : {
“allowed” : [ “allowed”, “allowed” ]
}
},
“version” : 2,
“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”
}
}
}
Produces: API call produces the following media types according to the
Accept request header;
the media type will be conveyed by the Content-Type response header:
- application/json
Response:
TestPlanDataWrapper
GET /testplans
Summary: Get all test plans in the project with the specified ID
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” : 6,
“globalId” : “globalId”,
“project” : 1,
“resources” : {
“key” : {
“allowed” : [ “allowed”, “allowed” ]
}
},
“version” : 2,
“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” : 6,
“globalId” : “globalId”,
“project” : 1,
“resources” : {
“key” : {
“allowed” : [ “allowed”, “allowed” ]
}
},
“version” : 2,
“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” : 0,
“resultCount” : 6,
“totalResults” : 1
},
“status” : “OK”,
“timestamp” : “2000-01-23T04:56:07.000+00:00”
},
“links” : {
“key” : {
“href” : “href”,
“type” : “type”
}
}
}
Produces: API call produces the following media types according to the
Accept request header;
the media type will be conveyed by the Content-Type response header:
- application/json
Response:
TestPlanDataListWrapper
GET /testplans/{id}/upstreamrelated
Summary: Get all upstream related items for the test plan with the specified ID
Path parameters:
- id
(required)
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” : 6,
“globalId” : “globalId”,
“project” : 1,
“resources” : {
“key” : {
“allowed” : [ “allowed”, “allowed” ]
}
},
“version” : 7,
“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” : 6,
“globalId” : “globalId”,
“project” : 1,
“resources” : {
“key” : {
“allowed” : [ “allowed”, “allowed” ]
}
},
“version” : 7,
“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” : 0,
“resultCount” : 6,
“totalResults” : 1
},
“status” : “OK”,
“timestamp” : “2000-01-23T04:56:07.000+00:00”
},
“links” : {
“key” : {
“href” : “href”,
“type” : “type”
}
}
}
Produces: API call produces the following media types according to the
Accept request header;
the media type will be conveyed by the Content-Type response header:
- application/json
Response:
AbstractItemDataListWrapper
GET /testplans/{id}/upstreamrelationships
Summary: Get all upstream relationships for the test plan with the specified ID
Path parameters:
- id
(required)
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” : 0,
“resultCount” : 6,
“totalResults” : 1
},
“status” : “OK”,
“timestamp” : “2000-01-23T04:56:07.000+00:00”
},
“links” : {
“key” : {
“href” : “href”,
“type” : “type”
}
}
}
Produces: API call produces the following media types according to the
Accept request header;
the media type will be conveyed by the Content-Type response header:
- application/json
Response:
RelationshipDataListWrapper
GET /testplans/{id}/versions/{versionNum}
Summary: Get the numbered version for the item with the specified ID
Path parameters:
- versionNum
(required)
- id
(required)
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” : 0,
“createdDate” : “2000-01-23T04:56:07.000+00:00”,
“versionedItem” : {
“id” : 2,
“value” : { },
“object” : {
“id” : 1,
“type” : “type”,
“version” : 5,
“currentVersion” : 5
}
},
“createdBy” : 7,
“comment” : “comment”,
“userName” : “userName”,
“type” : “type”,
“versionNumber” : 6,
“changeDetails” : “changeDetails”
},
“meta” : {
“status” : “OK”,
“timestamp” : “2000-01-23T04:56:07.000+00:00”
},
“links” : {
“key” : {
“href” : “href”,
“type” : “type”
}
}
}
Produces: API call produces the following media types according to the
Accept request header;
the media type will be conveyed by the Content-Type response header:
- application/json
Response:
VersionDataWrapper
GET /testplans/{id}/versions/{versionNum}/versioneditem
Summary: Get the snapshot of the test plan at the specified version
Path parameters:
- versionNum
(required)
- id
(required)
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” : 6,
“fileName” : “fileName”,
“globalId” : “globalId”,
“project” : 1,
“resources” : {
“key” : {
“allowed” : [ “allowed”, “allowed” ]
}
},
“mimeType” : “mimeType”,
“version” : 2,
“currentVersion” : 3,
“createdDate” : “2000-01-23T04:56:07.000+00:00”,
“lastActivityDate” : “2000-01-23T04:56:07.000+00:00”,
“createdBy” : 5,
“fileSize” : 9,
“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” : 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”
}
}
}
Produces: API call produces the following media types according to the
Accept request header;
the media type will be conveyed by the Content-Type response header:
- application/json
Response:
VersionedAttachmentDataWrapper
GET /testplans/{id}/versions
Summary: Get all versions for the item with the specified ID
Path parameters:
- id
(required)
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” : 0,
“createdDate” : “2000-01-23T04:56:07.000+00:00”,
“versionedItem” : {
“id” : 2,
“value” : { },
“object” : {
“id” : 1,
“type” : “type”,
“version” : 5,
“currentVersion” : 5
}
},
“createdBy” : 7,
“comment” : “comment”,
“userName” : “userName”,
“type” : “type”,
“versionNumber” : 6,
“changeDetails” : “changeDetails”
}, {
“item” : 0,
“createdDate” : “2000-01-23T04:56:07.000+00:00”,
“versionedItem” : {
“id” : 2,
“value” : { },
“object” : {
“id” : 1,
“type” : “type”,
“version” : 5,
“currentVersion” : 5
}
},
“createdBy” : 7,
“comment” : “comment”,
“userName” : “userName”,
“type” : “type”,
“versionNumber” : 6,
“changeDetails” : “changeDetails”
} ],
“meta” : {
“pageInfo” : {
“startIndex” : 0,
“resultCount” : 6,
“totalResults” : 1
},
“status” : “OK”,
“timestamp” : “2000-01-23T04:56:07.000+00:00”
},
“links” : {
“key” : {
“href” : “href”,
“type” : “type”
}
}
}
Produces: API call produces the following media types according to the
Accept request header;
the media type will be conveyed by the Content-Type response header:
- application/json
Response:
VersionDataListWrapper
PATCH /testplans/{id}
Summary: Update the test plan with the specified ID
Path parameters:
- id
(required)
Consumes: this API call consumes the following media types via the
Content-Type request header:
- application/json
Body:
Examples:
- Example data, content-type: application/json
{
“status” : “OK”,
“timestamp” : “2000-01-23T04:56:07.000+00:00”
}
Produces: API call produces the following media types according to the
Accept request header;
the media type will be conveyed by the Content-Type response header:
- application/json
Response:
MetaWrapper
POST /testplans/{id}/testgroups/{testGroupId}/testcases
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
Content-Type request header:
- application/json
Body:
Examples:
- Example data, content-type: application/json
{
“meta” : {
“location” : “location”,
“id” : 0,
“status” : “OK”,
“timestamp” : “2000-01-23T04:56:07.000+00:00”
}
}
Produces: API call produces the following media types according to the
Accept request header;
the media type will be conveyed by the Content-Type response header:
- application/json
Response:
CreatedResponseDataWrapper
DELETE /testplans/{id}/attachments/{attachmentId}
Summary: Remove an existing attachment from the item
Path parameters:
- attachmentId
(required)
- id
(required)
DELETE /testplans/{id}/tags/{tagId}
Summary: Remove an existing tag from the item with the specified ID
Path parameters:
- tagId
(required)
- id
(required)
PUT /testplans/{id}/archived
Summary: Update the archived status of the test plan
Path parameters:
- id
(required)
Consumes: this API call consumes the following media types via the
Content-Type request header:
- application/json
Body:
Examples:
- Example data, content-type: application/json
{
“status” : “OK”,
“timestamp” : “2000-01-23T04:56:07.000+00:00”
}
Produces: API call produces the following media types according to the
Accept request header;
the media type will be conveyed by the Content-Type response header:
- application/json
Response:
MetaWrapper
PUT /testplans/{id}/links/{linkId}
Summary: Update the link with the specified ID
Path parameters:
- linkId
(required)
- id
(required)
Consumes: this API call consumes the following media types via the
Content-Type request header:
- application/json
Body:
Examples:
- Example data, content-type: application/json
{
“meta” : {
“status” : “OK”,
“timestamp” : “2000-01-23T04:56:07.000+00:00”
}
}
Produces: API call produces the following media types according to the
Accept request header;
the media type will be conveyed by the Content-Type response header:
- application/json
Response:
OkResponseDataWraper
PUT /testplans/{id}/lock
Summary: Update the locked state of the item with the specified ID
Path parameters:
- id
(required)
Consumes: this API call consumes the following media types via the
Content-Type request header:
- application/json
Body:
Examples:
- Example data, content-type: application/json
{
“meta” : {
“status” : “OK”,
“timestamp” : “2000-01-23T04:56:07.000+00:00”
}
}
Produces: API call produces the following media types according to the
Accept request header;
the media type will be conveyed by the Content-Type response header:
- application/json
Response:
OkResponseDataWraper
PUT /testplans/{id}/testgroups/{testGroupId}
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
Content-Type request header:
- application/json
Body:
Examples:
- Example data, content-type: application/json
{
“status” : “OK”,
“timestamp” : “2000-01-23T04:56:07.000+00:00”
}
Produces: API call produces the following media types according to the
Accept request header;
the media type will be conveyed by the Content-Type response header:
- application/json
Response:
MetaWrapper
PUT /testplans/{id}
Summary: Update the test plan with the specified ID
Path parameters:
- id
(required)
Consumes: this API call consumes the following media types via the
Content-Type request header:
- application/json
Body:
Examples:
- Example data, content-type: application/json
{
“status” : “OK”,
“timestamp” : “2000-01-23T04:56:07.000+00:00”
}
Produces: API call produces the following media types according to the
Accept request header;
the media type will be conveyed by the Content-Type response header:
- application/json
Response:
MetaWrapper
Endpoint testruns
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.
POST /testruns/{id}/attachments
Summary: Add an existing attachment to the item with the specified ID
Path parameters:
- id
(required)
Consumes: this API call consumes the following media types via the
Content-Type request header:
- application/json
Body:
Examples:
- Example data, content-type: application/json
{
“meta” : {
“location” : “location”,
“id” : 0,
“status” : “OK”,
“timestamp” : “2000-01-23T04:56:07.000+00:00”
}
}
Produces: API call produces the following media types according to the
Accept request header;
the media type will be conveyed by the Content-Type response header:
- application/json
Response:
CreatedResponseDataWrapper
POST /testruns/{id}/links
Summary: Create a new link for the item with the specified ID
Path parameters:
- id
(required)
Consumes: this API call consumes the following media types via the
Content-Type request header:
- application/json
Body:
Examples:
- Example data, content-type: application/json
{
“meta” : {
“location” : “location”,
“id” : 0,
“status” : “OK”,
“timestamp” : “2000-01-23T04:56:07.000+00:00”
}
}
Produces: API call produces the following media types according to the
Accept request header;
the media type will be conveyed by the Content-Type response header:
- application/json
Response:
CreatedResponseDataWrapper
POST /testruns/{id}/tags
Summary: Add an existing tag to the item with the specified ID
Path parameters:
- id
(required)
Consumes: this API call consumes the following media types via the
Content-Type request header:
- application/json
Body:
Examples:
- Example data, content-type: application/json
{
“meta” : {
“location” : “location”,
“id” : 0,
“status” : “OK”,
“timestamp” : “2000-01-23T04:56:07.000+00:00”
}
}
Produces: API call produces the following media types according to the
Accept request header;
the media type will be conveyed by the Content-Type response header:
- application/json
Response:
CreatedResponseDataWrapper
DELETE /testruns/{id}/links/{linkId}
Summary: Delete the link with the specified ID
Path parameters:
- linkId
(required)
- id
(required)
DELETE /testruns/{id}
Summary: Delete the test run with the specified ID
Path parameters:
- id
(required)
GET /testruns/{id}/activities
Summary: Get all activities for the test run with the specified ID
Path parameters:
- id
(required)
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” : 6,
“itemType” : 5,
“userComment” : “userComment”,
“action” : “action”,
“details” : “details”,
“id” : 0,
“eventType” : “CREATE”,
“userName” : “userName”,
“user” : 1,
“objectType” : “PROJECT”
}, {
“date” : “2000-01-23T04:56:07.000+00:00”,
“item” : 6,
“itemType” : 5,
“userComment” : “userComment”,
“action” : “action”,
“details” : “details”,
“id” : 0,
“eventType” : “CREATE”,
“userName” : “userName”,
“user” : 1,
“objectType” : “PROJECT”
} ],
“meta” : {
“pageInfo” : {
“startIndex” : 0,
“resultCount” : 6,
“totalResults” : 1
},
“status” : “OK”,
“timestamp” : “2000-01-23T04:56:07.000+00:00”
},
“links” : {
“key” : {
“href” : “href”,
“type” : “type”
}
}
}
Produces: API call produces the following media types according to the
Accept request header;
the media type will be conveyed by the Content-Type response header:
- application/json
Response:
ActivityDataListWrapper
GET /testruns/{id}/attachments
Summary: Get all attachments for the item with the specified ID
Path parameters:
- id
(required)
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”,
“attachmentTypeId” : 8,
“description” : “description”,
“project” : {
“parent” : 7,
“projectType” : {
“components” : “components”,
“scopeId” : 0,
“description” : “description”,
“xmlToString” : “xmlToString”,
“organizationId” : 3,
“createdDate” : “2000-01-23T04:56:07.000+00:00”,
“createdBy” : 6,
“newObject” : true,
“name” : “name”,
“defaultDisplay” : “defaultDisplay”,
“modifiedDate” : “2000-01-23T04:56:07.000+00:00”,
“defaultPrefix” : “defaultPrefix”,
“defaultDisplayPlural” : “defaultDisplayPlural”,
“modifiedBy” : 8,
“id” : 4,
“refId” : 2,
“scopeByType” : “SYSTEM”
},
“description” : “description”,
“flag2” : true,
“flag1” : true,
“organizationId” : 4,
“projectKey” : “projectKey”,
“string3” : “string3”,
“string4” : “string4”,
“string1” : “string1”,
“newObject” : true,
“string2” : “string2”,
“modifiedBy” : 8,
“id” : 6,
“user1” : {
“lastName” : “lastName”,
“active” : true,
“customData” : [ {
“name” : “name”,
“value” : “value”
}, {
“name” : “name”,
“value” : “value”
} ],
“title” : “title”,
“type” : “users”,
“firstName” : “firstName”,
“licenseType” : “NAMED”,
“uid” : “uid”,
“phone” : “phone”,
“location” : “location”,
“id” : 9,
“authenticationType” : {
“name” : “name”,
“id” : 3
},
“email” : “email”,
“username” : “username”
},
“active” : true,
“date2” : “2000-01-23T04:56:07.000+00:00”,
“xmlToString” : “xmlToString”,
“date1” : “2000-01-23T04:56:07.000+00:00”,
“defaultDashboard” : {
“scopeId” : 5,
“xmlToString” : “xmlToString”,
“dashboardName” : “dashboardName”,
“layout” : “SINGLE_COLUMN”,
“organizationId” : 7,
“createdDate” : “2000-01-23T04:56:07.000+00:00”,
“createdBy” : 0,
“newObject” : true,
“modifiedDate” : “2000-01-23T04:56:07.000+00:00”,
“modifiedBy” : 9,
“id” : 0,
“refId” : 4,
“portletInstances” : [ {
“organizationId” : 9,
“location” : “location”,
“portlet” : “FILTER_RESULTS”,
“id” : 7,
“properties” : {
“key” : “properties”
}
}, {
“organizationId” : 9,
“location” : “location”,
“portlet” : “FILTER_RESULTS”,
“id” : 7,
“properties” : {
“key” : “properties”
}
} ],
“scopeByType” : “SYSTEM”
},
“lookup1” : {
“image” : “image”,
“color” : “color”,
“dataValue” : “dataValue”,
“description” : “description”,
“active” : true,
“lookupType” : {
“lookups” : [ null, null ],
“scopeId” : 6,
“description” : “description”,
“active” : true,
“xmlToString” : “xmlToString”,
“type” : 2,
“organizationId” : 1,
“createdDate” : “2000-01-23T04:56:07.000+00:00”,
“createdBy” : 7,
“newObject” : true,
“name” : “name”,
“modifiedDate” : “2000-01-23T04:56:07.000+00:00”,
“modifiedBy” : 1,
“id” : 1,
“refId” : 7,
“category” : 4,
“scopeByType” : “SYSTEM”
},
“xmlToString” : “xmlToString”,
“organizationId” : 9,
“archived” : true,
“isDefault” : true,
“createdDate” : “2000-01-23T04:56:07.000+00:00”,
“createdBy” : 4,
“newObject” : true,
“sortOrder” : 1,
“name” : “name”,
“modifiedDate” : “2000-01-23T04:56:07.000+00:00”,
“infotip” : “infotip”,
“modifiedBy” : 5,
“id” : 9
},
“isFolder” : true,
“createdDate” : “2000-01-23T04:56:07.000+00:00”,
“text3” : “text3”,
“createdBy” : 1,
“text1” : “text1”,
“text2” : “text2”,
“name” : “name”,
“modifiedDate” : “2000-01-23T04:56:07.000+00:00”,
“relationshipRuleSet” : {
“organizationId” : 4,
“isExclusive” : true,
“name” : “name”,
“rules” : [ {
“organizationId” : 4,
“forCoverage” : true,
“relationshipType” : {
“image” : “image”,
“scopeId” : 6,
“showNote” : true,
“description” : “description”,
“active” : true,
“showStatus” : true,
“xmlToString” : “xmlToString”,
“organizationId” : 3,
“isDefault” : true,
“createdDate” : “2000-01-23T04:56:07.000+00:00”,
“createdBy” : 8,
“newObject” : true,
“sortOrder” : 6,
“name” : “name”,
“modifiedDate” : “2000-01-23T04:56:07.000+00:00”,
“modifiedBy” : 9,
“id” : 6,
“refId” : 1,
“scopeByType” : “SYSTEM”
},
“fromDocType” : {
“image” : “image”,
“workflowFieldId” : 2,
“display” : “display”,
“description” : “description”,
“active” : true,
“xmlToString” : “xmlToString”,
“documentTypeKey” : “documentTypeKey”,
“organizationId” : 0,
“documentTypeFields” : [ {
“documentField” : {
“isDerived” : true,
“scopeId” : 0,
“userConfigurable” : true,
“custom” : true,
“dataType” : “INTEGER”,
“description” : “description”,
“readOnly” : true,
“xmlToString” : “xmlToString”,
“editXtype” : “editXtype”,
“organizationId” : 7,
“createdDate” : “2000-01-23T04:56:07.000+00:00”,
“formXtype” : “formXtype”,
“createdBy” : 6,
“newObject” : true,
“name” : “name”,
“modifiedDate” : “2000-01-23T04:56:07.000+00:00”,
“modifiedBy” : 3,
“id” : 3,
“refId” : 7,
“category” : 5,
“gridXtype” : “gridXtype”,
“scopeByType” : “SYSTEM”,
“fieldType” : 6
},
“description” : “description”,
“defaultTemplateId” : 0,
“isSynchronizeField” : true,
“required” : true,
“controlStyle” : “controlStyle”,
“organizationId” : 3,
“newObject” : true,
“infotip” : “infotip”,
“modifiedBy” : 8,
“id” : 7,
“readOnlyAllowApiOverwrite” : true,
“shouldVersion” : true,
“readOnly” : true,
“lookupTypeId” : 6,
“label” : “label”,
“xmlToString” : “xmlToString”,
“createdDate” : “2000-01-23T04:56:07.000+00:00”,
“controlType” : “TEXTAREA”,
“isReqAdvisorEnabled” : true,
“createdBy” : 4,
“sortOrder” : 6,
“modifiedDate” : “2000-01-23T04:56:07.000+00:00”,
“isInherited” : true,
“triggerSuspect” : true
}, {
“documentField” : {
“isDerived” : true,
“scopeId” : 0,
“userConfigurable” : true,
“custom” : true,
“dataType” : “INTEGER”,
“description” : “description”,
“readOnly” : true,
“xmlToString” : “xmlToString”,
“editXtype” : “editXtype”,
“organizationId” : 7,
“createdDate” : “2000-01-23T04:56:07.000+00:00”,
“formXtype” : “formXtype”,
“createdBy” : 6,
“newObject” : true,
“name” : “name”,
“modifiedDate” : “2000-01-23T04:56:07.000+00:00”,
“modifiedBy” : 3,
“id” : 3,
“refId” : 7,
“category” : 5,
“gridXtype” : “gridXtype”,
“scopeByType” : “SYSTEM”,
“fieldType” : 6
},
“description” : “description”,
“defaultTemplateId” : 0,
“isSynchronizeField” : true,
“required” : true,
“controlStyle” : “controlStyle”,
“organizationId” : 3,
“newObject” : true,
“infotip” : “infotip”,
“modifiedBy” : 8,
“id” : 7,
“readOnlyAllowApiOverwrite” : true,
“shouldVersion” : true,
“readOnly” : true,
“lookupTypeId” : 6,
“label” : “label”,
“xmlToString” : “xmlToString”,
“createdDate” : “2000-01-23T04:56:07.000+00:00”,
“controlType” : “TEXTAREA”,
“isReqAdvisorEnabled” : true,
“createdBy” : 4,
“sortOrder” : 6,
“modifiedDate” : “2000-01-23T04:56:07.000+00:00”,
“isInherited” : true,
“triggerSuspect” : true
} ],
“createdDate” : “2000-01-23T04:56:07.000+00:00”,
“createdBy” : 5,
“newObject” : true,
“modifiedDate” : “2000-01-23T04:56:07.000+00:00”,
“hasCustomImage” : true,
“modifiedBy” : 3,
“id” : 4,
“category” : “CORE”,
“documentTypeFacets” : [ {
“organizationId” : 7,
“isSyncedFacet” : true,
“id” : 3,
“facet” : “ACTIVITIES”
}, {
“organizationId” : 7,
“isSyncedFacet” : true,
“id” : 3,
“facet” : “ACTIVITIES”
} ],
“displayPlural” : “displayPlural”
},
“id” : 6
}, {
“organizationId” : 4,
“forCoverage” : true,
“relationshipType” : {
“image” : “image”,
“scopeId” : 6,
“showNote” : true,
“description” : “description”,
“active” : true,
“showStatus” : true,
“xmlToString” : “xmlToString”,
“organizationId” : 3,
“isDefault” : true,
“createdDate” : “2000-01-23T04:56:07.000+00:00”,
“createdBy” : 8,
“newObject” : true,
“sortOrder” : 6,
“name” : “name”,
“modifiedDate” : “2000-01-23T04:56:07.000+00:00”,
“modifiedBy” : 9,
“id” : 6,
“refId” : 1,
“scopeByType” : “SYSTEM”
},
“fromDocType” : {
“image” : “image”,
“workflowFieldId” : 2,
“display” : “display”,
“description” : “description”,
“active” : true,
“xmlToString” : “xmlToString”,
“documentTypeKey” : “documentTypeKey”,
“organizationId” : 0,
“documentTypeFields” : [ {
“documentField” : {
“isDerived” : true,
“scopeId” : 0,
“userConfigurable” : true,
“custom” : true,
“dataType” : “INTEGER”,
“description” : “description”,
“readOnly” : true,
“xmlToString” : “xmlToString”,
“editXtype” : “editXtype”,
“organizationId” : 7,
“createdDate” : “2000-01-23T04:56:07.000+00:00”,
“formXtype” : “formXtype”,
“createdBy” : 6,
“newObject” : true,
“name” : “name”,
“modifiedDate” : “2000-01-23T04:56:07.000+00:00”,
“modifiedBy” : 3,
“id” : 3,
“refId” : 7,
“category” : 5,
“gridXtype” : “gridXtype”,
“scopeByType” : “SYSTEM”,
“fieldType” : 6
},
“description” : “description”,
“defaultTemplateId” : 0,
“isSynchronizeField” : true,
“required” : true,
“controlStyle” : “controlStyle”,
“organizationId” : 3,
“newObject” : true,
“infotip” : “infotip”,
“modifiedBy” : 8,
“id” : 7,
“readOnlyAllowApiOverwrite” : true,
“shouldVersion” : true,
“readOnly” : true,
“lookupTypeId” : 6,
“label” : “label”,
“xmlToString” : “xmlToString”,
“createdDate” : “2000-01-23T04:56:07.000+00:00”,
“controlType” : “TEXTAREA”,
“isReqAdvisorEnabled” : true,
“createdBy” : 4,
“sortOrder” : 6,
“modifiedDate” : “2000-01-23T04:56:07.000+00:00”,
“isInherited” : true,
“triggerSuspect” : true
}, {
“documentField” : {
“isDerived” : true,
“scopeId” : 0,
“userConfigurable” : true,
“custom” : true,
“dataType” : “INTEGER”,
“description” : “description”,
“readOnly” : true,
“xmlToString” : “xmlToString”,
“editXtype” : “editXtype”,
“organizationId” : 7,
“createdDate” : “2000-01-23T04:56:07.000+00:00”,
“formXtype” : “formXtype”,
“createdBy” : 6,
“newObject” : true,
“name” : “name”,
“modifiedDate” : “2000-01-23T04:56:07.000+00:00”,
“modifiedBy” : 3,
“id” : 3,
“refId” : 7,
“category” : 5,
“gridXtype” : “gridXtype”,
“scopeByType” : “SYSTEM”,
“fieldType” : 6
},
“description” : “description”,
“defaultTemplateId” : 0,
“isSynchronizeField” : true,
“required” : true,
“controlStyle” : “controlStyle”,
“organizationId” : 3,
“newObject” : true,
“infotip” : “infotip”,
“modifiedBy” : 8,
“id” : 7,
“readOnlyAllowApiOverwrite” : true,
“shouldVersion” : true,
“readOnly” : true,
“lookupTypeId” : 6,
“label” : “label”,
“xmlToString” : “xmlToString”,
“createdDate” : “2000-01-23T04:56:07.000+00:00”,
“controlType” : “TEXTAREA”,
“isReqAdvisorEnabled” : true,
“createdBy” : 4,
“sortOrder” : 6,
“modifiedDate” : “2000-01-23T04:56:07.000+00:00”,
“isInherited” : true,
“triggerSuspect” : true
} ],
“createdDate” : “2000-01-23T04:56:07.000+00:00”,
“createdBy” : 5,
“newObject” : true,
“modifiedDate” : “2000-01-23T04:56:07.000+00:00”,
“hasCustomImage” : true,
“modifiedBy” : 3,
“id” : 4,
“category” : “CORE”,
“documentTypeFacets” : [ {
“organizationId” : 7,
“isSyncedFacet” : true,
“id” : 3,
“facet” : “ACTIVITIES”
}, {
“organizationId” : 7,
“isSyncedFacet” : true,
“id” : 3,
“facet” : “ACTIVITIES”
} ],
“displayPlural” : “displayPlural”
},
“id” : 6
} ],
“id” : 1
}
},
“diagramGraphXml” : “diagramGraphXml”,
“xmlToString” : “xmlToString”,
“organizationId” : 0,
“system” : true,
“createdDate” : “2000-01-23T04:56:07.000+00:00”,
“fileSize” : 0,
“diagramHeight” : 1,
“createdBy” : 3,
“newObject” : true,
“organization” : {
“redirectUrl” : “redirectUrl”,
“licenseMessage” : 6,
“description” : “description”,
“xmlToString” : “xmlToString”,
“organizationId” : 2,
“baseUrl” : “baseUrl”,
“createdDate” : “2000-01-23T04:56:07.000+00:00”,
“createdBy” : 1,
“newObject” : true,
“name” : “name”,
“modifiedDate” : “2000-01-23T04:56:07.000+00:00”,
“closed” : true,
“subdomain” : “subdomain”,
“modifiedBy” : 5,
“returnEmail” : “returnEmail”,
“id” : 5
},
“diagramImageXml” : “diagramImageXml”,
“modifiedDate” : “2000-01-23T04:56:07.000+00:00”,
“modifiedBy” : 9,
“id” : 8,
“diagramWidth” : 9
}, {
“fileName” : “fileName”,
“attachmentTypeId” : 8,
“description” : “description”,
“project” : {
“parent” : 7,
“projectType” : {
“components” : “components”,
“scopeId” : 0,
“description” : “description”,
“xmlToString” : “xmlToString”,
“organizationId” : 3,
“createdDate” : “2000-01-23T04:56:07.000+00:00”,
“createdBy” : 6,
“newObject” : true,
“name” : “name”,
“defaultDisplay” : “defaultDisplay”,
“modifiedDate” : “2000-01-23T04:56:07.000+00:00”,
“defaultPrefix” : “defaultPrefix”,
“defaultDisplayPlural” : “defaultDisplayPlural”,
“modifiedBy” : 8,
“id” : 4,
“refId” : 2,
“scopeByType” : “SYSTEM”
},
“description” : “description”,
“flag2” : true,
“flag1” : true,
“organizationId” : 4,
“projectKey” : “projectKey”,
“string3” : “string3”,
“string4” : “string4”,
“string1” : “string1”,
“newObject” : true,
“string2” : “string2”,
“modifiedBy” : 8,
“id” : 6,
“user1” : {
“lastName” : “lastName”,
“active” : true,
“customData” : [ {
“name” : “name”,
“value” : “value”
}, {
“name” : “name”,
“value” : “value”
} ],
“title” : “title”,
“type” : “users”,
“firstName” : “firstName”,
“licenseType” : “NAMED”,
“uid” : “uid”,
“phone” : “phone”,
“location” : “location”,
“id” : 9,
“authenticationType” : {
“name” : “name”,
“id” : 3
},
“email” : “email”,
“username” : “username”
},
“active” : true,
“date2” : “2000-01-23T04:56:07.000+00:00”,
“xmlToString” : “xmlToString”,
“date1” : “2000-01-23T04:56:07.000+00:00”,
“defaultDashboard” : {
“scopeId” : 5,
“xmlToString” : “xmlToString”,
“dashboardName” : “dashboardName”,
“layout” : “SINGLE_COLUMN”,
“organizationId” : 7,
“createdDate” : “2000-01-23T04:56:07.000+00:00”,
“createdBy” : 0,
“newObject” : true,
“modifiedDate” : “2000-01-23T04:56:07.000+00:00”,
“modifiedBy” : 9,
“id” : 0,
“refId” : 4,
“portletInstances” : [ {
“organizationId” : 9,
“location” : “location”,
“portlet” : “FILTER_RESULTS”,
“id” : 7,
“properties” : {
“key” : “properties”
}
}, {
“organizationId” : 9,
“location” : “location”,
“portlet” : “FILTER_RESULTS”,
“id” : 7,
“properties” : {
“key” : “properties”
}
} ],
“scopeByType” : “SYSTEM”
},
“lookup1” : {
“image” : “image”,
“color” : “color”,
“dataValue” : “dataValue”,
“description” : “description”,
“active” : true,
“lookupType” : {
“lookups” : [ null, null ],
“scopeId” : 6,
“description” : “description”,
“active” : true,
“xmlToString” : “xmlToString”,
“type” : 2,
“organizationId” : 1,
“createdDate” : “2000-01-23T04:56:07.000+00:00”,
“createdBy” : 7,
“newObject” : true,
“name” : “name”,
“modifiedDate” : “2000-01-23T04:56:07.000+00:00”,
“modifiedBy” : 1,
“id” : 1,
“refId” : 7,
“category” : 4,
“scopeByType” : “SYSTEM”
},
“xmlToString” : “xmlToString”,
“organizationId” : 9,
“archived” : true,
“isDefault” : true,
“createdDate” : “2000-01-23T04:56:07.000+00:00”,
“createdBy” : 4,
“newObject” : true,
“sortOrder” : 1,
“name” : “name”,
“modifiedDate” : “2000-01-23T04:56:07.000+00:00”,
“infotip” : “infotip”,
“modifiedBy” : 5,
“id” : 9
},
“isFolder” : true,
“createdDate” : “2000-01-23T04:56:07.000+00:00”,
“text3” : “text3”,
“createdBy” : 1,
“text1” : “text1”,
“text2” : “text2”,
“name” : “name”,
“modifiedDate” : “2000-01-23T04:56:07.000+00:00”,
“relationshipRuleSet” : {
“organizationId” : 4,
“isExclusive” : true,
“name” : “name”,
“rules” : [ {
“organizationId” : 4,
“forCoverage” : true,
“relationshipType” : {
“image” : “image”,
“scopeId” : 6,
“showNote” : true,
“description” : “description”,
“active” : true,
“showStatus” : true,
“xmlToString” : “xmlToString”,
“organizationId” : 3,
“isDefault” : true,
“createdDate” : “2000-01-23T04:56:07.000+00:00”,
“createdBy” : 8,
“newObject” : true,
“sortOrder” : 6,
“name” : “name”,
“modifiedDate” : “2000-01-23T04:56:07.000+00:00”,
“modifiedBy” : 9,
“id” : 6,
“refId” : 1,
“scopeByType” : “SYSTEM”
},
“fromDocType” : {
“image” : “image”,
“workflowFieldId” : 2,
“display” : “display”,
“description” : “description”,
“active” : true,
“xmlToString” : “xmlToString”,
“documentTypeKey” : “documentTypeKey”,
“organizationId” : 0,
“documentTypeFields” : [ {
“documentField” : {
“isDerived” : true,
“scopeId” : 0,
“userConfigurable” : true,
“custom” : true,
“dataType” : “INTEGER”,
“description” : “description”,
“readOnly” : true,
“xmlToString” : “xmlToString”,
“editXtype” : “editXtype”,
“organizationId” : 7,
“createdDate” : “2000-01-23T04:56:07.000+00:00”,
“formXtype” : “formXtype”,
“createdBy” : 6,
“newObject” : true,
“name” : “name”,
“modifiedDate” : “2000-01-23T04:56:07.000+00:00”,
“modifiedBy” : 3,
“id” : 3,
“refId” : 7,
“category” : 5,
“gridXtype” : “gridXtype”,
“scopeByType” : “SYSTEM”,
“fieldType” : 6
},
“description” : “description”,
“defaultTemplateId” : 0,
“isSynchronizeField” : true,
“required” : true,
“controlStyle” : “controlStyle”,
“organizationId” : 3,
“newObject” : true,
“infotip” : “infotip”,
“modifiedBy” : 8,
“id” : 7,
“readOnlyAllowApiOverwrite” : true,
“shouldVersion” : true,
“readOnly” : true,
“lookupTypeId” : 6,
“label” : “label”,
“xmlToString” : “xmlToString”,
“createdDate” : “2000-01-23T04:56:07.000+00:00”,
“controlType” : “TEXTAREA”,
“isReqAdvisorEnabled” : true,
“createdBy” : 4,
“sortOrder” : 6,
“modifiedDate” : “2000-01-23T04:56:07.000+00:00”,
“isInherited” : true,
“triggerSuspect” : true
}, {
“documentField” : {
“isDerived” : true,
“scopeId” : 0,
“userConfigurable” : true,
“custom” : true,
“dataType” : “INTEGER”,
“description” : “description”,
“readOnly” : true,
“xmlToString” : “xmlToString”,
“editXtype” : “editXtype”,
“organizationId” : 7,
“createdDate” : “2000-01-23T04:56:07.000+00:00”,
“formXtype” : “formXtype”,
“createdBy” : 6,
“newObject” : true,
“name” : “name”,
“modifiedDate” : “2000-01-23T04:56:07.000+00:00”,
“modifiedBy” : 3,
“id” : 3,
“refId” : 7,
“category” : 5,
“gridXtype” : “gridXtype”,
“scopeByType” : “SYSTEM”,
“fieldType” : 6
},
“description” : “description”,
“defaultTemplateId” : 0,
“isSynchronizeField” : true,
“required” : true,
“controlStyle” : “controlStyle”,
“organizationId” : 3,
“newObject” : true,
“infotip” : “infotip”,
“modifiedBy” : 8,
“id” : 7,
“readOnlyAllowApiOverwrite” : true,
“shouldVersion” : true,
“readOnly” : true,
“lookupTypeId” : 6,
“label” : “label”,
“xmlToString” : “xmlToString”,
“createdDate” : “2000-01-23T04:56:07.000+00:00”,
“controlType” : “TEXTAREA”,
“isReqAdvisorEnabled” : true,
“createdBy” : 4,
“sortOrder” : 6,
“modifiedDate” : “2000-01-23T04:56:07.000+00:00”,
“isInherited” : true,
“triggerSuspect” : true
} ],
“createdDate” : “2000-01-23T04:56:07.000+00:00”,
“createdBy” : 5,
“newObject” : true,
“modifiedDate” : “2000-01-23T04:56:07.000+00:00”,
“hasCustomImage” : true,
“modifiedBy” : 3,
“id” : 4,
“category” : “CORE”,
“documentTypeFacets” : [ {
“organizationId” : 7,
“isSyncedFacet” : true,
“id” : 3,
“facet” : “ACTIVITIES”
}, {
“organizationId” : 7,
“isSyncedFacet” : true,
“id” : 3,
“facet” : “ACTIVITIES”
} ],
“displayPlural” : “displayPlural”
},
“id” : 6
}, {
“organizationId” : 4,
“forCoverage” : true,
“relationshipType” : {
“image” : “image”,
“scopeId” : 6,
“showNote” : true,
“description” : “description”,
“active” : true,
“showStatus” : true,
“xmlToString” : “xmlToString”,
“organizationId” : 3,
“isDefault” : true,
“createdDate” : “2000-01-23T04:56:07.000+00:00”,
“createdBy” : 8,
“newObject” : true,
“sortOrder” : 6,
“name” : “name”,
“modifiedDate” : “2000-01-23T04:56:07.000+00:00”,
“modifiedBy” : 9,
“id” : 6,
“refId” : 1,
“scopeByType” : “SYSTEM”
},
“fromDocType” : {
“image” : “image”,
“workflowFieldId” : 2,
“display” : “display”,
“description” : “description”,
“active” : true,
“xmlToString” : “xmlToString”,
“documentTypeKey” : “documentTypeKey”,
“organizationId” : 0,
“documentTypeFields” : [ {
“documentField” : {
“isDerived” : true,
“scopeId” : 0,
“userConfigurable” : true,
“custom” : true,
“dataType” : “INTEGER”,
“description” : “description”,
“readOnly” : true,
“xmlToString” : “xmlToString”,
“editXtype” : “editXtype”,
“organizationId” : 7,
“createdDate” : “2000-01-23T04:56:07.000+00:00”,
“formXtype” : “formXtype”,
“createdBy” : 6,
“newObject” : true,
“name” : “name”,
“modifiedDate” : “2000-01-23T04:56:07.000+00:00”,
“modifiedBy” : 3,
“id” : 3,
“refId” : 7,
“category” : 5,
“gridXtype” : “gridXtype”,
“scopeByType” : “SYSTEM”,
“fieldType” : 6
},
“description” : “description”,
“defaultTemplateId” : 0,
“isSynchronizeField” : true,
“required” : true,
“controlStyle” : “controlStyle”,
“organizationId” : 3,
“newObject” : true,
“infotip” : “infotip”,
“modifiedBy” : 8,
“id” : 7,
“readOnlyAllowApiOverwrite” : true,
“shouldVersion” : true,
“readOnly” : true,
“lookupTypeId” : 6,
“label” : “label”,
“xmlToString” : “xmlToString”,
“createdDate” : “2000-01-23T04:56:07.000+00:00”,
“controlType” : “TEXTAREA”,
“isReqAdvisorEnabled” : true,
“createdBy” : 4,
“sortOrder” : 6,
“modifiedDate” : “2000-01-23T04:56:07.000+00:00”,
“isInherited” : true,
“triggerSuspect” : true
}, {
“documentField” : {
“isDerived” : true,
“scopeId” : 0,
“userConfigurable” : true,
“custom” : true,
“dataType” : “INTEGER”,
“description” : “description”,
“readOnly” : true,
“xmlToString” : “xmlToString”,
“editXtype” : “editXtype”,
“organizationId” : 7,
“createdDate” : “2000-01-23T04:56:07.000+00:00”,
“formXtype” : “formXtype”,
“createdBy” : 6,
“newObject” : true,
“name” : “name”,
“modifiedDate” : “2000-01-23T04:56:07.000+00:00”,
“modifiedBy” : 3,
“id” : 3,
“refId” : 7,
“category” : 5,
“gridXtype” : “gridXtype”,
“scopeByType” : “SYSTEM”,
“fieldType” : 6
},
“description” : “description”,
“defaultTemplateId” : 0,
“isSynchronizeField” : true,
“required” : true,
“controlStyle” : “controlStyle”,
“organizationId” : 3,
“newObject” : true,
“infotip” : “infotip”,
“modifiedBy” : 8,
“id” : 7,
“readOnlyAllowApiOverwrite” : true,
“shouldVersion” : true,
“readOnly” : true,
“lookupTypeId” : 6,
“label” : “label”,
“xmlToString” : “xmlToString”,
“createdDate” : “2000-01-23T04:56:07.000+00:00”,
“controlType” : “TEXTAREA”,
“isReqAdvisorEnabled” : true,
“createdBy” : 4,
“sortOrder” : 6,
“modifiedDate” : “2000-01-23T04:56:07.000+00:00”,
“isInherited” : true,
“triggerSuspect” : true
} ],
“createdDate” : “2000-01-23T04:56:07.000+00:00”,
“createdBy” : 5,
“newObject” : true,
“modifiedDate” : “2000-01-23T04:56:07.000+00:00”,
“hasCustomImage” : true,
“modifiedBy” : 3,
“id” : 4,
“category” : “CORE”,
“documentTypeFacets” : [ {
“organizationId” : 7,
“isSyncedFacet” : true,
“id” : 3,
“facet” : “ACTIVITIES”
}, {
“organizationId” : 7,
“isSyncedFacet” : true,
“id” : 3,
“facet” : “ACTIVITIES”
} ],
“displayPlural” : “displayPlural”
},
“id” : 6
} ],
“id” : 1
}
},
“diagramGraphXml” : “diagramGraphXml”,
“xmlToString” : “xmlToString”,
“organizationId” : 0,
“system” : true,
“createdDate” : “2000-01-23T04:56:07.000+00:00”,
“fileSize” : 0,
“diagramHeight” : 1,
“createdBy” : 3,
“newObject” : true,
“organization” : {
“redirectUrl” : “redirectUrl”,
“licenseMessage” : 6,
“description” : “description”,
“xmlToString” : “xmlToString”,
“organizationId” : 2,
“baseUrl” : “baseUrl”,
“createdDate” : “2000-01-23T04:56:07.000+00:00”,
“createdBy” : 1,
“newObject” : true,
“name” : “name”,
“modifiedDate” : “2000-01-23T04:56:07.000+00:00”,
“closed” : true,
“subdomain” : “subdomain”,
“modifiedBy” : 5,
“returnEmail” : “returnEmail”,
“id” : 5
},
“diagramImageXml” : “diagramImageXml”,
“modifiedDate” : “2000-01-23T04:56:07.000+00:00”,
“modifiedBy” : 9,
“id” : 8,
“diagramWidth” : 9
} ],
“meta” : {
“pageInfo” : {
“startIndex” : 0,
“resultCount” : 6,
“totalResults” : 1
},
“status” : “OK”,
“timestamp” : “2000-01-23T04:56:07.000+00:00”
},
“links” : {
“key” : {
“href” : “href”,
“type” : “type”
}
}
}
Produces: API call produces the following media types according to the
Accept request header;
the media type will be conveyed by the Content-Type response header:
- application/json
Response:
AttachmentDataListWrapper
GET /testruns/{id}/downstreamrelated
Summary: Get all downstream related items for the test run with the specified ID
Path parameters:
- id
(required)
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” : 6,
“globalId” : “globalId”,
“project” : 1,
“resources” : {
“key” : {
“allowed” : [ “allowed”, “allowed” ]
}
},
“version” : 7,
“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” : 6,
“globalId” : “globalId”,
“project” : 1,
“resources” : {
“key” : {
“allowed” : [ “allowed”, “allowed” ]
}
},
“version” : 7,
“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” : 0,
“resultCount” : 6,
“totalResults” : 1
},
“status” : “OK”,
“timestamp” : “2000-01-23T04:56:07.000+00:00”
},
“links” : {
“key” : {
“href” : “href”,
“type” : “type”
}
}
}
Produces: API call produces the following media types according to the
Accept request header;
the media type will be conveyed by the Content-Type response header:
- application/json
Response:
AbstractItemDataListWrapper
GET /testruns/{id}/downstreamrelationships
Summary: Get all downstream relationships for the test run with the specified ID
Path parameters:
- id
(required)
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” : 0,
“resultCount” : 6,
“totalResults” : 1
},
“status” : “OK”,
“timestamp” : “2000-01-23T04:56:07.000+00:00”
},
“links” : {
“key” : {
“href” : “href”,
“type” : “type”
}
}
}
Produces: API call produces the following media types according to the
Accept request header;
the media type will be conveyed by the Content-Type response header:
- application/json
Response:
RelationshipDataListWrapper
GET /testruns/{id}/comments
Summary: Get all comments for the item with the specified ID
Path parameters:
- id
(required)
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” : 0,
“resultCount” : 6,
“totalResults” : 1
},
“status” : “OK”,
“timestamp” : “2000-01-23T04:56:07.000+00:00”
},
“links” : {
“key” : {
“href” : “href”,
“type” : “type”
}
}
}
Produces: API call produces the following media types according to the
Accept request header;
the media type will be conveyed by the Content-Type response header:
- application/json
Response:
CommentDataListWrapper
GET /testruns/{id}/links
Summary: Get all links for the item with the specified ID
Path parameters:
- id
(required)
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” : 0,
“resultCount” : 6,
“totalResults” : 1
},
“status” : “OK”,
“timestamp” : “2000-01-23T04:56:07.000+00:00”
},
“links” : { }
}
Produces: API call produces the following media types according to the
Accept request header;
the media type will be conveyed by the Content-Type response header:
- application/json
Response:
LinkDataListWrapper
GET /testruns/{id}/links/{linkId}
Summary: Get the link with the specified ID
Path parameters:
- linkId
(required)
- id
(required)
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” : { }
}
Produces: API call produces the following media types according to the
Accept request header;
the media type will be conveyed by the Content-Type response header:
- application/json
Response:
LinkDataWrapper
GET /testruns/{id}/lock
Summary: Get the locked state, last locked date, and last locked by user for the item with the specified ID
Path parameters:
- id
(required)
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”
}
}
}
Produces: API call produces the following media types according to the
Accept request header;
the media type will be conveyed by the Content-Type response header:
- application/json
Response:
LockDataWrapper
GET /testruns/{id}/tags/{tagId}
Summary: Get the tag with the specified ID
Path parameters:
- tagId
(required)
- id
(required)
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”
}
}
}
Produces: API call produces the following media types according to the
Accept request header;
the media type will be conveyed by the Content-Type response header:
- application/json
Response:
TagDataWrapper
GET /testruns/{id}/tags
Summary: Get all tags for the item with the specified ID
Path parameters:
- id
(required)
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” : 0,
“resultCount” : 6,
“totalResults” : 1
},
“status” : “OK”,
“timestamp” : “2000-01-23T04:56:07.000+00:00”
},
“links” : {
“key” : {
“href” : “href”,
“type” : “type”
}
}
}
Produces: API call produces the following media types according to the
Accept request header;
the media type will be conveyed by the Content-Type response header:
- application/json
Response:
TagDataListWrapper
GET /testruns/{id}
Summary: Get the test run with the specified ID
Path parameters:
- id
(required)
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” : 6,
“TestCycleTestGroup” : {
“id” : 2,
“value” : { },
“object” : {
“testCycle” : 1,
“name” : “name”,
“testGroup” : 6,
“type” : “type”,
“assignedTo” : 0
}
},
“testCaseCurrentVersionNumber” : 9,
“globalId” : “globalId”,
“project” : 1,
“resources” : {
“key” : {
“allowed” : [ “allowed”, “allowed” ]
}
},
“version” : 2,
“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” : 7,
“sortOrderFromTestGroup” : 3,
“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”
}
}
}
Produces: API call produces the following media types according to the
Accept request header;
the media type will be conveyed by the Content-Type response header:
- application/json
Response:
TestRunDataWrapper
GET /testruns
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
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” : 6,
“TestCycleTestGroup” : {
“id” : 2,
“value” : { },
“object” : {
“testCycle” : 1,
“name” : “name”,
“testGroup” : 6,
“type” : “type”,
“assignedTo” : 0
}
},
“testCaseCurrentVersionNumber” : 9,
“globalId” : “globalId”,
“project” : 1,
“resources” : {
“key” : {
“allowed” : [ “allowed”, “allowed” ]
}
},
“version” : 2,
“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” : 7,
“sortOrderFromTestGroup” : 3,
“modifiedBy” : 5,
“id” : 0,
“fields” : {
“key” : { }
},
“baselinedAppliedCategorySnapshots” : [ {
“categoryPathSequence” : “categoryPathSequence”,
“itemVersionNumberApplied” : 2
}, {
“categoryPathSequence” : “categoryPathSequence”,
“itemVersionNumberApplied” : 2
} ]
}, {
“itemType” : 6,
“TestCycleTestGroup” : {
“id” : 2,
“value” : { },
“object” : {
“testCycle” : 1,
“name” : “name”,
“testGroup” : 6,
“type” : “type”,
“assignedTo” : 0
}
},
“testCaseCurrentVersionNumber” : 9,
“globalId” : “globalId”,
“project” : 1,
“resources” : {
“key” : {
“allowed” : [ “allowed”, “allowed” ]
}
},
“version” : 2,
“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” : 7,
“sortOrderFromTestGroup” : 3,
“modifiedBy” : 5,
“id” : 0,
“fields” : {
“key” : { }
},
“baselinedAppliedCategorySnapshots” : [ {
“categoryPathSequence” : “categoryPathSequence”,
“itemVersionNumberApplied” : 2
}, {
“categoryPathSequence” : “categoryPathSequence”,
“itemVersionNumberApplied” : 2
} ]
} ],
“meta” : {
“pageInfo” : {
“startIndex” : 0,
“resultCount” : 6,
“totalResults” : 1
},
“status” : “OK”,
“timestamp” : “2000-01-23T04:56:07.000+00:00”
},
“links” : {
“key” : {
“href” : “href”,
“type” : “type”
}
}
}
Produces: API call produces the following media types according to the
Accept request header;
the media type will be conveyed by the Content-Type response header:
- application/json
Response:
TestRunDataListWrapper
GET /testruns/{id}/upstreamrelated
Summary: Get all upstream related items for the test run with the specified ID
Path parameters:
- id
(required)
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” : 6,
“globalId” : “globalId”,
“project” : 1,
“resources” : {
“key” : {
“allowed” : [ “allowed”, “allowed” ]
}
},
“version” : 7,
“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” : 6,
“globalId” : “globalId”,
“project” : 1,
“resources” : {
“key” : {
“allowed” : [ “allowed”, “allowed” ]
}
},
“version” : 7,
“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” : 0,
“resultCount” : 6,
“totalResults” : 1
},
“status” : “OK”,
“timestamp” : “2000-01-23T04:56:07.000+00:00”
},
“links” : {
“key” : {
“href” : “href”,
“type” : “type”
}
}
}
Produces: API call produces the following media types according to the
Accept request header;
the media type will be conveyed by the Content-Type response header:
- application/json
Response:
AbstractItemDataListWrapper
GET /testruns/{id}/upstreamrelationships
Summary: Get all upstream relationships for the test run with the specified ID
Path parameters:
- id
(required)
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” : 0,
“resultCount” : 6,
“totalResults” : 1
},
“status” : “OK”,
“timestamp” : “2000-01-23T04:56:07.000+00:00”
},
“links” : {
“key” : {
“href” : “href”,
“type” : “type”
}
}
}
Produces: API call produces the following media types according to the
Accept request header;
the media type will be conveyed by the Content-Type response header:
- application/json
Response:
RelationshipDataListWrapper
GET /testruns/{id}/versions/{versionNum}
Summary: Get the numbered version for the item with the specified ID
Path parameters:
- versionNum
(required)
- id
(required)
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” : 0,
“createdDate” : “2000-01-23T04:56:07.000+00:00”,
“versionedItem” : {
“id” : 2,
“value” : { },
“object” : {
“id” : 1,
“type” : “type”,
“version” : 5,
“currentVersion” : 5
}
},
“createdBy” : 7,
“comment” : “comment”,
“userName” : “userName”,
“type” : “type”,
“versionNumber” : 6,
“changeDetails” : “changeDetails”
},
“meta” : {
“status” : “OK”,
“timestamp” : “2000-01-23T04:56:07.000+00:00”
},
“links” : {
“key” : {
“href” : “href”,
“type” : “type”
}
}
}
Produces: API call produces the following media types according to the
Accept request header;
the media type will be conveyed by the Content-Type response header:
- application/json
Response:
VersionDataWrapper
GET /testruns/{id}/versions/{versionNum}/versioneditem
Summary: Get the snapshot of the test run at the specified version
Path parameters:
- versionNum
(required)
- id
(required)
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” : 6,
“fileName” : “fileName”,
“globalId” : “globalId”,
“project” : 1,
“resources” : {
“key” : {
“allowed” : [ “allowed”, “allowed” ]
}
},
“mimeType” : “mimeType”,
“version” : 2,
“currentVersion” : 3,
“createdDate” : “2000-01-23T04:56:07.000+00:00”,
“lastActivityDate” : “2000-01-23T04:56:07.000+00:00”,
“createdBy” : 5,
“fileSize” : 9,
“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” : 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”
}
}
}
Produces: API call produces the following media types according to the
Accept request header;
the media type will be conveyed by the Content-Type response header:
- application/json
Response:
VersionedAttachmentDataWrapper
GET /testruns/{id}/versions
Summary: Get all versions for the item with the specified ID
Path parameters:
- id
(required)
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” : 0,
“createdDate” : “2000-01-23T04:56:07.000+00:00”,
“versionedItem” : {
“id” : 2,
“value” : { },
“object” : {
“id” : 1,
“type” : “type”,
“version” : 5,
“currentVersion” : 5
}
},
“createdBy” : 7,
“comment” : “comment”,
“userName” : “userName”,
“type” : “type”,
“versionNumber” : 6,
“changeDetails” : “changeDetails”
}, {
“item” : 0,
“createdDate” : “2000-01-23T04:56:07.000+00:00”,
“versionedItem” : {
“id” : 2,
“value” : { },
“object” : {
“id” : 1,
“type” : “type”,
“version” : 5,
“currentVersion” : 5
}
},
“createdBy” : 7,
“comment” : “comment”,
“userName” : “userName”,
“type” : “type”,
“versionNumber” : 6,
“changeDetails” : “changeDetails”
} ],
“meta” : {
“pageInfo” : {
“startIndex” : 0,
“resultCount” : 6,
“totalResults” : 1
},
“status” : “OK”,
“timestamp” : “2000-01-23T04:56:07.000+00:00”
},
“links” : {
“key” : {
“href” : “href”,
“type” : “type”
}
}
}
Produces: API call produces the following media types according to the
Accept request header;
the media type will be conveyed by the Content-Type response header:
- application/json
Response:
VersionDataListWrapper
POST /testruns/{id}/updatedtestcase
Summary: Creates a new test run version with Not run status that reflects the newest test case version
Path parameters:
- id
(required)
Examples:
- Example data, content-type: application/json
{
“meta” : {
“location” : “location”,
“id” : 0,
“status” : “OK”,
“timestamp” : “2000-01-23T04:56:07.000+00:00”
}
}
Produces: API call produces the following media types according to the
Accept request header;
the media type will be conveyed by the Content-Type response header:
- application/json
Response:
CreatedResponseDataWrapper
PATCH /testruns/{id}
Summary: Update the execution results for the test run with the specified ID
Path parameters:
- id
(required)
Consumes: this API call consumes the following media types via the
Content-Type request header:
- application/json
Body:
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
{
“status” : “OK”,
“timestamp” : “2000-01-23T04:56:07.000+00:00”
}
Produces: API call produces the following media types according to the
Accept request header;
the media type will be conveyed by the Content-Type response header:
- application/json
Response:
MetaWrapper
DELETE /testruns/{id}/attachments/{attachmentId}
Summary: Remove an existing attachment from the item
Path parameters:
- attachmentId
(required)
- id
(required)
DELETE /testruns/{id}/tags/{tagId}
Summary: Remove an existing tag from the item with the specified ID
Path parameters:
- tagId
(required)
- id
(required)
PUT /testruns/{id}/links/{linkId}
Summary: Update the link with the specified ID
Path parameters:
- linkId
(required)
- id
(required)
Consumes: this API call consumes the following media types via the
Content-Type request header:
- application/json
Body:
Examples:
- Example data, content-type: application/json
{
“meta” : {
“status” : “OK”,
“timestamp” : “2000-01-23T04:56:07.000+00:00”
}
}
Produces: API call produces the following media types according to the
Accept request header;
the media type will be conveyed by the Content-Type response header:
- application/json
Response:
OkResponseDataWraper
PUT /testruns/{id}/lock
Summary: Update the locked state of the item with the specified ID
Path parameters:
- id
(required)
Consumes: this API call consumes the following media types via the
Content-Type request header:
- application/json
Body:
Examples:
- Example data, content-type: application/json
{
“meta” : {
“status” : “OK”,
“timestamp” : “2000-01-23T04:56:07.000+00:00”
}
}
Produces: API call produces the following media types according to the
Accept request header;
the media type will be conveyed by the Content-Type response header:
- application/json
Response:
OkResponseDataWraper
PUT /testruns/{id}
Summary: Update the execution results for the test run with the specified ID
Path parameters:
- id
(required)
Consumes: this API call consumes the following media types via the
Content-Type request header:
- application/json
Body:
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
{
“status” : “OK”,
“timestamp” : “2000-01-23T04:56:07.000+00:00”
}
Produces: API call produces the following media types according to the
Accept request header;
the media type will be conveyed by the Content-Type response header:
- application/json
Response:
MetaWrapper
Endpoint usergroups
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.
POST /usergroups
Summary: Create a new user group
Consumes: this API call consumes the following media types via the
Content-Type request header:
- application/json
Body:
Examples:
- Example data, content-type: application/json
{
“meta” : {
“location” : “location”,
“id” : 0,
“status” : “OK”,
“timestamp” : “2000-01-23T04:56:07.000+00:00”
}
}
Produces: API call produces the following media types according to the
Accept request header;
the media type will be conveyed by the Content-Type response header:
- application/json
Response:
CreatedResponseDataWrapper
POST /usergroups/{id}/users
Summary: Add an existing user to the user group with the specified ID
Path parameters:
- id
(required)
Consumes: this API call consumes the following media types via the
Content-Type request header:
- application/json
Body:
Examples:
- Example data, content-type: application/json
{
“meta” : {
“location” : “location”,
“id” : 0,
“status” : “OK”,
“timestamp” : “2000-01-23T04:56:07.000+00:00”
}
}
Produces: API call produces the following media types according to the
Accept request header;
the media type will be conveyed by the Content-Type response header:
- application/json
Response:
CreatedResponseDataWrapper
DELETE /usergroups/{id}
Summary: Delete the user group with the specified ID
Path parameters:
- id
(required)
GET /usergroups/{id}
Summary: Get the user group with the specified ID
Path parameters:
- id
(required)
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,
“type” : “usergroups”
},
“meta” : {
“status” : “OK”,
“timestamp” : “2000-01-23T04:56:07.000+00:00”
},
“links” : {
“key” : {
“href” : “href”,
“type” : “type”
}
}
}
Produces: API call produces the following media types according to the
Accept request header;
the media type will be conveyed by the Content-Type response header:
- application/json
Response:
UserGroupDataWrapper
GET /usergroups/{id}/users
Summary: Get all users for the user group with the specified ID
Path parameters:
- id
(required)
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”,
“active” : true,
“customData” : [ {
“name” : “name”,
“value” : “value”
}, {
“name” : “name”,
“value” : “value”
} ],
“title” : “title”,
“type” : “users”,
“firstName” : “firstName”,
“licenseType” : “NAMED”,
“uid” : “uid”,
“phone” : “phone”,
“location” : “location”,
“id” : 9,
“authenticationType” : {
“name” : “name”,
“id” : 3
},
“email” : “email”,
“username” : “username”
}, {
“lastName” : “lastName”,
“active” : true,
“customData” : [ {
“name” : “name”,
“value” : “value”
}, {
“name” : “name”,
“value” : “value”
} ],
“title” : “title”,
“type” : “users”,
“firstName” : “firstName”,
“licenseType” : “NAMED”,
“uid” : “uid”,
“phone” : “phone”,
“location” : “location”,
“id” : 9,
“authenticationType” : {
“name” : “name”,
“id” : 3
},
“email” : “email”,
“username” : “username”
} ],
“meta” : {
“pageInfo” : {
“startIndex” : 0,
“resultCount” : 6,
“totalResults” : 1
},
“status” : “OK”,
“timestamp” : “2000-01-23T04:56:07.000+00:00”
},
“links” : {
“key” : {
“href” : “href”,
“type” : “type”
}
}
}
Produces: API call produces the following media types according to the
Accept request header;
the media type will be conveyed by the Content-Type response header:
- application/json
Response:
UserDataListWrapper
GET /usergroups
Summary: Get all user groups
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,
“type” : “usergroups”
}, {
“uid” : “uid”,
“name” : “name”,
“description” : “description”,
“project” : 6,
“id” : 0,
“type” : “usergroups”
} ],
“meta” : {
“pageInfo” : {
“startIndex” : 0,
“resultCount” : 6,
“totalResults” : 1
},
“status” : “OK”,
“timestamp” : “2000-01-23T04:56:07.000+00:00”
},
“links” : {
“key” : {
“href” : “href”,
“type” : “type”
}
}
}
Produces: API call produces the following media types according to the
Accept request header;
the media type will be conveyed by the Content-Type response header:
- application/json
Response:
UserGroupDataListWrapper
DELETE /usergroups/{id}/users/{userId}
Summary: Remove an existing user from the user group with the specified ID
Path parameters:
- userId
(required)
- id
(required)
PUT /usergroups/{id}
Summary: Update the user group with the specified ID
Path parameters:
- id
(required)
Consumes: this API call consumes the following media types via the
Content-Type request header:
- application/json
Body:
Examples:
- Example data, content-type: application/json
{
“status” : “OK”,
“timestamp” : “2000-01-23T04:56:07.000+00:00”
}
Produces: API call produces the following media types according to the
Accept request header;
the media type will be conveyed by the Content-Type response header:
- application/json
Response:
MetaWrapper
Endpoint users
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.
POST /users
Summary: Create a new user
Consumes: this API call consumes the following media types via the
Content-Type request header:
- application/json
Body:
Examples:
- Example data, content-type: application/json
{
“data” : 0,
“meta” : {
“status” : “OK”,
“timestamp” : “2000-01-23T04:56:07.000+00:00”
}
}
Produces: API call produces the following media types according to the
Accept request header;
the media type will be conveyed by the Content-Type response header:
- application/json
Response:
CreatedResponseSimpleDataWrapper
GET /users/current
Summary: Gets the current user
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”,
“active” : true,
“customData” : [ {
“name” : “name”,
“value” : “value”
}, {
“name” : “name”,
“value” : “value”
} ],
“title” : “title”,
“type” : “users”,
“firstName” : “firstName”,
“licenseType” : “NAMED”,
“uid” : “uid”,
“phone” : “phone”,
“location” : “location”,
“id” : 9,
“authenticationType” : {
“name” : “name”,
“id” : 3
},
“email” : “email”,
“username” : “username”
},
“meta” : {
“status” : “OK”,
“timestamp” : “2000-01-23T04:56:07.000+00:00”
},
“links” : {
“key” : {
“href” : “href”,
“type” : “type”
}
}
}
Produces: API call produces the following media types according to the
Accept request header;
the media type will be conveyed by the Content-Type response header:
- application/json
Response:
UserDataWrapper
GET /users/{userId}/customData
Summary: Get all custom data for the user with the specified ID
Path parameters:
- userId
(required)
Examples:
- Example data, content-type: application/json
{
“data” : [ {
“name” : “name”,
“value” : “value”
}, {
“name” : “name”,
“value” : “value”
} ],
“meta” : {
“pageInfo” : {
“startIndex” : 0,
“resultCount” : 6,
“totalResults” : 1
},
“status” : “OK”,
“timestamp” : “2000-01-23T04:56:07.000+00:00”
}
}
Produces: API call produces the following media types according to the
Accept request header;
the media type will be conveyed by the Content-Type response header:
- application/json
Response:
UserCustomDataDataListWrapper
GET /users/current/favoritefilters
Summary: Gets the current user's favorite filters
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”,
“type” : “filters”,
“filterQuery” : {
“orderRules” : [ {
“direction” : “ASC”
}, {
“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”,
“type” : “filters”,
“filterQuery” : {
“orderRules” : [ {
“direction” : “ASC”
}, {
“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” : 0,
“resultCount” : 6,
“totalResults” : 1
},
“status” : “OK”,
“timestamp” : “2000-01-23T04:56:07.000+00:00”
},
“links” : {
“key” : {
“href” : “href”,
“type” : “type”
}
}
}
Produces: API call produces the following media types according to the
Accept request header;
the media type will be conveyed by the Content-Type response header:
- application/json
Response:
FilterDataListWrapper
GET /users/{userId}
Summary: Get the user with the specified ID
Path parameters:
- userId
(required)
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”,
“active” : true,
“customData” : [ {
“name” : “name”,
“value” : “value”
}, {
“name” : “name”,
“value” : “value”
} ],
“title” : “title”,
“type” : “users”,
“firstName” : “firstName”,
“licenseType” : “NAMED”,
“uid” : “uid”,
“phone” : “phone”,
“location” : “location”,
“id” : 9,
“authenticationType” : {
“name” : “name”,
“id” : 3
},
“email” : “email”,
“username” : “username”
},
“meta” : {
“status” : “OK”,
“timestamp” : “2000-01-23T04:56:07.000+00:00”
},
“links” : {
“key” : {
“href” : “href”,
“type” : “type”
}
}
}
Produces: API call produces the following media types according to the
Accept request header;
the media type will be conveyed by the Content-Type response header:
- application/json
Response:
UserDataWrapper
GET /users
Summary: Get all users
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”,
“active” : true,
“customData” : [ {
“name” : “name”,
“value” : “value”
}, {
“name” : “name”,
“value” : “value”
} ],
“title” : “title”,
“type” : “users”,
“firstName” : “firstName”,
“licenseType” : “NAMED”,
“uid” : “uid”,
“phone” : “phone”,
“location” : “location”,
“id” : 9,
“authenticationType” : {
“name” : “name”,
“id” : 3
},
“email” : “email”,
“username” : “username”
}, {
“lastName” : “lastName”,
“active” : true,
“customData” : [ {
“name” : “name”,
“value” : “value”
}, {
“name” : “name”,
“value” : “value”
} ],
“title” : “title”,
“type” : “users”,
“firstName” : “firstName”,
“licenseType” : “NAMED”,
“uid” : “uid”,
“phone” : “phone”,
“location” : “location”,
“id” : 9,
“authenticationType” : {
“name” : “name”,
“id” : 3
},
“email” : “email”,
“username” : “username”
} ],
“meta” : {
“pageInfo” : {
“startIndex” : 0,
“resultCount” : 6,
“totalResults” : 1
},
“status” : “OK”,
“timestamp” : “2000-01-23T04:56:07.000+00:00”
},
“links” : {
“key” : {
“href” : “href”,
“type” : “type”
}
}
}
Produces: API call produces the following media types according to the
Accept request header;
the media type will be conveyed by the Content-Type response header:
- application/json
Response:
UserDataListWrapper
PUT /users/{userId}
Summary: Update the user with the specified ID
Path parameters:
- userId
(required)
Consumes: this API call consumes the following media types via the
Content-Type request header:
- application/json
Body:
Examples:
- Example data, content-type: application/json
{
“status” : “OK”,
“timestamp” : “2000-01-23T04:56:07.000+00:00”
}
Produces: API call produces the following media types according to the
Accept request header;
the media type will be conveyed by the Content-Type response header:
- application/json
Response:
MetaWrapper
PUT /users/{userId}/active
Summary: Update the active status for the user with the specified ID
Path parameters:
- userId
(required)
Consumes: this API call consumes the following media types via the
Content-Type request header:
- application/json
Body:
Examples:
- Example data, content-type: application/json
{
“meta” : {
“status” : “OK”,
“timestamp” : “2000-01-23T04:56:07.000+00:00”
}
}
Produces: API call produces the following media types according to the
Accept request header;
the media type will be conveyed by the Content-Type response header:
- application/json
Response:
OkResponseDataWraper
PUT /users/{userId}/customData
Summary: Update the custom data for the user with the specified ID
Path parameters:
- userId
(required)
Consumes: this API call consumes the following media types via the
Content-Type request header:
- application/json
Body:
Examples:
- Example data, content-type: application/json
{
“status” : “OK”,
“timestamp” : “2000-01-23T04:56:07.000+00:00”
}
Produces: API call produces the following media types according to the
Accept request header;
the media type will be conveyed by the Content-Type response header:
- application/json
Response:
MetaWrapper
Data Types
Data Type AbstractItem
| Name | Required | Type | Notes |
|---|---|---|---|
| id | required | Integer | |
| documentKey | required | String | |
| globalId | required | String | |
| itemType | required | Integer | Reference to another object in a REST Resource |
| project | required | Integer | Reference to another object in a REST Resource |
| createdDate | required | Date | |
| modifiedDate | required | Date | |
| lastActivityDate | required | Date | |
| createdBy | required | Integer | Reference to another object in a REST Resource |
| modifiedBy | required | Integer | Reference to another object in a REST Resource |
| fields | required | Map | |
| resources | required | Map | |
| baselinedAppliedCategorySnapshots | required | List | |
| version | required | Integer |
Data Type AbstractItemDataListWrapper
| Name | Required | Type | Notes |
|---|---|---|---|
| data | required | List | |
| links | required | Map | |
| meta | required | MetaListWrapper |
Data Type AbstractItemDataWrapper
| Name | Required | Type | Notes |
|---|---|---|---|
| data | required | AbstractItem | |
| links | required | Map | |
| meta | required | MetaWrapper |
Data Type AbstractRestResponse
| Name | Required | Type | Notes |
|---|---|---|---|
| status | required | Integer | |
| statusReasonPhrase | required | String | |
| pageInfo | required | PageInfo | |
| headers | required | AbstractRestResponse_headers |
Data Type AbstractRestResponse_headers
| Name | Required | Type | Notes |
|---|---|---|---|
| empty | required | Boolean |
Data Type AbstractVersionedItem
| Name | Required | Type | Notes |
|---|---|---|---|
| id | 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. |
| type | required | String |
Data Type AcceptedMetaWrapper
| Name | Required | Type | Notes |
|---|---|---|---|
| status | required | String | |
| timestamp | required | Date | |
| location | required | String | |
| workId | required | String |
Data Type AcceptedResponseDataWrapper
| Name | Required | Type | Notes |
|---|---|---|---|
| meta | required | AcceptedMetaWrapper |
Data Type Activity
| Name | Required | Type | Notes |
|---|---|---|---|
| id | required | Integer | |
| item | required | Integer | Reference to another object in a REST Resource |
| date | required | Date | |
| user | required | Integer | Reference to another object in a REST Resource |
| userName | required | String | |
| action | required | String | |
| eventType | required | String | |
| details | required | String | |
| userComment | required | String | |
| objectType | required | String | |
| itemType | required | Integer | Reference to another object in a REST Resource |
Data Type ActivityDataListWrapper
| Name | Required | Type | Notes |
|---|---|---|---|
| data | required | List | |
| links | required | Map | |
| meta | required | MetaListWrapper |
Data Type ActivityDataWrapper
| Name | Required | Type | Notes |
|---|---|---|---|
| data | required | Activity | |
| links | required | Map | |
| meta | required | MetaWrapper |
Data Type AllowedResource
| Name | Required | Type | Notes |
|---|---|---|---|
| allowed | required | List |
Data Type Attachment
| Name | Required | Type | Notes |
|---|---|---|---|
| fileSize | required | Integer | |
| organization | required | Organization | |
| fileName | required | String | |
| system | required | Boolean | |
| description | required | String | |
| diagramImageXml | required | String | |
| project | required | Project | |
| attachmentTypeId | required | Integer | |
| diagramWidth | required | Integer | |
| diagramHeight | required | Integer | |
| diagramGraphXml | required | String | |
| createdBy | required | Integer | |
| createdDate | required | Date | |
| modifiedDate | required | Date | |
| modifiedBy | required | Integer | |
| newObject | required | Boolean | |
| xmlToString | required | String | |
| id | required | Integer | |
| organizationId | required | Integer |
Data Type AttachmentDataListWrapper
| Name | Required | Type | Notes |
|---|---|---|---|
| data | required | List | |
| links | required | Map | |
| meta | required | MetaListWrapper |
Data Type AttachmentVersionsSubResource
| Name | Required | Type | Notes |
|---|---|---|---|
| clientServiceSupport | required | ClientServiceSupport | |
| dataResponseProvider | required | DataResponseProvider | |
| itemId | required | Integer | |
| restVersionService | required | RestVersionService |
Data Type AuthenticationType
| Name | Required | Type | Notes |
|---|---|---|---|
| id | required | Integer | |
| name | required | String |
Data Type AuthenticationTypeLookup
| Name | Required | Type | Notes |
|---|---|---|---|
| name | required | String | |
| id | required | Integer |
Data Type BadRequestMetaWrapper
| Name | Required | Type | Notes |
|---|---|---|---|
| status | required | String | |
| timestamp | required | Date | |
| message | required | String |
Data Type BadRequestResponseDataWrapper
| Name | Required | Type | Notes |
|---|---|---|---|
| meta | required | BadRequestMetaWrapper |
Data Type Baseline
| 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 | Reference to another object in a REST Resource |
| project | required | Integer | Reference to another object in a REST Resource |
| 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 |
Data Type BaselineDataListWrapper
| Name | Required | Type | Notes |
|---|---|---|---|
| data | required | List | |
| links | required | Map | |
| meta | required | MetaListWrapper |
Data Type BaselineDataWrapper
| Name | Required | Type | Notes |
|---|---|---|---|
| data | required | Baseline | |
| links | required | Map | |
| meta | required | MetaWrapper |
Data Type BaselineItem
| Name | Required | Type | Notes |
|---|---|---|---|
| id | required | Integer | |
| documentKey | required | String | |
| globalId | required | String | |
| itemType | required | Integer | Reference to another object in a REST Resource |
| project | required | Integer | Reference to another object in a REST Resource |
| createdDate | required | Date | |
| modifiedDate | required | Date | |
| lastActivityDate | required | Date | |
| createdBy | required | Integer | Reference to another object in a REST Resource |
| modifiedBy | required | Integer | Reference to another object in a REST Resource |
| fields | required | Map | |
| resources | required | Map | |
| baselinedAppliedCategorySnapshots | required | List | |
| version | required | Integer | |
| childItemType | required | Integer | Reference to another object in a REST Resource |
| currentVersion | required | Integer | Currently active version of the versioned item. If no version is active, currentVersion will not be returned. |
| baseline | required | Integer | Reference to another object in a REST Resource |
| baselineLocation | required | BaselineLocation |
Data Type BaselineItemDataListWrapper
| Name | Required | Type | Notes |
|---|---|---|---|
| data | required | List | |
| links | required | Map | |
| meta | required | MetaListWrapper |
Data Type BaselineItemDataWrapper
| Name | Required | Type | Notes |
|---|---|---|---|
| data | required | BaselineItem | |
| links | required | Map | |
| meta | required | MetaWrapper |
Data Type BaselineLocation
| Name | Required | Type | Notes |
|---|---|---|---|
| sequence | required | String | |
| parent | required | BaselineParent |
Data Type BaselineOrigin
| Name | Required | Type | Notes |
|---|---|---|---|
| project | required | Integer | Reference to another object in a REST Resource |
| item | required | Integer | Reference to another object in a REST Resource |
| filter | required | Integer | Reference to another object in a REST Resource |
| release | required | Integer | Reference to another object in a REST Resource |
| simplefilter | required | Integer | Reference to another object in a REST Resource |
| testCycle | required | Integer | Reference to another object in a REST Resource |
| testPlan | required | Integer | Reference to another object in a REST Resource |
| simpleFilter | required | SimpleFilter |
Data Type BaselineParent
| Name | Required | Type | Notes |
|---|---|---|---|
| VersionedItem | required | CompositeVersionedItem | |
| project | required | Integer | Reference to another object in a REST Resource |
Data Type BaselineReviewLink
| Name | Required | Type | Notes |
|---|---|---|---|
| reviewKey | required | String | |
| revisionId | required | Integer | |
| url | required | String | |
| readAccess | required | Boolean | |
| reviewName | required | String | |
| deleted | required | Boolean |
Data Type BaselineReviewLinkDataWrapper
| Name | Required | Type | Notes |
|---|---|---|---|
| data | required | BaselineReviewLink | |
| meta | required | MetaWrapper |
Data Type BaselinedAppliedCategorySnapshotInfo
| Name | Required | Type | Notes |
|---|---|---|---|
| categoryPathSequence | required | String | |
| itemVersionNumberApplied | required | Integer |
Data Type BatchItemLockResponse
| Name | Required | Type | Notes |
|---|---|---|---|
| lockedOrUnlockedCount | required | Integer | |
| failedLockOrUnlockCount | required | Integer |
Data Type BodyPart
| Name | Required | Type | Notes |
|---|---|---|---|
| contentDisposition | required | ContentDisposition | |
| entity | required | Object | |
| headers | required | AbstractRestResponse_headers | |
| mediaType | required | MediaType | |
| messageBodyWorkers | required | MessageBodyWorkers | |
| parent | required | MultiPart | |
| providers | required | Providers | |
| parameterizedHeaders | required | BodyPart_parameterizedHeaders |
Data Type BodyPart_parameterizedHeaders
| Name | Required | Type | Notes |
|---|---|---|---|
| empty | required | Boolean |
Data Type CategoryPathInfo
| Name | Required | Type | Notes |
|---|---|---|---|
| categoryPathId | required | Integer | |
| categoryPathName | required | String | |
| itemVersionIdApplied | required | Integer | |
| itemVersionIdUnapplied | required | Integer | |
| pathIdsToRoot | required | List | |
| qtip | required | String |
Data Type CategoryPathInfoDataWrapper
| Name | Required | Type | Notes |
|---|---|---|---|
| data | required | List | |
| links | required | Map | |
| meta | required | MetaListWrapper |
Data Type CategoryResponseDataWrapper
| Name | Required | Type | Notes |
|---|---|---|---|
| data | required | List | |
| links | required | Map | |
| meta | required | MetaListWrapper |
Data Type CategoryVisibilityUpdateRequest
| Name | Required | Type | Notes |
|---|---|---|---|
| projectIds | required | List | |
| isGlobal | required | Boolean |
Data Type ClientServiceSupport
| Name | Required | Type | Notes |
|---|---|---|---|
| currentUserId | required | Integer | |
| currentUser | required | User | |
| currentUserOrganizationId | required | Integer |
Data Type CollectionSummary
| Name | Required | Type | Notes |
|---|---|---|---|
| totalChildren | required | Integer | |
| totalMissing | required | Integer | |
| totalOutOfSync | required | Integer |
Data Type Comment
| Name | Required | Type | Notes |
|---|---|---|---|
| id | required | Integer | |
| inReplyTo | required | Integer | Reference to another object in a REST Resource |
| createdDate | required | Date | |
| createdBy | required | Integer | Reference to another object in a REST Resource |
| modifiedBy | required | Integer | Reference to another object in a REST Resource |
| deleted | required | Boolean | |
| status | required | String | |
| body | required | CommentBody | |
| commentType | required | String | |
| location | required | CommentLocation |
Data Type CommentBody
| Name | Required | Type | Notes |
|---|---|---|---|
| text | required | String |
Data Type CommentDataListWrapper
| Name | Required | Type | Notes |
|---|---|---|---|
| data | required | List | |
| links | required | Map | |
| meta | required | MetaListWrapper |
Data Type CommentDataWrapper
| Name | Required | Type | Notes |
|---|---|---|---|
| data | required | Comment | |
| links | required | Map | |
| meta | required | MetaWrapper |
Data Type CommentLocation
| Name | Required | Type | Notes |
|---|---|---|---|
| item | required | Integer | Reference to another object in a REST Resource |
| project | required | Integer | Reference to another object in a REST Resource |
Data Type CompositeAbstractVersionedItem
| Name | Required | Type | Notes |
|---|---|---|---|
| object | required | AbstractVersionedItem | |
| value | required | Object | |
| id | required | Integer |
Data Type CompositeTestCycleTestGroup
| Name | Required | Type | Notes |
|---|---|---|---|
| object | required | TestCycleTestGroup | |
| value | required | Object | |
| id | required | Integer |
Data Type CompositeVersionedItem
| Name | Required | Type | Notes |
|---|---|---|---|
| object | required | VersionedItem | |
| value | required | Object | |
| id | required | Integer |
Data Type ConflictErrorMetaWrapper
| Name | Required | Type | Notes |
|---|---|---|---|
| status | required | String | |
| timestamp | required | Date | |
| message | required | String |
Data Type ConflictErrorResponseDataWrapper
| Name | Required | Type | Notes |
|---|---|---|---|
| meta | required | ConflictErrorMetaWrapper |
Data Type ContentDisposition
| Name | Required | Type | Notes |
|---|---|---|---|
| type | required | String | |
| parameters | required | Map | |
| fileName | required | String | |
| creationDate | required | Date | |
| modificationDate | required | Date | |
| readDate | required | Date | |
| size | required | Long |
Data Type CreateCategoryRequest
| Name | Required | Type | Notes |
|---|---|---|---|
| path | required | String |
Data Type CreatedResponse
| Name | Required | Type | Notes |
|---|---|---|---|
| status | required | Integer | |
| statusReasonPhrase | required | String | |
| pageInfo | required | PageInfo | |
| headers | required | AbstractRestResponse_headers | |
| location | required | String | |
| id | required | Integer |
Data Type CreatedResponseDataWrapper
| Name | Required | Type | Notes |
|---|---|---|---|
| meta | required | CreatedResponseMetaWrapper |
Data Type CreatedResponseMetaWrapper
| Name | Required | Type | Notes |
|---|---|---|---|
| status | required | String | |
| timestamp | required | Date | |
| location | required | String | |
| id | required | Integer |
Data Type CreatedResponseSimpleDataWrapper
| Name | Required | Type | Notes |
|---|---|---|---|
| data | required | Integer | |
| meta | required | MetaWrapper |
Data Type CreatedResponseSimpleMetaDataWrapper
| Name | Required | Type | Notes |
|---|---|---|---|
| meta | required | MetaWrapper |
Data Type CrossOriginDomainWhiteList
| Name | Required | Type | Notes |
|---|---|---|---|
| domains | required | List |
Data Type Dashboard
| Name | Required | Type | Notes |
|---|---|---|---|
| layout | required | String | |
| dashboardName | required | String | |
| portletInstances | required | List | |
| createdBy | required | Integer | |
| createdDate | required | Date | |
| modifiedDate | required | Date | |
| modifiedBy | required | Integer | |
| newObject | required | Boolean | |
| xmlToString | required | String | |
| id | required | Integer | |
| organizationId | required | Integer | |
| scopeId | required | Integer | |
| refId | required | Integer | |
| scopeByType | required | String |
Data Type DataResponseProvider
| Name | Required | Type | Notes |
|---|---|---|---|
| serializableValueProviders | required | List |
Data Type DocumentField
| Name | Required | Type | Notes |
|---|---|---|---|
| name | required | String | |
| readOnly | required | Boolean | |
| fieldType | required | Integer | |
| description | required | String | |
| category | required | Integer | |
| custom | required | Boolean | |
| dataType | required | String | |
| formXtype | required | String | |
| editXtype | required | String | |
| gridXtype | required | String | |
| userConfigurable | required | Boolean | |
| isDerived | required | Boolean | |
| createdBy | required | Integer | |
| createdDate | required | Date | |
| modifiedDate | required | Date | |
| modifiedBy | required | Integer | |
| newObject | required | Boolean | |
| xmlToString | required | String | |
| id | required | Integer | |
| organizationId | required | Integer | |
| scopeId | required | Integer | |
| refId | required | Integer | |
| scopeByType | required | String |
Data Type DocumentType
| Name | Required | Type | Notes |
|---|---|---|---|
| description | required | String | |
| category | required | String | |
| active | required | Boolean | |
| display | required | String | |
| displayPlural | required | String | |
| image | required | String | |
| workflowFieldId | required | Integer | |
| hasCustomImage | required | Boolean | |
| documentTypeFields | required | List | |
| documentTypeFacets | required | List | |
| documentTypeKey | required | String | |
| createdBy | required | Integer | |
| createdDate | required | Date | |
| modifiedDate | required | Date | |
| modifiedBy | required | Integer | |
| newObject | required | Boolean | |
| xmlToString | required | String | |
| id | required | Integer | |
| organizationId | required | Integer |
Data Type DocumentTypeField
| Name | Required | Type | Notes |
|---|---|---|---|
| label | required | String | |
| readOnly | required | Boolean | |
| description | required | String | |
| required | required | Boolean | |
| sortOrder | required | Integer | |
| documentType | required | DocumentType | |
| documentField | required | DocumentField | |
| controlStyle | required | String | |
| lookupTypeId | required | Integer | |
| infotip | required | String | |
| controlType | required | String | |
| readOnlyAllowApiOverwrite | required | Boolean | |
| triggerSuspect | required | Boolean | |
| isSynchronizeField | required | Boolean | |
| defaultTemplateId | required | Integer | |
| isReqAdvisorEnabled | required | Boolean | |
| shouldVersion | required | Boolean | |
| isInherited | required | Boolean | |
| createdBy | required | Integer | |
| createdDate | required | Date | |
| modifiedDate | required | Date | |
| modifiedBy | required | Integer | |
| newObject | required | Boolean | |
| xmlToString | required | String | |
| id | required | Integer | |
| organizationId | required | Integer |
Data Type DocumentType_Facet
| Name | Required | Type | Notes |
|---|---|---|---|
| facet | required | String | |
| documentType | required | DocumentType | |
| isSyncedFacet | required | Boolean | |
| id | required | Integer | |
| organizationId | required | Integer |
Data Type DocumentsPatchResult
| Name | Required | Type | Notes |
|---|---|---|---|
| workKey | required | String | |
| message | required | String |
Data Type DocumentsPatchResultDataWrapper
| Name | Required | Type | Notes |
|---|---|---|---|
| data | required | DocumentsPatchResult | |
| meta | required | MetaWrapper |
Data Type DuplicateConfig
| Name | Required | Type | Notes |
|---|---|---|---|
| includeTags | required | Boolean | |
| includeAttachments | required | Boolean | |
| includeLinks | required | Boolean |
Data Type Filter
| Name | Required | Type | Notes |
|---|---|---|---|
| id | required | Integer | |
| name | required | String | |
| author | required | Integer | Reference to another object in a REST Resource |
| projectScope | required | String | |
| specifiedProject | required | Integer | Reference to another object in a REST Resource |
| filterQuery | required | FilterQuery | |
| type | required | String | Resource type identifier. Always returns 'filters' for this resource. |
| public | required | Boolean |
Data Type FilterDataListWrapper
| Name | Required | Type | Notes |
|---|---|---|---|
| data | required | List | |
| links | required | Map | |
| meta | required | MetaListWrapper |
Data Type FilterDataWrapper
| Name | Required | Type | Notes |
|---|---|---|---|
| data | required | Filter | |
| links | required | Map | |
| meta | required | MetaWrapper |
Data Type FilterField
| Name | Required | Type | Notes |
|---|---|---|---|
| id | required | Integer | |
| name | required | String | |
| display | required | String | |
| fieldDataType | required | String |
Data Type FilterOrderRule
| Name | Required | Type | Notes |
|---|---|---|---|
| direction | required | String | |
| field | required | FilterField |
Data Type FilterQuery
| Name | Required | Type | Notes |
|---|---|---|---|
| name | required | String | |
| rule | required | FilterRule | |
| orderRules | required | List |
Data Type FilterRule
| Name | Required | Type | Notes |
|---|---|---|---|
| field | required | FilterField | |
| operator | required | String | |
| values | required | List | |
| itemType | required | Integer | Reference to another object in a REST Resource |
| subQuery | required | FilterQuery | |
| rules | required | List |
Data Type FormDataBodyPart
| Name | Required | Type | Notes |
|---|---|---|---|
| contentDisposition | required | ContentDisposition | |
| entity | required | Object | |
| headers | required | AbstractRestResponse_headers | |
| mediaType | required | MediaType | |
| messageBodyWorkers | required | MessageBodyWorkers | |
| parent | required | MultiPart | |
| providers | required | Providers | |
| formDataContentDisposition | required | FormDataContentDisposition | |
| name | required | String | |
| value | required | String | |
| content | required | Object | |
| fileName | required | String | |
| simple | required | Boolean | |
| parameterizedHeaders | required | BodyPart_parameterizedHeaders |
Data Type FormDataContentDisposition
| Name | Required | Type | Notes |
|---|---|---|---|
| type | required | String | |
| parameters | required | Map | |
| fileName | required | String | |
| creationDate | required | Date | |
| modificationDate | required | Date | |
| readDate | required | Date | |
| size | required | Long | |
| name | required | String |
Data Type FormDataMultiPart
| Name | Required | Type | Notes |
|---|---|---|---|
| contentDisposition | required | ContentDisposition | |
| entity | required | Object | |
| headers | required | AbstractRestResponse_headers | |
| mediaType | required | MediaType | |
| messageBodyWorkers | required | MessageBodyWorkers | |
| parent | required | MultiPart | |
| providers | required | Providers | |
| bodyParts | required | List | |
| fields | required | Map | |
| parameterizedHeaders | required | BodyPart_parameterizedHeaders |
Data Type Item
| Name | Required | Type | Notes |
|---|---|---|---|
| id | required | Integer | |
| documentKey | required | String | |
| globalId | required | String | |
| itemType | required | Integer | Reference to another object in a REST Resource |
| project | required | Integer | Reference to another object in a REST Resource |
| createdDate | required | Date | |
| modifiedDate | required | Date | |
| lastActivityDate | required | Date | |
| createdBy | required | Integer | Reference to another object in a REST Resource |
| modifiedBy | required | Integer | Reference to another object in a REST Resource |
| fields | required | Map | |
| resources | required | Map | |
| baselinedAppliedCategorySnapshots | required | List | |
| version | required | Integer | |
| location | required | Location | |
| lock | required | Lock | |
| childItemType | required | Integer | Reference to another object in a REST Resource |
Data Type ItemCategoryDataListWrapper
| Name | Required | Type | Notes |
|---|---|---|---|
| data | required | List | |
| links | required | Map | |
| meta | required | MetaListWrapper |
Data Type ItemDataListWrapper
| Name | Required | Type | Notes |
|---|---|---|---|
| data | required | List | |
| links | required | Map | |
| meta | required | MetaListWrapper |
Data Type ItemDataWrapper
| Name | Required | Type | Notes |
|---|---|---|---|
| data | required | Item | |
| links | required | Map | |
| meta | required | MetaWrapper |
Data Type ItemLockSubResource
| Name | Required | Type | Notes |
|---|---|---|---|
| clientServiceSupport | required | ClientServiceSupport | |
| dataResponseProvider | required | DataResponseProvider | |
| itemId | required | Integer | |
| restItemService | required | RestItemService |
Data Type ItemType
| 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 | List | |
| fields | required | List | |
| system | required | Boolean |
Data Type ItemTypeDataListWrapper
| Name | Required | Type | Notes |
|---|---|---|---|
| data | required | List | |
| links | required | Map | |
| meta | required | MetaListWrapper |
Data Type ItemTypeDataWrapper
| Name | Required | Type | Notes |
|---|---|---|---|
| data | required | ItemType | |
| links | required | Map | |
| meta | required | MetaWrapper |
Data Type ItemTypeField
| 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 | Reference to another object in a REST Resource |
| textType | required | String | |
| itemType | required | Integer | Reference to another object in a REST Resource |
| infotip | required | String | |
| controlStyle | required | String | |
| defaultTemplateId | required | Integer | |
| isInherited | required | Boolean | |
| reqAdvisorEnabled | required | Boolean |
Data Type ItemTypeWidget
| Name | Required | Type | Notes |
|---|---|---|---|
| name | required | String | |
| synchronize | required | Boolean |
Data Type Link
| Name | Required | Type | Notes |
|---|---|---|---|
| type | required | String | |
| href | required | String |
Data Type LinkDataListWrapper
| Name | Required | Type | Notes |
|---|---|---|---|
| data | required | List | |
| links | required | Map | |
| meta | required | MetaListWrapper |
Data Type LinkDataWrapper
| Name | Required | Type | Notes |
|---|---|---|---|
| data | required | Link | |
| links | required | Map | |
| meta | required | MetaWrapper |
Data Type Location
| 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 |
Data Type LocationDataWrapper
| Name | Required | Type | Notes |
|---|---|---|---|
| data | required | Location | |
| links | required | Map | |
| meta | required | MetaWrapper |
Data Type Lock
| Name | Required | Type | Notes |
|---|---|---|---|
| locked | required | Boolean | |
| lastLockedDate | required | Date | |
| lockedBy | required | Integer | Reference to another object in a REST Resource |
Data Type LockDataWrapper
| Name | Required | Type | Notes |
|---|---|---|---|
| data | required | Lock | |
| links | required | Map | |
| meta | required | MetaWrapper |
Data Type Lookup
| Name | Required | Type | Notes |
|---|---|---|---|
| name | required | String | |
| color | required | String | |
| description | required | String | |
| lookupType | required | LookupType | |
| active | required | Boolean | |
| sortOrder | required | Integer | |
| isDefault | required | Boolean | |
| archived | required | Boolean | |
| dataValue | required | String | |
| replacementLookup | required | Lookup | |
| infotip | required | String | |
| image | required | String | |
| createdBy | required | Integer | |
| createdDate | required | Date | |
| modifiedDate | required | Date | |
| modifiedBy | required | Integer | |
| newObject | required | Boolean | |
| xmlToString | required | String | |
| id | required | Integer | |
| organizationId | required | Integer |
Data Type LookupType
| Name | Required | Type | Notes |
|---|---|---|---|
| name | required | String | |
| type | required | Integer | |
| description | required | String | |
| category | required | Integer | |
| active | required | Boolean | |
| lookups | required | List | |
| createdBy | required | Integer | |
| createdDate | required | Date | |
| modifiedDate | required | Date | |
| modifiedBy | required | Integer | |
| newObject | required | Boolean | |
| xmlToString | required | String | |
| id | required | Integer | |
| organizationId | required | Integer | |
| scopeId | required | Integer | |
| refId | required | Integer | |
| scopeByType | required | String |
Data Type MediaType
| Name | Required | Type | Notes |
|---|---|---|---|
| type | required | String | |
| subtype | required | String | |
| parameters | required | Map | |
| wildcardType | required | Boolean | |
| wildcardSubtype | required | Boolean |
Data Type MessageBodyWorkers
| Name | Required | Type | Notes |
|---|
Data Type MetaListWrapper
| Name | Required | Type | Notes |
|---|---|---|---|
| pageInfo | required | PageInfo | |
| status | required | String | |
| timestamp | required | Date |
Data Type MetaWrapper
| Name | Required | Type | Notes |
|---|---|---|---|
| status | required | String | |
| timestamp | required | Date |
Data Type MultiPart
| Name | Required | Type | Notes |
|---|---|---|---|
| contentDisposition | required | ContentDisposition | |
| entity | required | Object | |
| headers | required | AbstractRestResponse_headers | |
| mediaType | required | MediaType | |
| messageBodyWorkers | required | MessageBodyWorkers | |
| parent | required | MultiPart | |
| providers | required | Providers | |
| bodyParts | required | List | |
| parameterizedHeaders | required | BodyPart_parameterizedHeaders |
Data Type MultivaluedMapStringParameterizedHeader
| Name | Required | Type | Notes |
|---|
Data Type MultivaluedMapStringString
| Name | Required | Type | Notes |
|---|
Data Type ObjectLoader
| Name | Required | Type | Notes |
|---|---|---|---|
| name | required | String | |
| supportedType | required | String |
Data Type ObjectResponseDataWrapper
| Name | Required | Type | Notes |
|---|---|---|---|
| data | required | Integer | |
| meta | required | MetaWrapper | |
| links | required | Map |
Data Type OkResponseDataWraper
| Name | Required | Type | Notes |
|---|---|---|---|
| meta | required | MetaWrapper |
Data Type Organization
| Name | Required | Type | Notes |
|---|---|---|---|
| name | required | String | |
| description | required | String | |
| baseUrl | required | String | |
| closed | required | Boolean | |
| returnEmail | required | String | |
| licenseMessage | required | Integer | |
| redirectUrl | required | String | |
| subdomain | required | String | |
| createdBy | required | Integer | |
| createdDate | required | Date | |
| modifiedDate | required | Date | |
| modifiedBy | required | Integer | |
| newObject | required | Boolean | |
| xmlToString | required | String | |
| id | required | Integer | |
| organizationId | required | Integer |
Data Type PageInfo
| Name | Required | Type | Notes |
|---|---|---|---|
| startIndex | required | Integer | |
| resultCount | required | Integer | |
| totalResults | required | Integer |
Data Type ParameterizedHeader
| Name | Required | Type | Notes |
|---|---|---|---|
| value | required | String | |
| parameters | required | Map |
Data Type Parent
| Name | Required | Type | Notes |
|---|---|---|---|
| project | required | Integer | Reference to another object in a REST Resource |
| item | required | Integer | Reference to another object in a REST Resource |
Data Type PickList
| Name | Required | Type | Notes |
|---|---|---|---|
| id | required | Integer | |
| name | required | String | |
| description | required | String |
Data Type PickListDataListWrapper
| Name | Required | Type | Notes |
|---|---|---|---|
| data | required | List | |
| links | required | Map | |
| meta | required | MetaListWrapper |
Data Type PickListDataWrapper
| Name | Required | Type | Notes |
|---|---|---|---|
| data | required | PickList | |
| links | required | Map | |
| meta | required | MetaWrapper |
Data Type PickListOption
| Name | Required | Type | Notes |
|---|---|---|---|
| id | required | Integer | |
| name | required | String | |
| description | required | String | |
| value | required | String | |
| active | required | Boolean | |
| archived | required | Boolean | |
| color | required | String | |
| sortOrder | required | Integer | |
| infotip | required | String | |
| pickList | required | Integer | Reference to another object in a REST Resource |
| default | required | Boolean |
Data Type PickListOptionDataListWrapper
| Name | Required | Type | Notes |
|---|---|---|---|
| data | required | List | |
| links | required | Map | |
| meta | required | MetaListWrapper |
Data Type PickListOptionDataWrapper
| Name | Required | Type | Notes |
|---|---|---|---|
| data | required | PickListOption | |
| links | required | Map | |
| meta | required | MetaWrapper |
Data Type PortletInstance
| Name | Required | Type | Notes |
|---|---|---|---|
| location | required | String | |
| properties | required | Map | |
| dashboard | required | Dashboard | |
| portlet | required | String | |
| id | required | Integer | |
| organizationId | required | Integer |
Data Type Project
| Name | Required | Type | Notes |
|---|---|---|---|
| organization | required | Organization | |
| name | required | String | |
| parent | required | Integer | |
| description | required | String | |
| active | required | Boolean | |
| flag1 | required | Boolean | |
| flag2 | required | Boolean | |
| date1 | required | Date | |
| date2 | required | Date | |
| user1 | required | User | |
| user2 | required | User | |
| text1 | required | String | |
| text2 | required | String | |
| text3 | required | String | |
| string1 | required | String | |
| string2 | required | String | |
| string3 | required | String | |
| string4 | required | String | |
| lookup1 | required | Lookup | |
| lookup2 | required | Lookup | |
| lookup3 | required | Lookup | |
| lookup4 | required | Lookup | |
| statusId | required | Lookup | |
| relationshipRuleSet | required | RelationshipRuleSet | |
| projectKey | required | String | |
| defaultDashboard | required | Dashboard | |
| isFolder | required | Boolean | |
| projectManager | required | User | |
| projectGroup | required | Lookup | |
| projectType | required | ProjectType | |
| createdBy | required | Integer | |
| createdDate | required | Date | |
| modifiedDate | required | Date | |
| modifiedBy | required | Integer | |
| newObject | required | Boolean | |
| xmlToString | required | String | |
| id | required | Integer | |
| organizationId | required | Integer |
Data Type ProjectDataListWrapper
| Name | Required | Type | Notes |
|---|---|---|---|
| data | required | List | |
| links | required | Map | |
| meta | required | MetaListWrapper |
Data Type ProjectDataWrapper
| Name | Required | Type | Notes |
|---|---|---|---|
| data | required | Project | |
| links | required | Map | |
| meta | required | MetaWrapper |
Data Type ProjectType
| Name | Required | Type | Notes |
|---|---|---|---|
| name | required | String | |
| description | required | String | |
| components | required | String | |
| defaultDisplay | required | String | |
| defaultDisplayPlural | required | String | |
| defaultPrefix | required | String | |
| createdBy | required | Integer | |
| createdDate | required | Date | |
| modifiedDate | required | Date | |
| modifiedBy | required | Integer | |
| newObject | required | Boolean | |
| xmlToString | required | String | |
| id | required | Integer | |
| organizationId | required | Integer | |
| scopeId | required | Integer | |
| refId | required | Integer | |
| scopeByType | required | String |
Data Type Providers
| Name | Required | Type | Notes |
|---|
Data Type Relationship
| Name | Required | Type | Notes |
|---|---|---|---|
| id | required | Integer | |
| fromItem | required | Integer | Reference to another object in a REST Resource |
| toItem | required | Integer | Reference to another object in a REST Resource |
| relationshipType | required | Integer | Reference to another object in a REST Resource |
| suspect | required | Boolean |
Data Type RelationshipDataListWrapper
| Name | Required | Type | Notes |
|---|---|---|---|
| data | required | List | |
| links | required | Map | |
| meta | required | MetaListWrapper |
Data Type RelationshipDataWrapper
| Name | Required | Type | Notes |
|---|---|---|---|
| data | required | Relationship | |
| links | required | Map | |
| meta | required | MetaWrapper |
Data Type RelationshipRule
| Name | Required | Type | Notes |
|---|---|---|---|
| relationshipType | required | RelationshipType | |
| fromDocType | required | DocumentType | |
| toDocType | required | DocumentType | |
| forCoverage | required | Boolean | |
| ruleSet | required | RelationshipRuleSet | |
| id | required | Integer | |
| organizationId | required | Integer |
Data Type RelationshipRuleSet
| Name | Required | Type | Notes |
|---|---|---|---|
| name | required | String | |
| rules | required | List | |
| isExclusive | required | Boolean | |
| id | required | Integer | |
| organizationId | required | Integer |
Data Type RelationshipType
| Name | Required | Type | Notes |
|---|---|---|---|
| name | required | String | |
| description | required | String | |
| active | required | Boolean | |
| sortOrder | required | Integer | |
| isDefault | required | Boolean | |
| showStatus | required | Boolean | |
| showNote | required | Boolean | |
| image | required | String | |
| createdBy | required | Integer | |
| createdDate | required | Date | |
| modifiedDate | required | Date | |
| modifiedBy | required | Integer | |
| newObject | required | Boolean | |
| xmlToString | required | String | |
| id | required | Integer | |
| organizationId | required | Integer | |
| scopeId | required | Integer | |
| refId | required | Integer | |
| scopeByType | required | String |
Data Type RelationshipTypeDataListWrapper
| Name | Required | Type | Notes |
|---|---|---|---|
| data | required | List | |
| links | required | Map | |
| meta | required | MetaListWrapper |
Data Type RelationshipTypeDataWrapper
| Name | Required | Type | Notes |
|---|---|---|---|
| data | required | RelationshipType | |
| links | required | Map | |
| meta | required | MetaWrapper |
Data Type Release
| Name | Required | Type | Notes |
|---|---|---|---|
| id | required | Integer | |
| name | required | String | |
| description | required | String | |
| project | required | Integer | Reference to another object in a REST Resource |
| releaseDate | required | Date | |
| active | required | Boolean | |
| archived | required | Boolean | |
| itemCount | required | Integer |
Data Type ReleaseDataListWrapper
| Name | Required | Type | Notes |
|---|---|---|---|
| data | required | List | |
| links | required | Map | |
| meta | required | MetaListWrapper |
Data Type ReleaseDataWrapper
| Name | Required | Type | Notes |
|---|---|---|---|
| data | required | Release | |
| links | required | Map | |
| meta | required | MetaWrapper |
Data Type RequestActiveStatus
| Name | Required | Type | Notes |
|---|---|---|---|
| active | required | Boolean |
Data Type RequestArchivedStatus
| Name | Required | Type | Notes |
|---|---|---|---|
| archived | required | Boolean |
Data Type RequestAttachment
| Name | Required | Type | Notes |
|---|---|---|---|
| fields | required | Map | A map of field names to field values e.g. {\"name\":\"Sample Item\", \"status\": 292, \"release\": 2, \"assigned\": 23} |
Data Type RequestBaseline
| 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 |
Data Type RequestBatchLock
| Name | Required | Type | Notes |
|---|---|---|---|
| itemIds | required | List | |
| locked | required | Boolean |
Data Type RequestCategoryPaths
| Name | Required | Type | Notes |
|---|---|---|---|
| categoryPathIds | required | List |
Data Type RequestComment
| Name | Required | Type | Notes |
|---|---|---|---|
| inReplyTo | required | Integer | ID of a comment. Comment that this comment is in reply to |
| body | required | RequestCommentBody | |
| commentType | required | String | |
| location | required | RequestCommentLocation |
Data Type RequestCommentBody
| Name | Required | Type | Notes |
|---|---|---|---|
| text | required | String |
Data Type RequestCommentLocation
| Name | Required | Type | Notes |
|---|---|---|---|
| item | required | Integer | ID of an item |
| project | required | Integer | ID of a project |
Data Type RequestCreateTestPlan
| Name | Required | Type | Notes |
|---|---|---|---|
| fields | required | Map | A map of field names to field values e.g. {\"name\":\"Sample Item\", \"status\": 292, \"release\": 2, \"assigned\": 23} |
| parentTestPlanFolderId | required | Integer |
Data Type RequestGroupUser
| Name | Required | Type | Notes |
|---|---|---|---|
| user | required | Integer |
Data Type RequestItem
| Name | Required | Type | Notes |
|---|---|---|---|
| fields | required | Map | A map of field names to field values e.g. {\"name\":\"Sample Item\", \"status\": 292, \"release\": 2, \"assigned\": 23} |
| globalId | required | String | Must use override if you want to set this description on POST. |
| itemType | required | Integer | ID of an item type. Only required when creating a new item (POST) |
| childItemType | required | Integer | ID of an item type. Required when creating an item type of set or folder |
| location | required | RequestLocation |
Data Type RequestItemAttachment
| Name | Required | Type | Notes |
|---|---|---|---|
| attachment | required | Integer |
Data Type RequestItemSyncedItem
| Name | Required | Type | Notes |
|---|---|---|---|
| item | required | Integer | ID of a item |
Data Type RequestItemTag
| Name | Required | Type | Notes |
|---|---|---|---|
| tag | required | Integer |
Data Type RequestItemType
| 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 | List |
Data Type RequestItemTypeField
| 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 | |
| infotip | required | String |
Data Type RequestItemTypeWidget
| Name | Required | Type | Notes |
|---|---|---|---|
| name | required | String | |
| synchronize | required | Boolean |
Data Type RequestItemsPatchOperations
| Name | Required | Type | Notes |
|---|---|---|---|
| items | required | List | The list of IDs of the items to modify |
| operations | required | List | The list of RequestPatchOperation to apply to the items |
Data Type RequestLink
| Name | Required | Type | Notes |
|---|---|---|---|
| url | required | String | |
| description | required | String |
Data Type RequestLocation
| Name | Required | Type | Notes |
|---|---|---|---|
| parent | required | RequestParent | |
| sortOrder | required | Integer |
Data Type RequestLock
| Name | Required | Type | Notes |
|---|---|---|---|
| locked | required | Boolean |
Data Type RequestMoveLocation
| Name | Required | Type | Notes |
|---|---|---|---|
| parent | required | RequestMoveParent |
Data Type RequestMoveParent
| Name | Required | Type | Notes |
|---|---|---|---|
| project | required | Integer | ID of an project |
Data Type RequestParent
| 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 description will be inferred by the \"project\" property at the root of the payload when a parent location is not specified. |
Data Type RequestPatchOperation
| 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) |
Data Type RequestPickList
| 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 |
Data Type RequestPickListOption
| Name | Required | Type | Notes |
|---|---|---|---|
| description | required | String | |
| name | required | String | |
| value | required | String | |
| color | required | String | |
| sortOrder | required | Integer | |
| infotip | required | String | |
| default | required | Boolean |
Data Type RequestProject
| Name | Required | Type | Notes |
|---|---|---|---|
| projectKey | required | String | Not Required if isFolder is true |
| isFolder | required | Boolean | |
| parent | required | Integer | parent project |
| fields | required | Map | A map of field names to field values e.g. {\"name\":\"Sample Project\", \"status\": 292, \"release\": 2, \"projectManager\": 23} |
Data Type RequestRelationship
| 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 |
Data Type RequestRelease
| Name | Required | Type | Notes |
|---|---|---|---|
| name | required | String | |
| description | required | String | |
| releaseDate | required | String | Dates must be in the format yyyy-mm-dd |
| project | required | Integer | Only required when creating a new item (POST) |
Data Type RequestTag
| Name | Required | Type | Notes |
|---|---|---|---|
| name | required | String | |
| project | required | Integer | Only required on tag creation (POST) |
Data Type RequestTestCycle
| Name | Required | Type | Notes |
|---|---|---|---|
| fields | required | Map | 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 |
Data Type RequestTestGroup
| Name | Required | Type | Notes |
|---|---|---|---|
| name | required | String | |
| assignedTo | required | Integer | ID of a user |
Data Type RequestTestGroupTestCase
| Name | Required | Type | Notes |
|---|---|---|---|
| testCase | required | Integer |
Data Type RequestTestPlan
| Name | Required | Type | Notes |
|---|---|---|---|
| fields | required | Map | A map of field names to field values e.g. {\"name\":\"Sample Item\", \"status\": 292, \"release\": 2, \"assigned\": 23} |
Data Type RequestTestRun
| Name | Required | Type | Notes |
|---|---|---|---|
| fields | required | Map | A map of field names to field values e.g. {\"name\":\"Sample Item\", \"status\": 292, \"release\": 2, \"assigned\": 23} |
Data Type RequestTransition
| Name | Required | Type | Notes |
|---|---|---|---|
| transitionId | required | String | |
| comment | required | String |
Data Type RequestUser
| 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) |
| 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 | |
| customData | required | List |
Data Type 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). |
Data Type RequestUserGroup
| Name | Required | Type | Notes |
|---|---|---|---|
| name | required | String | |
| description | required | String | |
| project | required | Integer |
Data Type RestItemService
| Name | Required | Type | Notes |
|---|---|---|---|
| batchItemLock | required | RequestBatchLock | |
| andReturnBatchItemLock | required | BatchItemLockResponse |
Data Type RestVersionService
| Name | Required | Type | Notes |
|---|
Data Type Role
| Name | Required | Type | Notes |
|---|---|---|---|
| name | required | String | |
| content | required | String | |
| description | required | String | |
| users | required | List | |
| projectId | required | Integer | |
| projectName | required | String | |
| display | required | String | |
| numUsers | required | Integer | |
| uid | required | String | |
| projectGroup | required | Boolean | |
| roleName | required | String | |
| createdBy | required | Integer | |
| createdDate | required | Date | |
| modifiedDate | required | Date | |
| modifiedBy | required | Integer | |
| newObject | required | Boolean | |
| xmlToString | required | String | |
| id | required | Integer | |
| organizationId | required | Integer |
Data Type SimpleDataWrapper
| Name | Required | Type | Notes |
|---|---|---|---|
| data | required | Object | |
| meta | required | MetaWrapper |
Data Type SimpleFilter
| Name | Required | Type | Notes |
|---|---|---|---|
| id | required | Integer | |
| type | required | String |
Data Type SyncStatus
| Name | Required | Type | Notes |
|---|---|---|---|
| collectionSummary | required | CollectionSummary | |
| inSync | required | Boolean |
Data Type SyncStatusDataWrapper
| Name | Required | Type | Notes |
|---|---|---|---|
| data | required | SyncStatus | |
| links | required | Map | |
| meta | required | MetaWrapper |
Data Type SystemDataWrapper
| Name | Required | Type | Notes |
|---|---|---|---|
| data | required | CrossOriginDomainWhiteList | |
| links | required | Map | |
| meta | required | MetaWrapper |
Data Type Tag
| Name | Required | Type | Notes |
|---|---|---|---|
| id | required | Integer | |
| name | required | String | |
| project | required | Integer | Reference to another object in a REST Resource |
Data Type TagDataListWrapper
| Name | Required | Type | Notes |
|---|---|---|---|
| data | required | List | |
| links | required | Map | |
| meta | required | MetaListWrapper |
Data Type TagDataWrapper
| Name | Required | Type | Notes |
|---|---|---|---|
| data | required | Tag | |
| links | required | Map | |
| meta | required | MetaWrapper |
Data Type TestCycle
| Name | Required | Type | Notes |
|---|---|---|---|
| id | required | Integer | |
| documentKey | required | String | |
| globalId | required | String | |
| itemType | required | Integer | Reference to another object in a REST Resource |
| project | required | Integer | Reference to another object in a REST Resource |
| createdDate | required | Date | |
| modifiedDate | required | Date | |
| lastActivityDate | required | Date | |
| createdBy | required | Integer | Reference to another object in a REST Resource |
| modifiedBy | required | Integer | Reference to another object in a REST Resource |
| fields | required | Map | |
| resources | required | Map | |
| baselinedAppliedCategorySnapshots | required | List | |
| version | required | Integer |
Data Type TestCycleDataListWrapper
| Name | Required | Type | Notes |
|---|---|---|---|
| data | required | List | |
| links | required | Map | |
| meta | required | MetaListWrapper |
Data Type TestCycleDataWrapper
| Name | Required | Type | Notes |
|---|---|---|---|
| data | required | TestCycle | |
| links | required | Map | |
| meta | required | MetaWrapper |
Data Type TestCycleTestGroup
| Name | Required | Type | Notes |
|---|---|---|---|
| name | required | String | |
| assignedTo | required | Integer | Reference to another object in a REST Resource |
| testGroup | required | Integer | |
| testCycle | required | Integer | |
| type | required | String |
Data Type TestCycleTestGroupDataWrapper
| Name | Required | Type | Notes |
|---|---|---|---|
| data | required | TestCycleTestGroup | |
| links | required | Map | |
| linked | required | Map | |
| meta | required | MetaWrapper |
Data Type TestCycleVersionsSubResource
| Name | Required | Type | Notes |
|---|---|---|---|
| clientServiceSupport | required | ClientServiceSupport | |
| dataResponseProvider | required | DataResponseProvider | |
| itemId | required | Integer | |
| restVersionService | required | RestVersionService |
Data Type TestGroup
| Name | Required | Type | Notes |
|---|---|---|---|
| id | required | Integer | |
| name | required | String | |
| assignedTo | required | Integer | Reference to another object in a REST Resource |
Data Type TestGroupDataListWrapper
| Name | Required | Type | Notes |
|---|---|---|---|
| data | required | List | |
| links | required | Map | |
| meta | required | MetaListWrapper |
Data Type TestGroupDataWrapper
| Name | Required | Type | Notes |
|---|---|---|---|
| data | required | TestGroup | |
| links | required | Map | |
| meta | required | MetaWrapper |
Data Type TestPlan
| Name | Required | Type | Notes |
|---|---|---|---|
| id | required | Integer | |
| documentKey | required | String | |
| globalId | required | String | |
| itemType | required | Integer | Reference to another object in a REST Resource |
| project | required | Integer | Reference to another object in a REST Resource |
| createdDate | required | Date | |
| modifiedDate | required | Date | |
| lastActivityDate | required | Date | |
| createdBy | required | Integer | Reference to another object in a REST Resource |
| modifiedBy | required | Integer | Reference to another object in a REST Resource |
| fields | required | Map | |
| resources | required | Map | |
| baselinedAppliedCategorySnapshots | required | List | |
| version | required | Integer | |
| archived | required | Boolean |
Data Type TestPlanDataListWrapper
| Name | Required | Type | Notes |
|---|---|---|---|
| data | required | List | |
| links | required | Map | |
| meta | required | MetaListWrapper |
Data Type TestPlanDataWrapper
| Name | Required | Type | Notes |
|---|---|---|---|
| data | required | TestPlan | |
| links | required | Map | |
| meta | required | MetaWrapper |
Data Type TestPlanVersionsSubResource
| Name | Required | Type | Notes |
|---|---|---|---|
| clientServiceSupport | required | ClientServiceSupport | |
| dataResponseProvider | required | DataResponseProvider | |
| itemId | required | Integer | |
| restVersionService | required | RestVersionService |
Data Type TestRun
| Name | Required | Type | Notes |
|---|---|---|---|
| id | required | Integer | |
| documentKey | required | String | |
| globalId | required | String | |
| itemType | required | Integer | Reference to another object in a REST Resource |
| project | required | Integer | Reference to another object in a REST Resource |
| createdDate | required | Date | |
| modifiedDate | required | Date | |
| lastActivityDate | required | Date | |
| createdBy | required | Integer | Reference to another object in a REST Resource |
| modifiedBy | required | Integer | Reference to another object in a REST Resource |
| fields | required | Map | |
| resources | required | Map | |
| baselinedAppliedCategorySnapshots | required | List | |
| version | required | Integer | |
| testCaseVersionNumber | required | Integer | The version of the test case at the time of test run creation |
| testCaseCurrentVersionNumber | required | Integer | The current version of the test case that the test run is based on |
| sortOrderFromTestGroup | required | Integer | The sort order within the test group at the time of test cycle creation |
| TestCycleTestGroup | required | CompositeTestCycleTestGroup |
Data Type TestRunDataListWrapper
| Name | Required | Type | Notes |
|---|---|---|---|
| data | required | List | |
| links | required | Map | |
| meta | required | MetaListWrapper |
Data Type TestRunDataWrapper
| Name | Required | Type | Notes |
|---|---|---|---|
| data | required | TestRun | |
| links | required | Map | |
| meta | required | MetaWrapper |
Data Type TestRunGenerationConfig
| Name | Required | Type | Notes |
|---|---|---|---|
| testGroupsToInclude | required | List | 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 | List | 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 |
Data Type TestRunVersionsSubResource
| Name | Required | Type | Notes |
|---|---|---|---|
| clientServiceSupport | required | ClientServiceSupport | |
| dataResponseProvider | required | DataResponseProvider | |
| itemId | required | Integer | |
| restVersionService | required | RestVersionService |
Data Type TreeLocationRequest
| Name | Required | Type | Notes |
|---|---|---|---|
| itemIds | required | List | |
| parentItemId | required | Integer | |
| insertBeforeItemId | required | Integer |
Data Type User
| Name | Required | Type | Notes |
|---|---|---|---|
| id | required | Integer | |
| username | required | String | |
| firstName | required | String | |
| lastName | required | String | |
| required | String | ||
| phone | required | String | |
| title | required | String | |
| location | required | String | |
| licenseType | required | String | |
| active | required | Boolean | |
| authenticationType | required | AuthenticationType | |
| uid | required | String | |
| customData | required | List | |
| type | required | String | Resource type identifier. Always returns 'users' for this resource. |
Data Type UserCustomData
| Name | Required | Type | Notes |
|---|---|---|---|
| name | required | String | |
| value | required | String |
Data Type UserCustomDataDataListWrapper
| Name | Required | Type | Notes |
|---|---|---|---|
| data | required | List | |
| meta | required | MetaListWrapper |
Data Type UserDataListWrapper
| Name | Required | Type | Notes |
|---|---|---|---|
| data | required | List | |
| links | required | Map | |
| meta | required | MetaListWrapper |
Data Type UserDataWrapper
| Name | Required | Type | Notes |
|---|---|---|---|
| data | required | User | |
| links | required | Map | |
| meta | required | MetaWrapper |
Data Type UserGroup
| Name | Required | Type | Notes |
|---|---|---|---|
| id | required | Integer | |
| uid | required | String | |
| name | required | String | |
| description | required | String | |
| project | required | Integer | Reference to another object in a REST Resource |
| type | required | String | Resource type identifier. Always returns 'usergroups' for this resource. |
Data Type UserGroupDataListWrapper
| Name | Required | Type | Notes |
|---|---|---|---|
| data | required | List | |
| links | required | Map | |
| meta | required | MetaListWrapper |
Data Type UserGroupDataWrapper
| Name | Required | Type | Notes |
|---|---|---|---|
| data | required | UserGroup | |
| links | required | Map | |
| meta | required | MetaWrapper |
Data Type Version
| Name | Required | Type | Notes |
|---|---|---|---|
| item | required | Integer | Reference to another object in a REST Resource |
| versionNumber | required | Integer | |
| versionedItem | required | CompositeAbstractVersionedItem | |
| changeDetails | required | String | |
| comment | required | String | |
| createdDate | required | Date | |
| createdBy | required | Integer | Reference to another object in a REST Resource |
| userName | required | String | |
| type | required | String |
Data Type VersionDataListWrapper
| Name | Required | Type | Notes |
|---|---|---|---|
| data | required | List | |
| links | required | Map | |
| meta | required | MetaListWrapper |
Data Type VersionDataWrapper
| Name | Required | Type | Notes |
|---|---|---|---|
| data | required | Version | |
| links | required | Map | |
| meta | required | MetaWrapper |
Data Type VersionedAttachment
| Name | Required | Type | Notes |
|---|---|---|---|
| id | required | Integer | |
| documentKey | required | String | |
| globalId | required | String | |
| itemType | required | Integer | Reference to another object in a REST Resource |
| project | required | Integer | Reference to another object in a REST Resource |
| createdDate | required | Date | |
| modifiedDate | required | Date | |
| lastActivityDate | required | Date | |
| createdBy | required | Integer | Reference to another object in a REST Resource |
| modifiedBy | required | Integer | Reference to another object in a REST Resource |
| fields | required | Map | |
| resources | required | Map | |
| baselinedAppliedCategorySnapshots | required | List | |
| version | required | Integer | |
| lock | required | Lock | |
| fileName | required | String | |
| mimeType | required | String | |
| fileSize | required | Integer | |
| currentVersion | required | Integer | Currently active version of the versioned item. If no version is active, currentVersion will not be returned. |
Data Type VersionedAttachmentDataWrapper
| Name | Required | Type | Notes |
|---|---|---|---|
| data | required | VersionedAttachment | |
| links | required | Map | |
| meta | required | MetaWrapper |
Data Type VersionedItem
| Name | Required | Type | Notes |
|---|---|---|---|
| id | required | Integer | |
| documentKey | required | String | |
| globalId | required | String | |
| itemType | required | Integer | Reference to another object in a REST Resource |
| project | required | Integer | Reference to another object in a REST Resource |
| createdDate | required | Date | |
| modifiedDate | required | Date | |
| lastActivityDate | required | Date | |
| createdBy | required | Integer | Reference to another object in a REST Resource |
| modifiedBy | required | Integer | Reference to another object in a REST Resource |
| fields | required | Map | |
| resources | required | Map | |
| baselinedAppliedCategorySnapshots | required | List | |
| version | required | Integer | |
| childItemType | required | Integer | Reference to another object in a REST Resource |
| currentVersion | required | Integer | Currently active version of the versioned item. If no version is active, currentVersion will not be returned. |
Data Type WorkStatus
| Name | Required | Type | Notes |
|---|---|---|---|
| workKey | required | String | |
| jobName | required | String | |
| inProgress | required | Boolean | |
| isFailed | required | Boolean | |
| workSteps | required | List | |
| returnValue | required | String |
Data Type WorkStatusDataWrapper
| Name | Required | Type | Notes |
|---|---|---|---|
| data | required | WorkStatus | |
| links | required | Map | |
| linked | required | Map | |
| meta | required | MetaWrapper |
Data Type WorkStepStatus
| Name | Required | Type | Notes |
|---|---|---|---|
| stepName | required | String | |
| completedWork | required | Integer | |
| totalWork | required | Integer |
Data Type WorkflowTransition
| Name | Required | Type | Notes |
|---|---|---|---|
| id | required | String | |
| action | required | String | |
| newStatus | required | Integer | Reference to another object in a REST Resource |
Data Type WorkflowTransitionDataListWrapper
| Name | Required | Type | Notes |
|---|---|---|---|
| data | required | List | |
| links | required | Map | |
| meta | required | MetaListWrapper |