This is the documentation for the Jama REST API.

API v1 / Connect v9.12

Endpoints

Endpoint abstractitems

The abstractitems endpoint has the following operations:

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

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

GET /abstractitems

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

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

• application/json

Request headers:

• xJamaDateFieldsWithTime
  (optional) 

Query parameters:

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

Examples:

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

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

• application/json

Response:

ItemDataListWrapper

GET /abstractitems/{id}

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

Path parameters:

• id(required)

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

• application/json

Request headers:

• xJamaDateFieldsWithTime
  (optional) 

Query parameters:

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

Examples:

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

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

• application/json

Response:

AbstractItemDataWrapper

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

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

Path parameters:

• versionNum(required)
• id(required)

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

• application/json

Request headers:

• xJamaDateFieldsWithTime
  (optional) 

Query parameters:

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

Examples:

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

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

• application/json

Response:

VersionDataWrapper

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

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

Path parameters:

• versionNum(required)
• id(required)

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

• application/json

Request headers:

• xJamaDateFieldsWithTime
  (optional) 

Query parameters:

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

Examples:

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

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

• application/json

Response:

AbstractVersionedItemDataWrapper

GET /abstractitems/{id}/versionedrelationships

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

Path parameters:

• id(required)

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

• application/json

Query parameters:

• timestamp(required)

  Get relationships for the specified item at this date and time. Requires ISO8601 formatting (milliseconds or seconds) – \”yyyy-MM-dd’T’HH:mm:ss.SSSZ\” or \”yyyy-MM-dd’T’HH:mm:ssZ\”

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

Examples:

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

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

• application/json

Response:

VersionedRelationshipDataListWrapper

GET /abstractitems/{id}/versions

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

Path parameters:

• id(required)

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

• application/json

Request headers:

• xJamaDateFieldsWithTime
  (optional) 

Query parameters:

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

Examples:

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

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

• application/json

Response:

VersionDataListWrapper

Endpoint activities

The activities endpoint has the following operations:

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

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

GET /activities

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

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

• application/json

Request headers:

• xJamaDateFieldsWithTime
  (optional) 

Query parameters:

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

Examples:

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

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

• application/json

Response:

ActivityDataListWrapper

GET /activities/{activityId}

Summary: Get the activity with the specified ID

Path parameters:

• activityId(required)

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

• application/json

Request headers:

• xJamaDateFieldsWithTime
  (optional) 

Query parameters:

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

Examples:

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

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

• application/json

Response:

ActivityDataWrapper

GET /activities/adminActivity

Summary: Get all activities at the admin level

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

• application/json

Request headers:

• xJamaDateFieldsWithTime
  (optional) 

Query parameters:

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

Examples:

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

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

• application/json

Response:

AbstractRestResponse

GET /activities/{activityId}/affecteditems

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

Path parameters:

• activityId(required)

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

• application/json

Request headers:

• xJamaDateFieldsWithTime
  (optional) 

Query parameters:

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

Examples:

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

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

• application/json

Response:

ItemDataListWrapper

POST /activities/{activityId}/restore

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

Path parameters:

• activityId(required)

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

• application/json

Examples:

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

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

• application/json

Response:

AbstractRestResponse

Endpoint attachments

The attachments endpoint has the following operations:

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

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

GET /attachments/{attachmentId}/file

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

Path parameters:

• attachmentId(required)

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

• application/json

Request headers:

• xJamaDateFieldsWithTime
  (optional) 

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

• application/octet-stream

Response:

GET /attachments/{attachmentId}

Summary: Get the attachment with the specified ID

Path parameters:

• attachmentId(required)

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

• application/json

Request headers:

• xJamaDateFieldsWithTime
  (optional) 

Query parameters:

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

Examples:

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

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

• application/json

Response:

AttachmentDataWrapper

GET /attachments/{attachmentId}/comments

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

Path parameters:

• attachmentId(required)

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

• application/json

Request headers:

• xJamaDateFieldsWithTime
  (optional) 

Query parameters:

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

Examples:

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

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

• application/json

Response:

CommentDataListWrapper

GET /attachments/{attachmentId}/lock

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

Path parameters:

• attachmentId(required)

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

• application/json

Request headers:

• xJamaDateFieldsWithTime
  (optional) 

Query parameters:

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

Examples:

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

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

• application/json

Response:

LockDataWrapper

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

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

Path parameters:

• versionNum(required)
• attachmentId(required)

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

• application/json

Request headers:

• xJamaDateFieldsWithTime
  (optional) 

Query parameters:

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

Examples:

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

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

• application/json

Response:

VersionDataWrapper

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

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

Path parameters:

• versionNum(required)
• attachmentId(required)

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

• application/json

Request headers:

• xJamaDateFieldsWithTime
  (optional) 

Query parameters:

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

Examples:

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

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

• application/json

Response:

VersionedAttachmentDataWrapper

GET /attachments/{attachmentId}/versions

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

Path parameters:

• attachmentId(required)

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

• application/json

Request headers:

• xJamaDateFieldsWithTime
  (optional) 

Query parameters:

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

Examples:

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

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

• application/json

Response:

VersionDataListWrapper

PUT /attachments/{attachmentId}/lock

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

Path parameters:

• attachmentId(required)

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

• application/json

Body:

RequestLockExamples:

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

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

• application/json

Response:

AbstractRestResponse

PUT /attachments/{attachmentId}/file

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

Path parameters:

• attachmentId(required)

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

• multipart/form-data

Body:

FormDataMultiPartExamples:

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

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

• application/json

Response:

AbstractRestResponse

Endpoint baselines

The baselines endpoint has the following operations:

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

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

DELETE /baselines/{baselineId}

Summary: Delete the baseline with the specified ID

Path parameters:

• baselineId(required)

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

• application/json

Examples:

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

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

• application/json

Response:

AbstractRestResponse

GET /baselines/{baselineId}

Summary: Get the baseline with the specified ID

Path parameters:

• baselineId(required)

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

• application/json

Request headers:

• xJamaDateFieldsWithTime
  (optional) 

Query parameters:

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

Examples:

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

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

• application/json

Response:

BaselineDataWrapper

GET /baselines

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

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

• application/json

Request headers:

• xJamaDateFieldsWithTime
  (optional) 

Query parameters:

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

Examples:

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

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

• application/json

Response:

BaselineDataListWrapper

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

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

Path parameters:

• itemId(required)
• baselineId(required)

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

• application/json

Request headers:

• xJamaDateFieldsWithTime
  (optional) 

Query parameters:

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

Examples:

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

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

• application/json

Response:

VersionedRelationshipDataListWrapper

GET /baselines/{baselineId}/reviewlink

Summary: Get related review link

Path parameters:

• baselineId(required)

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

• application/json

Examples:

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

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

• application/json

Response:

AbstractRestResponse

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

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

Path parameters:

• itemId(required)
• baselineId(required)

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

• application/json

Request headers:

• xJamaDateFieldsWithTime
  (optional) 

Query parameters:

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

Examples:

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

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

• application/json

Response:

BaselineItemDataWrapper

GET /baselines/{baselineId}/versioneditems

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

Path parameters:

• baselineId(required)

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

• application/json

Request headers:

• xJamaDateFieldsWithTime
  (optional) 

Query parameters:

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

Examples:

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

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

• application/json

Response:

BaselineItemDataListWrapper

PUT /baselines/{baselineId}

Summary: Update the baseline with the specified ID

Path parameters:

• baselineId(required)

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

• application/json

Body:

RequestBaselineExamples:

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

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

• application/json

Response:

AbstractRestResponse

Endpoint categories

The categories endpoint has the following operations:

1. POST /categories
2. PUT /categories/{categoryPathId}/visibility
3. GET /categories

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:

CreateCategoryRequestExamples:

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

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

• application/json

Response:

AbstractRestResponse

Response:

CreatedResponse

Response:

BadRequestResponse

Response:

ConflictErrorResponse

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:

CategoryVisibilityUpdateRequestExamples:

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

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

• application/json

Response:

AbstractRestResponse

GET /categories

Summary: Get all category paths by name (and/or) project id

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

• application/json

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
  {
  “headers” : {
  “key” : [ “headers”, “headers” ]
  },
  “pageInfo” : {
  “startIndex” : 6,
  “resultCount” : 1,
  “totalResults” : 5
  },
  “statusReasonPhrase” : “statusReasonPhrase”,
  “status” : 0
  }

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

• application/json

Response:

AbstractRestResponse

Endpoint comments

The comments endpoint has the following operations:

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

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

POST /comments

Summary: Create a new comment

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

• application/json

Body:

RequestCommentExamples:

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

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

• application/json

Response:

CreatedResponse

GET /comments/{id}

Summary: Get the comment with the specified ID

Path parameters:

• id(required)

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

• application/json

Request headers:

• xJamaDateFieldsWithTime
  (optional) 

Query parameters:

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

Examples:

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

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

• application/json

Response:

CommentDataWrapper

GET /comments

Summary: Get all comments viewable by the current user

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

• application/json

Request headers:

• xJamaDateFieldsWithTime
  (optional) 

Query parameters:

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

Examples:

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

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

• application/json

Response:

CommentDataListWrapper

GET /comments/{id}/replies

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

Path parameters:

• id(required)

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

• application/json

Request headers:

• xJamaDateFieldsWithTime
  (optional) 

Query parameters:

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

Examples:

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

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

• application/json

Response:

CommentDataListWrapper

Endpoint files

The files endpoint has the following operations:

1. GET /files

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

GET /files

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

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

• application/json

Request headers:

• xJamaDateFieldsWithTime
  (optional) 

Query parameters:

• url(required)

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

• application/json
• application/octet-stream

Response:

Endpoint filters

The filters endpoint has the following operations:

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

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

GET /filters/{filterId}/count

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

Path parameters:

• filterId(required)

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

• application/json

Examples:

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

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

• application/json

Response:

ItemDataListWrapper

GET /filters/{filterId}

Summary: Get the filter with the specified ID

Path parameters:

• filterId(required)

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

• application/json

Request headers:

• xJamaDateFieldsWithTime
  (optional) 

Query parameters:

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

Examples:

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

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

• application/json

Response:

FilterDataWrapper

GET /filters

Summary: Get all filters viewable by the current user

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

• application/json

Request headers:

• xJamaDateFieldsWithTime
  (optional) 

Query parameters:

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

Examples:

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

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

• application/json

Response:

FilterDataListWrapper

GET /filters/{filterId}/results

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

Path parameters:

• filterId(required)

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

• application/json

Request headers:

• xJamaDateFieldsWithTime
  (optional) 

Query parameters:

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

Examples:

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

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

• application/json

Response:

ItemDataListWrapper

Endpoint items

The items endpoint has the following operations:

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

RequestItemAttachmentExamples:

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

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

• application/json

Response:

CreatedResponse

POST /items

Summary: Create a new item

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

• application/json

Body:

RequestItemRequest headers:

• xJamaDateFieldsWithTime
  (optional)
  Preserves both date and time of any DATETIME field value passed in the body of the request. Must be in ISO8601 format (milliseconds or seconds) – \”yyyy-MM-dd’T’HH:mm:ss.SSSZ\” or \”yyyy-MM-dd’T’HH:mm:ssZ\”.

Query parameters:

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

Examples:

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

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

• application/json

Response:

CreatedResponse

POST /items/{id}/links

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

Path parameters:

• id(required)

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

• application/json

Body:

RequestLinkExamples:

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

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

• application/json

Response:

CreatedResponse

POST /items/{id}/tags

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

Path parameters:

• id(required)

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

• application/json

Body:

RequestItemTagExamples:

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

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

• application/json

Response:

CreatedResponse

POST /items/{id}/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:

RequestCategoryPathsExamples:

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

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

• application/json

Response:

AbstractRestResponse

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

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

Path parameters:

• syncedItemId(required)
• id(required)

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

• application/json

Examples:

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

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

• application/json

Response:

AbstractRestResponse

POST /items/{id}/synceditems

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

Path parameters:

• id(required)

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

• application/json

Body:

RequestItemSyncedItemExamples:

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

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

• application/json

Response:

CreatedResponse

DELETE /items/{id}

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

Path parameters:

• id(required)

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

• application/json

Examples:

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

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

• application/json

Response:

AbstractRestResponse

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

Summary: Delete the link with the specified ID

Path parameters:

• linkId(required)
• id(required)

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

• application/json

Examples:

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

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

• application/json

Response:

AbstractRestResponse

POST /items/{id}/duplicate

Summary: Create a duplicate of item

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

Path parameters:

• id(required)

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

• application/json

Body:

DuplicateConfigExamples:

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

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

• application/json

Response:

CreatedResponse

POST /items/{id}/workflowtransitions

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

Path parameters:

• id(required)

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

• application/json

Body:

RequestTransitionExamples:

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

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

• application/json

Response:

CreatedResponse

GET /items/{id}/activities

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

Path parameters:

• id(required)

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

• application/json

Request headers:

• xJamaDateFieldsWithTime
  (optional) 

Query parameters:

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

Examples:

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

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

• application/json

Response:

ActivityDataListWrapper

GET /items/{id}/attachments

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

Path parameters:

• id(required)

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

• application/json

Request headers:

• xJamaDateFieldsWithTime
  (optional) 

Query parameters:

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

Examples:

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

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

• application/json

Response:

AttachmentDataListWrapper

GET /items/{id}/baselinedcategories

Summary: Get all categories for the item associated with a specific baseline

Path parameters:

• id(required)

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

• application/json

Query parameters:

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

Examples:

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

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

• application/json

Response:

AbstractRestResponse

GET /items/{id}/categories

Summary: Retrieve all categories for an item

Path parameters:

• id(required)

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

• application/json

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” : 6,
  “resultCount” : 1,
  “totalResults” : 5
  },
  “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:

ItemCategoryDataListWrapper

GET /items/{id}/children

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

Path parameters:

• id(required)

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

• application/json

Request headers:

• xJamaDateFieldsWithTime
  (optional) 

Query parameters:

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

Examples:

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

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

• application/json

Response:

ItemDataListWrapper

GET /items/{id}/downstreamrelated

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

Path parameters:

• id(required)

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

• application/json

Request headers:

• xJamaDateFieldsWithTime
  (optional) 

Query parameters:

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

Examples:

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

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

• application/json

Response:

ItemDataListWrapper

GET /items/{id}/downstreamrelationships

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

Path parameters:

• id(required)

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

• application/json

Request headers:

• xJamaDateFieldsWithTime
  (optional) 

Query parameters:

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

Examples:

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

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

• application/json

Response:

RelationshipDataListWrapper

GET /items/{id}

Summary: Get the item with the specified ID

Path parameters:

• id(required)

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

• application/json

Request headers:

• xJamaDateFieldsWithTime
  (optional) 

Query parameters:

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

Examples:

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

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

• application/json

Response:

ItemDataWrapper

GET /items/{id}/comments

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

Path parameters:

• id(required)

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

• application/json

Request headers:

• xJamaDateFieldsWithTime
  (optional) 

Query parameters:

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

Examples:

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

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

• application/json

Response:

CommentDataListWrapper

GET /items/{id}/links

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

Path parameters:

• id(required)

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

• application/json

Request headers:

• xJamaDateFieldsWithTime
  (optional) 

Query parameters:

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

Examples:

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

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

• application/json

Response:

LinkDataListWrapper

GET /items

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

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

• application/json

Request headers:

• xJamaDateFieldsWithTime
  (optional) 

Query parameters:

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

Examples:

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

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

• application/json

Response:

ItemDataListWrapper

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

Summary: Get the link with the specified ID

Path parameters:

• linkId(required)
• id(required)

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

• application/json

Request headers:

• xJamaDateFieldsWithTime
  (optional) 

Query parameters:

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

Examples:

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

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

• application/json

Response:

LinkDataWrapper

GET /items/{id}/location

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

Path parameters:

• id(required)

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

• application/json

Request headers:

• xJamaDateFieldsWithTime
  (optional) 

Query parameters:

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

Examples:

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

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

• application/json

Response:

LocationDataWrapper

GET /items/{id}/lock

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

Path parameters:

• id(required)

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

• application/json

Request headers:

• xJamaDateFieldsWithTime
  (optional) 

Query parameters:

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

Examples:

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

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

• application/json

Response:

LockDataWrapper

GET /items/{id}/parent

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

Path parameters:

• id(required)

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

• application/json

Request headers:

• xJamaDateFieldsWithTime
  (optional) 

Query parameters:

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

Examples:

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

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

• application/json

Response:

ItemDataWrapper

GET /items/{id}/synceditems

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

Path parameters:

• id(required)

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

• application/json

Request headers:

• xJamaDateFieldsWithTime
  (optional) 

Query parameters:

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

Examples:

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

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

• application/json

Response:

ItemDataListWrapper

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

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

Path parameters:

• syncedItemId(required)
• id(required)

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

• application/json

Request headers:

• xJamaDateFieldsWithTime
  (optional) 

Query parameters:

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

Examples:

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

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

• application/json

Response:

SyncStatusDataWrapper

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

Summary: Get the tag with the specified ID

Path parameters:

• tagId(required)
• id(required)

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

• application/json

Request headers:

• xJamaDateFieldsWithTime
  (optional) 

Query parameters:

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

Examples:

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

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

• application/json

Response:

TagDataWrapper

GET /items/{id}/tags

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

Path parameters:

• id(required)

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

• application/json

Request headers:

• xJamaDateFieldsWithTime
  (optional) 

Query parameters:

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

Examples:

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

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

• application/json

Response:

TagDataListWrapper

GET /items/{id}/upstreamrelated

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

Path parameters:

• id(required)

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

• application/json

Request headers:

• xJamaDateFieldsWithTime
  (optional) 

Query parameters:

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

Examples:

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

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

• application/json

Response:

ItemDataListWrapper

GET /items/{id}/upstreamrelationships

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

Path parameters:

• id(required)

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

• application/json

Request headers:

• xJamaDateFieldsWithTime
  (optional) 

Query parameters:

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

Examples:

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

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

• application/json

Response:

RelationshipDataListWrapper

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

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

Path parameters:

• versionNum(required)
• id(required)

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

• application/json

Request headers:

• xJamaDateFieldsWithTime
  (optional) 

Query parameters:

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

Examples:

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

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

• application/json

Response:

VersionDataWrapper

GET /items/{id}/versionedcategories

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

Path parameters:

• id(required)

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

• application/json

Query parameters:

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

Examples:

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

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

• application/json

Response:

AbstractRestResponse

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

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

Path parameters:

• versionNum(required)
• id(required)

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

• application/json

Request headers:

• xJamaDateFieldsWithTime
  (optional) 

Query parameters:

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

Examples:

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

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

• application/json

Response:

VersionedItemDataWrapper

GET /items/{id}/versions

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

Path parameters:

• id(required)

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

• application/json

Request headers:

• xJamaDateFieldsWithTime
  (optional) 

Query parameters:

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

Examples:

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

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

• application/json

Response:

VersionDataListWrapper

GET /items/{id}/workflowtransitionoptions

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

Path parameters:

• id(required)

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

• application/json

Request headers:

• xJamaDateFieldsWithTime
  (optional) 

Query parameters:

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

Examples:

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

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

• application/json

Response:

WorkflowTransitionDataListWrapper

PUT /items/treeLocation

Summary:

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

• application/json

Body:

TreeLocationRequestExamples:

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

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

• application/json

Response:

AbstractRestResponse

PATCH /items/{id}

Summary: Update the item with the specified ID

Path parameters:

• id(required)

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

• application/json

Body:

array[RequestPatchOperation]Request headers:

• xJamaDateFieldsWithTime
  (optional)
  Preserves both date and time of any DATETIME field value passed in the body of the request. Must be in ISO8601 format (milliseconds or seconds) – \”yyyy-MM-dd’T’HH:mm:ss.SSSZ\” or \”yyyy-MM-dd’T’HH:mm:ssZ\”.

Query parameters:

• returnItem
  (optional)
  , default value: false

Examples:

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

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

• application/json

Response:

AbstractRestResponse

PATCH /items

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

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

• application/json

Body:

array[RequestItemsPatchOperations]Request headers:

• xJamaDateFieldsWithTime
  (optional)
  Preserves both date and time of any DATETIME field value passed in the body of the request. Must be in ISO8601 format (milliseconds or seconds) – \”yyyy-MM-dd’T’HH:mm:ss.SSSZ\” or \”yyyy-MM-dd’T’HH:mm:ssZ\”.

Examples:

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

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

• application/json

Response:

ObjectResponse

Response:

BadRequestResponse

PUT /items/{id}

Summary: Update the item with the specified ID

Path parameters:

• id(required)

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

• application/json

Body:

RequestItemRequest headers:

• xJamaDateFieldsWithTime
  (optional)
  Preserves both date and time of any DATETIME field value passed in the body of the request. Must be in ISO8601 format (milliseconds or seconds) – \”yyyy-MM-dd’T’HH:mm:ss.SSSZ\” or \”yyyy-MM-dd’T’HH:mm:ssZ\”.

Query parameters:

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

Examples:

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

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

• application/json

Response:

AbstractRestResponse

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

Summary: Remove an existing attachment from the item

Path parameters:

• attachmentId(required)
• id(required)

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

• application/json

Examples:

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

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

• application/json

Response:

AbstractRestResponse

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

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

Path parameters:

• tagId(required)
• id(required)

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

• application/json

Examples:

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

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

• application/json

Response:

AbstractRestResponse

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

Summary: Update the link with the specified ID

Path parameters:

• linkId(required)
• id(required)

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

• application/json

Body:

RequestLinkExamples:

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

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

• application/json

Response:

AbstractRestResponse

PUT /items/{id}/location

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

Path parameters:

• id(required)

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

• application/json

Body:

RequestMoveLocationExamples:

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

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

• application/json

Response:

AbstractRestResponse

PUT /items/{id}/lock

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

Path parameters:

• id(required)

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

• application/json

Body:

RequestLockExamples:

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

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

• application/json

Response:

AbstractRestResponse

Endpoint itemtypes

The itemtypes endpoint has the following operations:

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

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

POST /itemtypes/{itemTypeId}/fields

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

Path parameters:

• itemTypeId(required)

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

• application/json

Body:

RequestItemTypeFieldExamples:

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

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

• application/json

Response:

AbstractRestResponse

POST /itemtypes

Summary: Create a new item type

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

• application/json

Body:

RequestItemTypeExamples:

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

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

• application/json

Response:

AbstractRestResponse

GET /itemtypes/{itemTypeId}

Summary: Get the item type with the specified ID

Path parameters:

• itemTypeId(required)

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

• application/json

Request headers:

• xJamaDateFieldsWithTime
  (optional) 

Query parameters:

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

Examples:

• Example data, content-type: application/json
  {
  “data” : {
  “image” : “image”,
  “typeKey” : “typeKey”,
  “system” : true,
  “display” : “display”,
  “description” : “description”,
  “id” : 0,
  “category” : “CORE”,
  “widgets” : [ {
  “name” : “ACTIVITIES”,
  “synchronize” : true
  }, {
  “name” : “ACTIVITIES”,
  “synchronize” : true
  } ],
  “fields” : [ {
  “readOnlyAllowApiOverwrite” : true,
  “itemType” : 5,
  “readOnly” : true,
  “textType” : “TEXTAREA”,
  “label” : “label”,
  “required” : true,
  “controlStyle” : “controlStyle”,
  “pickList” : 1,
  “name” : “name”,
  “infotip” : “infotip”,
  “id” : 6,
  “fieldType” : “INTEGER”,
  “triggerSuspect” : true,
  “synchronize” : true
  }, {
  “readOnlyAllowApiOverwrite” : true,
  “itemType” : 5,
  “readOnly” : true,
  “textType” : “TEXTAREA”,
  “label” : “label”,
  “required” : true,
  “controlStyle” : “controlStyle”,
  “pickList” : 1,
  “name” : “name”,
  “infotip” : “infotip”,
  “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”
  }
  },
  “linked” : {
  “key” : {
  “key” : “{}”
  }
  }
  }

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

• application/json

Response:

ItemTypeDataWrapper

GET /itemtypes

Summary: Get all item types

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

• application/json

Request headers:

• xJamaDateFieldsWithTime
  (optional) 

Query parameters:

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

Examples:

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

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

• application/json

Response:

ItemTypeDataListWrapper

Endpoint picklistoptions

The picklistoptions endpoint has the following operations:

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

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

GET /picklistoptions/{picklistOptionId}

Summary: Get the pick list option with the specified ID

Path parameters:

• picklistOptionId(required)

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

• application/json

Request headers:

• xJamaDateFieldsWithTime
  (optional) 

Query parameters:

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

Examples:

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

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

• application/json

Response:

PickListOptionDataWrapper

PUT /picklistoptions/{picklistOptionId}

Summary: Update the pick list option with the specified ID

Path parameters:

• picklistOptionId(required)

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

• application/json

Body:

RequestPickListOptionExamples:

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

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

• application/json

Response:

AbstractRestResponse

Endpoint picklists

The picklists endpoint has the following operations:

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

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

POST /picklists/{picklistId}/options

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

Path parameters:

• picklistId(required)

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

• application/json

Body:

RequestPickListOptionExamples:

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

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

• application/json

Response:

CreatedResponse

POST /picklists

Summary: Create a new pick list

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

• application/json

Body:

RequestPickListExamples:

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

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

• application/json

Response:

AbstractRestResponse

DELETE /picklists/{picklistId}

Summary: Delete the pick list

Path parameters:

• picklistId(required)

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

• application/json

Examples:

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

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

• application/json

Response:

AbstractRestResponse

GET /picklists/{picklistId}

Summary: Get the pick list with the specified ID

Path parameters:

• picklistId(required)

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

• application/json

Request headers:

• xJamaDateFieldsWithTime
  (optional) 

Query parameters:

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

Examples:

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

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

• application/json

Response:

PickListDataWrapper

GET /picklists/{picklistId}/options

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

Path parameters:

• picklistId(required)

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

• application/json

Request headers:

• xJamaDateFieldsWithTime
  (optional) 

Query parameters:

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

Examples:

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

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

• application/json

Response:

PickListOptionDataListWrapper

GET /picklists

Summary: Get all pick lists

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

• application/json

Request headers:

• xJamaDateFieldsWithTime
  (optional) 

Query parameters:

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

Examples:

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

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

• application/json

Response:

PickListDataListWrapper

Endpoint projects

The projects endpoint has the following operations:

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

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

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

Summary: Add an Item Type to a Project

Path parameters:

• itemTypeId(required)
• projectId(required)

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

• application/json

Examples:

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

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

• application/json

Response:

AbstractRestResponse

POST /projects

Summary: Create a new project

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

• application/json

Body:

RequestProjectExamples:

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

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

• application/json

Response:

CreatedResponse

GET /projects/{projectId}/itemtypes

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

Path parameters:

• projectId(required)

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

• application/json

Request headers:

• xJamaDateFieldsWithTime
  (optional) 

Query parameters:

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

Examples:

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

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

• application/json

Response:

ItemTypeDataListWrapper

GET /projects/{projectId}

Summary: Get the project with the specified ID

Path parameters:

• projectId(required)

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

• application/json

Request headers:

• xJamaDateFieldsWithTime
  (optional) 

Query parameters:

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

Examples:

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

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

• application/json

Response:

ProjectDataWrapper

GET /projects

Summary: Get all projects

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

• application/json

Request headers:

• xJamaDateFieldsWithTime
  (optional) 

Query parameters:

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

Examples:

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

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

• application/json

Response:

ProjectDataListWrapper

GET /projects/{projectId}/tags

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

Path parameters:

• projectId(required)

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

• application/json

Request headers:

• xJamaDateFieldsWithTime
  (optional) 

Query parameters:

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

Examples:

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

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

• application/json

Response:

TagDataListWrapper

POST /projects/{projectId}/attachments

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

Path parameters:

• projectId(required)

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

• application/json

Body:

RequestAttachmentExamples:

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

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

• application/json

Response:

CreatedResponse

PUT /projects/{projectId}

Summary: Update the project with the specified ID

Path parameters:

• projectId(required)

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

• application/json

Body:

RequestProjectExamples:

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

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

• application/json

Response:

AbstractRestResponse

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

Summary: Remove an Item Type from a Project

Path parameters:

• itemTypeId(required)
• projectId(required)

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

• application/json

Examples:

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

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

• application/json

Response:

AbstractRestResponse

Endpoint relationshiprulesets

The relationshiprulesets endpoint has the following operations:

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

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

GET /relationshiprulesets/{id}/projects

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

Path parameters:

• id(required)

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

• application/json

Request headers:

• xJamaDateFieldsWithTime
  (optional) 

Query parameters:

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

Examples:

• Example data, content-type: application/json
  {
  “organizationId” : 1,
  “projectKey” : “projectKey”,
  “string1” : “string1”,
  “name” : “name”,
  “modifiedDate” : “2000-01-23T04:56:07.000+00:00”,
  “active” : true,
  “modifiedBy” : {
  “lastName” : “lastName”,
  “notes” : “notes”,
  “displayName” : “displayName”,
  “customData” : [ {
  “name” : “name”,
  “value” : “value”
  }, {
  “name” : “name”,
  “value” : “value”
  } ],
  “title” : “title”,
  “subscriptionJobName” : “subscriptionJobName”,
  “orgId” : 1,
  “emailUpdatesToFollowedItems” : true,
  “uid” : “uid”,
  “licenseType” : “NAMED”,
  “subscriptionIsMuted” : true,
  “disabled” : true,
  “id” : 5,
  “unregistered” : true,
  “userDn” : “userDn”,
  “email” : “email”,
  “projectAdmin” : true,
  “avatarUrl” : “avatarUrl”,
  “fullName” : “fullName”,
  “authProviderId” : 5,
  “avatar” : {
  “fileName” : “fileName”,
  “attachmentTypeId” : 2,
  “userFullName” : “userFullName”,
  “description” : “description”,
  “diagramGraphXml” : “diagramGraphXml”,
  “inputStream” : { },
  “organizationId” : 9,
  “system” : true,
  “createdDate” : “2000-01-23T04:56:07.000+00:00”,
  “fileSize” : 7,
  “diagramHeight” : 7,
  “diagramImageXml” : “diagramImageXml”,
  “mimetype” : “mimetype”,
  “id” : 2,
  “projectId” : 3,
  “diagramWidth” : 4
  },
  “userName” : “userName”,
  “firstName” : “firstName”,
  “system” : true,
  “roleIds” : [ 1, 1 ],
  “createdDate” : “2000-01-23T04:56:07.000+00:00”,
  “phone” : “phone”,
  “name” : “name”,
  “location” : “location”,
  “authenticationType” : {
  “name” : “name”,
  “id” : 6
  },
  “autoFollowCommentedItems” : true,
  “userLogins” : 1,
  “roleNames” : [ “roleNames”, “roleNames” ]
  },
  “id” : 0,
  “mask” : 6
  }

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

• application/json

Response:

ProjectPropertyDTO

GET /relationshiprulesets

Summary: Gets all Relationship Rule Sets in the organization

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

• application/json

Request headers:

• xJamaDateFieldsWithTime
  (optional) 

Query parameters:

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

Examples:

• Example data, content-type: application/json
  [ {
  “isExclusive” : true,
  “name” : “name”,
  “rules” : [ {
  “forCoverage” : true,
  “fromItemTypeId” : 1,
  “relationshipTypeId” : 5,
  “id” : 6,
  “toItemTypeId” : 5
  }, {
  “forCoverage” : true,
  “fromItemTypeId” : 1,
  “relationshipTypeId” : 5,
  “id” : 6,
  “toItemTypeId” : 5
  } ],
  “id” : 0,
  “mappedProjects” : [ {
  “organizationId” : 1,
  “projectKey” : “projectKey”,
  “string1” : “string1”,
  “name” : “name”,
  “modifiedDate” : “2000-01-23T04:56:07.000+00:00”,
  “active” : true,
  “modifiedBy” : {
  “lastName” : “lastName”,
  “notes” : “notes”,
  “displayName” : “displayName”,
  “customData” : [ {
  “name” : “name”,
  “value” : “value”
  }, {
  “name” : “name”,
  “value” : “value”
  } ],
  “title” : “title”,
  “subscriptionJobName” : “subscriptionJobName”,
  “orgId” : 1,
  “emailUpdatesToFollowedItems” : true,
  “uid” : “uid”,
  “licenseType” : “NAMED”,
  “subscriptionIsMuted” : true,
  “disabled” : true,
  “id” : 5,
  “unregistered” : true,
  “userDn” : “userDn”,
  “email” : “email”,
  “projectAdmin” : true,
  “avatarUrl” : “avatarUrl”,
  “fullName” : “fullName”,
  “authProviderId” : 5,
  “avatar” : {
  “fileName” : “fileName”,
  “attachmentTypeId” : 2,
  “userFullName” : “userFullName”,
  “description” : “description”,
  “diagramGraphXml” : “diagramGraphXml”,
  “inputStream” : { },
  “organizationId” : 9,
  “system” : true,
  “createdDate” : “2000-01-23T04:56:07.000+00:00”,
  “fileSize” : 7,
  “diagramHeight” : 7,
  “diagramImageXml” : “diagramImageXml”,
  “mimetype” : “mimetype”,
  “id” : 2,
  “projectId” : 3,
  “diagramWidth” : 4
  },
  “userName” : “userName”,
  “firstName” : “firstName”,
  “system” : true,
  “roleIds” : [ 1, 1 ],
  “createdDate” : “2000-01-23T04:56:07.000+00:00”,
  “phone” : “phone”,
  “name” : “name”,
  “location” : “location”,
  “authenticationType” : {
  “name” : “name”,
  “id” : 6
  },
  “autoFollowCommentedItems” : true,
  “userLogins” : 1,
  “roleNames” : [ “roleNames”, “roleNames” ]
  },
  “id” : 0,
  “mask” : 6
  }, {
  “organizationId” : 1,
  “projectKey” : “projectKey”,
  “string1” : “string1”,
  “name” : “name”,
  “modifiedDate” : “2000-01-23T04:56:07.000+00:00”,
  “active” : true,
  “modifiedBy” : {
  “lastName” : “lastName”,
  “notes” : “notes”,
  “displayName” : “displayName”,
  “customData” : [ {
  “name” : “name”,
  “value” : “value”
  }, {
  “name” : “name”,
  “value” : “value”
  } ],
  “title” : “title”,
  “subscriptionJobName” : “subscriptionJobName”,
  “orgId” : 1,
  “emailUpdatesToFollowedItems” : true,
  “uid” : “uid”,
  “licenseType” : “NAMED”,
  “subscriptionIsMuted” : true,
  “disabled” : true,
  “id” : 5,
  “unregistered” : true,
  “userDn” : “userDn”,
  “email” : “email”,
  “projectAdmin” : true,
  “avatarUrl” : “avatarUrl”,
  “fullName” : “fullName”,
  “authProviderId” : 5,
  “avatar” : {
  “fileName” : “fileName”,
  “attachmentTypeId” : 2,
  “userFullName” : “userFullName”,
  “description” : “description”,
  “diagramGraphXml” : “diagramGraphXml”,
  “inputStream” : { },
  “organizationId” : 9,
  “system” : true,
  “createdDate” : “2000-01-23T04:56:07.000+00:00”,
  “fileSize” : 7,
  “diagramHeight” : 7,
  “diagramImageXml” : “diagramImageXml”,
  “mimetype” : “mimetype”,
  “id” : 2,
  “projectId” : 3,
  “diagramWidth” : 4
  },
  “userName” : “userName”,
  “firstName” : “firstName”,
  “system” : true,
  “roleIds” : [ 1, 1 ],
  “createdDate” : “2000-01-23T04:56:07.000+00:00”,
  “phone” : “phone”,
  “name” : “name”,
  “location” : “location”,
  “authenticationType” : {
  “name” : “name”,
  “id” : 6
  },
  “autoFollowCommentedItems” : true,
  “userLogins” : 1,
  “roleNames” : [ “roleNames”, “roleNames” ]
  },
  “id” : 0,
  “mask” : 6
  } ]
  }, {
  “isExclusive” : true,
  “name” : “name”,
  “rules” : [ {
  “forCoverage” : true,
  “fromItemTypeId” : 1,
  “relationshipTypeId” : 5,
  “id” : 6,
  “toItemTypeId” : 5
  }, {
  “forCoverage” : true,
  “fromItemTypeId” : 1,
  “relationshipTypeId” : 5,
  “id” : 6,
  “toItemTypeId” : 5
  } ],
  “id” : 0,
  “mappedProjects” : [ {
  “organizationId” : 1,
  “projectKey” : “projectKey”,
  “string1” : “string1”,
  “name” : “name”,
  “modifiedDate” : “2000-01-23T04:56:07.000+00:00”,
  “active” : true,
  “modifiedBy” : {
  “lastName” : “lastName”,
  “notes” : “notes”,
  “displayName” : “displayName”,
  “customData” : [ {
  “name” : “name”,
  “value” : “value”
  }, {
  “name” : “name”,
  “value” : “value”
  } ],
  “title” : “title”,
  “subscriptionJobName” : “subscriptionJobName”,
  “orgId” : 1,
  “emailUpdatesToFollowedItems” : true,
  “uid” : “uid”,
  “licenseType” : “NAMED”,
  “subscriptionIsMuted” : true,
  “disabled” : true,
  “id” : 5,
  “unregistered” : true,
  “userDn” : “userDn”,
  “email” : “email”,
  “projectAdmin” : true,
  “avatarUrl” : “avatarUrl”,
  “fullName” : “fullName”,
  “authProviderId” : 5,
  “avatar” : {
  “fileName” : “fileName”,
  “attachmentTypeId” : 2,
  “userFullName” : “userFullName”,
  “description” : “description”,
  “diagramGraphXml” : “diagramGraphXml”,
  “inputStream” : { },
  “organizationId” : 9,
  “system” : true,
  “createdDate” : “2000-01-23T04:56:07.000+00:00”,
  “fileSize” : 7,
  “diagramHeight” : 7,
  “diagramImageXml” : “diagramImageXml”,
  “mimetype” : “mimetype”,
  “id” : 2,
  “projectId” : 3,
  “diagramWidth” : 4
  },
  “userName” : “userName”,
  “firstName” : “firstName”,
  “system” : true,
  “roleIds” : [ 1, 1 ],
  “createdDate” : “2000-01-23T04:56:07.000+00:00”,
  “phone” : “phone”,
  “name” : “name”,
  “location” : “location”,
  “authenticationType” : {
  “name” : “name”,
  “id” : 6
  },
  “autoFollowCommentedItems” : true,
  “userLogins” : 1,
  “roleNames” : [ “roleNames”, “roleNames” ]
  },
  “id” : 0,
  “mask” : 6
  }, {
  “organizationId” : 1,
  “projectKey” : “projectKey”,
  “string1” : “string1”,
  “name” : “name”,
  “modifiedDate” : “2000-01-23T04:56:07.000+00:00”,
  “active” : true,
  “modifiedBy” : {
  “lastName” : “lastName”,
  “notes” : “notes”,
  “displayName” : “displayName”,
  “customData” : [ {
  “name” : “name”,
  “value” : “value”
  }, {
  “name” : “name”,
  “value” : “value”
  } ],
  “title” : “title”,
  “subscriptionJobName” : “subscriptionJobName”,
  “orgId” : 1,
  “emailUpdatesToFollowedItems” : true,
  “uid” : “uid”,
  “licenseType” : “NAMED”,
  “subscriptionIsMuted” : true,
  “disabled” : true,
  “id” : 5,
  “unregistered” : true,
  “userDn” : “userDn”,
  “email” : “email”,
  “projectAdmin” : true,
  “avatarUrl” : “avatarUrl”,
  “fullName” : “fullName”,
  “authProviderId” : 5,
  “avatar” : {
  “fileName” : “fileName”,
  “attachmentTypeId” : 2,
  “userFullName” : “userFullName”,
  “description” : “description”,
  “diagramGraphXml” : “diagramGraphXml”,
  “inputStream” : { },
  “organizationId” : 9,
  “system” : true,
  “createdDate” : “2000-01-23T04:56:07.000+00:00”,
  “fileSize” : 7,
  “diagramHeight” : 7,
  “diagramImageXml” : “diagramImageXml”,
  “mimetype” : “mimetype”,
  “id” : 2,
  “projectId” : 3,
  “diagramWidth” : 4
  },
  “userName” : “userName”,
  “firstName” : “firstName”,
  “system” : true,
  “roleIds” : [ 1, 1 ],
  “createdDate” : “2000-01-23T04:56:07.000+00:00”,
  “phone” : “phone”,
  “name” : “name”,
  “location” : “location”,
  “authenticationType” : {
  “name” : “name”,
  “id” : 6
  },
  “autoFollowCommentedItems” : true,
  “userLogins” : 1,
  “roleNames” : [ “roleNames”, “roleNames” ]
  },
  “id” : 0,
  “mask” : 6
  } ]
  } ]

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

• application/json

Response:

array[RelationshipRuleSetDTO]

GET /relationshiprulesets/{id}

Summary: Get a Relationship Rule Set by id

Path parameters:

• id(required)

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

• application/json

Request headers:

• xJamaDateFieldsWithTime
  (optional) 

Examples:

• Example data, content-type: application/json
  {
  “isExclusive” : true,
  “name” : “name”,
  “rules” : [ {
  “forCoverage” : true,
  “fromItemTypeId” : 1,
  “relationshipTypeId” : 5,
  “id” : 6,
  “toItemTypeId” : 5
  }, {
  “forCoverage” : true,
  “fromItemTypeId” : 1,
  “relationshipTypeId” : 5,
  “id” : 6,
  “toItemTypeId” : 5
  } ],
  “id” : 0,
  “mappedProjects” : [ {
  “organizationId” : 1,
  “projectKey” : “projectKey”,
  “string1” : “string1”,
  “name” : “name”,
  “modifiedDate” : “2000-01-23T04:56:07.000+00:00”,
  “active” : true,
  “modifiedBy” : {
  “lastName” : “lastName”,
  “notes” : “notes”,
  “displayName” : “displayName”,
  “customData” : [ {
  “name” : “name”,
  “value” : “value”
  }, {
  “name” : “name”,
  “value” : “value”
  } ],
  “title” : “title”,
  “subscriptionJobName” : “subscriptionJobName”,
  “orgId” : 1,
  “emailUpdatesToFollowedItems” : true,
  “uid” : “uid”,
  “licenseType” : “NAMED”,
  “subscriptionIsMuted” : true,
  “disabled” : true,
  “id” : 5,
  “unregistered” : true,
  “userDn” : “userDn”,
  “email” : “email”,
  “projectAdmin” : true,
  “avatarUrl” : “avatarUrl”,
  “fullName” : “fullName”,
  “authProviderId” : 5,
  “avatar” : {
  “fileName” : “fileName”,
  “attachmentTypeId” : 2,
  “userFullName” : “userFullName”,
  “description” : “description”,
  “diagramGraphXml” : “diagramGraphXml”,
  “inputStream” : { },
  “organizationId” : 9,
  “system” : true,
  “createdDate” : “2000-01-23T04:56:07.000+00:00”,
  “fileSize” : 7,
  “diagramHeight” : 7,
  “diagramImageXml” : “diagramImageXml”,
  “mimetype” : “mimetype”,
  “id” : 2,
  “projectId” : 3,
  “diagramWidth” : 4
  },
  “userName” : “userName”,
  “firstName” : “firstName”,
  “system” : true,
  “roleIds” : [ 1, 1 ],
  “createdDate” : “2000-01-23T04:56:07.000+00:00”,
  “phone” : “phone”,
  “name” : “name”,
  “location” : “location”,
  “authenticationType” : {
  “name” : “name”,
  “id” : 6
  },
  “autoFollowCommentedItems” : true,
  “userLogins” : 1,
  “roleNames” : [ “roleNames”, “roleNames” ]
  },
  “id” : 0,
  “mask” : 6
  }, {
  “organizationId” : 1,
  “projectKey” : “projectKey”,
  “string1” : “string1”,
  “name” : “name”,
  “modifiedDate” : “2000-01-23T04:56:07.000+00:00”,
  “active” : true,
  “modifiedBy” : {
  “lastName” : “lastName”,
  “notes” : “notes”,
  “displayName” : “displayName”,
  “customData” : [ {
  “name” : “name”,
  “value” : “value”
  }, {
  “name” : “name”,
  “value” : “value”
  } ],
  “title” : “title”,
  “subscriptionJobName” : “subscriptionJobName”,
  “orgId” : 1,
  “emailUpdatesToFollowedItems” : true,
  “uid” : “uid”,
  “licenseType” : “NAMED”,
  “subscriptionIsMuted” : true,
  “disabled” : true,
  “id” : 5,
  “unregistered” : true,
  “userDn” : “userDn”,
  “email” : “email”,
  “projectAdmin” : true,
  “avatarUrl” : “avatarUrl”,
  “fullName” : “fullName”,
  “authProviderId” : 5,
  “avatar” : {
  “fileName” : “fileName”,
  “attachmentTypeId” : 2,
  “userFullName” : “userFullName”,
  “description” : “description”,
  “diagramGraphXml” : “diagramGraphXml”,
  “inputStream” : { },
  “organizationId” : 9,
  “system” : true,
  “createdDate” : “2000-01-23T04:56:07.000+00:00”,
  “fileSize” : 7,
  “diagramHeight” : 7,
  “diagramImageXml” : “diagramImageXml”,
  “mimetype” : “mimetype”,
  “id” : 2,
  “projectId” : 3,
  “diagramWidth” : 4
  },
  “userName” : “userName”,
  “firstName” : “firstName”,
  “system” : true,
  “roleIds” : [ 1, 1 ],
  “createdDate” : “2000-01-23T04:56:07.000+00:00”,
  “phone” : “phone”,
  “name” : “name”,
  “location” : “location”,
  “authenticationType” : {
  “name” : “name”,
  “id” : 6
  },
  “autoFollowCommentedItems” : true,
  “userLogins” : 1,
  “roleNames” : [ “roleNames”, “roleNames” ]
  },
  “id” : 0,
  “mask” : 6
  } ]
  }

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

• application/json

Response:

RelationshipRuleSetDTO

Endpoint relationships

The relationships endpoint has the following operations:

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

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

DELETE /relationships/{relationshipId}/suspect

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

Path parameters:

• relationshipId(required)

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

• application/json

Examples:

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

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

• application/json

Response:

AbstractRestResponse

POST /relationships

Summary: Create a new relationship

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

• application/json

Body:

RequestRelationshipExamples:

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

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

• application/json

Response:

CreatedResponse

DELETE /relationships/{relationshipId}

Summary: Delete the relationship with the specified ID

Path parameters:

• relationshipId(required)

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

• application/json

Examples:

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

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

• application/json

Response:

AbstractRestResponse

GET /relationships/{relationshipId}

Summary: Get the relationship with the specified ID

Path parameters:

• relationshipId(required)

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

• application/json

Request headers:

• xJamaDateFieldsWithTime
  (optional) 

Query parameters:

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

Examples:

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

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

• application/json

Response:

RelationshipDataWrapper

GET /relationships

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

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

• application/json

Request headers:

• xJamaDateFieldsWithTime
  (optional) 

Query parameters:

• project(required)
• startAt
  (optional) 
• 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” : 6,
  “resultCount” : 1,
  “totalResults” : 5
  },
  “status” : “OK”,
  “timestamp” : “2000-01-23T04:56:07.000+00:00”
  },
  “links” : {
  “key” : {
  “href” : “href”,
  “type” : “type”
  }
  },
  “linked” : {
  “key” : {
  “key” : “{}”
  }
  }
  }

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

• application/json

Response:

RelationshipDataListWrapper

PUT /relationships/{relationshipId}

Summary: Update the relationship with the specified ID

Path parameters:

• relationshipId(required)

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

• application/json

Body:

RequestRelationshipExamples:

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

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

• application/json

Response:

AbstractRestResponse

Endpoint relationshiptypes

The relationshiptypes endpoint has the following operations:

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

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

GET /relationshiptypes/{id}

Summary: Get the relationship type with the specified ID

Path parameters:

• id(required)

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

• application/json

Request headers:

• xJamaDateFieldsWithTime
  (optional) 

Query parameters:

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

Examples:

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

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

• application/json

Response:

RelationshipTypeDataWrapper

GET /relationshiptypes

Summary: Get all relationship types

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

• application/json

Request headers:

• xJamaDateFieldsWithTime
  (optional) 

Query parameters:

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

Examples:

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

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

• application/json

Response:

RelationshipTypeDataListWrapper

Endpoint releases

The releases endpoint has the following operations:

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

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

POST /releases

Summary: Create a new release

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

• application/json

Body:

RequestReleaseExamples:

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

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

• application/json

Response:

CreatedResponse

GET /releases/{releaseId}

Summary: Get the release with the specified ID

Path parameters:

• releaseId(required)

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

• application/json

Request headers:

• xJamaDateFieldsWithTime
  (optional) 

Query parameters:

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

Examples:

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

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

• application/json

Response:

ReleaseDataWrapper

GET /releases

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

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

• application/json

Request headers:

• xJamaDateFieldsWithTime
  (optional) 

Query parameters:

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

Examples:

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

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

• application/json

Response:

ReleaseDataListWrapper

PUT /releases/{releaseId}

Summary: Update the release with the specified ID

Path parameters:

• releaseId(required)

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

• application/json

Body:

RequestReleaseExamples:

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

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

• application/json

Response:

AbstractRestResponse

Endpoint system

The system endpoint has the following operations:

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

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

GET /system/settings/corsdomains

Summary: Get the current CORS domain whitelist

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

• application/json

Request headers:

• xJamaDateFieldsWithTime
  (optional) 

Examples:

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

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

• application/json

Response:

CrossOriginDomainWhiteList

POST /system/settings/corsdomains

Summary: Update CORS domain whitelist

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

• application/json

Body:

CrossOriginDomainWhiteListExamples:

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

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

• application/json

Response:

AbstractRestResponse

Endpoint tags

The tags endpoint has the following operations:

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

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

POST /tags

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

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

• application/json

Body:

RequestTagExamples:

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

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

• application/json

Response:

CreatedResponse

DELETE /tags/{id}

Summary: Delete the tag with the specified ID

Path parameters:

• id(required)

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

• application/json

Examples:

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

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

• application/json

Response:

AbstractRestResponse

GET /tags/{id}/items

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

Path parameters:

• id(required)

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

• application/json

Request headers:

• xJamaDateFieldsWithTime
  (optional) 

Query parameters:

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

Examples:

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

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

• application/json

Response:

ItemDataListWrapper

GET /tags/{id}

Summary: Get the tag with the specified ID

Path parameters:

• id(required)

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

• application/json

Request headers:

• xJamaDateFieldsWithTime
  (optional) 

Query parameters:

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

Examples:

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

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

• application/json

Response:

TagDataWrapper

GET /tags

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

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

• application/json

Request headers:

• xJamaDateFieldsWithTime
  (optional) 

Query parameters:

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

Examples:

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

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

• application/json

Response:

TagDataListWrapper

PUT /tags/{id}

Summary: Update the tag with the specified ID

Path parameters:

• id(required)

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

• application/json

Body:

RequestTagExamples:

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

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

• application/json

Response:

AbstractRestResponse

Endpoint testcycles

The testcycles endpoint has the following operations:

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

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

DELETE /testcycles/{testCycleId}

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

Path parameters:

• testCycleId(required)

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

• application/json

Examples:

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

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

• application/json

Response:

AbstractRestResponse

GET /testcycles/{testCycleId}

Summary: Get the test cycle with the specified ID

Path parameters:

• testCycleId(required)

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

• application/json

Request headers:

• xJamaDateFieldsWithTime
  (optional) 

Query parameters:

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

Examples:

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

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

• application/json

Response:

TestCycleDataWrapper

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

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

Path parameters:

• testGroupId(required)

  Get the test group with the specified ID

• testCycleId(required)

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

• application/json

Request headers:

• xJamaDateFieldsWithTime
  (optional) 

Query parameters:

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

Examples:

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

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

• application/json

Response:

TestCycleTestGroupDataWrapper

GET /testcycles/{testCycleId}/testruns

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

Path parameters:

• testCycleId(required)

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

• application/json

Request headers:

• xJamaDateFieldsWithTime
  (optional) 

Query parameters:

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

Examples:

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

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

• application/json

Response:

TestRunDataListWrapper

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

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

Path parameters:

• versionNum(required)
• testCycleId(required)

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

• application/json

Request headers:

• xJamaDateFieldsWithTime
  (optional) 

Query parameters:

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

Examples:

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

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

• application/json

Response:

VersionDataWrapper

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

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

Path parameters:

• versionNum(required)
• testCycleId(required)

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

• application/json

Request headers:

• xJamaDateFieldsWithTime
  (optional) 

Query parameters:

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

Examples:

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

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

• application/json

Response:

VersionedTestCycleDataWrapper

GET /testcycles/{testCycleId}/versions

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

Path parameters:

• testCycleId(required)

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

• application/json

Request headers:

• xJamaDateFieldsWithTime
  (optional) 

Query parameters:

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

Examples:

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

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

• application/json

Response:

VersionDataListWrapper

PATCH /testcycles/{testCycleId}

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

Path parameters:

• testCycleId(required)

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

• application/json

Body:

array[RequestPatchOperation]Examples:

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

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

• application/json

Response:

AbstractRestResponse

PUT /testcycles/{testCycleId}

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

Path parameters:

• testCycleId(required)

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

• application/json

Body:

RequestTestCycleExamples:

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

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

• application/json

Response:

AbstractRestResponse

Endpoint testplans

The testplans endpoint has the following operations:

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

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

POST /testplans/{id}/attachments

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

Path parameters:

• id(required)

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

• application/json

Body:

RequestItemAttachmentExamples:

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

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

• application/json

Response:

CreatedResponse

POST /testplans/{id}/links

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

Path parameters:

• id(required)

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

• application/json

Body:

RequestLinkExamples:

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

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

• application/json

Response:

CreatedResponse

POST /testplans/{id}/tags

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

Path parameters:

• id(required)

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

• application/json

Body:

RequestItemTagExamples:

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

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

• application/json

Response:

CreatedResponse

POST /testplans/{id}/testgroups

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

Path parameters:

• id(required)

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

• application/json

Body:

RequestTestGroupExamples:

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

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

• application/json

Response:

CreatedResponse

POST /testplans/{id}/testcycles

Summary: Create a new test cycle

Path parameters:

• id(required)

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

• application/json

Body:

RequestTestCycleExamples:

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

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

• application/json

Response:

CreatedResponse

POST /testplans

Summary: Create a new test plan

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

• application/json

Body:

RequestTestPlanExamples:

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

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

• application/json

Response:

CreatedResponse

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

Summary: Delete the link with the specified ID

Path parameters:

• linkId(required)
• id(required)

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

• application/json

Examples:

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

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

• application/json

Response:

AbstractRestResponse

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

Summary: Remove an existing test case from the test group

Path parameters:

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

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

• application/json

Examples:

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

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

• application/json

Response:

AbstractRestResponse

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

Summary: Delete the test group with the specified ID

Path parameters:

• testGroupId(required)
• id(required)

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

• application/json

Examples:

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

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

• application/json

Response:

AbstractRestResponse

DELETE /testplans/{id}

Summary: Delete the test plan with the specified ID

Path parameters:

• id(required)

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

• application/json

Examples:

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

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

• application/json

Response:

AbstractRestResponse

GET /testplans/{id}/activities

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

Path parameters:

• id(required)

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

• application/json

Request headers:

• xJamaDateFieldsWithTime
  (optional) 

Query parameters:

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

Examples:

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

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

• application/json

Response:

ActivityDataListWrapper

GET /testplans/{id}/attachments

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

Path parameters:

• id(required)

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

• application/json

Request headers:

• xJamaDateFieldsWithTime
  (optional) 

Query parameters:

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

Examples:

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

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

• application/json

Response:

AttachmentDataListWrapper

GET /testplans/{id}/downstreamrelated

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

Path parameters:

• id(required)

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

• application/json

Request headers:

• xJamaDateFieldsWithTime
  (optional) 

Query parameters:

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

Examples:

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

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

• application/json

Response:

AbstractItemDataListWrapper

GET /testplans/{id}/downstreamrelationships

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

Path parameters:

• id(required)

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

• application/json

Request headers:

• xJamaDateFieldsWithTime
  (optional) 

Query parameters:

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

Examples:

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

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

• application/json

Response:

RelationshipDataListWrapper

GET /testplans/{id}/comments

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

Path parameters:

• id(required)

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

• application/json

Request headers:

• xJamaDateFieldsWithTime
  (optional) 

Query parameters:

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

Examples:

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

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

• application/json

Response:

CommentDataListWrapper

GET /testplans/{id}/links

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

Path parameters:

• id(required)

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

• application/json

Request headers:

• xJamaDateFieldsWithTime
  (optional) 

Query parameters:

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

Examples:

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

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

• application/json

Response:

LinkDataListWrapper

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

Summary: Get the link with the specified ID

Path parameters:

• linkId(required)
• id(required)

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

• application/json

Request headers:

• xJamaDateFieldsWithTime
  (optional) 

Query parameters:

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

Examples:

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

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

• application/json

Response:

LinkDataWrapper

GET /testplans/{id}/lock

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

Path parameters:

• id(required)

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

• application/json

Request headers:

• xJamaDateFieldsWithTime
  (optional) 

Query parameters:

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

Examples:

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

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

• application/json

Response:

LockDataWrapper

GET /testplans/{id}/tags/{tagId}

Summary: Get the tag with the specified ID

Path parameters:

• tagId(required)
• id(required)

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

• application/json

Request headers:

• xJamaDateFieldsWithTime
  (optional) 

Query parameters:

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

Examples:

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

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

• application/json

Response:

TagDataWrapper

GET /testplans/{id}/tags

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

Path parameters:

• id(required)

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

• application/json

Request headers:

• xJamaDateFieldsWithTime
  (optional) 

Query parameters:

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

Examples:

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

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

• application/json

Response:

TagDataListWrapper

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

Summary: Get the test case with the specified ID

Path parameters:

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

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

• application/json

Request headers:

• xJamaDateFieldsWithTime
  (optional) 

Query parameters:

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

Examples:

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

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

• application/json

Response:

ItemDataWrapper

GET /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)

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

• application/json

Request headers:

• xJamaDateFieldsWithTime
  (optional) 

Query parameters:

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

Examples:

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

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

• application/json

Response:

ItemDataListWrapper

GET /testplans/{id}/testcycles

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

Path parameters:

• id(required)

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

• application/json

Request headers:

• xJamaDateFieldsWithTime
  (optional) 

Query parameters:

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

Examples:

• Example data, content-type: application/json
  {
  “data” : [ {
  “itemType” : 1,
  “globalId” : “globalId”,
  “project” : 6,
  “resources” : {
  “key” : {
  “allowed” : [ “allowed”, “allowed” ]
  }
  },
  “createdDate” : “2000-01-23T04:56:07.000+00:00”,
  “lastActivityDate” : “2000-01-23T04:56:07.000+00:00”,
  “createdBy” : 5,
  “documentKey” : “documentKey”,
  “modifiedDate” : “2000-01-23T04:56:07.000+00:00”,
  “modifiedBy” : 5,
  “id” : 0,
  “fields” : {
  “key” : “{}”
  },
  “baselinedAppliedCategorySnapshots” : [ {
  “categoryPathSequence” : “categoryPathSequence”,
  “itemVersionNumberApplied” : 2
  }, {
  “categoryPathSequence” : “categoryPathSequence”,
  “itemVersionNumberApplied” : 2
  } ]
  }, {
  “itemType” : 1,
  “globalId” : “globalId”,
  “project” : 6,
  “resources” : {
  “key” : {
  “allowed” : [ “allowed”, “allowed” ]
  }
  },
  “createdDate” : “2000-01-23T04:56:07.000+00:00”,
  “lastActivityDate” : “2000-01-23T04:56:07.000+00:00”,
  “createdBy” : 5,
  “documentKey” : “documentKey”,
  “modifiedDate” : “2000-01-23T04:56:07.000+00:00”,
  “modifiedBy” : 5,
  “id” : 0,
  “fields” : {
  “key” : “{}”
  },
  “baselinedAppliedCategorySnapshots” : [ {
  “categoryPathSequence” : “categoryPathSequence”,
  “itemVersionNumberApplied” : 2
  }, {
  “categoryPathSequence” : “categoryPathSequence”,
  “itemVersionNumberApplied” : 2
  } ]
  } ],
  “meta” : {
  “pageInfo” : {
  “startIndex” : 6,
  “resultCount” : 1,
  “totalResults” : 5
  },
  “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:

TestCycleDataListWrapper

GET /testplans/{id}/testgroups/{testGroupId}

Summary: Get the test group with the specified ID

Path parameters:

• testGroupId(required)
• id(required)

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

• application/json

Request headers:

• xJamaDateFieldsWithTime
  (optional) 

Query parameters:

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

Examples:

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

Produces: API call produces the following media types according to the
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)

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

• application/json

Request headers:

• xJamaDateFieldsWithTime
  (optional) 

Query parameters:

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

Examples:

• Example data, content-type: application/json
  {
  “data” : [ {
  “name” : “name”,
  “id” : 0,
  “assignedTo” : 6
  }, {
  “name” : “name”,
  “id” : 0,
  “assignedTo” : 6
  } ],
  “meta” : {
  “pageInfo” : {
  “startIndex” : 6,
  “resultCount” : 1,
  “totalResults” : 5
  },
  “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:

TestGroupDataListWrapper

GET /testplans/{id}

Summary: Get the test plan with the specified ID

Path parameters:

• id(required)

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

• application/json

Request headers:

• xJamaDateFieldsWithTime
  (optional) 

Query parameters:

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

Examples:

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

Produces: API call produces the following media types according to the
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

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

• application/json

Request headers:

• xJamaDateFieldsWithTime
  (optional) 

Query parameters:

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

Examples:

• Example data, content-type: application/json
  {
  “data” : [ {
  “itemType” : 1,
  “globalId” : “globalId”,
  “project” : 6,
  “resources” : {
  “key” : {
  “allowed” : [ “allowed”, “allowed” ]
  }
  },
  “archived” : true,
  “createdDate” : “2000-01-23T04:56:07.000+00:00”,
  “lastActivityDate” : “2000-01-23T04:56:07.000+00:00”,
  “createdBy” : 5,
  “documentKey” : “documentKey”,
  “modifiedDate” : “2000-01-23T04:56:07.000+00:00”,
  “modifiedBy” : 5,
  “id” : 0,
  “fields” : {
  “key” : “{}”
  },
  “baselinedAppliedCategorySnapshots” : [ {
  “categoryPathSequence” : “categoryPathSequence”,
  “itemVersionNumberApplied” : 2
  }, {
  “categoryPathSequence” : “categoryPathSequence”,
  “itemVersionNumberApplied” : 2
  } ]
  }, {
  “itemType” : 1,
  “globalId” : “globalId”,
  “project” : 6,
  “resources” : {
  “key” : {
  “allowed” : [ “allowed”, “allowed” ]
  }
  },
  “archived” : true,
  “createdDate” : “2000-01-23T04:56:07.000+00:00”,
  “lastActivityDate” : “2000-01-23T04:56:07.000+00:00”,
  “createdBy” : 5,
  “documentKey” : “documentKey”,
  “modifiedDate” : “2000-01-23T04:56:07.000+00:00”,
  “modifiedBy” : 5,
  “id” : 0,
  “fields” : {
  “key” : “{}”
  },
  “baselinedAppliedCategorySnapshots” : [ {
  “categoryPathSequence” : “categoryPathSequence”,
  “itemVersionNumberApplied” : 2
  }, {
  “categoryPathSequence” : “categoryPathSequence”,
  “itemVersionNumberApplied” : 2
  } ]
  } ],
  “meta” : {
  “pageInfo” : {
  “startIndex” : 6,
  “resultCount” : 1,
  “totalResults” : 5
  },
  “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:

TestPlanDataListWrapper

GET /testplans/{id}/upstreamrelated

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

Path parameters:

• id(required)

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

• application/json

Request headers:

• xJamaDateFieldsWithTime
  (optional) 

Query parameters:

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

Examples:

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

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

• application/json

Response:

AbstractItemDataListWrapper

GET /testplans/{id}/upstreamrelationships

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

Path parameters:

• id(required)

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

• application/json

Request headers:

• xJamaDateFieldsWithTime
  (optional) 

Query parameters:

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

Examples:

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

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

• application/json

Response:

RelationshipDataListWrapper

GET /testplans/{id}/versions/{versionNum}

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

Path parameters:

• versionNum(required)
• id(required)

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

• application/json

Request headers:

• xJamaDateFieldsWithTime
  (optional) 

Query parameters:

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

Examples:

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

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

• application/json

Response:

VersionDataWrapper

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

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

Path parameters:

• versionNum(required)
• id(required)

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

• application/json

Request headers:

• xJamaDateFieldsWithTime
  (optional) 

Query parameters:

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

Examples:

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

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

• application/json

Response:

VersionedTestPlanDataWrapper

GET /testplans/{id}/versions

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

Path parameters:

• id(required)

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

• application/json

Request headers:

• xJamaDateFieldsWithTime
  (optional) 

Query parameters:

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

Examples:

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

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

• application/json

Response:

VersionDataListWrapper

PATCH /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:

array[RequestPatchOperation]Examples:

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

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

• application/json

Response:

AbstractRestResponse

POST /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:

RequestTestGroupTestCaseExamples:

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

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

• application/json

Response:

CreatedResponse

DELETE /testplans/{id}/attachments/{attachmentId}

Summary: Remove an existing attachment from the item

Path parameters:

• attachmentId(required)
• id(required)

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

• application/json

Examples:

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

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

• application/json

Response:

AbstractRestResponse

DELETE /testplans/{id}/tags/{tagId}

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

Path parameters:

• tagId(required)
• id(required)

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

• application/json

Examples:

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

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

• application/json

Response:

AbstractRestResponse

PUT /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:

RequestArchivedStatusExamples:

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

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

• application/json

Response:

AbstractRestResponse

PUT /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:

RequestLinkExamples:

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

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

• application/json

Response:

AbstractRestResponse

PUT /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:

RequestLockExamples:

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

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

• application/json

Response:

AbstractRestResponse

PUT /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:

RequestTestGroupExamples:

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

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

• application/json

Response:

AbstractRestResponse

PUT /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:

RequestTestPlanExamples:

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

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

• application/json

Response:

AbstractRestResponse

Endpoint testruns

The testruns endpoint has the following operations:

1. POST /testruns/{id}/attachments
2. POST /testruns/{id}/links
3. POST /testruns/{id}/tags
4. DELETE /testruns/{id}/links/{linkId}
5. DELETE /testruns/{id}
6. GET /testruns/{id}/activities
7. GET /testruns/{id}/attachments
8. GET /testruns/{id}/downstreamrelated
9. GET /testruns/{id}/downstreamrelationships
10. GET /testruns/{id}/comments
11. GET /testruns/{id}/links
12. GET /testruns/{id}/links/{linkId}
13. GET /testruns/{id}/lock
14. GET /testruns/{id}/tags/{tagId}
15. GET /testruns/{id}/tags
16. GET /testruns/{id}
17. GET /testruns
18. GET /testruns/{id}/upstreamrelated
19. GET /testruns/{id}/upstreamrelationships
20. GET /testruns/{id}/versions/{versionNum}
21. GET /testruns/{id}/versions/{versionNum}/versioneditem
22. GET /testruns/{id}/versions
23. POST /testruns/{id}/updatedtestcase
24. PATCH /testruns/{id}
25. DELETE /testruns/{id}/attachments/{attachmentId}
26. DELETE /testruns/{id}/tags/{tagId}
27. PUT /testruns/{id}/links/{linkId}
28. PUT /testruns/{id}/lock
29. 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:

RequestItemAttachmentExamples:

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

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

• application/json

Response:

CreatedResponse

POST /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:

RequestLinkExamples:

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

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

• application/json

Response:

CreatedResponse

POST /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:

RequestItemTagExamples:

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

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

• application/json

Response:

CreatedResponse

DELETE /testruns/{id}/links/{linkId}

Summary: Delete the link with the specified ID

Path parameters:

• linkId(required)
• id(required)

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

• application/json

Examples:

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

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

• application/json

Response:

AbstractRestResponse

DELETE /testruns/{id}

Summary: Delete 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

Examples:

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

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

• application/json

Response:

AbstractRestResponse

GET /testruns/{id}/activities

Summary: Get all activities 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

Request headers:

• xJamaDateFieldsWithTime
  (optional) 

Query parameters:

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

Examples:

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

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

• application/json

Response:

ActivityDataListWrapper

GET /testruns/{id}/attachments

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

Path parameters:

• id(required)

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

• application/json

Request headers:

• xJamaDateFieldsWithTime
  (optional) 

Query parameters:

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

Examples:

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

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

• application/json

Response:

AttachmentDataListWrapper

GET /testruns/{id}/downstreamrelated

Summary: Get all downstream related items 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

Request headers:

• xJamaDateFieldsWithTime
  (optional) 

Query parameters:

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

Examples:

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

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

• application/json

Response:

AbstractItemDataListWrapper

GET /testruns/{id}/downstreamrelationships

Summary: Get all downstream relationships 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

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” : 6,
  “resultCount” : 1,
  “totalResults” : 5
  },
  “status” : “OK”,
  “timestamp” : “2000-01-23T04:56:07.000+00:00”
  },
  “links” : {
  “key” : {
  “href” : “href”,
  “type” : “type”
  }
  },
  “linked” : {
  “key” : {
  “key” : “{}”
  }
  }
  }

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

• application/json

Response:

RelationshipDataListWrapper

GET /testruns/{id}/comments

Summary: Get all comments for the item with the specified ID

Path parameters:

• id(required)

Consumes: this API call consumes the following media types via the
Content-Type request header:

• application/json

Request headers:

• xJamaDateFieldsWithTime
  (optional) 

Query parameters:

• startAt
  (optional) 
• maxResults
  (optional)
  If not set, this defaults to 20. This cannot be larger than 50
• rootCommentsOnly
  (optional)
  , default value: false
• include
  (optional)
  Links to include as full objects in the linked map

Examples:

• Example data, content-type: application/json
  {
  “data” : [ {
  “createdDate” : “2000-01-23T04:56:07.000+00:00”,
  “deleted” : true,
  “createdBy” : 1,
  “inReplyTo” : 6,
  “commentType” : “GENERAL”,
  “modifiedBy” : 5,
  “location” : {
  “item” : 5,
  “project” : 2
  },
  “id” : 0,
  “body” : {
  “text” : “text”
  },
  “status” : “OPEN”
  }, {
  “createdDate” : “2000-01-23T04:56:07.000+00:00”,
  “deleted” : true,
  “createdBy” : 1,
  “inReplyTo” : 6,
  “commentType” : “GENERAL”,
  “modifiedBy” : 5,
  “location” : {
  “item” : 5,
  “project” : 2
  },
  “id” : 0,
  “body” : {
  “text” : “text”
  },
  “status” : “OPEN”
  } ],
  “meta” : {
  “pageInfo” : {
  “startIndex” : 6,
  “resultCount” : 1,
  “totalResults” : 5
  },
  “status” : “OK”,
  “timestamp” : “2000-01-23T04:56:07.000+00:00”
  },
  “links” : {
  “key” : {
  “href” : “href”,
  “type” : “type”
  }
  },
  “linked” : {
  “key” : {
  “key” : “{}”
  }
  }
  }

Produces: API call produces the following media types according to the
Accept request header;
the media type will be conveyed by the Content-Type response header:

• application/json

Response:

CommentDataListWrapper

GET /testruns/{id}/links

Summary: Get all links for the item with the specified ID

Path parameters:

• id(required)

Consumes: this API call consumes the following media types via the
Content-Type request header:

• application/json

Request headers:

• xJamaDateFieldsWithTime
  (optional) 

Query parameters:

• startAt
  (optional) 
• maxResults
  (optional)
  If not set, this defaults to 20. This cannot be larger than 50
• include
  (optional)
  Links to include as full objects in the linked map

Examples:

• Example data, content-type: application/json
  {
  “data” : [ {
  “href” : “href”,
  “type” : “type”
  }, {
  “href” : “href”,
  “type” : “type”
  } ],
  “meta” : {
  “pageInfo” : {
  “startIndex” : 6,
  “resultCount” : 1,
  “totalResults” : 5
  },
  “status” : “OK”,
  “timestamp” : “2000-01-23T04:56:07.000+00:00”
  },
  “links” : {
  “key” : {
  “href” : “href”,
  “type” : “type”
  }
  },
  “linked” : {
  “key” : {
  “key” : “{}”
  }
  }
  }

Produces: API call produces the following media types according to the
Accept request header;
the media type will be conveyed by the Content-Type response header:

• application/json

Response:

LinkDataListWrapper

GET /testruns/{id}/links/{linkId}

Summary: Get the link with the specified ID

Path parameters:

• linkId(required)
• id(required)

Consumes: this API call consumes the following media types via the
Content-Type request header:

• application/json

Request headers:

• xJamaDateFieldsWithTime
  (optional) 

Query parameters:

• include
  (optional)
  Links to include as full objects in the linked map

Examples:

• Example data, content-type: application/json
  {
  “data” : {
  “href” : “href”,
  “type” : “type”
  },
  “meta” : {
  “status” : “OK”,
  “timestamp” : “2000-01-23T04:56:07.000+00:00”
  },
  “links” : {
  “key” : {
  “href” : “href”,
  “type” : “type”
  }
  },
  “linked” : {
  “key” : {
  “key” : “{}”
  }
  }
  }

Produces: API call produces the following media types according to the
Accept request header;
the media type will be conveyed by the Content-Type response header:

• application/json

Response:

LinkDataWrapper

GET /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)

Consumes: this API call consumes the following media types via the
Content-Type request header:

• application/json

Request headers:

• xJamaDateFieldsWithTime
  (optional) 

Query parameters:

• include
  (optional)
  Links to include as full objects in the linked map

Examples:

• Example data, content-type: application/json
  {
  “data” : {
  “lockedBy” : 7,
  “lastLockedDate” : “2000-01-23T04:56:07.000+00:00”,
  “locked” : true
  },
  “meta” : {
  “status” : “OK”,
  “timestamp” : “2000-01-23T04:56:07.000+00:00”
  },
  “links” : {
  “key” : {
  “href” : “href”,
  “type” : “type”
  }
  },
  “linked” : {
  “key” : {
  “key” : “{}”
  }
  }
  }

Produces: API call produces the following media types according to the
Accept request header;
the media type will be conveyed by the Content-Type response header:

• application/json

Response:

LockDataWrapper

GET /testruns/{id}/tags/{tagId}

Summary: Get the tag with the specified ID

Path parameters:

• tagId(required)
• id(required)

Consumes: this API call consumes the following media types via the
Content-Type request header:

• application/json

Request headers:

• xJamaDateFieldsWithTime
  (optional) 

Query parameters:

• include
  (optional)
  Links to include as full objects in the linked map

Examples:

• Example data, content-type: application/json
  {
  “data” : {
  “name” : “name”,
  “project” : 6,
  “id” : 0
  },
  “meta” : {
  “status” : “OK”,
  “timestamp” : “2000-01-23T04:56:07.000+00:00”
  },
  “links” : {
  “key” : {
  “href” : “href”,
  “type” : “type”
  }
  },
  “linked” : {
  “key” : {
  “key” : “{}”
  }
  }
  }

Produces: API call produces the following media types according to the
Accept request header;
the media type will be conveyed by the Content-Type response header:

• application/json

Response:

TagDataWrapper

GET /testruns/{id}/tags

Summary: Get all tags for the item with the specified ID

Path parameters:

• id(required)

Consumes: this API call consumes the following media types via the
Content-Type request header:

• application/json

Request headers:

• xJamaDateFieldsWithTime
  (optional) 

Query parameters:

• startAt
  (optional) 
• maxResults
  (optional)
  If not set, this defaults to 20. This cannot be larger than 50
• include
  (optional)
  Links to include as full objects in the linked map

Examples:

• Example data, content-type: application/json
  {
  “data” : [ {
  “name” : “name”,
  “project” : 6,
  “id” : 0
  }, {
  “name” : “name”,
  “project” : 6,
  “id” : 0
  } ],
  “meta” : {
  “pageInfo” : {
  “startIndex” : 6,
  “resultCount” : 1,
  “totalResults” : 5
  },
  “status” : “OK”,
  “timestamp” : “2000-01-23T04:56:07.000+00:00”
  },
  “links” : {
  “key” : {
  “href” : “href”,
  “type” : “type”
  }
  },
  “linked” : {
  “key” : {
  “key” : “{}”
  }
  }
  }

Produces: API call produces the following media types according to the
Accept request header;
the media type will be conveyed by the Content-Type response header:

• application/json

Response:

TagDataListWrapper

GET /testruns/{id}

Summary: Get 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

Request headers:

• xJamaDateFieldsWithTime
  (optional) 

Query parameters:

• include
  (optional)
  Links to include as full objects in the linked map

Examples:

• Example data, content-type: application/json
  {
  “data” : {
  “itemType” : 1,
  “globalId” : “globalId”,
  “project” : 6,
  “resources” : {
  “key” : {
  “allowed” : [ “allowed”, “allowed” ]
  }
  },
  “createdDate” : “2000-01-23T04:56:07.000+00:00”,
  “lastActivityDate” : “2000-01-23T04:56:07.000+00:00”,
  “createdBy” : 5,
  “documentKey” : “documentKey”,
  “modifiedDate” : “2000-01-23T04:56:07.000+00:00”,
  “testCaseVersionNumber” : 2,
  “testGroup” : [ 9, 9 ],
  “sortOrderFromTestGroup” : 7,
  “modifiedBy” : 5,
  “id” : 0,
  “fields” : {
  “key” : “{}”
  },
  “baselinedAppliedCategorySnapshots” : [ {
  “categoryPathSequence” : “categoryPathSequence”,
  “itemVersionNumberApplied” : 2
  }, {
  “categoryPathSequence” : “categoryPathSequence”,
  “itemVersionNumberApplied” : 2
  } ]
  },
  “meta” : {
  “status” : “OK”,
  “timestamp” : “2000-01-23T04:56:07.000+00:00”
  },
  “links” : {
  “key” : {
  “href” : “href”,
  “type” : “type”
  }
  },
  “linked” : {
  “key” : {
  “key” : “{}”
  }
  }
  }

Produces: API call produces the following media types according to the
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

Consumes: this API call consumes the following media types via the
Content-Type request header:

• application/json

Request headers:

• xJamaDateFieldsWithTime
  (optional) 

Query parameters:

• testCycle
  (optional)
  Filter by test runs in test cycle id
• testCase
  (optional)
  Filter by test runs from test case id
• testPlan
  (optional)
  Filter by test runs in test plan id
• sortBy
  (optional)
  Sort orders can be added with the name of the field by which to sort, followed by .asc or .desc (e.g. ‘name.asc’ or ‘testCycle.desc’). If not set, this defaults to documentKey.asc.
• startAt
  (optional) 
• maxResults
  (optional)
  If not set, this defaults to 20. This cannot be larger than 50
• include
  (optional)
  Links to include as full objects in the linked map

Examples:

• Example data, content-type: application/json
  {
  “data” : [ {
  “itemType” : 1,
  “globalId” : “globalId”,
  “project” : 6,
  “resources” : {
  “key” : {
  “allowed” : [ “allowed”, “allowed” ]
  }
  },
  “createdDate” : “2000-01-23T04:56:07.000+00:00”,
  “lastActivityDate” : “2000-01-23T04:56:07.000+00:00”,
  “createdBy” : 5,
  “documentKey” : “documentKey”,
  “modifiedDate” : “2000-01-23T04:56:07.000+00:00”,
  “testCaseVersionNumber” : 2,
  “testGroup” : [ 9, 9 ],
  “sortOrderFromTestGroup” : 7,
  “modifiedBy” : 5,
  “id” : 0,
  “fields” : {
  “key” : “{}”
  },
  “baselinedAppliedCategorySnapshots” : [ {
  “categoryPathSequence” : “categoryPathSequence”,
  “itemVersionNumberApplied” : 2
  }, {
  “categoryPathSequence” : “categoryPathSequence”,
  “itemVersionNumberApplied” : 2
  } ]
  }, {
  “itemType” : 1,
  “globalId” : “globalId”,
  “project” : 6,
  “resources” : {
  “key” : {
  “allowed” : [ “allowed”, “allowed” ]
  }
  },
  “createdDate” : “2000-01-23T04:56:07.000+00:00”,
  “lastActivityDate” : “2000-01-23T04:56:07.000+00:00”,
  “createdBy” : 5,
  “documentKey” : “documentKey”,
  “modifiedDate” : “2000-01-23T04:56:07.000+00:00”,
  “testCaseVersionNumber” : 2,
  “testGroup” : [ 9, 9 ],
  “sortOrderFromTestGroup” : 7,
  “modifiedBy” : 5,
  “id” : 0,
  “fields” : {
  “key” : “{}”
  },
  “baselinedAppliedCategorySnapshots” : [ {
  “categoryPathSequence” : “categoryPathSequence”,
  “itemVersionNumberApplied” : 2
  }, {
  “categoryPathSequence” : “categoryPathSequence”,
  “itemVersionNumberApplied” : 2
  } ]
  } ],
  “meta” : {
  “pageInfo” : {
  “startIndex” : 6,
  “resultCount” : 1,
  “totalResults” : 5
  },
  “status” : “OK”,
  “timestamp” : “2000-01-23T04:56:07.000+00:00”
  },
  “links” : {
  “key” : {
  “href” : “href”,
  “type” : “type”
  }
  },
  “linked” : {
  “key” : {
  “key” : “{}”
  }
  }
  }

Produces: API call produces the following media types according to the
Accept request header;
the media type will be conveyed by the Content-Type response header:

• application/json

Response:

TestRunDataListWrapper

GET /testruns/{id}/upstreamrelated

Summary: Get all upstream related items 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

Request headers:

• xJamaDateFieldsWithTime
  (optional) 

Query parameters:

• startAt
  (optional) 
• maxResults
  (optional)
  If not set, this defaults to 20. This cannot be larger than 50
• include
  (optional)
  Links to include as full objects in the linked map

Examples:

• Example data, content-type: application/json
  {
  “data” : [ {
  “itemType” : 1,
  “globalId” : “globalId”,
  “project” : 6,
  “resources” : {
  “key” : {
  “allowed” : [ “allowed”, “allowed” ]
  }
  },
  “createdDate” : “2000-01-23T04:56:07.000+00:00”,
  “lastActivityDate” : “2000-01-23T04:56:07.000+00:00”,
  “createdBy” : 5,
  “documentKey” : “documentKey”,
  “modifiedDate” : “2000-01-23T04:56:07.000+00:00”,
  “modifiedBy” : 5,
  “id” : 0,
  “fields” : {
  “key” : “{}”
  },
  “baselinedAppliedCategorySnapshots” : [ {
  “categoryPathSequence” : “categoryPathSequence”,
  “itemVersionNumberApplied” : 2
  }, {
  “categoryPathSequence” : “categoryPathSequence”,
  “itemVersionNumberApplied” : 2
  } ]
  }, {
  “itemType” : 1,
  “globalId” : “globalId”,
  “project” : 6,
  “resources” : {
  “key” : {
  “allowed” : [ “allowed”, “allowed” ]
  }
  },
  “createdDate” : “2000-01-23T04:56:07.000+00:00”,
  “lastActivityDate” : “2000-01-23T04:56:07.000+00:00”,
  “createdBy” : 5,
  “documentKey” : “documentKey”,
  “modifiedDate” : “2000-01-23T04:56:07.000+00:00”,
  “modifiedBy” : 5,
  “id” : 0,
  “fields” : {
  “key” : “{}”
  },
  “baselinedAppliedCategorySnapshots” : [ {
  “categoryPathSequence” : “categoryPathSequence”,
  “itemVersionNumberApplied” : 2
  }, {
  “categoryPathSequence” : “categoryPathSequence”,
  “itemVersionNumberApplied” : 2
  } ]
  } ],
  “meta” : {
  “pageInfo” : {
  “startIndex” : 6,
  “resultCount” : 1,
  “totalResults” : 5
  },
  “status” : “OK”,
  “timestamp” : “2000-01-23T04:56:07.000+00:00”
  },
  “links” : {
  “key” : {
  “href” : “href”,
  “type” : “type”
  }
  },
  “linked” : {
  “key” : {
  “key” : “{}”
  }
  }
  }

Produces: API call produces the following media types according to the
Accept request header;
the media type will be conveyed by the Content-Type response header:

• application/json

Response:

AbstractItemDataListWrapper

GET /testruns/{id}/upstreamrelationships

Summary: Get all upstream relationships 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

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” : 6,
  “resultCount” : 1,
  “totalResults” : 5
  },
  “status” : “OK”,
  “timestamp” : “2000-01-23T04:56:07.000+00:00”
  },
  “links” : {
  “key” : {
  “href” : “href”,
  “type” : “type”
  }
  },
  “linked” : {
  “key” : {
  “key” : “{}”
  }
  }
  }

Produces: API call produces the following media types according to the
Accept request header;
the media type will be conveyed by the Content-Type response header:

• application/json

Response:

RelationshipDataListWrapper

GET /testruns/{id}/versions/{versionNum}

Summary: Get the numbered version for the item with the specified ID

Path parameters:

• versionNum(required)
• id(required)

Consumes: this API call consumes the following media types via the
Content-Type request header:

• application/json

Request headers:

• xJamaDateFieldsWithTime
  (optional) 

Query parameters:

• include
  (optional)
  Links to include as full objects in the linked map

Examples:

• Example data, content-type: application/json
  {
  “data” : {
  “item” : 6,
  “createdDate” : “2000-01-23T04:56:07.000+00:00”,
  “versionedItem” : [ 0, 0 ],
  “createdBy” : 5,
  “comment” : “comment”,
  “type” : “type”,
  “userName” : “userName”,
  “versionNumber” : 1,
  “changeDetails” : “changeDetails”
  },
  “meta” : {
  “status” : “OK”,
  “timestamp” : “2000-01-23T04:56:07.000+00:00”
  },
  “links” : {
  “key” : {
  “href” : “href”,
  “type” : “type”
  }
  },
  “linked” : {
  “key” : {
  “key” : “{}”
  }
  }
  }

Produces: API call produces the following media types according to the
Accept request header;
the media type will be conveyed by the Content-Type response header:

• application/json

Response:

VersionDataWrapper

GET /testruns/{id}/versions/{versionNum}/versioneditem

Summary: Get the snapshot of the test run at the specified version

Path parameters:

• versionNum(required)
• id(required)

Consumes: this API call consumes the following media types via the
Content-Type request header:

• application/json

Request headers:

• xJamaDateFieldsWithTime
  (optional) 

Query parameters:

• include
  (optional)
  Links to include as full objects in the linked map

Examples:

• Example data, content-type: application/json
  {
  “data” : {
  “itemType” : 5,
  “globalId” : “globalId”,
  “project” : 5,
  “resources” : {
  “key” : {
  “allowed” : [ “allowed”, “allowed” ]
  }
  },
  “version” : 0,
  “currentVersion” : 6,
  “createdDate” : “2000-01-23T04:56:07.000+00:00”,
  “lastActivityDate” : “2000-01-23T04:56:07.000+00:00”,
  “createdBy” : 2,
  “documentKey” : “documentKey”,
  “modifiedDate” : “2000-01-23T04:56:07.000+00:00”,
  “testCaseVersionNumber” : 9,
  “testGroup” : [ 2, 2 ],
  “sortOrderFromTestGroup” : 3,
  “modifiedBy” : 7,
  “id” : 1,
  “fields” : {
  “key” : “{}”
  },
  “baselinedAppliedCategorySnapshots” : [ {
  “categoryPathSequence” : “categoryPathSequence”,
  “itemVersionNumberApplied” : 2
  }, {
  “categoryPathSequence” : “categoryPathSequence”,
  “itemVersionNumberApplied” : 2
  } ]
  },
  “meta” : {
  “status” : “OK”,
  “timestamp” : “2000-01-23T04:56:07.000+00:00”
  },
  “links” : {
  “key” : {
  “href” : “href”,
  “type” : “type”
  }
  },
  “linked” : {
  “key” : {
  “key” : “{}”
  }
  }
  }

Produces: API call produces the following media types according to the
Accept request header;
the media type will be conveyed by the Content-Type response header:

• application/json

Response:

VersionedTestRunDataWrapper

GET /testruns/{id}/versions

Summary: Get all versions for the item with the specified ID

Path parameters:

• id(required)

Consumes: this API call consumes the following media types via the
Content-Type request header:

• application/json

Request headers:

• xJamaDateFieldsWithTime
  (optional) 

Query parameters:

• startAt
  (optional) 
• maxResults
  (optional)
  If not set, this defaults to 20. This cannot be larger than 50
• include
  (optional)
  Links to include as full objects in the linked map

Examples:

• Example data, content-type: application/json
  {
  “data” : [ {
  “item” : 6,
  “createdDate” : “2000-01-23T04:56:07.000+00:00”,
  “versionedItem” : [ 0, 0 ],
  “createdBy” : 5,
  “comment” : “comment”,
  “type” : “type”,
  “userName” : “userName”,
  “versionNumber” : 1,
  “changeDetails” : “changeDetails”
  }, {
  “item” : 6,
  “createdDate” : “2000-01-23T04:56:07.000+00:00”,
  “versionedItem” : [ 0, 0 ],
  “createdBy” : 5,
  “comment” : “comment”,
  “type” : “type”,
  “userName” : “userName”,
  “versionNumber” : 1,
  “changeDetails” : “changeDetails”
  } ],
  “meta” : {
  “pageInfo” : {
  “startIndex” : 6,
  “resultCount” : 1,
  “totalResults” : 5
  },
  “status” : “OK”,
  “timestamp” : “2000-01-23T04:56:07.000+00:00”
  },
  “links” : {
  “key” : {
  “href” : “href”,
  “type” : “type”
  }
  },
  “linked” : {
  “key” : {
  “key” : “{}”
  }
  }
  }

Produces: API call produces the following media types according to the
Accept request header;
the media type will be conveyed by the Content-Type response header:

• application/json

Response:

VersionDataListWrapper

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)

Consumes: this API call consumes the following media types via the
Content-Type request header:

• application/json

Examples:

• Example data, content-type: application/json
  {
  “headers” : {
  “key” : [ “headers”, “headers” ]
  },
  “pageInfo” : {
  “startIndex” : 6,
  “resultCount” : 1,
  “totalResults” : 5
  },
  “location” : “http://example.com/aeiou”,
  “id” : 6,
  “statusReasonPhrase” : “statusReasonPhrase”,
  “status” : 0
  }

Produces: API call produces the following media types according to the
Accept request header;
the media type will be conveyed by the Content-Type response header:

• application/json

Response:

CreatedResponse

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:

array[RequestPatchOperation]Request headers:

• xJamaDateFieldsWithTime
  (optional)
  When updating testrun, required to preserve existing executionDate field’s full datetime info. With this set, if passing in new executionDate value, must be in ISO8601 format (milliseconds or seconds) – \”yyyy-MM-dd’T’HH:mm:ss.SSSZ\” or \”yyyy-MM-dd’T’HH:mm:ssZ\”.

Examples:

• Example data, content-type: application/json
  {
  “headers” : {
  “key” : [ “headers”, “headers” ]
  },
  “pageInfo” : {
  “startIndex” : 6,
  “resultCount” : 1,
  “totalResults” : 5
  },
  “statusReasonPhrase” : “statusReasonPhrase”,
  “status” : 0
  }

Produces: API call produces the following media types according to the
Accept request header;
the media type will be conveyed by the Content-Type response header:

• application/json

Response:

AbstractRestResponse

DELETE /testruns/{id}/attachments/{attachmentId}

Summary: Remove an existing attachment from the item

Path parameters:

• attachmentId(required)
• id(required)

Consumes: this API call consumes the following media types via the
Content-Type request header:

• application/json

Examples:

• Example data, content-type: application/json
  {
  “headers” : {
  “key” : [ “headers”, “headers” ]
  },
  “pageInfo” : {
  “startIndex” : 6,
  “resultCount” : 1,
  “totalResults” : 5
  },
  “statusReasonPhrase” : “statusReasonPhrase”,
  “status” : 0
  }

Produces: API call produces the following media types according to the
Accept request header;
the media type will be conveyed by the Content-Type response header:

• application/json

Response:

AbstractRestResponse

DELETE /testruns/{id}/tags/{tagId}

Summary: Remove an existing tag from the item with the specified ID

Path parameters:

• tagId(required)
• id(required)

Consumes: this API call consumes the following media types via the
Content-Type request header:

• application/json

Examples:

• Example data, content-type: application/json
  {
  “headers” : {
  “key” : [ “headers”, “headers” ]
  },
  “pageInfo” : {
  “startIndex” : 6,
  “resultCount” : 1,
  “totalResults” : 5
  },
  “statusReasonPhrase” : “statusReasonPhrase”,
  “status” : 0
  }

Produces: API call produces the following media types according to the
Accept request header;
the media type will be conveyed by the Content-Type response header:

• application/json

Response:

AbstractRestResponse

PUT /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:

RequestLinkExamples:

• Example data, content-type: application/json
  {
  “headers” : {
  “key” : [ “headers”, “headers” ]
  },
  “pageInfo” : {
  “startIndex” : 6,
  “resultCount” : 1,
  “totalResults” : 5
  },
  “statusReasonPhrase” : “statusReasonPhrase”,
  “status” : 0
  }

Produces: API call produces the following media types according to the
Accept request header;
the media type will be conveyed by the Content-Type response header:

• application/json

Response:

AbstractRestResponse

PUT /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:

RequestLockExamples:

• Example data, content-type: application/json
  {
  “headers” : {
  “key” : [ “headers”, “headers” ]
  },
  “pageInfo” : {
  “startIndex” : 6,
  “resultCount” : 1,
  “totalResults” : 5
  },
  “statusReasonPhrase” : “statusReasonPhrase”,
  “status” : 0
  }

Produces: API call produces the following media types according to the
Accept request header;
the media type will be conveyed by the Content-Type response header:

• application/json

Response:

AbstractRestResponse

PUT /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:

RequestTestRunRequest headers:

• xJamaDateFieldsWithTime
  (optional)
  When updating testrun, required to preserve existing executionDate field’s full datetime info. With this set, if passing in new executionDate value, must be in ISO8601 format (milliseconds or seconds) – \”yyyy-MM-dd’T’HH:mm:ss.SSSZ\” or \”yyyy-MM-dd’T’HH:mm:ssZ\”.

Examples:

• Example data, content-type: application/json
  {
  “headers” : {
  “key” : [ “headers”, “headers” ]
  },
  “pageInfo” : {
  “startIndex” : 6,
  “resultCount” : 1,
  “totalResults” : 5
  },
  “statusReasonPhrase” : “statusReasonPhrase”,
  “status” : 0
  }

Produces: API call produces the following media types according to the
Accept request header;
the media type will be conveyed by the Content-Type response header:

• application/json

Response:

AbstractRestResponse

Endpoint usergroups

The usergroups endpoint has the following operations:

1. POST /usergroups
2. POST /usergroups/{id}/users
3. DELETE /usergroups/{id}
4. GET /usergroups/{id}
5. GET /usergroups/{id}/users
6. GET /usergroups
7. DELETE /usergroups/{id}/users/{userId}
8. 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:

RequestUserGroupExamples:

• Example data, content-type: application/json
  {
  “headers” : {
  “key” : [ “headers”, “headers” ]
  },
  “pageInfo” : {
  “startIndex” : 6,
  “resultCount” : 1,
  “totalResults” : 5
  },
  “location” : “http://example.com/aeiou”,
  “id” : 6,
  “statusReasonPhrase” : “statusReasonPhrase”,
  “status” : 0
  }

Produces: API call produces the following media types according to the
Accept request header;
the media type will be conveyed by the Content-Type response header:

• application/json

Response:

CreatedResponse

POST /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:

RequestGroupUserExamples:

• Example data, content-type: application/json
  {
  “headers” : {
  “key” : [ “headers”, “headers” ]
  },
  “pageInfo” : {
  “startIndex” : 6,
  “resultCount” : 1,
  “totalResults” : 5
  },
  “location” : “http://example.com/aeiou”,
  “id” : 6,
  “statusReasonPhrase” : “statusReasonPhrase”,
  “status” : 0
  }

Produces: API call produces the following media types according to the
Accept request header;
the media type will be conveyed by the Content-Type response header:

• application/json

Response:

CreatedResponse

DELETE /usergroups/{id}

Summary: Delete 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

Examples:

• Example data, content-type: application/json
  {
  “headers” : {
  “key” : [ “headers”, “headers” ]
  },
  “pageInfo” : {
  “startIndex” : 6,
  “resultCount” : 1,
  “totalResults” : 5
  },
  “statusReasonPhrase” : “statusReasonPhrase”,
  “status” : 0
  }

Produces: API call produces the following media types according to the
Accept request header;
the media type will be conveyed by the Content-Type response header:

• application/json

Response:

AbstractRestResponse

GET /usergroups/{id}

Summary: Get 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

Request headers:

• xJamaDateFieldsWithTime
  (optional) 

Query parameters:

• include
  (optional)
  Links to include as full objects in the linked map

Examples:

• Example data, content-type: application/json
  {
  “data” : {
  “uid” : “uid”,
  “name” : “name”,
  “description” : “description”,
  “project” : 6,
  “id” : 0
  },
  “meta” : {
  “status” : “OK”,
  “timestamp” : “2000-01-23T04:56:07.000+00:00”
  },
  “links” : {
  “key” : {
  “href” : “href”,
  “type” : “type”
  }
  },
  “linked” : {
  “key” : {
  “key” : “{}”
  }
  }
  }

Produces: API call produces the following media types according to the
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)

Consumes: this API call consumes the following media types via the
Content-Type request header:

• application/json

Request headers:

• xJamaDateFieldsWithTime
  (optional) 

Query parameters:

• startAt
  (optional) 
• maxResults
  (optional)
  If not set, this defaults to 20. This cannot be larger than 50
• include
  (optional)
  Links to include as full objects in the linked map

Examples:

• Example data, content-type: application/json
  {
  “data” : [ {
  “lastName” : “lastName”,
  “avatarUrl” : “avatarUrl”,
  “active” : true,
  “customData” : [ {
  “name” : “name”,
  “value” : “value”
  }, {
  “name” : “name”,
  “value” : “value”
  } ],
  “title” : “title”,
  “firstName” : “firstName”,
  “licenseType” : “NAMED”,
  “uid” : “uid”,
  “phone” : “phone”,
  “location” : “location”,
  “id” : 0,
  “authenticationType” : {
  “name” : “name”,
  “id” : 6
  },
  “email” : “email”,
  “username” : “username”
  }, {
  “lastName” : “lastName”,
  “avatarUrl” : “avatarUrl”,
  “active” : true,
  “customData” : [ {
  “name” : “name”,
  “value” : “value”
  }, {
  “name” : “name”,
  “value” : “value”
  } ],
  “title” : “title”,
  “firstName” : “firstName”,
  “licenseType” : “NAMED”,
  “uid” : “uid”,
  “phone” : “phone”,
  “location” : “location”,
  “id” : 0,
  “authenticationType” : {
  “name” : “name”,
  “id” : 6
  },
  “email” : “email”,
  “username” : “username”
  } ],
  “meta” : {
  “pageInfo” : {
  “startIndex” : 6,
  “resultCount” : 1,
  “totalResults” : 5
  },
  “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:

UserDataListWrapper

GET /usergroups

Summary: Get all user groups

Consumes: this API call consumes the following media types via the
Content-Type request header:

• application/json

Request headers:

• xJamaDateFieldsWithTime
  (optional) 

Query parameters:

• project
  (optional) 
• startAt
  (optional) 
• maxResults
  (optional)
  If not set, this defaults to 20. This cannot be larger than 50
• include
  (optional)
  Links to include as full objects in the linked map

Examples:

• Example data, content-type: application/json
  {
  “data” : [ {
  “uid” : “uid”,
  “name” : “name”,
  “description” : “description”,
  “project” : 6,
  “id” : 0
  }, {
  “uid” : “uid”,
  “name” : “name”,
  “description” : “description”,
  “project” : 6,
  “id” : 0
  } ],
  “meta” : {
  “pageInfo” : {
  “startIndex” : 6,
  “resultCount” : 1,
  “totalResults” : 5
  },
  “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:

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)

Consumes: this API call consumes the following media types via the
Content-Type request header:

• application/json

Examples:

• Example data, content-type: application/json
  {
  “headers” : {
  “key” : [ “headers”, “headers” ]
  },
  “pageInfo” : {
  “startIndex” : 6,
  “resultCount” : 1,
  “totalResults” : 5
  },
  “statusReasonPhrase” : “statusReasonPhrase”,
  “status” : 0
  }

Produces: API call produces the following media types according to the
Accept request header;
the media type will be conveyed by the Content-Type response header:

• application/json

Response:

AbstractRestResponse

PUT /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:

RequestUserGroupExamples:

• Example data, content-type: application/json
  {
  “headers” : {
  “key” : [ “headers”, “headers” ]
  },
  “pageInfo” : {
  “startIndex” : 6,
  “resultCount” : 1,
  “totalResults” : 5
  },
  “statusReasonPhrase” : “statusReasonPhrase”,
  “status” : 0
  }

Produces: API call produces the following media types according to the
Accept request header;
the media type will be conveyed by the Content-Type response header:

• application/json

Response:

AbstractRestResponse

Endpoint users

The users endpoint has the following operations:

1. POST /users
2. GET /users/current
3. GET /users/{userId}/customData
4. GET /users/current/favoritefilters
5. GET /users/{userId}
6. GET /users
7. PUT /users/{userId}
8. PUT /users/{userId}/active
9. 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:

RequestUserExamples:

• Example data, content-type: application/json
  {
  “headers” : {
  “key” : [ “headers”, “headers” ]
  },
  “pageInfo” : {
  “startIndex” : 6,
  “resultCount” : 1,
  “totalResults” : 5
  },
  “location” : “http://example.com/aeiou”,
  “id” : 6,
  “statusReasonPhrase” : “statusReasonPhrase”,
  “status” : 0
  }

Produces: API call produces the following media types according to the
Accept request header;
the media type will be conveyed by the Content-Type response header:

• application/json

Response:

CreatedResponse

GET /users/current

Summary: Gets the current user

Consumes: this API call consumes the following media types via the
Content-Type request header:

• application/json

Request headers:

• xJamaDateFieldsWithTime
  (optional) 

Query parameters:

• include
  (optional)
  Links to include as full objects in the linked map

Examples:

• Example data, content-type: application/json
  {
  “data” : {
  “lastName” : “lastName”,
  “avatarUrl” : “avatarUrl”,
  “active” : true,
  “customData” : [ {
  “name” : “name”,
  “value” : “value”
  }, {
  “name” : “name”,
  “value” : “value”
  } ],
  “title” : “title”,
  “firstName” : “firstName”,
  “licenseType” : “NAMED”,
  “uid” : “uid”,
  “phone” : “phone”,
  “location” : “location”,
  “id” : 0,
  “authenticationType” : {
  “name” : “name”,
  “id” : 6
  },
  “email” : “email”,
  “username” : “username”
  },
  “meta” : {
  “status” : “OK”,
  “timestamp” : “2000-01-23T04:56:07.000+00:00”
  },
  “links” : {
  “key” : {
  “href” : “href”,
  “type” : “type”
  }
  },
  “linked” : {
  “key” : {
  “key” : “{}”
  }
  }
  }

Produces: API call produces the following media types according to the
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)

Consumes: this API call consumes the following media types via the
Content-Type request header:

• application/json

Examples:

• Example data, content-type: application/json
  {
  “data” : [ {
  “name” : “name”,
  “value” : “value”
  }, {
  “name” : “name”,
  “value” : “value”
  } ],
  “meta” : {
  “pageInfo” : {
  “startIndex” : 6,
  “resultCount” : 1,
  “totalResults” : 5
  },
  “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:

UserCustomDataDataListWrapper

GET /users/current/favoritefilters

Summary: Gets the current user’s favorite filters

Consumes: this API call consumes the following media types via the
Content-Type request header:

• application/json

Request headers:

• xJamaDateFieldsWithTime
  (optional) 

Query parameters:

• startAt
  (optional) 
• maxResults
  (optional)
  If not set, this defaults to 20. This cannot be larger than 50
• include
  (optional)
  Links to include as full objects in the linked map

Examples:

• Example data, content-type: application/json
  {
  “data” : [ {
  “specifiedProject” : 1,
  “public” : true,
  “author” : 6,
  “name” : “name”,
  “id” : 0,
  “projectScope” : “ALL”,
  “filterQuery” : {
  “orderRules” : [ {
  “field” : {
  “display” : “display”,
  “name” : “name”,
  “id” : 5,
  “fieldDataType” : “INTEGER”
  },
  “direction” : “ASC”
  }, {
  “field” : {
  “display” : “display”,
  “name” : “name”,
  “id” : 5,
  “fieldDataType” : “INTEGER”
  },
  “direction” : “ASC”
  } ],
  “name” : “name”,
  “rule” : {
  “itemType” : 5,
  “field” : {
  “display” : “display”,
  “name” : “name”,
  “id” : 5,
  “fieldDataType” : “INTEGER”
  },
  “values” : [ “values”, “values” ],
  “rules” : [ null, null ],
  “operator” : “GROUP_OR”
  }
  }
  }, {
  “specifiedProject” : 1,
  “public” : true,
  “author” : 6,
  “name” : “name”,
  “id” : 0,
  “projectScope” : “ALL”,
  “filterQuery” : {
  “orderRules” : [ {
  “field” : {
  “display” : “display”,
  “name” : “name”,
  “id” : 5,
  “fieldDataType” : “INTEGER”
  },
  “direction” : “ASC”
  }, {
  “field” : {
  “display” : “display”,
  “name” : “name”,
  “id” : 5,
  “fieldDataType” : “INTEGER”
  },
  “direction” : “ASC”
  } ],
  “name” : “name”,
  “rule” : {
  “itemType” : 5,
  “field” : {
  “display” : “display”,
  “name” : “name”,
  “id” : 5,
  “fieldDataType” : “INTEGER”
  },
  “values” : [ “values”, “values” ],
  “rules” : [ null, null ],
  “operator” : “GROUP_OR”
  }
  }
  } ],
  “meta” : {
  “pageInfo” : {
  “startIndex” : 6,
  “resultCount” : 1,
  “totalResults” : 5
  },
  “status” : “OK”,
  “timestamp” : “2000-01-23T04:56:07.000+00:00”
  },
  “links” : {
  “key” : {
  “href” : “href”,
  “type” : “type”
  }
  },
  “linked” : {
  “key” : {
  “key” : “{}”
  }
  }
  }

Produces: API call produces the following media types according to the
Accept request header;
the media type will be conveyed by the Content-Type response header:

• application/json

Response:

FilterDataListWrapper

GET /users/{userId}

Summary: Get 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

Request headers:

• xJamaDateFieldsWithTime
  (optional) 

Query parameters:

• include
  (optional)
  Links to include as full objects in the linked map

Examples:

• Example data, content-type: application/json
  {
  “data” : {
  “lastName” : “lastName”,
  “avatarUrl” : “avatarUrl”,
  “active” : true,
  “customData” : [ {
  “name” : “name”,
  “value” : “value”
  }, {
  “name” : “name”,
  “value” : “value”
  } ],
  “title” : “title”,
  “firstName” : “firstName”,
  “licenseType” : “NAMED”,
  “uid” : “uid”,
  “phone” : “phone”,
  “location” : “location”,
  “id” : 0,
  “authenticationType” : {
  “name” : “name”,
  “id” : 6
  },
  “email” : “email”,
  “username” : “username”
  },
  “meta” : {
  “status” : “OK”,
  “timestamp” : “2000-01-23T04:56:07.000+00:00”
  },
  “links” : {
  “key” : {
  “href” : “href”,
  “type” : “type”
  }
  },
  “linked” : {
  “key” : {
  “key” : “{}”
  }
  }
  }

Produces: API call produces the following media types according to the
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

Consumes: this API call consumes the following media types via the
Content-Type request header:

• application/json

Request headers:

• xJamaDateFieldsWithTime
  (optional) 

Query parameters:

• project
  (optional) 
• username
  (optional) 
• email
  (optional) 
• firstName
  (optional) 
• lastName
  (optional) 
• licenseType
  (optional) 
• includeInactive
  (optional) 
• startAt
  (optional) 
• maxResults
  (optional)
  If not set, this defaults to 20. This cannot be larger than 50
• include
  (optional)
  Links to include as full objects in the linked map

Examples:

• Example data, content-type: application/json
  {
  “data” : [ {
  “lastName” : “lastName”,
  “avatarUrl” : “avatarUrl”,
  “active” : true,
  “customData” : [ {
  “name” : “name”,
  “value” : “value”
  }, {
  “name” : “name”,
  “value” : “value”
  } ],
  “title” : “title”,
  “firstName” : “firstName”,
  “licenseType” : “NAMED”,
  “uid” : “uid”,
  “phone” : “phone”,
  “location” : “location”,
  “id” : 0,
  “authenticationType” : {
  “name” : “name”,
  “id” : 6
  },
  “email” : “email”,
  “username” : “username”
  }, {
  “lastName” : “lastName”,
  “avatarUrl” : “avatarUrl”,
  “active” : true,
  “customData” : [ {
  “name” : “name”,
  “value” : “value”
  }, {
  “name” : “name”,
  “value” : “value”
  } ],
  “title” : “title”,
  “firstName” : “firstName”,
  “licenseType” : “NAMED”,
  “uid” : “uid”,
  “phone” : “phone”,
  “location” : “location”,
  “id” : 0,
  “authenticationType” : {
  “name” : “name”,
  “id” : 6
  },
  “email” : “email”,
  “username” : “username”
  } ],
  “meta” : {
  “pageInfo” : {
  “startIndex” : 6,
  “resultCount” : 1,
  “totalResults” : 5
  },
  “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:

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:

RequestUserExamples:

• Example data, content-type: application/json
  {
  “headers” : {
  “key” : [ “headers”, “headers” ]
  },
  “pageInfo” : {
  “startIndex” : 6,
  “resultCount” : 1,
  “totalResults” : 5
  },
  “statusReasonPhrase” : “statusReasonPhrase”,
  “status” : 0
  }

Produces: API call produces the following media types according to the
Accept request header;
the media type will be conveyed by the Content-Type response header:

• application/json

Response:

AbstractRestResponse

PUT /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:

RequestActiveStatusExamples:

• Example data, content-type: application/json
  {
  “headers” : {
  “key” : [ “headers”, “headers” ]
  },
  “pageInfo” : {
  “startIndex” : 6,
  “resultCount” : 1,
  “totalResults” : 5
  },
  “statusReasonPhrase” : “statusReasonPhrase”,
  “status” : 0
  }

Produces: API call produces the following media types according to the
Accept request header;
the media type will be conveyed by the Content-Type response header:

• application/json

Response:

AbstractRestResponse

PUT /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:

array[RequestUserCustomData]Examples:

• Example data, content-type: application/json
  {
  “headers” : {
  “key” : [ “headers”, “headers” ]
  },
  “pageInfo” : {
  “startIndex” : 6,
  “resultCount” : 1,
  “totalResults” : 5
  },
  “statusReasonPhrase” : “statusReasonPhrase”,
  “status” : 0
  }

Produces: API call produces the following media types according to the
Accept request header;
the media type will be conveyed by the Content-Type response header:

• application/json

Response:

AbstractRestResponse

Data Types

Data Type AbstractItem

Name	Required	Type	Notes
id	required	Integer
documentKey	required	String
globalId	required	String
project	required	Integer	ID of a project
itemType	required	Integer	ID of an item type
createdDate	required	Date
modifiedDate	required	Date
lastActivityDate	required	Date
createdBy	required	Integer	ID of a user
modifiedBy	required	Integer	ID of a user
baselinedAppliedCategorySnapshots	required	array[BaselinedAppliedCategorySnapshotInfo]	A list of baselined applied category snapshots
resources	required	map[String, AllowedResource]	A set of resources and allowed permissions
fields	required	map[String, Object]	A map of field names to field values e.g. {\”name\”:\”Sample Item\”, \”status\”: 292, \”release\”: 2, \”assigned\”: 23}

Data Type AbstractItemDataListWrapper

Name	Required	Type	Notes
data	required	array[AbstractItem]
links	required	map[String, Link]
linked	required	map[String, map[String, Object]]
meta	required	MetaListWrapper

Data Type AbstractItemDataWrapper

Name	Required	Type	Notes
data	required	AbstractItem
links	required	map[String, Link]
linked	required	map[String, map[String, Object]]
meta	required	MetaWrapper

Data Type AbstractRestResponse

Name	Required	Type	Notes
status	required	Integer
statusReasonPhrase	required	String
pageInfo	required	PageInfo
headers	required	map[String, array[String]]

Data Type AbstractVersionedItem

Name	Required	Type	Notes
version	required	Integer
id	required	Integer
currentVersion	required	Integer	Currently active version of the versioned item. If no version is active, currentVersion will not be returned.
type	required	String

Data Type AbstractVersionedItemDataWrapper

Name	Required	Type	Notes
data	required	AbstractVersionedItem
links	required	map[String, Link]
linked	required	map[String, map[String, Object]]
meta	required	MetaWrapper

Data Type Activity

Name	Required	Type	Notes
id	required	Integer
date	required	Date
details	required	String
action	required	String
user	required	Integer	ID of a user
userName	required	String
userComment	required	String
item	required	Integer	ID of an item
itemType	required	Integer	ID of an item type
eventType	required	String
objectType	required	String

Data Type ActivityDataListWrapper

Name	Required	Type	Notes
data	required	array[Activity]
links	required	map[String, Link]
linked	required	map[String, map[String, Object]]
meta	required	MetaListWrapper

Data Type ActivityDataWrapper

Name	Required	Type	Notes
data	required	Activity
links	required	map[String, Link]
linked	required	map[String, map[String, Object]]
meta	required	MetaWrapper

Data Type AllowedResource

Name	Required	Type	Notes
allowed	required	array[String]

Data Type Attachment

Name	Required	Type	Notes
lock	required	Lock
fileName	required	String
mimeType	required	String
fileSize	required	Integer
id	required	Integer
documentKey	required	String
globalId	required	String
project	required	Integer	ID of a project
itemType	required	Integer	ID of an item type
createdDate	required	Date
modifiedDate	required	Date
lastActivityDate	required	Date
createdBy	required	Integer	ID of a user
modifiedBy	required	Integer	ID of a user
baselinedAppliedCategorySnapshots	required	array[BaselinedAppliedCategorySnapshotInfo]	A list of baselined applied category snapshots
resources	required	map[String, AllowedResource]	A set of resources and allowed permissions
fields	required	map[String, Object]	A map of field names to field values e.g. {\”name\”:\”Sample Item\”, \”status\”: 292, \”release\”: 2, \”assigned\”: 23}

Data Type AttachmentDTO

Name	Required	Type	Notes
id	required	Integer
mimetype	required	String
fileName	required	String
fileSize	required	Integer
organizationId	required	Integer
description	required	String
projectId	required	Integer
attachmentTypeId	required	Integer
system	required	Boolean
diagramWidth	required	Integer
diagramHeight	required	Integer
diagramImageXml	required	String
diagramGraphXml	required	String
createdDate	required	Date
inputStream	required	InputStream
userFullName	required	String

Data Type AttachmentDataListWrapper

Name	Required	Type	Notes
data	required	array[Attachment]
links	required	map[String, Link]
linked	required	map[String, map[String, Object]]
meta	required	MetaListWrapper

Data Type AttachmentDataWrapper

Name	Required	Type	Notes
data	required	Attachment
links	required	map[String, Link]
linked	required	map[String, map[String, Object]]
meta	required	MetaWrapper

Data Type AuthenticationType

Name	Required	Type	Notes
id	required	Integer
name	required	String

Data Type AuthenticationTypeDTO

Name	Required	Type	Notes
id	required	Integer
name	required	String

Data Type BadRequestResponse

Name	Required	Type	Notes
status	required	Integer
statusReasonPhrase	required	String
pageInfo	required	PageInfo
headers	required	map[String, array[String]]
message	required	String
exception	required	Exception

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	ID of a user
project	required	Integer	ID of a project
origin	required	BaselineOrigin
sourceName	required	String	Name of the source that the baseline is part of
source	required	Integer	ID of the source that the baseline is part of
sourceKey	required	String	Key of the source that the baseline is part of
baselinePickListOption	required	Object	Info about baseline picklist option
signed	required	Boolean	Is true when the baseline has a signature
type	required	String

Data Type BaselineDataListWrapper

Name	Required	Type	Notes
data	required	array[Baseline]
links	required	map[String, Link]
linked	required	map[String, map[String, Object]]
meta	required	MetaListWrapper

Data Type BaselineDataWrapper

Name	Required	Type	Notes
data	required	Baseline
links	required	map[String, Link]
linked	required	map[String, map[String, Object]]
meta	required	MetaWrapper

Data Type BaselineItem

Name	Required	Type	Notes
version	required	Integer
currentVersion	required	Integer	Currently active version of the versioned item. If no version is active, currentVersion will not be returned.
baseline	required	Integer	ID of a baseline
baselineLocation	required	BaselineLocation
type	required	String
id	required	Integer
documentKey	required	String
globalId	required	String
project	required	Integer	ID of a project
itemType	required	Integer	ID of an item type
childItemType	required	Integer	ID of an item type
createdDate	required	Date
modifiedDate	required	Date
lastActivityDate	required	Date
createdBy	required	Integer	ID of a user
modifiedBy	required	Integer	ID of a user
baselinedAppliedCategorySnapshots	required	array[BaselinedAppliedCategorySnapshotInfo]	A list of baselined applied category snapshots
resources	required	map[String, AllowedResource]	A set of resources and allowed permissions
fields	required	map[String, Object]	A map of field names to field values e.g. {\”name\”:\”Sample Item\”, \”status\”: 292, \”release\”: 2, \”assigned\”: 23}

Data Type BaselineItemDataListWrapper

Name	Required	Type	Notes
data	required	array[BaselineItem]
links	required	map[String, Link]
linked	required	map[String, map[String, Object]]
meta	required	MetaListWrapper

Data Type BaselineItemDataWrapper

Name	Required	Type	Notes
data	required	BaselineItem
links	required	map[String, Link]
linked	required	map[String, map[String, Object]]
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	ID of a user
item	required	Integer	ID of an item
filter	required	Integer	ID of a filter
release	required	Integer	ID of a release
simplefilter	required	Integer	ID of a simplefilter
testCycle	required	Integer	ID of a test cycle
testPlan	required	Integer	ID of a test plan

Data Type BaselineParent

Name	Required	Type	Notes
item	required	array[Integer]	Item ID and version number for an item
project	required	Integer	ID of a project

Data Type BaselinedAppliedCategorySnapshotInfo

Name	Required	Type	Notes
categoryPathSequence	required	String
itemVersionNumberApplied	required	Integer

Data Type BodyPart

Name	Required	Type	Notes
contentDisposition	required	ContentDisposition
entity	required	Object
headers	required	map[String, array[String]]
mediaType	required	MediaType
messageBodyWorkers	required	MessageBodyWorkers
parent	required	MultiPart
providers	required	Providers
parameterizedHeaders	required	map[String, array[ParameterizedHeader]]

Data Type CategoryPathInfo

Name	Required	Type	Notes
categoryPathId	required	Integer
categoryPathName	required	String
pathIdsToRoot	required	array[String]
itemVersionIdApplied	required	Integer
itemVersionIdUnapplied	required	Integer
qtip	required	String

Data Type CategoryVisibilityUpdateRequest

Name	Required	Type	Notes
projectIds	required	array[Integer]
isGlobal	required	Boolean

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	ID of a comment
createdDate	required	Date
createdBy	required	Integer	ID of a user
modifiedBy	required	Integer	ID of a user
deleted	required	Boolean
status	required	String
body	required	CommentBody
commentType	required	String
location	required	CommentLocation

Data Type CommentBody

Name	Required	Type	Notes
text	required	String

Data Type CommentDataListWrapper

Name	Required	Type	Notes
data	required	array[Comment]
links	required	map[String, Link]
linked	required	map[String, map[String, Object]]
meta	required	MetaListWrapper

Data Type CommentDataWrapper

Name	Required	Type	Notes
data	required	Comment
links	required	map[String, Link]
linked	required	map[String, map[String, Object]]
meta	required	MetaWrapper

Data Type CommentLocation

Name	Required	Type	Notes
item	required	Integer	ID of an item
project	required	Integer	ID of a project

Data Type ConflictErrorResponse

Name	Required	Type	Notes
status	required	Integer
statusReasonPhrase	required	String
pageInfo	required	PageInfo
headers	required	map[String, array[String]]
message	required	String
exception	required	Exception

Data Type ContentDisposition

Name	Required	Type	Notes
type	required	String
parameters	required	map[String, String]
fileName	required	String
creationDate	required	Date
modificationDate	required	Date
readDate	required	Date
size	required	Long

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	map[String, array[String]]
location	required	String
id	required	Integer

Data Type CrossOriginDomainWhiteList

Name	Required	Type	Notes
domains	required	array[String]

Data Type DuplicateConfig

Name	Required	Type	Notes
includeTags	required	Boolean
includeAttachments	required	Boolean
includeLinks	required	Boolean

Data Type Exception

Name	Required	Type	Notes
cause	required	Throwable
stackTrace	required	array[StackTraceElement]
message	required	String
suppressed	required	array[Throwable]
localizedMessage	required	String

Data Type Filter

Name	Required	Type	Notes
id	required	Integer
name	required	String
author	required	Integer	ID of a user
projectScope	required	String
specifiedProject	required	Integer	ID of a project
filterQuery	required	FilterQuery
public	required	Boolean

Data Type FilterDataListWrapper

Name	Required	Type	Notes
data	required	array[Filter]
links	required	map[String, Link]
linked	required	map[String, map[String, Object]]
meta	required	MetaListWrapper

Data Type FilterDataWrapper

Name	Required	Type	Notes
data	required	Filter
links	required	map[String, Link]
linked	required	map[String, map[String, Object]]
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	array[FilterOrderRule]

Data Type FilterRule

Name	Required	Type	Notes
field	required	FilterField
operator	required	String
values	required	array[String]
itemType	required	Integer	ID of an item type
subQuery	required	FilterQuery
rules	required	array[FilterRule]

Data Type FormDataBodyPart

Name	Required	Type	Notes
contentDisposition	required	ContentDisposition
entity	required	Object
headers	required	map[String, array[String]]
mediaType	required	MediaType
messageBodyWorkers	required	MessageBodyWorkers
parent	required	MultiPart
providers	required	Providers
formDataContentDisposition	required	FormDataContentDisposition
name	required	String
value	required	String
simple	required	Boolean
parameterizedHeaders	required	map[String, array[ParameterizedHeader]]

Data Type FormDataContentDisposition

Name	Required	Type	Notes
type	required	String
parameters	required	map[String, String]
fileName	required	String
creationDate	required	Date
modificationDate	required	Date
readDate	required	Date
size	required	Long
name	required	String

Data Type FormDataMultiPart

Name	Required	Type	Notes
contentDisposition	required	ContentDisposition
entity	required	Object
headers	required	map[String, array[String]]
mediaType	required	MediaType
messageBodyWorkers	required	MessageBodyWorkers
parent	required	MultiPart
providers	required	Providers
bodyParts	required	array[BodyPart]
fields	required	map[String, array[FormDataBodyPart]]
parameterizedHeaders	required	map[String, array[ParameterizedHeader]]

Data Type InputStream

Name	Required	Type	Notes

Data Type Item

Name	Required	Type	Notes
id	required	Integer
documentKey	required	String
globalId	required	String
project	required	Integer	ID of a project
itemType	required	Integer	ID of an item type
childItemType	required	Integer	ID of an item type
createdDate	required	Date
modifiedDate	required	Date
lastActivityDate	required	Date
createdBy	required	Integer	ID of a user
modifiedBy	required	Integer	ID of a user
lock	required	Lock
location	required	Location
baselinedAppliedCategorySnapshots	required	array[BaselinedAppliedCategorySnapshotInfo]	A list of baselined applied category snapshots
resources	required	map[String, AllowedResource]	A set of resources and allowed permissions
fields	required	map[String, Object]	A map of field names to field values e.g. {\”name\”:\”Sample Item\”, \”status\”: 292, \”release\”: 2, \”assigned\”: 23}

Data Type ItemCategoryDataListWrapper

Name	Required	Type	Notes
data	required	array[CategoryPathInfo]
links	required	map[String, Link]
linked	required	map[String, map[String, Object]]
meta	required	MetaListWrapper

Data Type ItemDataListWrapper

Name	Required	Type	Notes
data	required	array[Item]
links	required	map[String, Link]
linked	required	map[String, map[String, Object]]
meta	required	MetaListWrapper

Data Type ItemDataWrapper

Name	Required	Type	Notes
data	required	Item
links	required	map[String, Link]
linked	required	map[String, map[String, Object]]
meta	required	MetaWrapper

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	array[ItemTypeWidget]
fields	required	array[ItemTypeField]
system	required	Boolean

Data Type ItemTypeDataListWrapper

Name	Required	Type	Notes
data	required	array[ItemType]
links	required	map[String, Link]
linked	required	map[String, map[String, Object]]
meta	required	MetaListWrapper

Data Type ItemTypeDataWrapper

Name	Required	Type	Notes
data	required	ItemType
links	required	map[String, Link]
linked	required	map[String, map[String, Object]]
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	ID of a pick list
textType	required	String
itemType	required	Integer	ID of an item type
infotip	required	String
controlStyle	required	String

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	array[Link]
links	required	map[String, Link]
linked	required	map[String, map[String, Object]]
meta	required	MetaListWrapper

Data Type LinkDataWrapper

Name	Required	Type	Notes
data	required	Link
links	required	map[String, Link]
linked	required	map[String, map[String, Object]]
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[String, Link]
linked	required	map[String, map[String, Object]]
meta	required	MetaWrapper

Data Type Lock

Name	Required	Type	Notes
locked	required	Boolean
lastLockedDate	required	Date
lockedBy	required	Integer	ID of a user

Data Type LockDataWrapper

Name	Required	Type	Notes
data	required	Lock
links	required	map[String, Link]
linked	required	map[String, map[String, Object]]
meta	required	MetaWrapper

Data Type MediaType

Name	Required	Type	Notes
type	required	String
subtype	required	String
parameters	required	map[String, String]
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	map[String, array[String]]
mediaType	required	MediaType
messageBodyWorkers	required	MessageBodyWorkers
parent	required	MultiPart
providers	required	Providers
bodyParts	required	array[BodyPart]
parameterizedHeaders	required	map[String, array[ParameterizedHeader]]

Data Type ObjectResponse

Name	Required	Type	Notes
status	required	Integer
statusReasonPhrase	required	String
pageInfo	required	PageInfo
headers	required	map[String, array[String]]
linked	required	map[String, map[String, Object]]
type	required	String
payload	required	Object

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[String, String]

Data Type Parent

Name	Required	Type	Notes
project	required	Integer	ID of a project
item	required	Integer	ID of an item

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	array[PickList]
links	required	map[String, Link]
linked	required	map[String, map[String, Object]]
meta	required	MetaListWrapper

Data Type PickListDataWrapper

Name	Required	Type	Notes
data	required	PickList
links	required	map[String, Link]
linked	required	map[String, map[String, Object]]
meta	required	MetaWrapper

Data Type PickListOption

Name	Required	Type	Notes
pickList	required	Integer	ID of a pick list
id	required	Integer
name	required	String
description	required	String
value	required	String
default	required	Boolean
active	required	Boolean
archived	required	Boolean
color	required	String
sortOrder	required	Integer
infotip	required	String

Data Type PickListOptionDataListWrapper

Name	Required	Type	Notes
data	required	array[PickListOption]
links	required	map[String, Link]
linked	required	map[String, map[String, Object]]
meta	required	MetaListWrapper

Data Type PickListOptionDataWrapper

Name	Required	Type	Notes
data	required	PickListOption
links	required	map[String, Link]
linked	required	map[String, map[String, Object]]
meta	required	MetaWrapper

Data Type Project

Name	Required	Type	Notes
id	required	Integer
projectKey	required	String
parent	required	Integer	ID of a project
isFolder	required	Boolean
createdDate	required	Date
modifiedDate	required	Date
createdBy	required	Integer	ID of a user
modifiedBy	required	Integer	ID of a user
fields	required	map[String, Object]

Data Type ProjectDataListWrapper

Name	Required	Type	Notes
data	required	array[Project]
links	required	map[String, Link]
linked	required	map[String, map[String, Object]]
meta	required	MetaListWrapper

Data Type ProjectDataWrapper

Name	Required	Type	Notes
data	required	Project
links	required	map[String, Link]
linked	required	map[String, map[String, Object]]
meta	required	MetaWrapper

Data Type ProjectPropertyDTO

Name	Required	Type	Notes
id	required	Integer
projectKey	required	String
name	required	String
string1	required	String
mask	required	Integer
organizationId	required	Integer
active	required	Boolean
modifiedDate	required	Date
modifiedBy	required	UserInfoDTO

Data Type Providers

Name	Required	Type	Notes

Data Type Relationship

Name	Required	Type	Notes
id	required	Integer
fromItem	required	Integer	ID of an item
toItem	required	Integer	ID of an item
relationshipType	required	Integer	ID of a relationship type
suspect	required	Boolean

Data Type RelationshipDataListWrapper

Name	Required	Type	Notes
data	required	array[Relationship]
links	required	map[String, Link]
linked	required	map[String, map[String, Object]]
meta	required	MetaListWrapper

Data Type RelationshipDataWrapper

Name	Required	Type	Notes
data	required	Relationship
links	required	map[String, Link]
linked	required	map[String, map[String, Object]]
meta	required	MetaWrapper

Data Type RelationshipRuleDTO

Name	Required	Type	Notes
id	required	Integer
fromItemTypeId	required	Integer
toItemTypeId	required	Integer
forCoverage	required	Boolean
relationshipTypeId	required	Integer

Data Type RelationshipRuleSetDTO

Name	Required	Type	Notes
id	required	Integer
name	required	String
isExclusive	required	Boolean
mappedProjects	required	array[ProjectPropertyDTO]
rules	required	array[RelationshipRuleDTO]

Data Type RelationshipType

Name	Required	Type	Notes
id	required	Integer
name	required	String
isDefault	required	Boolean

Data Type RelationshipTypeDataListWrapper

Name	Required	Type	Notes
data	required	array[RelationshipType]
links	required	map[String, Link]
linked	required	map[String, map[String, Object]]
meta	required	MetaListWrapper

Data Type RelationshipTypeDataWrapper

Name	Required	Type	Notes
data	required	RelationshipType
links	required	map[String, Link]
linked	required	map[String, map[String, Object]]
meta	required	MetaWrapper

Data Type Release

Name	Required	Type	Notes
id	required	Integer
name	required	String
description	required	String
project	required	Integer	ID of a project
releaseDate	required	Date
active	required	Boolean
archived	required	Boolean
itemCount	required	Integer

Data Type ReleaseDataListWrapper

Name	Required	Type	Notes
data	required	array[Release]
links	required	map[String, Link]
linked	required	map[String, map[String, Object]]
meta	required	MetaListWrapper

Data Type ReleaseDataWrapper

Name	Required	Type	Notes
data	required	Release
links	required	map[String, Link]
linked	required	map[String, map[String, Object]]
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[String, Object]	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 RequestCategoryPaths

Name	Required	Type	Notes
categoryPathIds	required	array[Integer]

Data Type RequestComment

Name	Required	Type	Notes
inReplyTo	required	Integer	ID of a comment
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 RequestGroupUser

Name	Required	Type	Notes
user	required	Integer

Data Type RequestItem

Name	Required	Type	Notes
globalId	required	String	Must use override if you want to set this value on POST.
project	required	Integer	Only required when creating a new item (POST).
itemType	required	Integer	ID of an item type
childItemType	required	Integer	ID of an item type
location	required	RequestLocation
fields	required	map[String, Object]	A map of field names to field values e.g. {\”name\”:\”Sample Item\”, \”status\”: 292, \”release\”: 2, \”assigned\”: 23}

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	array[RequestItemTypeWidget]

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	array[Integer]	The list of IDs of the items to modify
operations	required	array[RequestPatchOperation]	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	This can point to either a project or a parent item at which this item is located, not both.

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 value 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[String, Object]	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
project	required	Integer

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[String, Object]	A map of field names to field values e.g. {\”name\”:\”Sample Item\”, \”startDate\”: \”2015-01-01\”, \”endDate\”: \”2015-01-15\”} Note: RequestTestCycle requires name, startDate, and endDate. startDate and endDate are formatted with ‘yyyy-mm-dd’
testRunGenerationConfig	required	TestRunGenerationConfig	Settings for how test runs will be generated in this test cycle

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
project	required	Integer	Only required when creating a new test plan (POST).
fields	required	map[String, Object]	A map of field names to field values e.g. {\”name\”:\”Sample Item\”, \”status\”: 292, \”release\”: 2, \”assigned\”: 23}

Data Type RequestTestRun

Name	Required	Type	Notes
fields	required	map[String, Object]	A map of field names to field values e.g. {\”name\”:\”Sample Item\”, \”status\”: 292, \”release\”: 2, \”assigned\”: 23}

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)
email	required	String	Required when creating a new user (POST). Optional on update (PUT)
phone	required	String
title	required	String
location	required	String
licenseType	required	String	Required when creating a new user (POST). Optional on update (PUT)
authenticationType	required	AuthenticationType	Required when creating a new or update user (POST or PUT), when the authentication mode is Basic+IdP
customData	required	array[RequestUserCustomData]

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 StackTraceElement

Name	Required	Type	Notes
classLoaderName	required	String
moduleName	required	String
moduleVersion	required	String
methodName	required	String
fileName	required	String
lineNumber	required	Integer
className	required	String
nativeMethod	required	Boolean

Data Type SyncStatus

Name	Required	Type	Notes
inSync	required	Boolean
collectionSummary	required	CollectionSummary

Data Type SyncStatusDataWrapper

Name	Required	Type	Notes
data	required	SyncStatus
links	required	map[String, Link]
linked	required	map[String, map[String, Object]]
meta	required	MetaWrapper

Data Type Tag

Name	Required	Type	Notes
id	required	Integer
name	required	String
project	required	Integer	ID of a project

Data Type TagDataListWrapper

Name	Required	Type	Notes
data	required	array[Tag]
links	required	map[String, Link]
linked	required	map[String, map[String, Object]]
meta	required	MetaListWrapper

Data Type TagDataWrapper

Name	Required	Type	Notes
data	required	Tag
links	required	map[String, Link]
linked	required	map[String, map[String, Object]]
meta	required	MetaWrapper

Data Type TestCycle

Name	Required	Type	Notes
id	required	Integer
documentKey	required	String
globalId	required	String
project	required	Integer	ID of a project
itemType	required	Integer	ID of an item type
createdDate	required	Date
modifiedDate	required	Date
lastActivityDate	required	Date
createdBy	required	Integer	ID of a user
modifiedBy	required	Integer	ID of a user
baselinedAppliedCategorySnapshots	required	array[BaselinedAppliedCategorySnapshotInfo]	A list of baselined applied category snapshots
resources	required	map[String, AllowedResource]	A set of resources and allowed permissions
fields	required	map[String, Object]	A map of field names to field values e.g. {\”name\”:\”Sample Item\”, \”status\”: 292, \”release\”: 2, \”assigned\”: 23}

Data Type TestCycleDataListWrapper

Name	Required	Type	Notes
data	required	array[TestCycle]
links	required	map[String, Link]
linked	required	map[String, map[String, Object]]
meta	required	MetaListWrapper

Data Type TestCycleDataWrapper

Name	Required	Type	Notes
data	required	TestCycle
links	required	map[String, Link]
linked	required	map[String, map[String, Object]]
meta	required	MetaWrapper

Data Type TestCycleTestGroup

Name	Required	Type	Notes
testGroup	required	Integer
name	required	String
assignedTo	required	Integer	ID of a user
testCycle	required	Integer
type	required	String

Data Type TestCycleTestGroupDataWrapper

Name	Required	Type	Notes
data	required	TestCycleTestGroup
links	required	map[String, Link]
linked	required	map[String, map[String, Object]]
meta	required	MetaWrapper

Data Type TestGroup

Name	Required	Type	Notes
id	required	Integer
name	required	String
assignedTo	required	Integer	ID of a user

Data Type TestGroupDataListWrapper

Name	Required	Type	Notes
data	required	array[TestGroup]
links	required	map[String, Link]
linked	required	map[String, map[String, Object]]
meta	required	MetaListWrapper

Data Type TestGroupDataWrapper

Name	Required	Type	Notes
data	required	TestGroup
links	required	map[String, Link]
linked	required	map[String, map[String, Object]]
meta	required	MetaWrapper

Data Type TestPlan

Name	Required	Type	Notes
id	required	Integer
documentKey	required	String
globalId	required	String
project	required	Integer	ID of a project
itemType	required	Integer	ID of an item type
createdDate	required	Date
modifiedDate	required	Date
lastActivityDate	required	Date
createdBy	required	Integer	ID of a user
modifiedBy	required	Integer	ID of a user
baselinedAppliedCategorySnapshots	required	array[BaselinedAppliedCategorySnapshotInfo]	A list of baselined applied category snapshots
resources	required	map[String, AllowedResource]	A set of resources and allowed permissions
fields	required	map[String, Object]	A map of field names to field values e.g. {\”name\”:\”Sample Item\”, \”status\”: 292, \”release\”: 2, \”assigned\”: 23}
archived	required	Boolean

Data Type TestPlanDataListWrapper

Name	Required	Type	Notes
data	required	array[TestPlan]
links	required	map[String, Link]
linked	required	map[String, map[String, Object]]
meta	required	MetaListWrapper

Data Type TestPlanDataWrapper

Name	Required	Type	Notes
data	required	TestPlan
links	required	map[String, Link]
linked	required	map[String, map[String, Object]]
meta	required	MetaWrapper

Data Type TestRun

Name	Required	Type	Notes
id	required	Integer
documentKey	required	String
globalId	required	String
project	required	Integer	ID of a project
itemType	required	Integer	ID of an item type
createdDate	required	Date
modifiedDate	required	Date
lastActivityDate	required	Date
createdBy	required	Integer	ID of a user
modifiedBy	required	Integer	ID of a user
testCaseVersionNumber	required	Integer	The version of the test case at the time of test run creation
sortOrderFromTestGroup	required	Integer	The sort order within the test group at the time of test cycle creation
testGroup	required	array[Integer]	ID of a test cycle and ID of a test group
baselinedAppliedCategorySnapshots	required	array[BaselinedAppliedCategorySnapshotInfo]	A list of baselined applied category snapshots
resources	required	map[String, AllowedResource]	A set of resources and allowed permissions
fields	required	map[String, Object]	A map of field names to field values e.g. {\”name\”:\”Sample Item\”, \”status\”: 292, \”release\”: 2, \”assigned\”: 23}

Data Type TestRunDataListWrapper

Name	Required	Type	Notes
data	required	array[TestRun]
links	required	map[String, Link]
linked	required	map[String, map[String, Object]]
meta	required	MetaListWrapper

Data Type TestRunDataWrapper

Name	Required	Type	Notes
data	required	TestRun
links	required	map[String, Link]
linked	required	map[String, map[String, Object]]
meta	required	MetaWrapper

Data Type TestRunGenerationConfig

Name	Required	Type	Notes
testGroupsToInclude	required	array[Integer]	The Test Group IDs of the Test Groups from which you would like to generate Test Runs. Do not specify anything to include all groups.
testRunStatusesToInclude	required	array[String]	Only valid after generating the first Test Cycle, you may choose to only generate Test Runs that were a specified status in the previous cycle. Do not specify anything to include all statuses

Data Type Throwable

Name	Required	Type	Notes
cause	required	Throwable
stackTrace	required	array[StackTraceElement]
message	required	String
suppressed	required	array[Throwable]
localizedMessage	required	String

Data Type TreeLocationRequest

Name	Required	Type	Notes
itemIds	required	array[Integer]
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
email	required	String
phone	required	String
title	required	String
location	required	String
licenseType	required	String
avatarUrl	required	String
active	required	Boolean
authenticationType	required	AuthenticationType
uid	required	String
customData	required	array[UserCustomData]

Data Type UserCustomData

Name	Required	Type	Notes
name	required	String
value	required	String

Data Type UserCustomDataDTO

Name	Required	Type	Notes
name	required	String
value	required	String

Data Type UserCustomDataDataListWrapper

Name	Required	Type	Notes
data	required	array[UserCustomData]
links	required	map[String, Link]
linked	required	map[String, map[String, Object]]
meta	required	MetaListWrapper

Data Type UserDataListWrapper

Name	Required	Type	Notes
data	required	array[User]
links	required	map[String, Link]
linked	required	map[String, map[String, Object]]
meta	required	MetaListWrapper

Data Type UserDataWrapper

Name	Required	Type	Notes
data	required	User
links	required	map[String, Link]
linked	required	map[String, map[String, Object]]
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	ID of a project

Data Type UserGroupDataListWrapper

Name	Required	Type	Notes
data	required	array[UserGroup]
links	required	map[String, Link]
linked	required	map[String, map[String, Object]]
meta	required	MetaListWrapper

Data Type UserGroupDataWrapper

Name	Required	Type	Notes
data	required	UserGroup
links	required	map[String, Link]
linked	required	map[String, map[String, Object]]
meta	required	MetaWrapper

Data Type UserInfoDTO

Name	Required	Type	Notes
id	required	Integer
uid	required	String
userName	required	String
firstName	required	String
lastName	required	String
userDn	required	String
email	required	String
phone	required	String
fullName	required	String
displayName	required	String
authProviderId	required	Integer
system	required	Boolean
avatar	required	AttachmentDTO
avatarUrl	required	String
licenseType	required	String
userLogins	required	Integer
title	required	String
notes	required	String
location	required	String
roleNames	required	array[String]
roleIds	required	array[Integer]
disabled	required	Boolean
emailUpdatesToFollowedItems	required	Boolean
autoFollowCommentedItems	required	Boolean
unregistered	required	Boolean
orgId	required	Integer
subscriptionJobName	required	String
subscriptionIsMuted	required	Boolean
createdDate	required	Date
authenticationType	required	AuthenticationTypeDTO
customData	required	array[UserCustomDataDTO]
name	required	String
projectAdmin	required	Boolean

Data Type Version

Name	Required	Type	Notes
versionedItem	required	array[Integer]	Item ID and version number for a versioned item
type	required	String
item	required	Integer	ID of an item
versionNumber	required	Integer
changeDetails	required	String
comment	required	String
createdDate	required	Date
createdBy	required	Integer	ID of a user
userName	required	String

Data Type VersionDataListWrapper

Name	Required	Type	Notes
data	required	array[Version]
links	required	map[String, Link]
linked	required	map[String, map[String, Object]]
meta	required	MetaListWrapper

Data Type VersionDataWrapper

Name	Required	Type	Notes
data	required	Version
links	required	map[String, Link]
linked	required	map[String, map[String, Object]]
meta	required	MetaWrapper

Data Type VersionedAttachment

Name	Required	Type	Notes
lock	required	Lock
fileName	required	String
mimeType	required	String
fileSize	required	Integer
version	required	Integer
currentVersion	required	Integer	Currently active version of the versioned item. If no version is active, currentVersion will not be returned.
id	required	Integer
documentKey	required	String
globalId	required	String
project	required	Integer	ID of a project
itemType	required	Integer	ID of an item type
createdDate	required	Date
modifiedDate	required	Date
lastActivityDate	required	Date
createdBy	required	Integer	ID of a user
modifiedBy	required	Integer	ID of a user
baselinedAppliedCategorySnapshots	required	array[BaselinedAppliedCategorySnapshotInfo]	A list of baselined applied category snapshots
resources	required	map[String, AllowedResource]	A set of resources and allowed permissions
fields	required	map[String, Object]	A map of field names to field values e.g. {\”name\”:\”Sample Item\”, \”status\”: 292, \”release\”: 2, \”assigned\”: 23}

Data Type VersionedAttachmentDataWrapper

Name	Required	Type	Notes
data	required	VersionedAttachment
links	required	map[String, Link]
linked	required	map[String, map[String, Object]]
meta	required	MetaWrapper

Data Type VersionedItem

Name	Required	Type	Notes
version	required	Integer
currentVersion	required	Integer	Currently active version of the versioned item. If no version is active, currentVersion will not be returned.
id	required	Integer
documentKey	required	String
globalId	required	String
project	required	Integer	ID of a project
itemType	required	Integer	ID of an item type
childItemType	required	Integer	ID of an item type
createdDate	required	Date
modifiedDate	required	Date
lastActivityDate	required	Date
createdBy	required	Integer	ID of a user
modifiedBy	required	Integer	ID of a user
baselinedAppliedCategorySnapshots	required	array[BaselinedAppliedCategorySnapshotInfo]	A list of baselined applied category snapshots
resources	required	map[String, AllowedResource]	A set of resources and allowed permissions
fields	required	map[String, Object]	A map of field names to field values e.g. {\”name\”:\”Sample Item\”, \”status\”: 292, \”release\”: 2, \”assigned\”: 23}

Data Type VersionedItemDataWrapper

Name	Required	Type	Notes
data	required	VersionedItem
links	required	map[String, Link]
linked	required	map[String, map[String, Object]]
meta	required	MetaWrapper

Data Type VersionedRelationship

Name	Required	Type	Notes
id	required	Integer
fromItem	required	array[Integer]	ID of a version
toItem	required	array[Integer]	ID of a version
suspect	required	Boolean
relationshipType	required	array[Object]	ID of a relationship type

Data Type VersionedRelationshipDataListWrapper

Name	Required	Type	Notes
data	required	array[VersionedRelationship]
links	required	map[String, Link]
linked	required	map[String, map[String, Object]]
meta	required	MetaListWrapper

Data Type VersionedTestCycle

Name	Required	Type	Notes
version	required	Integer
currentVersion	required	Integer	Currently active version of the versioned item. If no version is active, currentVersion will not be returned.
id	required	Integer
documentKey	required	String
globalId	required	String
project	required	Integer	ID of a project
itemType	required	Integer	ID of an item type
createdDate	required	Date
modifiedDate	required	Date
lastActivityDate	required	Date
createdBy	required	Integer	ID of a user
modifiedBy	required	Integer	ID of a user
baselinedAppliedCategorySnapshots	required	array[BaselinedAppliedCategorySnapshotInfo]	A list of baselined applied category snapshots
resources	required	map[String, AllowedResource]	A set of resources and allowed permissions
fields	required	map[String, Object]	A map of field names to field values e.g. {\”name\”:\”Sample Item\”, \”status\”: 292, \”release\”: 2, \”assigned\”: 23}

Data Type VersionedTestCycleDataWrapper

Name	Required	Type	Notes
data	required	VersionedTestCycle
links	required	map[String, Link]
linked	required	map[String, map[String, Object]]
meta	required	MetaWrapper

Data Type VersionedTestPlan

Name	Required	Type	Notes
version	required	Integer
currentVersion	required	Integer	Currently active version of the versioned item. If no version is active, currentVersion will not be returned.
id	required	Integer
documentKey	required	String
globalId	required	String
project	required	Integer	ID of a project
itemType	required	Integer	ID of an item type
createdDate	required	Date
modifiedDate	required	Date
lastActivityDate	required	Date
createdBy	required	Integer	ID of a user
modifiedBy	required	Integer	ID of a user
baselinedAppliedCategorySnapshots	required	array[BaselinedAppliedCategorySnapshotInfo]	A list of baselined applied category snapshots
resources	required	map[String, AllowedResource]	A set of resources and allowed permissions
fields	required	map[String, Object]	A map of field names to field values e.g. {\”name\”:\”Sample Item\”, \”status\”: 292, \”release\”: 2, \”assigned\”: 23}
archived	required	Boolean

Data Type VersionedTestPlanDataWrapper

Name	Required	Type	Notes
data	required	VersionedTestPlan
links	required	map[String, Link]
linked	required	map[String, map[String, Object]]
meta	required	MetaWrapper

Data Type VersionedTestRun

Name	Required	Type	Notes
version	required	Integer
currentVersion	required	Integer	Currently active version of the versioned item. If no version is active, currentVersion will not be returned.
id	required	Integer
documentKey	required	String
globalId	required	String
project	required	Integer	ID of a project
itemType	required	Integer	ID of an item type
createdDate	required	Date
modifiedDate	required	Date
lastActivityDate	required	Date
createdBy	required	Integer	ID of a user
modifiedBy	required	Integer	ID of a user
testCaseVersionNumber	required	Integer	The version of the test case at the time of test run creation
sortOrderFromTestGroup	required	Integer	The sort order within the test group at the time of test cycle creation
testGroup	required	array[Integer]	ID of a test cycle and ID of a test group
baselinedAppliedCategorySnapshots	required	array[BaselinedAppliedCategorySnapshotInfo]	A list of baselined applied category snapshots
resources	required	map[String, AllowedResource]	A set of resources and allowed permissions
fields	required	map[String, Object]	A map of field names to field values e.g. {\”name\”:\”Sample Item\”, \”status\”: 292, \”release\”: 2, \”assigned\”: 23}

Data Type VersionedTestRunDataWrapper

Name	Required	Type	Notes
data	required	VersionedTestRun
links	required	map[String, Link]
linked	required	map[String, map[String, Object]]
meta	required	MetaWrapper

Data Type WorkStatus

Name	Required	Type	Notes
workKey	required	String
jobName	required	String
inProgress	required	Boolean
isFailed	required	Boolean
workSteps	required	array[WorkStepStatus]
returnValue	required	String

Data Type WorkStatusDataWrapper

Name	Required	Type	Notes
data	required	WorkStatus
links	required	map[String, Link]
linked	required	map[String, map[String, Object]]
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	ID of a pick list option

Data Type WorkflowTransitionDataListWrapper

Name	Required	Type	Notes
data	required	array[WorkflowTransition]
links	required	map[String, Link]
linked	required	map[String, map[String, Object]]
meta	required	MetaListWrapper