Schema¶
All API endpoints return the below types, or lists of the below types. Additionally, the fields shown in this schema are all queryable using the search API.
Problem
identifier
[integer] – The problem’s user visible identifiertitle
[string]creationDate
[date]modificationDate
[date]resolveDate
[date] – Most recent date that the problem state transitioned to a resolved state.originator
[User] – The person who created the problemassignee
[User]modifier
[User] – Most recent person to modify the problemresolver
[User] – If the problem’s state is resolved, this is the person who did it.component
[Component]milestone
[Milestone]priority
[Priority]classification
[Classification]state
[State]watching
[boolean] – Api token user is watching the problemread
[boolean] – Api token user has read the problemreadByAssignee
[boolean]history
[Array of Problem] – Previous savepoints of this problem (not returned as json output but searchable)logs
[Array of Log] – Full problem modification log (only returned via the single problem load endpoint)
User
identifier
[uuid] – Unique identifier referring to this user.name
[string]
Component
identifier
[uuid]fullName
[string]name
[string]closed
[boolean]successor
[Component] – If closed, successor points to the follow-on component
Milestone
identifier
[uuid]component
[Component] – Associated component (may be null)name
[string]creationDate
[date]startDate
[date]endDate
[date]
Priority
identifier
[uuid]name
[string]order
[integer]
Classification
identifier
[uuid]name
[uuid]
State
identifier
[uuid]name
[uuid]resolved
[boolean]initial
[boolean]order
[integer]nextStates
[Array of States] – Valid transitions
Log
identifier
[uuid]type
[string] – Type of log entrycreationDate
[date] – Timestamp of log entryauthor
[User] – Author of log entrybatchIdentifier
[uuid] – Grouping of log entries. A single save of the problem but with multiple edits groups the log entries by this identifier.isSignificant
[boolean] – Whether or not the log entry affects the modifier and modification date of the problem (e.g. adding a user to the watchers list incurs a log entry, but doesn’t change the modifier or modification date)....
– Additional attributes exist and are specific to each type of log entry.
Comment
identifier
[uuid]html
[string] – HTML log contenttext
[string] – Plain text log contentrtf
[string] – RTF log contentauthor
[User] – Author of the commentcreationDate
[date] – Date comment addedfileAttachments
[array]identifier
[uuid]mimeType
[string]filename
[string]fileSize
[int]created
[date]lastModified
[date]md5
[string]width
[int] – Present if the attachment is a media attachmentheight
[int] – Present if the attachment is a media attachment
previousVersion
[Comment] – If the comment has been edited, this contains the previous version of the comment.