comments-list-minimal

comments

comment-get-minimal

Comments List (Prefer return=minimal)

String that uniquely identifies this comment.

string

text

Display name (i.e., given name and surname) of the user who posted this comment. (If the comment was posted using this API, it is inferred to be the authorized user making the request.)

authorDisplayName

createdDateTime

date-time

Will only be set if the comment is a workflow transition note. This is the name of the status the issue was in before the transition.

workflowNoteFrom

Will only be set if the comment is a workflow transition note. This is the name of the status the issue is in after the transition.

workflowNoteTo

A URL that can be used to retrieve more information about the comment author.

_links.author.href

Comment (get, Prefer return=minimal)

comments-list-representation

comment-get-representation

Comments List (Prefer return=representation)

Email address of the user who wrote this comment.

authorEmail

Comment (get, Prefer return=representation)

comment-create

The text of the comment. If this includes a project member's email address preceeded by an @ sign, like `@john.doe@example.com`, then that user will receive an email notification.

Comment (create)

attachment-metadata-list

attachments

attachment-metadata-get

Attachment Metadata List

Read-only. String that uniquely identifies this attachment and can be used in the `Get attachment file by ID` request to download the file.

fileName

Read-only. File extension of the uploaded file. Derived from fileName.

type

Descriptive string provided by a user for this attachment, if any.

caption

Date and time the attachment was uploaded. Read-only; auto-set when attachment is created.

Size of the file in bytes. Read-only; auto-set when attachment is uploaded.

size

integer

If the attachment was uploaded from an Image Drop control, this is the property name the control is bound to. Otherwise, null.

binding

Attachment Metadata (get)

attachment-metadata-create

The file's filename. This will determine the MIME type of the file when requested.

A string describing the significance of this attachment.

If this attachment is being created from an Image Drop control, this associates the attachment with that control.

Attachment Metadata (create)

audit-trail

auditTrailEntries

audit-trail-entry-get

Audit Trail

The type of change that was made to the issue.  Possible values: 'Created', 'Modified', 'Assigned', 'Status', 'Closed', 'Opened', 'Draft', 'Deleted', 'Undeleted', 'File Attached', 'File Removed', 'Form Raised'

audit-trail-entry-get-action

Created

Modified

Assigned

Status

Closed

Opened

Draft

Deleted

Undeleted

File Attached

File Removed

Form Raised

Audit Trail Entry (get) action

Information about a single occurrence of a change to this issue.

String that uniquely identifies this entry.

The display name (i.e., given name and surname) of the user who made this change.

changeBy

The GUID of the user who made this change.

changeById

changeDateTime

The individual property modifications that were made in this changeset.

changes

A string representation of the changed property's new value, if any.

A string representation of the changed property's previous value, if any.

object

Audit Trail Entry (get)

form-definition-list

formDefinitions

form-definition-summary

Form Definition List

The name of this form definition as it is displayed to users in the Form Manager UI and Issues webapp UI.

displayName

The issue type that can be created from this form definition.

Form Definition Summary

workflow-response-get

workflow

workflow-get

Workflow Response (get)

The names of all the states that can be chosen for a newly-created issue's `status` property.

startStates

A list of possible workflow states, i.e. possible values of the `status` issue property.

states

workflow-state

A list of valid workflow transitions. The `status` property of an issue can only be changed if there is a transition, accessible to the current user, whose `start` property matches the current value of the `status` property of the issue, and whose `end` property matches the new `status` value.

transitions

workflow-transition

Transitions that govern setting the `status` property of a brand-new issue. These will each have a null value for `start` and a starting state name for `end`. Clients should not depend on this array existing or including a transition for every start state, but should still allow the user to select any start state when creating a new issue.

startingTransitions

starting-transition

Workflow state representing the status of a new issue, before it has been saved. This mainly just determines (through the `editableProperties` array) which properties can be set on the issue's initial save. Even though this state's `name` property may be null, the issue's `status` property will have to be set to a valid, non-null value that matches one of the start state names.

uninitializedState

uninitialized-state

Workflow (get)

Classifies this state as a 'Closed', 'Open', or 'Draft' state. While the issue is in this state, its `state` property will automatically be set to this string.

workflow-state-stateCategory

Open

Workflow State stateCategory

The name of this state. This is used both for display purposes and to uniquely identify this state within the workflow. If an issue has a workflow, its `status` property must match a state's `name` property.

name

A hexadecimal RGB color string, e.g. '#ff0000'. This provides a hint to clients on how to highlight issues based on their current `status` property. Not all clients use, or are required to use, this property, and it may be null.

color

The names of properties that can be edited while the workflow is in this state.

editableProperties

Workflow State

Denotes whether the transition allows or requires a workflow note to be set when it is triggered (`workflowNote` property on `Issue Update` object). Possible values: 'None', 'Optional', 'Required'.

workflow-transition-notes

None

Optional

Required

Workflow Transition notes

The name of this transition, i.e. the text that should appear on the UI element that triggers this transition.

The name of the workflow state where this transition begins.

start

The name of the workflow state where this transition ends.

Workflow Transition

The names of properties that can be edited while the workflow is in this state (i.e., when it is newly created and it has not yet been saved). A null value means there are no restrictions.

Uninitialized State

starting-transition-notes

Starting Transition notes

Starting Transition

form-definition-details-response

formDefinition

form-definition-details

Form Definition Details Response

The form definition's availability. This can be set by a project administrator. Only forms set to Approved can be used to create issues. Possible values: 'Draft', 'Approved', 'Archived'.

form-definition-details-status

Approved

Archived

Form Definition Details status

String describing whether the form definition has problems that could prevent it from displaying (Warning) or functioning (Error or Critical) correctly. Possible values: 'None', 'Warning', 'Error', 'Critical', 'Unknown'.

form-definition-details-errorStatus

Warning

Error

Critical

Unknown

Form Definition Details errorStatus

Unique identifier for this form definition. Can be set as the formId property in the 'Create issue' request body.

The name of this form definition as it should be displayed to users if they are choosing which form definition to use for a new issue.

Determines which issue type will be created when this form definition is used.

A JSON string defining this form's layout, including all of its controls and their bindings, locations, and styles. As of now third-party applications are not expected to use this property. An automated custom form renderer that works with this REST API is reserved for future development.

definition

Form Definition Details

static-image-response

_links

static-image-link

Static Image Response

list-group-response

listGroup

list-group

List Group Response

The unique ID of this list group. Will be the same as the list group ID in the URL.

The names of the lists defined by this list group, from outermost (first) to innermost (last).

lists

A recursive data structure defining the options available in these lists. Its properties can have any name. For each property in the outermost object, its key should be used as the name of an option in the first list, and its value is an object whose keys correspond to the options that become available in the second list when that particular first-list option is chosen, and so forth. This pattern continues down to the last list, whose options will be represented by properties with empty object values.

optionsTree

dynamic-object

List Group

issues-list-minimal

issues

issue-summary

forward-only-paging-links

Issues List (Prefer return=minimal)

issues-list-representation

issue-representation

Issues List (Prefer return=representation)

Indicates whether the issue's current workflow status is an Open, Closed, or Draft status.

issue-summary-state

Issue Summary state

The issue's unique ID. Can be used to query for issue details with the Get Issue Details endpoint.

Name that should be used to display this issue to users.

Read-only. Describes which domain of work the issue involves, which determines what applications will show it. Automatically set based on the form definition (referenced by `formId`) that was used to create the issue.

A user-provided short description of the issue, if it exists. Can be shown alongside DisplayName to display the issue to users in a UI.

subject

Issue Summary

Contains the full data of this issue, except formId, for inclusion in a list. Any property that was never set on the issue will be omitted from the response.

Unique identifier for this instance. Read-only.

Name that should be used to show this issue in a list of issues in the UI. This is read-only. Project managers can configure how this is generated; usually, it will be the value of another property.

description

Read-only. Describes which domain of work the issue involves, which determines what applications will show it. Automatically set based on the form definition that was used to create the issue.

An human-readable identifier for the issue, consisting of an alphanumeric prefix (that can be configured by the project administrator) followed by an auto-incrementing number. Read-only.

number

The date by which an action should be taken on this issue. Applications will use this to determine whether an issue is near due or overdue.

dueDate

The current workflow status the issue is in right now.

status

Indicates whether the issue's status is an Open, Closed, or Draft status. This property is read-only.

API references