JIRA

cloudId

The cloud ID.

issueIdOrKey

The ID or key of the issue where the attachment will be added to.

file

Provide either a file URL or a path to a file in the /tmp directory (for example, /tmp/myFile.pdf).

syncDir

syncDir

cloudId

The cloud ID.

issueIdOrKey

The ID or key of the issue where the attachment will be added to.

body

The comment text in [Atlassian Document Format](https://developer.atlassian.com/cloud/jira/platform/apis/document/structure/), e.g. `{\

visibility

The group or role to which this comment is visible, See `Visibility` section of [doc](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-comments/#api-rest-api-3-issue-issueidorkey-comment-post)

properties

A list of comment properties.

additionalProperties

Extra properties of any type may be provided to this object.

expand

The Jira REST API uses resource expansion, which means that some parts of a resource are not returned unless specified in the request. This parameter accepts `renderedBody`, which returns the comment body rendered in HTML.

cloudId

The cloud ID.

issueIdOrKey

The ID or key of the issue where the attachment will be added to.

files

Provide either an array of file URLs or paths to files in the /tmp directory (for example, /tmp/myFile.pdf).

syncDir

syncDir

cloudId

The cloud ID.

issueIdOrKey

The ID or key of the issue where the attachment will be added to.

accountId

The account ID of the user, which uniquely identifies the user across all Atlassian products, For example, `5b10ac8d82e05b22cc7d4ef5`

cloudId

The cloud ID.

issueIdOrKey

The ID or key of the issue where the attachment will be added to.

accountId

The account ID of the user, which uniquely identifies the user across all Atlassian products, For example, `5b10ac8d82e05b22cc7d4ef5`

cloudId

The cloud ID.

fieldId

The ID of the field.

contextId

The ID of the context.

options

Options to create. Each option should be a JSON object with the following structure as an example: `{ \

updateHistory

Whether the project in which the issue is created is added to the user

projectId

The project ID.

issueTypeId

An ID identifying the type of issue, [Check the API docs](https://developer.atlassian.com/cloud/jira/platform/rest/v3/#api-rest-api-3-issue-post) to see available options

cloudId

The cloud ID.

projectID

The project ID.

name

The unique name of the version. Required when creating a version. The maximum length is 255 characters.

description

The description of the version.

archived

Indicates that the version is archived.

released

Indicates that the version is released. If the version is released a request to release again is ignored. Not applicable when creating a version.

startDate

The start date of the version. Expressed in ISO 8601 format (yyyy-mm-dd).

releaseDate

The release date of the version. Expressed in ISO 8601 format (yyyy-mm-dd).

moveUnfixedIssuesTo

The URL of the self link to the version to which all unfixed issues are moved when a version is released. Not applicable when creating a version. Optional when updating a version.

expand

Use expand to include additional information about version in the response. This parameter accepts a comma-separated list. Expand options include:\n`operations` Returns the list of operations available for this version.\n`issuesstatus` Returns the count of issues in this version for each of the status categories `to do`, `in progress`, `done`, and `unmapped`.

Project key

The key of the project where the issue will be created.

Summary

A brief summary of the issue.

Description

Detailed description of the issue.

Issue type name

Name of the issue type, such as Bug or Task.

cloudId

The cloud ID.

projectID

The project ID.

enableUndo

Whether this project is placed in the Jira recycle bin where it will be available for restoration.

cloudId

The cloud ID.

recent

Returns the user

properties

Details of issue properties to be add or update, please provide an array of objects with keys and values.

expand

Use expand to include additional information in the response. This parameter accepts a comma-separated list. Expanded options include:\n`description` Returns the project description.\n`issueTypes` Returns all issue types associated with the project.\n`lead` Returns information about the project lead.\n`projectKeys` Returns all project keys associated with the project.

cloudId

The cloud ID.

issueIdOrKey

The ID or key of the issue where the attachment will be added to.

fields

A list of fields to return for the issue. This parameter accepts a comma-separated list. Use it to retrieve a subset of fields. All fields are returned by default. Allowed values:\n`*all` Returns all fields.\n`*navigable` Returns navigable fields.\nAny issue field, prefixed with a minus to exclude, as in `-description `.

fieldsByKeys

Whether `fields` in fields are referenced by keys rather than IDs. This parameter is useful where fields have been added by a connect app and a field

properties

A list of issue properties to return for the issue. This parameter accepts a comma-separated list. Allowed values:\n`*all` Returns all issue properties.\nAny issue property key, prefixed with a minus to exclude.

updateHistory

Whether the project in which the issue is created is added to the user

expand

Use expand to include additional information about the issues in the response. This parameter accepts a comma-separated list. Expand options include:\n`renderedFields` Returns field values rendered in HTML format.\n`names` Returns the display name of each field.\n`schema` Returns the schema describing a field type.\n`transitions` Returns all possible transitions for the issue.\n`editmeta` Returns information about how each field can be edited.\n`changelog` Returns a list of recent updates to an issue, sorted by date, starting from the most recent.\n`versionedRepresentations` Returns a JSON array for each version of a field

cloudId

The cloud ID.

taskId

The ID of the task to get details of. A task is a resource that represents a [long-running asynchronous tasks](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#async-operations).

query

JQL query string to filter which tickets to retrieve.

startAt

The starting index of the results.

maxResults

The maximum number of results to return.

fields

A list of fields to be included in the results.

cloudId

The cloud ID.

issueIdOrKey

The ID or key of the issue where the attachment will be added to.

transitionId

The ID of the transition.

skipRemoteOnlyCondition

Whether transitions with the condition *Hide From User Condition* are included in the response.

includeUnavailableTransitions

Whether details of transitions that fail a condition are included in the response.

sortByOpsBarAndStatus

Whether the transitions are sorted by ops-bar sequence value first then category order (Todo, In Progress, Done) or only by ops-bar sequence value.

expand

Use expand to include additional information about transitions in the response. This parameter accepts `transitions.fields`, which returns information about the fields in the transition screen for each transition. Fields hidden from the screen are not returned. Use this information to populate the fields and update fields in [Transition issue](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issues/#api-rest-api-3-issue-issueidorkey-transitions-post).

cloudId

The cloud ID.

accountId

The account ID of the user, which uniquely identifies the user across all Atlassian products, For example, `5b10ac8d82e05b22cc7d4ef5`

expand

Use expand to include additional information about users in the response. This parameter accepts a comma-separated list. Expand options include:\n*`groups` includes all groups and nested groups to which the user belongs.\n*`applicationRoles` includes details of all the applications to which the user has access.

cloudId

The cloud ID.

query

Filter for a name or term

cloudId

The cloud ID.

issueIdOrKey

The ID or key of the issue where the attachment will be added to.

orderBy

[Order](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#ordering) the results by a field. Accepts *created* to sort comments by their created date.\nValid values: `created`, `-created`, `+created`.

expand

Use expand to include additional information about comments in the response. This parameter accepts `renderedBody`, which returns the comment body rendered in HTML.

cloudId

The cloud ID.

jql

The [JQL](https://support.atlassian.com/jira-software-cloud/docs/what-is-advanced-search-in-jira-cloud/) query to search for issues

maxResults

Maximum number of issues to return (default: 50, max: 100)

fields

Comma-separated list of fields to return for each issue

expand

Use expand to include additional information about the issues in the response

properties

A list of up to 5 issue properties to include in the results. This parameter accepts a comma-separated list.

fieldsByKeys

Reference fields by their key (rather than ID). The default is `false`.

failFast

Fail this request early if we can

cloudId

The cloud ID.

issueIdOrKey

The ID or key of the issue where the attachment will be added to.

transition

Details of a transition. Required when performing a transition, optional when creating or editing an issue, See `Transition` section of [doc](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issues/#api-rest-api-3-issue-issueidorkey-put). Also you can go edit the workflow and choose the Text option instead of the Diagram option. You can see the transition ID in parenthesis.

fields

List of issue screen fields to update, specifying the sub-field to update and its value for each field. This field provides a straightforward option when setting a sub-field. When multiple sub-fields or other operations are required, use `update`. Fields included in here cannot be included in `update`. (.i.e for Fields \

update

List of operations to perform on issue screen fields. Note that fields included in here cannot be included in fields.

historyMetadata

Additional issue history details, See `HistoryMetadata` section of [doc](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issues/#api-rest-api-3-issue-issueidorkey-transitions-post)

properties

Details of issue properties to be add or update.

additionalProperties

Extra properties of any type may be provided to this object.

cloudId

The cloud ID.

issueIdOrKey

The ID or key of the issue where the attachment will be added to.

commentId

The ID of the comment.

body

The comment text in [Atlassian Document Format](https://developer.atlassian.com/cloud/jira/platform/apis/document/structure/), e.g. `{\

visibility

The group or role to which this comment is visible, See `Visibility` section of [doc](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-comments/#api-rest-api-3-issue-issueidorkey-comment-id-put)

properties

Details of issue properties to be add or update, please provide an array of objects with keys and values.

additionalProperties

Extra properties of any type may be provided to this object.

notifyUsers

Whether users are notified when a comment is updated.

expand

Use expand to include additional information about comments in the response. This parameter accepts `renderedBody`, which returns the comment body rendered in HTML.

projectId

The project ID.

issueIdOrKey

The ID or key of the issue where the attachment will be added to.

issueTypeId

An ID identifying the type of issue, [Check the API docs](https://developer.atlassian.com/cloud/jira/platform/rest/v3/#api-rest-api-3-issue-post) to see available options

notifyUsers

Whether a notification email about the issue update is sent to all watchers. To disable the notification, administer Jira or administer project permissions are required. If the user doesn

overrideScreenSecurity

Whether screen security should be overridden to enable hidden fields to be edited. Available to Connect app users with admin permissions.

overrideEditableFlag

Whether screen security should be overridden to enable uneditable fields to be edited. Available to Connect app users with admin permissions.

transitionId

The ID of the issue transition. Retrieving options requires a static `issueIdOrKey`. Required when specifying a transition to undertake.

transitionLooped

Whether the transition is looped.