add_actor_to_project_role
Adds an actor (user or group) to a project role.
Parameters
id (required)
the project role id
Type: integer
projectIdOrKey (required)
the project id or project key
Type: string
$body
Type: object
{ }
add_actors_to_role
Adds default actors to the given role. The request data should contain a list of usernames or a list of groups to add.
Parameters
id (required)
the role id to remove the actors from
Type: integer
$body
Type: object
{
"user" : [ "string" ],
"group" : [ "string" ]
}
add_audit_record
Store a record in Audit Log
Parameters
$body
Type: object
{
"summary" : "string",
"changedValues" : [ {
"changedTo" : "string",
"fieldName" : "string",
"changedFrom" : "string"
} ],
"objectItem" : {
"parentName" : "string",
"name" : "string",
"typeName" : "string",
"id" : "string",
"parentId" : "string"
},
"created" : "string",
"authorKey" : "string",
"eventSource" : "string",
"description" : "string",
"associatedItems" : [ {
"parentName" : "string",
"name" : "string",
"typeName" : "string",
"id" : "string",
"parentId" : "string"
} ],
"id" : "integer",
"category" : "string",
"remoteAddress" : "string"
}
add_comment
Adds a new comment to an issue.
Parameters
issueIdOrKey (required)
a string containing the issue id or key the comment will be added to
Type: string
$body
Type: object
{
"renderedBody" : "The rendered version of the comment.",
"visibility" : {
"type" : "string. Possible values: group | role",
"value" : "string"
},
"author" : {
"emailAddress" : "string",
"avatarUrls" : { },
"displayName" : "string",
"name" : "string",
"active" : "boolean",
"timeZone" : "string",
"key" : "string"
},
"created" : "The date and time at which the comment was created.",
"updateAuthor" : {
"emailAddress" : "string",
"avatarUrls" : { },
"displayName" : "string",
"name" : "string",
"active" : "boolean",
"timeZone" : "string",
"key" : "string"
},
"self" : "The URL of the comment.",
"id" : "The ID of the comment.",
"body" : "The comment text.",
"updated" : "The date and time at which the comment was updated last.",
"properties" : [ {
"value" : { },
"key" : "string"
} ]
}
expand
optional flags: renderedBody (provides body rendered in HTML)
Type: string
add_field_to_default_screen
Adds field or custom field to the default tab
Parameters
fieldId (required)
id of field / custom field
Type: string
$body
Type: object
{ }
add_field_to_tab
Adds field to the given tab.
Parameters
screenId (required)
id of screen
Type: integer
tabId (required)
id of tab
Type: integer
$body
Type: object
{
"fieldId" : "string"
}
add_filter_share_permission
Adds a share permissions to the given filter. Adding a global permission removes all previous permissions from the filter.
Parameters
id (required)
Type: integer
$body
Type: object
{
"view" : "Required boolean",
"edit" : "Required boolean",
"type" : "string",
"projectId" : "string",
"groupname" : "string",
"projectRoleId" : "string",
"userKey" : "string"
}
add_issue_worklog
Adds a new worklog entry to an issue.
Parameters
issueIdOrKey (required)
a string containing the issue id or key the worklog will be added to
Type: string
$body
Type: object
{
"issueId" : "string",
"timeSpentSeconds" : "integer",
"visibility" : {
"type" : "string. Possible values: group | role",
"value" : "string"
},
"timeSpent" : "string",
"author" : {
"emailAddress" : "string",
"avatarUrls" : { },
"displayName" : "string",
"name" : "string",
"active" : "boolean",
"timeZone" : "string",
"key" : "string"
},
"created" : "string",
"updateAuthor" : {
"emailAddress" : "string",
"avatarUrls" : { },
"displayName" : "string",
"name" : "string",
"active" : "boolean",
"timeZone" : "string",
"key" : "string"
},
"comment" : "string",
"started" : "string",
"id" : "string",
"updated" : "string"
}
adjustEstimate
(optional) allows you to provide specific instructions to update the remaining time estimate of the issue.
Type: string
newEstimate
(required when "new" is selected for adjustEstimate) the new value for the remaining estimate field. e.g. "2d"
Type: string
reduceBy
(required when "manual" is selected for adjustEstimate) the amount to reduce the remaining estimate by e.g. "2d"
Type: string
add_user_to_application
Add user to given application. Admin permission will be required to perform this operation.
Parameters
$body
Type: object
{ }
applicationKey
application key
Type: string
username
username
Type: string
add_user_to_group
Adds given user to a group. Returns the current state of the group.
Parameters
$body
Type: object
{
"name" : "string"
}
groupname
A name of requested group.
Type: string
add_vote
Cast your vote in favour of an issue.
Parameters
issueIdOrKey (required)
the issue to view voting information for
Type: string
$body
Type: object
{ }
add_watcher
Adds a user to an issue's watcher list.
Parameters
issueIdOrKey (required)
a String containing an issue key.
Type: string
$body
Type: object
{
"name" : "string"
}
are_jmx_metrics_exposed
This operation has no parameters
assign_issue
Assigns an issue to a user. You can use this resource to assign issues when the user submitting the request has the assign permission but not the edit issue permission. If the name is "-1" automatic assignee is used. A null name will remove the assignee.
Parameters
issueIdOrKey (required)
a String containing an issue key
Type: string
$body
Type: object
{
"name" : "string"
}
assign_permission_scheme_to_project
Assigns a permission scheme with a project.
Parameters
projectKeyOrId (required)
key or id of the project
Type: string
$body
Type: object
{
"id" : "integer"
}
expand
Type: string
bulk_create_issues
Creates issues or sub-tasks from a JSON representation. Creates many issues in one bulk operation.
Parameters
$body
Type: object
{
"issueUpdates" : [ {
"historyMetadata" : {
"emailDescription" : "string",
"actor" : {
"avatarUrl" : "string",
"displayName" : "string",
"id" : "string",
"type" : "string",
"displayNameKey" : "string",
"url" : "string"
},
"extraData" : { },
"activityDescriptionKey" : "string",
"emailDescriptionKey" : "string",
"descriptionKey" : "string",
"description" : "string",
"generator" : {
"avatarUrl" : "string",
"displayName" : "string",
"id" : "string",
"type" : "string",
"displayNameKey" : "string",
"url" : "string"
},
"cause" : {
"avatarUrl" : "string",
"displayName" : "string",
"id" : "string",
"type" : "string",
"displayNameKey" : "string",
"url" : "string"
},
"activityDescription" : "string",
"type" : "string"
},
"update" : { },
"fields" : { },
"transition" : {
"name" : "The name of the issue transition.",
"id" : "The ID of the issue transition. Required when specifying a transition to undertake.",
"to" : {
"statusColor" : "string",
"name" : "string",
"description" : "string",
"iconUrl" : "string",
"id" : "string",
"statusCategory" : {
"colorName" : "string",
"name" : "string",
"id" : "integer",
"key" : "string"
}
},
"fields" : {
"schema" : {
"system" : "string",
"custom" : "string",
"type" : "string",
"items" : "string",
"customId" : "integer"
},
"hasDefaultValue" : "boolean",
"allowedValues" : [ { } ],
"operations" : [ "string" ],
"name" : "string",
"autoCompleteUrl" : "string",
"required" : "Required boolean"
}
},
"properties" : [ {
"value" : { },
"key" : "string"
} ]
} ]
}
bulk_find_assignable_users
Returns a list of users that match the search string and can be assigned issues for all the given projects. This resource cannot be accessed anonymously.
Parameters
maxResults
the maximum number of users to return (defaults to 50). The maximum allowed value is 1000. If you specify a value that is higher than this number, your search results will be truncated.
Type: integer
projectKeys
the keys of the projects we are finding assignable users for, comma-separated
Type: string
startAt
the index of the first user to return (0-based)
Type: integer
username
the username
Type: string
bulk_get_reindex_request_progress
Retrieves the progress of a multiple reindex requests. Only reindex requests that actually exist will be returned in the results.
Parameters
requestId
the reindex request IDs.
Type: string
bulk_update_application_roles
Updates the ApplicationRoles with the passed data if the version hash is the same as the server. Only the groups and default groups setting of the role may be updated. Requests to change the key or the name of the role will be silently ignored. It is acceptable to pass only the roles that are updated as roles that are present in the server but not in data to update with, will not be deleted.
Parameters
$body
Type: array
[ {
"numberOfSeats" : "integer",
"userCount" : "integer",
"userCountDescription" : "string",
"defaultGroups" : [ "string" ],
"hasUnlimitedSeats" : "boolean",
"name" : "string",
"groups" : [ "string" ],
"remainingSeats" : "integer",
"key" : "string",
"selectedByDefault" : "boolean",
"defined" : "boolean",
"platform" : "boolean"
} ]
If-Match
Type: string
can_move_sub_task
Check if you can move a subtask
Parameters
issueIdOrKey (required)
The parent issue's key or id
Type: string
change_user_password
Modify user password.
Parameters
$body
Type: object
{
"password" : "string",
"currentPassword" : "string"
}
key
user key
Type: string
username
the username
Type: string
check_create_user_password_policy
Returns a list of statements explaining why the password policy would disallow a proposed password for a new user. You can use this method to test the password policy validation. For example, you could use this to validate a password in a create user form in the user interface, as the user enters it. The username and new password must be not empty to perform the validation. Note: This method will help you validate against the policy only. It won't check any other validations that might be performed when creating a new user, e.g. checking whether a user with the same name already exists.
Parameters
$body
Type: object
{
"emailAddress" : "string",
"password" : "string",
"displayName" : "string",
"username" : "string"
}
check_update_user_password_policy
Returns a list of statements explaining why the password policy would disallow a proposed new password for a user with an existing password. You can use this method to test the password policy validation. For example, you could use this to validate a password in a change password form in the user interface, as the user enters it. The user must exist and the username and new password must be not empty, to perform the validation. Note: This method will help you validate against the policy only. It won't check any other validations that might be performed when submitting a password change/reset request, e.g. verifying whether the old password is valid.
Parameters
$body
Type: object
{
"emailAddress" : "string",
"password" : "string",
"username" : "string"
}
create_avatar_from_temporary
Updates the cropping instructions of the temporary avatar.
Parameters
type (required)
the avatar type
Type: string
$body
Type: object
{
"cropperWidth" : "Required integer",
"needsCropping" : "Required boolean",
"cropperOffsetY" : "Required integer",
"url" : "string",
"cropperOffsetX" : "Required integer"
}
create_component
Create a component via POST.
Parameters
$body
Type: object
{
"archived" : "boolean",
"leadUserName" : "string",
"isAssigneeTypeValid" : "Required boolean",
"realAssigneeType" : "string. Possible values: PROJECT_DEFAULT | COMPONENT_LEAD | PROJECT_LEAD | UNASSIGNED",
"name" : "string",
"description" : "string",
"project" : "string",
"realAssignee" : {
"emailAddress" : "string",
"avatarUrls" : { },
"displayName" : "string",
"name" : "string",
"active" : "boolean",
"timeZone" : "string",
"key" : "string"
},
"assigneeType" : "string. Possible values: PROJECT_DEFAULT | COMPONENT_LEAD | PROJECT_LEAD | UNASSIGNED",
"assignee" : {
"emailAddress" : "string",
"avatarUrls" : { },
"displayName" : "string",
"name" : "string",
"active" : "boolean",
"timeZone" : "string",
"key" : "string"
},
"projectId" : "integer",
"lead" : {
"emailAddress" : "string",
"avatarUrls" : { },
"displayName" : "string",
"name" : "string",
"active" : "boolean",
"timeZone" : "string",
"key" : "string"
}
}
create_custom_field
Creates a custom field using a definition (object encapsulating custom field data)
Parameters
$body
Type: object
{
"searcherKey" : "string",
"name" : "string",
"description" : "string",
"id" : "string",
"type" : "string"
}
create_filter
Creates a new filter, and returns newly created filter. Currently sets permissions just using the users default sharing permissions
Parameters
$body
Type: object
{
"owner" : {
"emailAddress" : "string",
"avatarUrls" : { },
"displayName" : "string",
"name" : "string",
"active" : "boolean",
"timeZone" : "string",
"key" : "string"
},
"sharedUsers" : {
"size" : "Required integer",
"max-results" : "Required integer",
"end-index" : "Required integer",
"start-index" : "Required integer",
"items" : [ {
"emailAddress" : "string",
"avatarUrls" : { },
"displayName" : "string",
"name" : "string",
"active" : "boolean",
"timeZone" : "string",
"key" : "string"
} ]
},
"subscriptions" : {
"size" : "Required integer",
"max-results" : "Required integer",
"end-index" : "Required integer",
"start-index" : "Required integer",
"items" : [ {
"id" : "integer",
"user" : {
"emailAddress" : "string",
"avatarUrls" : { },
"displayName" : "string",
"name" : "string",
"active" : "boolean",
"timeZone" : "string",
"key" : "string"
},
"group" : {
"name" : "string"
}
} ]
},
"jql" : "string",
"editable" : "boolean",
"name" : "string",
"viewUrl" : "uri",
"description" : "string",
"searchUrl" : "uri",
"id" : "string",
"sharePermissions" : [ {
"view" : "Required boolean",
"role" : {
"actors" : [ {
"avatarUrl" : "uri",
"displayName" : "string",
"name" : "string",
"id" : "integer",
"type" : "string"
} ],
"name" : "string",
"description" : "string",
"id" : "integer"
},
"edit" : "Required boolean",
"project" : {
"components" : [ {
"archived" : "boolean",
"leadUserName" : "string",
"isAssigneeTypeValid" : "Required boolean",
"realAssigneeType" : "string. Possible values: PROJECT_DEFAULT | COMPONENT_LEAD | PROJECT_LEAD | UNASSIGNED",
"name" : "string",
"description" : "string",
"project" : "string",
"realAssignee" : {
"emailAddress" : "string",
"avatarUrls" : { },
"displayName" : "string",
"name" : "string",
"active" : "boolean",
"timeZone" : "string",
"key" : "string"
},
"assigneeType" : "string. Possible values: PROJECT_DEFAULT | COMPONENT_LEAD | PROJECT_LEAD | UNASSIGNED",
"assignee" : {
"emailAddress" : "string",
"avatarUrls" : { },
"displayName" : "string",
"name" : "string",
"active" : "boolean",
"timeZone" : "string",
"key" : "string"
},
"projectId" : "integer",
"lead" : {
"emailAddress" : "string",
"avatarUrls" : { },
"displayName" : "string",
"name" : "string",
"active" : "boolean",
"timeZone" : "string",
"key" : "string"
}
} ],
"avatarUrls" : { },
"roles" : { },
"description" : "string",
"lead" : {
"emailAddress" : "string",
"avatarUrls" : { },
"displayName" : "string",
"name" : "string",
"active" : "boolean",
"timeZone" : "string",
"key" : "string"
},
"url" : "string",
"issueTypes" : [ {
"avatarId" : "integer",
"name" : "string",
"description" : "string",
"id" : "string",
"iconUrl" : "string",
"subtask" : "Required boolean"
} ],
"archived" : "boolean",
"versions" : [ {
"description" : "string",
"project" : "string",
"archived" : "boolean",
"operations" : [ {
"weight" : "integer",
"id" : "string",
"label" : "string",
"href" : "string",
"styleClass" : "string",
"title" : "string",
"iconClass" : "string"
} ],
"overdue" : "boolean",
"remotelinks" : [ {
"name" : "string",
"link" : { }
} ],
"name" : "string",
"moveUnfixedIssuesTo" : "uri",
"userReleaseDate" : "string",
"id" : "string",
"userStartDate" : "string",
"projectId" : "integer",
"released" : "boolean"
} ],
"projectCategory" : {
"name" : "string",
"description" : "string",
"id" : "string"
},
"name" : "string",
"id" : "string",
"assigneeType" : "string. Possible values: PROJECT_LEAD | UNASSIGNED",
"projectKeys" : [ "string" ],
"projectTypeKey" : "string",
"key" : "string",
"email" : "string"
},
"id" : "integer",
"type" : "string",
"user" : {
"emailAddress" : "string",
"avatarUrls" : { },
"displayName" : "string",
"name" : "string",
"active" : "boolean",
"timeZone" : "string",
"key" : "string"
},
"group" : {
"name" : "string"
}
} ],
"favourite" : "boolean"
}
expand
the parameters to expand
Type: string
create_group
Creates a group by given group parameter. Returns REST representation for the requested group.
Parameters
$body
Type: object
{
"name" : "string"
}
create_issue
Creates an issue or a sub-task from a JSON representation. The fields that can be set on create, in either the fields parameter or the update parameter can be determined using the /rest/api/2/issue/createmeta resource. If a field is not configured to appear on the create screen, then it will not be in the createmeta, and a field validation error will occur if it is submitted. Creating a sub-task is similar to creating a regular issue, with two important differences: the issueType field must correspond to a sub-task issue type (you can use /issue/createmeta to discover sub-task issue types), and you must provide a parent field in the issue create request containing the id or key of the parent issue.
Parameters
$body
Type: object
{
"historyMetadata" : {
"emailDescription" : "string",
"actor" : {
"avatarUrl" : "string",
"displayName" : "string",
"id" : "string",
"type" : "string",
"displayNameKey" : "string",
"url" : "string"
},
"extraData" : { },
"activityDescriptionKey" : "string",
"emailDescriptionKey" : "string",
"descriptionKey" : "string",
"description" : "string",
"generator" : {
"avatarUrl" : "string",
"displayName" : "string",
"id" : "string",
"type" : "string",
"displayNameKey" : "string",
"url" : "string"
},
"cause" : {
"avatarUrl" : "string",
"displayName" : "string",
"id" : "string",
"type" : "string",
"displayNameKey" : "string",
"url" : "string"
},
"activityDescription" : "string",
"type" : "string"
},
"update" : { },
"fields" : { },
"transition" : {
"name" : "The name of the issue transition.",
"id" : "The ID of the issue transition. Required when specifying a transition to undertake.",
"to" : {
"statusColor" : "string",
"name" : "string",
"description" : "string",
"iconUrl" : "string",
"id" : "string",
"statusCategory" : {
"colorName" : "string",
"name" : "string",
"id" : "integer",
"key" : "string"
}
},
"fields" : {
"schema" : {
"system" : "string",
"custom" : "string",
"type" : "string",
"items" : "string",
"customId" : "integer"
},
"hasDefaultValue" : "boolean",
"allowedValues" : [ { } ],
"operations" : [ "string" ],
"name" : "string",
"autoCompleteUrl" : "string",
"required" : "Required boolean"
}
},
"properties" : [ {
"value" : { },
"key" : "string"
} ]
}
create_issue_avatar_from_temporary
Converts temporary avatar into a real avatar
Parameters
id (required)
the id of the issue type, which avatar is updated.
Type: string
$body
Type: object
{
"cropperWidth" : "Required integer",
"needsCropping" : "Required boolean",
"cropperOffsetY" : "Required integer",
"url" : "string",
"cropperOffsetX" : "Required integer"
}
create_issue_link_type
Create a new issue link type.
Parameters
$body
Type: object
{
"inward" : "string",
"name" : "string",
"id" : "string",
"outward" : "string"
}
create_issue_type
Creates an issue type from a JSON representation and adds the issue newly created issue type to the default issue type scheme.
Parameters
$body
Type: object
{
"name" : "string",
"description" : "string",
"type" : "string. Possible values: subtask | standard"
}
create_or_update_remote_issue_link
Creates or updates a remote issue link from a JSON representation. If a globalId is provided and a remote issue link exists with that globalId, the remote issue link is updated. Otherwise, the remote issue link is created.
Parameters
issueIdOrKey (required)
the issue to create the remote issue link for
Type: string
$body
Type: object
{
"application" : {
"name" : "string",
"type" : "string"
},
"globalId" : "string",
"relationship" : "string",
"object" : {
"summary" : "string",
"icon" : {
"url16x16" : "string",
"link" : "string",
"title" : "string"
},
"title" : "string",
"url" : "string",
"status" : {
"icon" : {
"url16x16" : "string",
"link" : "string",
"title" : "string"
},
"resolved" : "boolean"
}
}
}
create_permission_scheme
Create a new permission scheme. This method can create schemes with a defined permission set, or without.
Parameters
$body
Type: object
{
"permissions" : [ {
"holder" : {
"parameter" : "string",
"type" : "string"
},
"permission" : "string"
} ],
"name" : "string",
"description" : "string"
}
expand
Type: string
create_permission_scheme_grant
Creates a permission grant in a permission scheme.
Parameters
schemeId (required)
Type: integer
$body
Type: object
{
"holder" : {
"parameter" : "string",
"type" : "string"
},
"permission" : "string"
}
expand
Type: string
create_project
Creates a new project.
Parameters
$body
Type: object
{
"notificationScheme" : "integer",
"description" : "string",
"lead" : "string",
"url" : "string",
"projectTemplateKey" : "string",
"avatarId" : "integer",
"issueSecurityScheme" : "integer",
"name" : "string",
"permissionScheme" : "integer",
"assigneeType" : "string. Possible values: PROJECT_LEAD | UNASSIGNED",
"projectTypeKey" : "string",
"key" : "string",
"categoryId" : "integer"
}
create_project_avatar_from_temporary
Converts temporary avatar into a real avatar
Parameters
projectIdOrKey (required)
Type: string
$body
Type: object
{
"cropperWidth" : "Required integer",
"needsCropping" : "Required boolean",
"cropperOffsetY" : "Required integer",
"url" : "string",
"cropperOffsetX" : "Required integer"
}
create_project_category
Create a project category via POST.
Parameters
$body
Type: object
{
"name" : "string",
"description" : "string",
"id" : "string"
}
create_project_role
Creates a new ProjectRole to be available in JIRA. The created role does not have any default actors assigned.
Parameters
$body
Type: object
{
"name" : "string",
"description" : "string"
}
create_remote_version_link_by_global_id
Create a remote version link via POST. The link's global ID will betaken from the JSON payload if provided; otherwise, it will be generated.
Parameters
globalId (required)
The global ID of the remote link
Type: string
versionId (required)
The version ID of the remote link
Type: string
$body
Type: string
create_remote_version_links_by_version_id
Create a remote version link via POST. The link's global ID will be taken from the JSON payload if provided; otherwise, it will be generated.
Parameters
versionId (required)
The version for which to delete ALL existing remote version links
Type: string
$body
Type: string
create_tab
Creates tab for given screen
Parameters
screenId (required)
id of screen
Type: integer
$body
Type: object
{
"name" : "string",
"id" : "integer"
}
create_universal_avatar_from_temporary
Converts temporary avatar into a real avatar
Parameters
owningObjectId (required)
Type: string
type (required)
Type: string
$body
Type: object
{
"cropperWidth" : "Required integer",
"needsCropping" : "Required boolean",
"cropperOffsetY" : "Required integer",
"url" : "string",
"cropperOffsetX" : "Required integer"
}
create_user
Create user. By default created user will not be notified with email. If password field is not set then password will be randomly generated.
Parameters
$body
Type: object
{
"applicationKeys" : [ "string" ],
"notification" : "string",
"password" : "string",
"emailAddress" : "string",
"displayName" : "string",
"name" : "string",
"active" : "boolean",
"key" : "string"
}
create_user_avatar_from_temporary
Converts temporary avatar into a real avatar
Parameters
$body
Type: object
{
"cropperWidth" : "Required integer",
"needsCropping" : "Required boolean",
"cropperOffsetY" : "Required integer",
"url" : "string",
"cropperOffsetX" : "Required integer"
}
username
username
Type: string
create_version
Create a version via POST.
Parameters
$body
Type: object
{
"description" : "string",
"project" : "string",
"archived" : "boolean",
"operations" : [ {
"weight" : "integer",
"id" : "string",
"label" : "string",
"href" : "string",
"styleClass" : "string",
"title" : "string",
"iconClass" : "string"
} ],
"overdue" : "boolean",
"remotelinks" : [ {
"name" : "string",
"link" : { }
} ],
"name" : "string",
"moveUnfixedIssuesTo" : "uri",
"userReleaseDate" : "string",
"id" : "string",
"userStartDate" : "string",
"projectId" : "integer",
"released" : "boolean"
}
create_workflow_property
Add a new property to a transition. Trying to add a property that already exists will fail.
Parameters
id (required)
the ID of the transition within the workflow.
Type: integer
$body
Type: object
{
"key" : "string"
}
key
the name of the property to add.
Type: string
workflowMode
the type of workflow to use. Can either be "live" or "draft".
Type: string
workflowName
the name of the workflow to use.
Type: string
create_workflow_scheme
Create a new workflow scheme. The body contains a representation of the new scheme. Values not passed are assumed to be set to their defaults.
Parameters
$body
Type: object
{
"originalIssueTypeMappings" : { },
"defaultWorkflow" : "string",
"updateDraftIfNeeded" : "boolean",
"draft" : "boolean",
"name" : "string",
"originalDefaultWorkflow" : "string",
"description" : "string",
"lastModifiedUser" : {
"emailAddress" : "string",
"avatarUrls" : { },
"displayName" : "string",
"name" : "string",
"active" : "Required boolean",
"timeZone" : "string",
"groups" : {
"size" : "Required integer",
"max-results" : "integer",
"items" : [ {
"name" : "string"
} ]
},
"locale" : "string",
"key" : "string",
"applicationRoles" : {
"size" : "Required integer",
"max-results" : "integer",
"items" : [ {
"name" : "string"
} ]
}
},
"id" : "integer",
"lastModified" : "string",
"issueTypeMappings" : { },
"issueTypes" : { }
}
create_workflow_scheme_draft_for_parent
Create a draft for the passed scheme. The draft will be a copy of the state of the parent.
Parameters
id (required)
the id of the parent scheme.
Type: integer
$body
Type: object
{
"originalIssueTypeMappings" : { },
"defaultWorkflow" : "string",
"updateDraftIfNeeded" : "boolean",
"draft" : "boolean",
"name" : "string",
"originalDefaultWorkflow" : "string",
"description" : "string",
"lastModifiedUser" : {
"emailAddress" : "string",
"avatarUrls" : { },
"displayName" : "string",
"name" : "string",
"active" : "Required boolean",
"timeZone" : "string",
"groups" : {
"size" : "Required integer",
"max-results" : "integer",
"items" : [ {
"name" : "string"
} ]
},
"locale" : "string",
"key" : "string",
"applicationRoles" : {
"size" : "Required integer",
"max-results" : "integer",
"items" : [ {
"name" : "string"
} ]
}
},
"id" : "integer",
"lastModified" : "string",
"issueTypeMappings" : { },
"issueTypes" : { }
}
delete_actor_from_project_role
Deletes actors (users or groups) from a project role.
Parameters
id (required)
the project role id
Type: integer
projectIdOrKey (required)
the project id or project key
Type: string
group
the groupname to remove from the project role
Type: string
user
the username to remove from the project role
Type: string
delete_actors_from_role
Removes default actor from the given role.
Parameters
id (required)
the role id to remove the actors from
Type: integer
group
if given, removes an actor from given role
Type: string
user
if given, removes an actor from given role
Type: string
delete_comment
Deletes an existing comment .
Parameters
id (required)
the ID of the comment to request
Type: string
issueIdOrKey (required)
of the issue the comment belongs to
Type: string
delete_comment_property
Removes the property from the comment identified by the key or by the id. Ths user removing the property is required to have permissions to administer the comment.
Parameters
commentId (required)
the comment from which keys will be returned.
Type: string
propertyKey (required)
the key of the property to return.
Type: string
delete_component
Delete a project component.
Parameters
id (required)
The component to delete.
Type: string
moveIssuesTo
The new component applied to issues whose 'id' component will be deleted. If this value is null, then the 'id' component is simply removed from the related isues.
Type: string
delete_dashboard_item_property
Removes the property from the dashboard item identified by the key or by the id. Ths user removing the property is required to have permissions to administer the dashboard item.
Parameters
dashboardId (required)
Type: string
itemId (required)
the dashboard item from which keys will be returned.
Type: string
propertyKey (required)
the key of the property to return.
Type: string
delete_default_workflow_for_draft_scheme
Remove the default workflow from the passed draft workflow scheme.
Parameters
id (required)
the id of the parent scheme.
Type: integer
delete_default_workflow_for_scheme
Remove the default workflow from the passed workflow scheme.
Parameters
id (required)
the id of the scheme.
Type: integer
updateDraftIfNeeded
when true will create and return a draft when the workflow scheme cannot be edited (e.g. when it is being used by a project).
Type: boolean
delete_draft_workflow_mapping
Delete the passed workflow from the draft workflow scheme.
Parameters
id (required)
the id of the parent scheme.
Type: integer
workflowName
the name of the workflow to delete.
Type: string
delete_draft_workflow_scheme
Delete the passed draft workflow scheme.
Parameters
id (required)
the id of the parent scheme.
Type: integer
delete_field_from_tab
Removes field from given tab
Parameters
id (required)
Type: string
screenId (required)
id of screen
Type: integer
tabId (required)
id of tab
Type: integer
delete_filter
Delete a filter.
Parameters
id (required)
the id of the filter being looked up
Type: integer
delete_filter_share_permission
Removes a share permissions from the given filter.
Parameters
id (required)
Type: integer
permissionId (required)
Type: integer
delete_group
Deletes a group by given group parameter. Returns no content
Parameters
groupname
(mandatory) The name of the group to delete.
Type: string
swapGroup
If you delete a group and content is restricted to that group, the content will be hidden from all users. To prevent this, use this parameter to specify a different group to transfer the restrictions (comments and worklogs only) to.
Type: string
delete_issue
Delete an issue. If the issue has subtasks you must set the parameter deleteSubtasks=true to delete the issue.
Parameters
issueIdOrKey (required)
the issue id or key to update (i.e. JRA-1330)
Type: string
deleteSubtasks
a String of true or false indicating that any subtasks should also be deleted. If the issue has no subtasks this parameter is ignored. If the issue has subtasks and this parameter is missing or false, then the issue will not be deleted and an error will be returned.
Type: string
delete_issue_link
Deletes an issue link with the specified id. To be able to delete an issue link you must be able to view both issues and must have the link issue permission for at least one of the issues.
Parameters
linkId (required)
the issue link id.
Type: string
delete_issue_link_type
Delete the specified issue link type.
Parameters
issueLinkTypeId (required)
Type: string
delete_issue_property
Removes the property from the issue identified by the key or by the id. The user removing the property is required to have permissions to edit the issue.
Parameters
issueIdOrKey (required)
the issue from which keys will be returned.
Type: string
propertyKey (required)
the key of the property to return.
Type: string
delete_issue_type
Deletes the specified issue type. If the issue type has any associated issues, these issues will be migrated to the alternative issue type specified in the parameter. You can determine the alternative issue types by calling the /rest/api/2/issuetype/{id}/alternatives resource.
Parameters
id (required)
the id of the issue type to update.
Type: string
alternativeIssueTypeId
the id of an issue type to which issues associated with the removed issue type will be migrated.
Type: string
delete_issue_type_from_draft_scheme
Remove the specified issue type mapping from the draft scheme.
Parameters
id (required)
the id of the parent scheme.
Type: integer
issueType (required)
the issue type being set.
Type: string
delete_issue_type_from_scheme
Remove the specified issue type mapping from the scheme.
Parameters
id (required)
the id of the scheme.
Type: integer
issueType (required)
the issue type being set.
Type: string
updateDraftIfNeeded
when true will create and return a draft when the workflow scheme cannot be edited (e.g. when it is being used by a project).
Type: boolean
delete_issue_type_property
Removes the property from the issue type identified by the id. Ths user removing the property is required to have permissions to edit the issue type.
Parameters
issueTypeId (required)
the issue type from which the keys will be returned
Type: string
propertyKey (required)
the key of the property to return
Type: string
delete_issue_worklog
Deletes an existing worklog entry.
Parameters
id (required)
id of the worklog to be deleted
Type: string
issueIdOrKey (required)
a string containing the issue id or key the worklog belongs to
Type: string
adjustEstimate
(optional) allows you to provide specific instructions to update the remaining time estimate of the issue.
Type: string
increaseBy
(required when "manual" is selected for adjustEstimate) the amount to increase the remaining estimate by e.g. "2d"
Type: string
newEstimate
(required when "new" is selected for adjustEstimate) the new value for the remaining estimate field. e.g. "2d"
Type: string
delete_permission_scheme
Deletes a permission scheme identified by the given id.
Parameters
schemeId (required)
Type: integer
delete_permission_scheme_grant
Deletes a permission grant from a permission scheme.
Parameters
permissionId (required)
Type: integer
schemeId (required)
Type: integer
delete_preference
Removes preference of the currently logged in user. Preference key must be provided as input parameters (key). If key parameter is not provided or wrong - status code 404. If preference is unset - status code 204.
Parameters
key
- key of the preference to be removed.
Type: string
delete_project
Deletes a project.
Parameters
projectIdOrKey (required)
the project id or project key
Type: string
delete_project_avatar
Deletes avatar
Parameters
id (required)
database id for avatar
Type: integer
projectIdOrKey (required)
Project id or project key
Type: string
delete_project_category
Delete a project category.
Parameters
id (required)
Type: integer
delete_project_property
Removes the property from the project identified by the key or by the id. Ths user removing the property is required to have permissions to administer the project.
Parameters
projectIdOrKey (required)
the project from which keys will be returned.
Type: string
propertyKey (required)
the key of the property to return.
Type: string
delete_remote_issue_link_by_global_id
Delete the remote issue link with the given global id on the issue.
Parameters
issueIdOrKey (required)
the issue to create the remote issue link for
Type: string
globalId
the global id of the remote issue link
Type: string
delete_remote_issue_link_by_id
Delete the remote issue link with the given id on the issue.
Parameters
issueIdOrKey (required)
the issue to create the remote issue link for
Type: string
linkId (required)
the id of the remote issue link
Type: string
delete_remote_version_link_by_global_id
Delete a specific remote version link with the given version ID and global ID.
Parameters
globalId (required)
The global ID of the remote link
Type: string
versionId (required)
The version ID of the remote link
Type: string
delete_remote_version_links_by_version_id
Delete all remote version links for a given version ID.
Parameters
versionId (required)
The version for which to delete ALL existing remote version links
Type: string
delete_role
Deletes a role. May return 403 in the future
Parameters
id (required)
Type: integer
swap
if given, removes a role even if it is used in scheme by replacing the role with the given one
Type: integer
delete_tab
Deletes tab to give screen
Parameters
screenId (required)
id of screen
Type: integer
tabId (required)
id of tab
Type: integer
delete_universal_avatar
Deletes Universal avatar
Parameters
id (required)
database id for avatar
Type: integer
owningObjectId (required)
Type: string
type (required)
Project id or project key
Type: string
delete_user
Removes user.
Parameters
key
user key
Type: string
username
the username
Type: string
delete_user_avatar
Deletes avatar
Parameters
id (required)
database id for avatar
Type: integer
username
username
Type: string
delete_user_from_group
Removes given user from a group. Returns no content
Parameters
groupname
A name of requested group.
Type: string
username
User to remove from a group
Type: string
delete_user_property
Removes the property from the user identified by the key or by the id. Ths user removing the property is required to have permissions to administer the user.
Parameters
propertyKey (required)
Type: string
userKey
key of the user whose property is to be removed
Type: string
username
username of the user whose property is to be removed
Type: string
delete_version
Delete a project version.
Parameters
id (required)
The version to delete
Type: string
moveAffectedIssuesTo
The version to set affectedVersion to on issues where the deleted version is the affected version, If null then the affectedVersion is removed.
Type: string
moveFixIssuesTo
The version to set fixVersion to on issues where the deleted version is the fix version, If null then the fixVersion is removed.
Type: string
delete_version_and_swap
Delete a project version and swap it.
Parameters
id (required)
The version to delete
Type: string
$body
Type: object
{ }
delete_workflow
Delete the passed workflow from the workflow scheme.
Parameters
id (required)
the id of the scheme.
Type: integer
updateDraftIfNeeded
flag to indicate if a draft should be created if necessary to delete the workflow from the scheme.
Type: boolean
workflowName
the name of the workflow to delete.
Type: string
delete_workflow_property
Delete a property from the passed transition on the passed workflow. It is not an error to delete a property that does not exist.
Parameters
id (required)
the ID of the transition within the workflow.
Type: integer
key
the name of the property to add.
Type: string
workflowMode
the type of workflow to use. Can either be "live" or "draft".
Type: string
workflowName
the name of the workflow to use.
Type: string
delete_workflow_scheme
Delete the passed workflow scheme.
Parameters
id (required)
the id of the scheme.
Type: integer
do_transition
Perform a transition on an issue. When performing the transition you can update or set other issue fields. The fields that can be set on transtion, in either the fields parameter or the update parameter can be determined using the /rest/api/2/issue/{issueIdOrKey}/transitions?expand=transitions.fields resource.
Parameters
issueIdOrKey (required)
the issue whose transitions you want to view
Type: string
$body
Type: object
{
"historyMetadata" : {
"emailDescription" : "string",
"actor" : {
"avatarUrl" : "string",
"displayName" : "string",
"id" : "string",
"type" : "string",
"displayNameKey" : "string",
"url" : "string"
},
"extraData" : { },
"activityDescriptionKey" : "string",
"emailDescriptionKey" : "string",
"descriptionKey" : "string",
"description" : "string",
"generator" : {
"avatarUrl" : "string",
"displayName" : "string",
"id" : "string",
"type" : "string",
"displayNameKey" : "string",
"url" : "string"
},
"cause" : {
"avatarUrl" : "string",
"displayName" : "string",
"id" : "string",
"type" : "string",
"displayNameKey" : "string",
"url" : "string"
},
"activityDescription" : "string",
"type" : "string"
},
"update" : { },
"fields" : { },
"transition" : {
"name" : "The name of the issue transition.",
"id" : "The ID of the issue transition. Required when specifying a transition to undertake.",
"to" : {
"statusColor" : "string",
"name" : "string",
"description" : "string",
"iconUrl" : "string",
"id" : "string",
"statusCategory" : {
"colorName" : "string",
"name" : "string",
"id" : "integer",
"key" : "string"
}
},
"fields" : {
"schema" : {
"system" : "string",
"custom" : "string",
"type" : "string",
"items" : "string",
"customId" : "integer"
},
"hasDefaultValue" : "boolean",
"allowedValues" : [ { } ],
"operations" : [ "string" ],
"name" : "string",
"autoCompleteUrl" : "string",
"required" : "Required boolean"
}
},
"properties" : [ {
"value" : { },
"key" : "string"
} ]
}
edit_filter
Updates an existing filter, and returns its new value.
Parameters
id (required)
the id of the filter being looked up
Type: integer
$body
Type: object
{
"owner" : {
"emailAddress" : "string",
"avatarUrls" : { },
"displayName" : "string",
"name" : "string",
"active" : "boolean",
"timeZone" : "string",
"key" : "string"
},
"sharedUsers" : {
"size" : "Required integer",
"max-results" : "Required integer",
"end-index" : "Required integer",
"start-index" : "Required integer",
"items" : [ {
"emailAddress" : "string",
"avatarUrls" : { },
"displayName" : "string",
"name" : "string",
"active" : "boolean",
"timeZone" : "string",
"key" : "string"
} ]
},
"subscriptions" : {
"size" : "Required integer",
"max-results" : "Required integer",
"end-index" : "Required integer",
"start-index" : "Required integer",
"items" : [ {
"id" : "integer",
"user" : {
"emailAddress" : "string",
"avatarUrls" : { },
"displayName" : "string",
"name" : "string",
"active" : "boolean",
"timeZone" : "string",
"key" : "string"
},
"group" : {
"name" : "string"
}
} ]
},
"jql" : "string",
"editable" : "boolean",
"name" : "string",
"viewUrl" : "uri",
"description" : "string",
"searchUrl" : "uri",
"id" : "string",
"sharePermissions" : [ {
"view" : "Required boolean",
"role" : {
"actors" : [ {
"avatarUrl" : "uri",
"displayName" : "string",
"name" : "string",
"id" : "integer",
"type" : "string"
} ],
"name" : "string",
"description" : "string",
"id" : "integer"
},
"edit" : "Required boolean",
"project" : {
"components" : [ {
"archived" : "boolean",
"leadUserName" : "string",
"isAssigneeTypeValid" : "Required boolean",
"realAssigneeType" : "string. Possible values: PROJECT_DEFAULT | COMPONENT_LEAD | PROJECT_LEAD | UNASSIGNED",
"name" : "string",
"description" : "string",
"project" : "string",
"realAssignee" : {
"emailAddress" : "string",
"avatarUrls" : { },
"displayName" : "string",
"name" : "string",
"active" : "boolean",
"timeZone" : "string",
"key" : "string"
},
"assigneeType" : "string. Possible values: PROJECT_DEFAULT | COMPONENT_LEAD | PROJECT_LEAD | UNASSIGNED",
"assignee" : {
"emailAddress" : "string",
"avatarUrls" : { },
"displayName" : "string",
"name" : "string",
"active" : "boolean",
"timeZone" : "string",
"key" : "string"
},
"projectId" : "integer",
"lead" : {
"emailAddress" : "string",
"avatarUrls" : { },
"displayName" : "string",
"name" : "string",
"active" : "boolean",
"timeZone" : "string",
"key" : "string"
}
} ],
"avatarUrls" : { },
"roles" : { },
"description" : "string",
"lead" : {
"emailAddress" : "string",
"avatarUrls" : { },
"displayName" : "string",
"name" : "string",
"active" : "boolean",
"timeZone" : "string",
"key" : "string"
},
"url" : "string",
"issueTypes" : [ {
"avatarId" : "integer",
"name" : "string",
"description" : "string",
"id" : "string",
"iconUrl" : "string",
"subtask" : "Required boolean"
} ],
"archived" : "boolean",
"versions" : [ {
"description" : "string",
"project" : "string",
"archived" : "boolean",
"operations" : [ {
"weight" : "integer",
"id" : "string",
"label" : "string",
"href" : "string",
"styleClass" : "string",
"title" : "string",
"iconClass" : "string"
} ],
"overdue" : "boolean",
"remotelinks" : [ {
"name" : "string",
"link" : { }
} ],
"name" : "string",
"moveUnfixedIssuesTo" : "uri",
"userReleaseDate" : "string",
"id" : "string",
"userStartDate" : "string",
"projectId" : "integer",
"released" : "boolean"
} ],
"projectCategory" : {
"name" : "string",
"description" : "string",
"id" : "string"
},
"name" : "string",
"id" : "string",
"assigneeType" : "string. Possible values: PROJECT_LEAD | UNASSIGNED",
"projectKeys" : [ "string" ],
"projectTypeKey" : "string",
"key" : "string",
"email" : "string"
},
"id" : "integer",
"type" : "string",
"user" : {
"emailAddress" : "string",
"avatarUrls" : { },
"displayName" : "string",
"name" : "string",
"active" : "boolean",
"timeZone" : "string",
"key" : "string"
},
"group" : {
"name" : "string"
}
} ],
"favourite" : "boolean"
}
expand
the parameters to expand
Type: string
edit_issue
Edits an issue from a JSON representation. The issue can either be updated by setting explicit the field value(s) or by using an operation to change the field value. The fields that can be updated, in either the fields parameter or the update parameter, can be determined using the /rest/api/2/issue/{issueIdOrKey}/editmeta resource. Field should appear either in "fields" or "update", not in both.
Parameters
issueIdOrKey (required)
the issue id or key to update (i.e. JRA-1330)
Type: string
$body
Type: object
{
"historyMetadata" : {
"emailDescription" : "string",
"actor" : {
"avatarUrl" : "string",
"displayName" : "string",
"id" : "string",
"type" : "string",
"displayNameKey" : "string",
"url" : "string"
},
"extraData" : { },
"activityDescriptionKey" : "string",
"emailDescriptionKey" : "string",
"descriptionKey" : "string",
"description" : "string",
"generator" : {
"avatarUrl" : "string",
"displayName" : "string",
"id" : "string",
"type" : "string",
"displayNameKey" : "string",
"url" : "string"
},
"cause" : {
"avatarUrl" : "string",
"displayName" : "string",
"id" : "string",
"type" : "string",
"displayNameKey" : "string",
"url" : "string"
},
"activityDescription" : "string",
"type" : "string"
},
"update" : { },
"fields" : { },
"transition" : {
"name" : "The name of the issue transition.",
"id" : "The ID of the issue transition. Required when specifying a transition to undertake.",
"to" : {
"statusColor" : "string",
"name" : "string",
"description" : "string",
"iconUrl" : "string",
"id" : "string",
"statusCategory" : {
"colorName" : "string",
"name" : "string",
"id" : "integer",
"key" : "string"
}
},
"fields" : {
"schema" : {
"system" : "string",
"custom" : "string",
"type" : "string",
"items" : "string",
"customId" : "integer"
},
"hasDefaultValue" : "boolean",
"allowedValues" : [ { } ],
"operations" : [ "string" ],
"name" : "string",
"autoCompleteUrl" : "string",
"required" : "Required boolean"
}
},
"properties" : [ {
"value" : { },
"key" : "string"
} ]
}
notifyUsers
send the email with notification that the issue was updated to users that watch it. Admin or project admin permissions are required to disable the notification.
Type: boolean
expand_attachment_for_humans
Tries to expand an attachment. Output is human-readable and subject to change.
Parameters
id (required)
the id of the attachment to expand.
Type: string
expand_attachment_for_machines
Tries to expand an attachment. Output is raw and should be backwards-compatible through the course of time.
Parameters
id (required)
the id of the attachment to expand.
Type: string
find_assignable_users
Returns a list of users that match the search string. This resource cannot be accessed anonymously. Please note that this resource should be called with an issue key when a list of assignable users is retrieved for editing. For create only a project key should be supplied. The list of assignable users may be incorrect if it's called with the project key for editing.
Parameters
actionDescriptorId
Type: integer
issueKey
the issue key for the issue being edited we need to find assignable users for.
Type: string
maxResults
the maximum number of users to return (defaults to 50). The maximum allowed value is 1000. If you specify a value that is higher than this number, your search results will be truncated.
Type: integer
project
the key of the project we are finding assignable users for
Type: string
startAt
the index of the first user to return (0-based)
Type: integer
username
the username
Type: string
find_groups
Returns groups with substrings matching a given query. This is mainly for use with the group picker, so the returned groups contain html to be used as picker suggestions. The groups are also wrapped in a single response object that also contains a header for use in the picker, specifically Showing X of Y matching groups. The groups will be unique and sorted.
Parameters
exclude
Type: string
maxResults
Type: integer
query
a String to match groups agains
Type: string
userName
Type: string
find_users
Returns a list of users that match the search string. This resource cannot be accessed anonymously.
Parameters
includeActive
If true, then active users are included in the results (default true)
Type: boolean
includeInactive
If true, then inactive users are included in the results (default false)
Type: boolean
maxResults
the maximum number of users to return (defaults to 50). The maximum allowed value is 1000. If you specify a value that is higher than this number, your search results will be truncated.
Type: integer
startAt
the index of the first user to return (0-based)
Type: integer
username
A query string used to search username, name or e-mail address
Type: string
find_users_and_groups
Returns a list of users and groups matching query with highlighting. This resource cannot be accessed anonymously.
Parameters
fieldId
The custom field id, if this request comes from a custom field, such as a user picker. Optional.
Type: string
issueTypeId
The list of issue type ids to further restrict the search. This parameter can occur multiple times to pass in multiple issue type ids. Comma separated value is not supported. Special values such as -1 (all standard issue types), -2 (all subtask issue types) are supported. This parameter is only used when fieldId is present.
Type: string
maxResults
the maximum number of users to return (defaults to 50). The maximum allowed value is 1000. If you specify a value that is higher than this number, your search results will be truncated.
Type: integer
projectId
The list of project ids to further restrict the search This parameter can occur multiple times to pass in multiple project ids. Comma separated value is not supported. This parameter is only used when fieldId is present.
Type: string
query
A string used to search username, Name or e-mail address
Type: string
showAvatar
Type: boolean
find_users_for_picker
Returns a list of users matching query with highlighting. This resource cannot be accessed anonymously.
Parameters
exclude
Type: string
maxResults
the maximum number of users to return (defaults to 50). The maximum allowed value is 1000. If you specify a value that is higher than this number, your search results will be truncated.
Type: integer
query
A string used to search username, Name or e-mail address
Type: string
showAvatar
Type: boolean
find_users_with_all_permissions
Returns a list of active users that match the search string and have all specified permissions for the project or issue.
Parameters
issueKey
the issue key for the issue for which returned users have specified permissions.
Type: string
maxResults
the maximum number of users to return (defaults to 50). The maximum allowed value is 1000. If you specify a value that is higher than this number, your search results will be truncated.
Type: integer
permissions
comma separated list of permissions for project or issue returned users must have.
Type: string
projectKey
the optional project key to search for users with if no issueKey is supplied.
Type: string
startAt
the index of the first user to return (0-based)
Type: integer
username
the username filter, list includes all users if unspecified
Type: string
find_users_with_browse_permission
Returns a list of active users that match the search string. This resource cannot be accessed anonymously and requires the Browse Users global permission. Given an issue key this resource will provide a list of users that match the search string and have the browse issue permission for the issue provided.
Parameters
issueKey
the issue key for the issue being edited we need to find viewable users for.
Type: string
maxResults
the maximum number of users to return (defaults to 50). The maximum allowed value is 1000. If you specify a value that is higher than this number, your search results will be truncated.
Type: integer
projectKey
the optional project key to search for users with if no issueKey is supplied.
Type: string
startAt
the index of the first user to return (0-based)
Type: integer
username
the username filter, no users returned if left blank
Type: string
fully_update_role
Fully updates a roles. Both name and description must be given.
Parameters
id (required)
Type: integer
$body
Type: object
{
"name" : "string",
"description" : "string"
}
get_accessible_project_type
Returns the project type with the given key, if it is accessible to the logged in user. This takes into account whether the user is licensed on the Application that defines the project type.
Parameters
projectTypeKey (required)
Type: string
get_actors_for_role
Gets default actors for the given role.
Parameters
id (required)
the role id to remove the actors from
Type: integer
get_advanced_settings
This operation has no parameters
get_application_properties
Returns an application property.
Parameters
key
a String containing the property key
Type: string
keyFilter
when fetching a list allows the list to be filtered by the property's start of key. e.g. "jira.lf.*" whould fetch only those permissions that are editable and whose keys start with "jira.lf.". This is a regex.
Type: string
permissionLevel
When fetching a list specifies the permission level of all items in the list.
Type: string
get_application_role
Returns the ApplicationRole with passed key if it exists.
Parameters
key (required)
the key of the role to update.
Type: string
get_attachment
Returns the meta-data for an attachment, including the URI of the actual attached file.
Parameters
id (required)
id of the attachment to remove
Type: string
get_attachment_meta
This operation has no parameters
get_audit_records
Returns auditing records filtered using provided parameters
Parameters
filter
- text query; each record that will be returned must contain the provided text in one of its fields
Type: string
from
- timestamp in past; 'from' must be less or equal 'to', otherwise the result set will be empty only records that where created in the same moment or after the 'from' timestamp will be provided in response
Type: string
limit
- maximum number of returned results (if is limit is <= 0 or > 1000, it will be set do default value: 1000)
Type: integer
offset
- the number of record from which search starts
Type: integer
projectIds
- list of project ids to look for
Type: string
to
- timestamp in past; 'from' must be less or equal 'to', otherwise the result set will be empty only records that where created in the same moment or earlier than the 'to' timestamp will be provided in response
Type: string
userIds
- list of user ids to look for
Type: string
get_available_jmx_metrics
This operation has no parameters
get_comment
Returns a single comment.
Parameters
id (required)
the ID of the comment to request
Type: string
issueIdOrKey (required)
of the issue the comment belongs to
Type: string
expand
optional flags: renderedBody (provides body rendered in HTML)
Type: string
get_comment_property
Returns the value of the property with a given key from the comment identified by the key or by the id. The user who retrieves the property is required to have permissions to read the comment.
Parameters
commentId (required)
the comment from which keys will be returned.
Type: string
propertyKey (required)
the key of the property to return.
Type: string
get_component
Returns a project component.
Parameters
id (required)
The component to delete.
Type: string
get_component_related_issues
Returns counts of issues related to this component.
Parameters
id (required)
a String containing the component id
Type: string
get_configuration
This operation has no parameters
get_create_issue_meta
Returns the meta data for creating issues. This includes the available projects, issue types and fields, including field types and whether or not those fields are required. Projects will not be returned if the user does not have permission to create issues in that project.
Parameters
issuetypeIds
combinded with issuetypeNames, lists the issue types with which to filter the results. If null, all issue types are returned. This parameter can be specified multiple times, and/or be a comma-separated list. Specifiying an issue type that does not exist is not an error.
Type: string
issuetypeNames
combinded with issuetypeIds, lists the issue types with which to filter the results. If null, all issue types are returned. This parameter can be specified multiple times, but is NOT interpreted as a comma-separated list. Specifiying an issue type that does not exist is not an error.
Type: string
projectIds
Combined with the projectKeys param, lists the projects with which to filter the results. If absent, all projects are returned. This parameter can be specified multiple times, and/or be a comma-separated list. Specifiying a project that does not exist (or that you cannot create issues in) is not an error, but it will not be in the results.
Type: string
projectKeys
Combined with the projectIds param, lists the projects with which to filter the results. If null, all projects are returned. This parameter can be specified multiple times, and/or be a comma-separated list. Specifiying a project that does not exist (or that you cannot create issues in) is not an error, but it will not be in the results.
Type: string
get_current_user
This operation has no parameters
get_custom_field_option
Returns a full representation of the Custom Field Option that has the given id.
Parameters
id (required)
a String containing an Custom Field Option id
Type: string
get_dashboard
Returns a single dashboard.
Parameters
id (required)
the dashboard id
Type: string
get_dashboard_item_property
Returns the value of the property with a given key from the dashboard item identified by the id. The user who retrieves the property is required to have permissions to read the dashboard item.
Parameters
dashboardId (required)
Type: string
itemId (required)
the dashboard item from which keys will be returned.
Type: string
propertyKey (required)
the key of the property to return.
Type: string
get_default_share_scope
This operation has no parameters
get_default_workflow_for_draft_scheme
Return the default workflow from the passed draft workflow scheme to the caller.
Parameters
id (required)
the id of the parent scheme.
Type: integer
get_default_workflow_for_scheme
Return the default workflow from the passed workflow scheme.
Parameters
id (required)
the id of the scheme.
Type: integer
returnDraftIfExists
when true indicates that a scheme's draft, if it exists, should be queried instead of the scheme itself.
Type: boolean
get_deleted_worklogs
Returns worklogs id and delete time of worklogs that was deleted since given time. The returns set of worklogs is limited to 1000 elements. This API will not return worklogs deleted during last minute.
Parameters
since
a date time in unix timestamp format since when deleted worklogs will be returned.
Type: integer
get_draft_workflow_mapping
Returns the draft workflow mappings or requested mapping to the caller.
Parameters
id (required)
the id of the parent scheme.
Type: integer
workflowName
the workflow mapping to return. Null can be passed to return all mappings. Must be a valid workflow name.
Type: string
get_draft_workflow_scheme
Returns the requested draft workflow scheme to the caller.
Parameters
id (required)
the id of the parent scheme.
Type: integer
get_edit_issue_meta
Returns the meta data for editing an issue.
The fields in the editmeta correspond to the fields in the edit screen for the issue. Fields not in the screen will not be in the editmeta.
Parameters
issueIdOrKey (required)
the issue whose edit meta data you want to view
Type: string
get_favourite_filters
Returns the favourite filters of the logged-in user.
Parameters
expand
the parameters to expand
Type: string
get_filter
Returns a filter given an id
Parameters
id (required)
the id of the filter being looked up
Type: integer
expand
the parameters to expand
Type: string
get_filter_columns
Returns the default columns for the given filter. Currently logged in user will be used as the user making such request.
Parameters
id (required)
id of the filter
Type: integer
get_filter_share_permission
Returns a single share permission of the given filter.
Parameters
id (required)
Type: integer
permissionId (required)
Type: integer
get_group
Returns REST representation for the requested group. Allows to get list of active users belonging to the specified group and its subgroups if "users" expand option is provided. You can page through users list by using indexes in expand param. For example to get users from index 10 to index 15 use "users[10:15]" expand value. This will return 6 users (if there are at least 16 users in this group). Indexes are 0-based and inclusive. This resource is deprecated, please use group/member API instead.
Parameters
expand
List of fields to expand. Currently only available expand is "users".
Type: string
groupname
A name of requested group.
Type: string
get_index_summary
This operation has no parameters
get_issue
Returns a full representation of the issue for the given issue key.
Parameters
issueIdOrKey (required)
the issue id or key to update (i.e. JRA-1330)
Type: string
expand
Type: string
fields
the list of fields to return for the issue. By default, all fields are returned.
Type: string
properties
the list of properties to return for the issue. By default no properties are returned.
Type: string
get_issue_link
Returns an issue link with the specified id.
Parameters
linkId (required)
the issue link id.
Type: string
get_issue_link_type
Returns for a given issue link type id all information about this issue link type.
Parameters
issueLinkTypeId (required)
Type: string
get_issue_picker_resource
Returns suggested issues which match the auto-completion query for the user which executes this request. This REST method will check the user's history and the user's browsing context and select this issues, which match the query.
Parameters
currentIssueKey
the key of the issue in context of which the request is executed. The issue which is in context will not be included in the auto-completion result, even if it matches the query.
Type: string
currentJQL
the JQL in context of which the request is executed. Only issues which match this JQL query will be included in results.
Type: string
currentProjectId
the id of the project in context of which the request is executed. Suggested issues will be only from this project.
Type: string
query
the query.
Type: string
showSubTaskParent
if set to false and request is executed in context of a subtask, the parent issue will not be included in the auto-completion result, even if it matches the query.
Type: boolean
showSubTasks
if set to false, subtasks will not be included in the list.
Type: boolean
get_issue_property
Returns the value of the property with a given key from the issue identified by the key or by the id. The user who retrieves the property is required to have permissions to read the issue.
Parameters
issueIdOrKey (required)
the issue from which keys will be returned.
Type: string
propertyKey (required)
the key of the property to return.
Type: string
get_issue_security_scheme
Returns the issue security scheme along with that are defined.
Parameters
id (required)
Type: integer
get_issue_security_scheme_for_project
Returns the issue security scheme for project.
Parameters
projectKeyOrId (required)
Type: string
get_issue_type
Returns a full representation of the issue type that has the given id.
Parameters
id (required)
the id of the issue type to update.
Type: string
get_issue_type_for_draft_scheme
Returns the issue type mapping for the passed draft workflow scheme.
Parameters
id (required)
the id of the parent scheme.
Type: integer
issueType (required)
the issue type being set.
Type: string
get_issue_type_for_scheme
Returns the issue type mapping for the passed workflow scheme.
Parameters
id (required)
the id of the scheme.
Type: integer
issueType (required)
the issue type being set.
Type: string
returnDraftIfExists
when true indicates that a scheme's draft, if it exists, should be queried instead of the scheme itself.
Type: boolean
get_issue_type_property
Returns the value of the property with a given key from the issue type identified by the id. The user who retrieves the property is required to have permissions to view the issue type.
Parameters
issueTypeId (required)
the issue type from which the keys will be returned
Type: string
propertyKey (required)
the key of the property to return
Type: string
get_issue_worklog
Returns a specific worklog. Note: The work log won't be returned if the Log work field is hidden for the project.
Parameters
id (required)
id of the worklog to be deleted
Type: string
issueIdOrKey (required)
a string containing the issue id or key the worklog belongs to
Type: string
get_issuesecuritylevel
Returns a full representation of the security level that has the given id.
Parameters
id (required)
a String containing an issue security level id
Type: string
get_jql_auto_complete
This operation has no parameters
get_jql_auto_complete_suggestions
Returns auto complete suggestions for JQL search.
Parameters
fieldName
the field name for which the suggestions are generated.
Type: string
fieldValue
the portion of the field value that has already been provided by the user.
Type: string
predicateName
the predicate for which the suggestions are generated. Suggestions are generated only for: "by", "from" and "to".
Type: string
predicateValue
the portion of the predicate value that has already been provided by the user.
Type: string
get_notification_sceheme
Returns a full representation of the notification scheme for the given id. This resource will return a notification scheme containing a list of events and recipient configured to receive notifications for these events. Consumer should allow events without recipients to appear in response. User accessing the data is required to have permissions to administer at least one project associated with the requested notification scheme.
Parameters
id (required)
an id of the notification scheme to retrieve
Type: integer
expand
Type: string
get_notification_scheme_for_project
Gets a notification scheme associated with the project. Follow the documentation of /notificationscheme/{id} resource for all details about returned value.
Parameters
projectKeyOrId (required)
key or id of the project
Type: string
expand
Type: string
get_password_policy
Returns the list of requirements for the current password policy. For example, "The password must have at least 10 characters.", "The password must not be similar to the user's name or email address.", etc.
Parameters
hasOldPassword
whether or not the user will be required to enter their current password. Use {@code false} (the default) if this is a new user or if an administrator is forcibly changing another user's password.
Type: boolean
get_permission_scheme
Returns a permission scheme identified by the given id.
Parameters
schemeId (required)
Type: integer
expand
Type: string
get_permission_scheme_attribute
Get the value of an attribute for a permission scheme specified by permission scheme id.
Parameters
attributeKey (required)
permission scheme attribute key
Type: string
permissionSchemeId (required)
permission scheme id
Type: integer
get_permission_scheme_for_project
Gets a permission scheme assigned with a project.
Parameters
projectKeyOrId (required)
key or id of the project
Type: string
expand
Type: string
get_permission_scheme_grant
Returns a permission grant identified by the given id.
Parameters
permissionId (required)
Type: integer
schemeId (required)
Type: integer
expand
Type: string
get_preference
Returns preference of the currently logged in user. Preference key must be provided as input parameter (key). The value is returned exactly as it is. If key parameter is not provided or wrong - status code 404. If value is found - status code 200.
Parameters
key
- key of the preference to be returned.
Type: string
get_priority
Returns an issue priority.
Parameters
id (required)
a String containing the priority id
Type: string
get_project
Contains a full representation of a project in JSON format. All project keys associated with the project will only be returned if expand=projectKeys.
Parameters
projectIdOrKey (required)
the project id or project key
Type: string
expand
the parameters to expand
Type: string
get_project_category
Contains a representation of a project category in JSON format.
Parameters
id (required)
Type: integer
get_project_property
Returns the value of the property with a given key from the project identified by the key or by the id. The user who retrieves the property is required to have permissions to read the project.
Parameters
projectIdOrKey (required)
the project from which keys will be returned.
Type: string
propertyKey (required)
the key of the property to return.
Type: string
get_project_role
Returns the details for a given project role in a project.
Parameters
id (required)
the project role id
Type: integer
projectIdOrKey (required)
the project id or project key
Type: string
get_project_type
Returns the project type with the given key.
Parameters
projectTypeKey (required)
Type: string
get_reindex_info
Returns information on the system reindexes. If a reindex is currently taking place then information about this reindex is returned. If there is no active index task, then returns information about the latest reindex task run, otherwise returns a 404 indicating that no reindex has taken place.
Parameters
taskId
the id of an indexing task you wish to obtain details on. If omitted, then defaults to the standard behaviour and returns information on the active reindex task, or the last task to run if no reindex is taking place. If there is no reindexing task with that id then a 404 is returned.
Type: integer
get_reindex_progress
Returns information on the system reindexes. If a reindex is currently taking place then information about this reindex is returned. If there is no active index task, then returns information about the latest reindex task run, otherwise returns a 404 indicating that no reindex has taken place.
Parameters
taskId
the id of an indexing task you wish to obtain details on. If omitted, then defaults to the standard behaviour and returns information on the active reindex task, or the last task to run if no reindex is taking place. If there is no reindexing task with that id then a 404 is returned.
Type: integer
get_reindex_request_progress
Retrieves the progress of a single reindex request.
Parameters
requestId (required)
the reindex request ID.
Type: integer
get_remote_issue_link
A REST sub-resource representing the remote issue links on the issue.
Parameters
issueIdOrKey (required)
the issue to create the remote issue link for
Type: string
globalId
The id of the remote issue link to be returned. If null (not provided) all remote links for the issue are returned.
Type: string
get_remote_issue_link_by_id
Get the remote issue link with the given id on the issue.
Parameters
issueIdOrKey (required)
the issue to create the remote issue link for
Type: string
linkId (required)
the id of the remote issue link
Type: string
get_remote_version_link_by_global_id
A REST sub-resource representing a remote version link
Parameters
globalId (required)
The global ID of the remote link
Type: string
versionId (required)
The version ID of the remote link
Type: string
get_remote_version_links
Returns the remote version links for a given global ID.
Parameters
globalId
the global ID of the remote resource that is linked to the versions
Type: string
get_remote_version_links_by_version_id
Returns the remote version links associated with the given version ID.
Parameters
versionId (required)
The version for which to delete ALL existing remote version links
Type: string
get_resolution
Returns a resolution.
Parameters
id (required)
a String containing the resolution id
Type: string
get_role
Get a specific ProjectRole available in JIRA.
Parameters
id (required)
Type: integer
get_server_info
Returns general information about the current JIRA server.
Parameters
doHealthCheck
Type: boolean
get_status
Returns a full representation of the Status having the given id or name.
Parameters
idOrName (required)
a numeric Status id or a status name
Type: string
get_status_category
Returns a full representation of the StatusCategory having the given id or key
Parameters
idOrKey (required)
a numeric StatusCategory id or a status category key
Type: string
get_sub_tasks
Returns an issue's subtask list
Parameters
issueIdOrKey (required)
The parent issue's key or id
Type: string
get_transitions
Get a list of the transitions possible for this issue by the current user, along with fields that are required and their types. Fields will only be returned if expand=transitions.fields. The fields in the metadata correspond to the fields in the transition screen for that transition.
Parameters
issueIdOrKey (required)
the issue whose transitions you want to view
Type: string
transitionId
Type: string
get_upgrade_task_result
This operation has no parameters
get_user
Returns a user. This resource cannot be accessed anonymously.
Parameters
key
user key
Type: string
username
the username
Type: string
get_user_columns
Returns the default columns for the given user. Admin permission will be required to get columns for a user other than the currently logged in user.
Parameters
username
username
Type: string
get_user_property
Returns the value of the property with a given key from the user identified by the key or by the id. The user who retrieves the property is required to have permissions to read the user.
Parameters
propertyKey (required)
Type: string
userKey
key of the user whose property is to be returned
Type: string
username
username of the user whose property is to be returned
Type: string
get_users_from_group
This resource returns a paginated list of users who are members of the specified group and its subgroups. Users in the page are ordered by user names. User of this resource is required to have sysadmin or admin permissions.
Parameters
groupname
a name of the group for which members will be returned.
Type: string
includeInactiveUsers
inactive users will be included in the response if set to true.
Type: boolean
maxResults
the maximum number of users to return (max 50).
Type: integer
startAt
the index of the first user in group to return (0 based).
Type: integer
get_version
Returns a project version.
Parameters
id (required)
The version to delete
Type: string
expand
Type: string
get_version_related_issue_counts
Returns a bean containing the number of fixed in and affected issues for the given version.
Parameters
id (required)
a String containing the version id
Type: string
get_version_unresolved_issue_counts
Returns the number of unresolved issues for the given version
Parameters
id (required)
a String containing the version id
Type: string
get_votes
A REST sub-resource representing the voters on the issue.
Parameters
issueIdOrKey (required)
the issue to view voting information for
Type: string
get_workflow
Returns the workflow mappings or requested mapping to the caller for the passed scheme.
Parameters
id (required)
the id of the scheme.
Type: integer
returnDraftIfExists
when true indicates that a scheme's draft, if it exists, should be queried instead of the scheme itself.
Type: boolean
workflowName
the workflow mapping to return. Null can be passed to return all mappings. Must be a valid workflow name.
Type: string
get_workflow_scheme
Returns the requested workflow scheme to the caller.
Parameters
id (required)
the id of the scheme.
Type: integer
returnDraftIfExists
when true indicates that a scheme's draft, if it exists, should be queried instead of the scheme itself.
Type: boolean
get_worklogs_for_ids
Returns worklogs for given worklog ids. Only worklogs to which the calling user has permissions, will be included in the result. The returns set of worklogs is limited to 1000 elements.
Parameters
$body
Type: object
{
"ids" : [ "integer" ]
}
link_issues
Creates an issue link between two issues.
Parameters
$body
Type: object
{
"outwardIssue" : {
"id" : "string",
"fields" : {
"summary" : "string",
"issuetype" : {
"avatarId" : "integer",
"name" : "string",
"description" : "string",
"id" : "string",
"iconUrl" : "string",
"subtask" : "Required boolean"
},
"priority" : {
"statusColor" : "string",
"name" : "string",
"description" : "string",
"iconUrl" : "string",
"id" : "string"
},
"status" : {
"statusColor" : "string",
"name" : "string",
"description" : "string",
"iconUrl" : "string",
"id" : "string",
"statusCategory" : {
"colorName" : "string",
"name" : "string",
"id" : "integer",
"key" : "string"
}
}
},
"key" : "string"
},
"comment" : {
"renderedBody" : "string",
"visibility" : {
"type" : "string. Possible values: group | role",
"value" : "string"
},
"author" : {
"emailAddress" : "string",
"avatarUrls" : { },
"displayName" : "string",
"name" : "string",
"active" : "boolean",
"timeZone" : "string",
"key" : "string"
},
"created" : "string",
"updateAuthor" : {
"emailAddress" : "string",
"avatarUrls" : { },
"displayName" : "string",
"name" : "string",
"active" : "boolean",
"timeZone" : "string",
"key" : "string"
},
"id" : "string",
"body" : "string",
"updated" : "string",
"properties" : [ {
"value" : { },
"key" : "string"
} ]
},
"inwardIssue" : {
"id" : "string",
"fields" : {
"summary" : "string",
"issuetype" : {
"avatarId" : "integer",
"name" : "string",
"description" : "string",
"id" : "string",
"iconUrl" : "string",
"subtask" : "Required boolean"
},
"priority" : {
"statusColor" : "string",
"name" : "string",
"description" : "string",
"iconUrl" : "string",
"id" : "string"
},
"status" : {
"statusColor" : "string",
"name" : "string",
"description" : "string",
"iconUrl" : "string",
"id" : "string",
"statusCategory" : {
"colorName" : "string",
"name" : "string",
"id" : "integer",
"key" : "string"
}
}
},
"key" : "string"
},
"type" : {
"inward" : "string",
"name" : "string",
"id" : "string",
"outward" : "string"
}
}
list_alternative_issue_types
Returns a list of all alternative issue types for the given issue type id. The list will contain these issues types, to which issues assigned to the given issue type can be migrated. The suitable alternatives are issue types which are assigned to the same workflow, the same field configuration and the same screen scheme.
Parameters
id (required)
Type: string
list_application_roles
This operation has no parameters
list_available_fields
Gets available fields for screen. i.e ones that haven't already been added.
Parameters
screenId (required)
id of screen
Type: integer
list_comment_properties_keys
Returns the keys of all properties for the comment identified by the key or by the id.
Parameters
commentId (required)
the comment from which keys will be returned.
Type: string
list_comments
Returns all comments for an issue.
Parameters
issueIdOrKey (required)
a string containing the issue id or key the comment will be added to
Type: string
expand
optional flags: renderedBody (provides body rendered in HTML)
Type: string
maxResults
how many results on the page should be included. Defaults to 50.
Type: integer
orderBy
ordering of the results.
Type: string
startAt
the page offset, if not specified then defaults to 0
Type: integer
list_dashboard_item_properties_keys
Returns the keys of all properties for the dashboard item identified by the id.
Parameters
dashboardId (required)
Type: string
itemId (required)
the dashboard item from which keys will be returned.
Type: string
list_dashboards
Returns a list of all dashboards, optionally filtering them.
Parameters
filter
an optional filter that is applied to the list of dashboards. Valid values include "favourite" for returning only favourite dashboards, and "my" for returning dashboards that are owned by the calling user.
Type: string
maxResults
a hint as to the the maximum number of dashboards to return in each call. Note that the JIRA server reserves the right to impose a maxResults limit that is lower than the value that a client provides, dues to lack or resources or any other condition. When this happens, your results will be truncated. Callers should always check the returned maxResults to determine the value that is effectively being used.
Type: integer
startAt
the index of the first dashboard to return (0-based). must be 0 or a multiple of maxResults
Type: integer
list_fields
This operation has no parameters
list_fields_for_tab
Gets all fields for a given tab
Parameters
screenId (required)
id of screen
Type: integer
tabId (required)
id of tab
Type: integer
projectKey
the key of the project; this parameter is optional
Type: string
list_filter_share_permissions
Returns all share permissions of the given filter.
Parameters
id (required)
Type: integer
list_issue_link_types
This operation has no parameters
list_issue_navigator_default_columns
This operation has no parameters
list_issue_properties_keys
Returns the keys of all properties for the issue identified by the key or by the id.
Parameters
issueIdOrKey (required)
the issue from which keys will be returned.
Type: string
list_issue_security_schemes
This operation has no parameters
list_issue_type_properties_keys
Returns the keys of all properties for the issue type identified by the id.
Parameters
issueTypeId (required)
the issue type from which the keys will be returned
Type: string
list_issue_types
This operation has no parameters
list_issue_worklogs
Returns all work logs for an issue. Work logs won't be returned if the Log work field is hidden for the project.
Parameters
issueIdOrKey (required)
a string containing the issue id or key the worklog will be added to
Type: string
list_my_permissions
Returns all permissions in the system and whether the currently logged in user has them. You can optionally provide a specific context to get permissions for (projectKey OR projectId OR issueKey OR issueId)
Parameters
issueId
- id of the issue to scope returned permissions for.
Type: string
issueKey
- key of the issue to scope returned permissions for.
Type: string
projectId
- id of project to scope returned permissions for.
Type: string
projectKey
- key of project to scope returned permissions for.
Type: string
list_notification_schemes
Returns a paginated list of notification schemes. In order to access notification scheme, the calling user is required to have permissions to administer at least one project associated with the requested notification scheme. Each scheme contains a list of events and recipient configured to receive notifications for these events. Consumer should allow events without recipients to appear in response.
Parameters
expand
Type: string
maxResults
the maximum number of notification schemes to return (max 50).
Type: integer
startAt
the index of the first notification scheme to return (0 based).
Type: integer
list_permission_scheme_grants
Returns all permission grants of the given permission scheme.
Parameters
schemeId (required)
Type: integer
expand
Type: string
list_permission_schemes
Returns a list of all permission schemes. By default only shortened beans are returned. If you want to include permissions of all the schemes, then specify the permissions expand parameter. Permissions will be included also if you specify any other expand parameter.
Parameters
expand
Type: string
list_permissions
This operation has no parameters
list_priorities
This operation has no parameters
list_project_avatars
Returns all avatars which are visible for the currently logged in user. The avatars are grouped into system and custom.
Parameters
projectIdOrKey (required)
project id or project key
Type: string
list_project_categories
This operation has no parameters
list_project_components
Contains a full representation of a the specified project's components.
Parameters
projectIdOrKey (required)
the project id or project key
Type: string
list_project_properties_keys
Returns the keys of all properties for the project identified by the key or by the id.
Parameters
projectIdOrKey (required)
the project from which keys will be returned.
Type: string
list_project_roles
Returns all roles in the given project Id or key, with links to full details on each role.
Parameters
projectIdOrKey (required)
the project id or project key
Type: string
list_project_statuses
Get all issue types with valid status values for a project
Parameters
projectIdOrKey (required)
Project id or project key
Type: string
list_project_types
This operation has no parameters
list_project_versions
Contains a full representation of a the specified project's versions.
Parameters
projectIdOrKey (required)
the project id or project key
Type: string
expand
the parameters to expand
Type: string
list_project_versions_paginated
Returns all versions for the specified project. Results are paginated
Parameters
projectIdOrKey (required)
the project id or project key
Type: string
expand
the parameters to expand
Type: string
maxResults
how many results on the page should be included. Defaults to 50.
Type: integer
orderBy
ordering of the results.
Type: string
startAt
the page offset, if not specified then defaults to 0
Type: integer
list_projects
Returns all projects which are visible for the currently logged in user. If no user is logged in, it returns the list of projects that are visible when using anonymous access.
Parameters
expand
the parameters to expand
Type: string
recent
if this parameter is set then only projects recently accessed by the current user (if not logged in then based on HTTP session) will be returned (maximum count limited to the specified number but no more than 20).
Type: integer
list_resolutions
This operation has no parameters
list_roles
This operation has no parameters
list_security_levels_for_project
Returns all security levels for the project that the current logged in user has access to. If the user does not have the Set Issue Security permission, the list will be empty.
Parameters
projectKeyOrId (required)
- key or id of project to list the security levels for
Type: string
list_status_categories
This operation has no parameters
list_statuses
This operation has no parameters
list_system_avatars
Returns all system avatars of the given type.
Parameters
type (required)
the avatar type
Type: string
list_tabs
Returns a list of all tabs for the given screen
Parameters
screenId (required)
id of screen
Type: integer
projectKey
the key of the project; this parameter is optional
Type: string
list_universal_avatars
List universal Avatars visible to the current user.
Parameters
owningObjectId (required)
Type: string
type (required)
Type: string
list_user_avatars
Returns all avatars which are visible for the currently logged in user.
Parameters
username
username
Type: string
list_user_properties_keys
Returns the keys of all properties for the user identified by the key or by the id.
Parameters
userKey
key of the user whose properties are to be returned
Type: string
username
username of the user whose properties are to be returned
Type: string
list_watchers
Returns the list of watchers for the issue with the given key.
Parameters
issueIdOrKey (required)
a String containing an issue key.
Type: string
list_workflow_properties_keys
Return the property or properties associated with a transition.
Parameters
id (required)
the ID of the transition within the workflow.
Type: integer
includeReservedKeys
some keys under the "jira." prefix are editable, some are not. Set this to true in order to include the non-editable keys in the response.
Type: boolean
key
the name of the property key to query. Can be left off the query to return all properties.
Type: string
workflowMode
the type of workflow to use. Can either be "live" or "draft".
Type: string
workflowName
the name of the workflow to use.
Type: string
list_workflows
Returns all workflows.
Parameters
workflowName
Type: string
merge_versions
Merge versions
Parameters
id (required)
The version that will be merged to version {@code moveIssuesTo} and removed
Type: string
moveIssuesTo (required)
The version to set fixVersion to on issues where the deleted version is the fix version, If null then the fixVersion is removed.
Type: string
$body
Type: object
{ }
move_field_on_tab
Moves field on the given tab
Parameters
id (required)
Type: string
screenId (required)
id of screen
Type: integer
tabId (required)
id of tab
Type: integer
$body
Type: object
{
"after" : "uri",
"position" : "string. Possible values: Earlier | Later | First | Last"
}
move_sub_tasks
Reorders an issue's subtasks by moving the subtask at index "from" to index "to".
Parameters
issueIdOrKey (required)
The parent issue's key or id
Type: string
$body
Type: object
{
"current" : "Required integer",
"original" : "Required integer"
}
move_tab_position
Moves tab position
Parameters
pos (required)
position of tab
Type: integer
screenId (required)
id of screen
Type: integer
tabId (required)
id of tab
Type: integer
$body
Type: object
{ }
move_version
Modify a version's sequence within a project.
Parameters
id (required)
a String containing the version id
Type: string
$body
Type: object
{
"after" : "uri",
"position" : "string. Possible values: Earlier | Later | First | Last"
}
notify_about_issue
Sends a notification (email) to the list or recipients defined in the request.
Parameters
issueIdOrKey (required)
a string containing the issue id or key the comment will be added to
Type: string
$body
Type: object
{
"htmlBody" : "string",
"subject" : "string",
"textBody" : "string",
"to" : {
"voters" : "Required boolean",
"watchers" : "Required boolean",
"groups" : [ {
"name" : "string"
} ],
"reporter" : "Required boolean",
"assignee" : "Required boolean",
"users" : [ {
"emailAddress" : "string",
"avatarUrls" : "string",
"displayName" : "string",
"name" : "string",
"active" : "Required boolean",
"timeZone" : "string",
"key" : "string"
} ]
},
"restrict" : {
"permissions" : [ {
"id" : "string",
"key" : "string"
} ],
"groups" : [ {
"name" : "string"
} ]
}
}
partial_update_role
Partially updates a roles name or description.
Parameters
id (required)
Type: integer
$body
Type: object
{
"name" : "string",
"description" : "string"
}
process_reindex_requests
Executes any pending reindex requests. Returns a JSON array containing the IDs of the reindex requests that are being processed. Execution is asynchronous - progress of the returned tasks can be monitored through other REST calls.
Parameters
$body
Type: object
{ }
remove_attachment
Remove an attachment from an issue.
Parameters
id (required)
id of the attachment to remove
Type: string
remove_user_from_application
Remove user from given application. Admin permission will be required to perform this operation.
Parameters
applicationKey
application key
Type: string
username
username
Type: string
remove_vote
Remove your vote from an issue. (i.e. "unvote")
Parameters
issueIdOrKey (required)
the issue to view voting information for
Type: string
remove_watcher
Removes a user from an issue's watcher list.
Parameters
issueIdOrKey (required)
a String containing an issue key.
Type: string
username
a String containing the name of the user to remove from the watcher list. Must not be null.
Type: string
rename_tab
Renames tab on given screen
Parameters
screenId (required)
id of screen
Type: integer
tabId (required)
id of tab
Type: integer
$body
Type: object
{
"name" : "string",
"id" : "integer"
}
reset_filter_columns
Resets the columns for the given filter such that the filter no longer has its own column config.
Parameters
id (required)
id of the filter
Type: integer
reset_user_columns
Reset the default columns for the given user to the system default. Admin permission will be required to get columns for a user other than the currently logged in user.
Parameters
username
username
Type: string
run_upgrade_tasks
Runs any pending delayed upgrade tasks. Need Admin permissions to do this.
Parameters
$body
Type: object
{ }
search_for_issues
Searches for issues using JQL.
Parameters
expand
A comma-separated list of the parameters to expand.
Type: string
fields
the list of fields to return for each issue. By default, all navigable fields are returned.
Type: string
jql
a JQL query string
Type: string
maxResults
the maximum number of issues to return (defaults to 50). The maximum allowable value is dictated by the JIRA property 'jira.search.views.default.max'. If you specify a value that is higher than this number, your search results will be truncated.
Type: integer
startAt
the index of the first issue to return (0-based)
Type: integer
validateQuery
whether to validate the JQL query
Type: boolean
search_for_issues_using_post
Performs a search using JQL.
Parameters
$body
Type: object
{
"jql" : "A [JQL](https://confluence.atlassian.com/x/egORLQ) expression.",
"maxResults" : "The maximum number of items to return per page. The default is `50` and the maximum is `100`.",
"validateQuery" : "Determines how to validate the JQL query and treat the validation results. Supported values:\n\n * `true` Returns a 400 response code if any errors are found, along with a list of all errors (and warnings).\n * `false` Returns all errors as warnings.\n\nNote: If the JQL is not correctly formed a 400 response code is returned, regardless of the `validateQuery` value.",
"fields" : [ "string" ],
"startAt" : "The index of the first item to return in the page of results (page offset). The base index is `0`."
}
set_actors_for_project_role
Updates a project role to include the specified actors (users or groups).
Parameters
id (required)
the project role id
Type: integer
projectIdOrKey (required)
the project id or project key
Type: string
$body
Type: object
{ }
set_application_property
Modify an application property via PUT. The "value" field present in the PUT will override the existing value.
Parameters
id (required)
Type: string
$body
Type: object
{
"id" : "string",
"value" : "string"
}
set_base_url
Sets the base URL that is configured for this JIRA instance.
Parameters
$body
Type: string
set_comment_property
Sets the value of the specified comment's property. You can use this resource to store a custom data against the comment identified by the key or by the id. The user who stores the data is required to have permissions to administer the comment.
Parameters
commentId (required)
the comment from which keys will be returned.
Type: string
propertyKey (required)
the key of the property to return.
Type: string
$body
Type: object
{ }
set_dashboard_item_property
Sets the value of the specified dashboard item's property. You can use this resource to store a custom data against the dashboard item identified by the id. The user who stores the data is required to have permissions to administer the dashboard item.
Parameters
dashboardId (required)
Type: string
itemId (required)
the dashboard item from which keys will be returned.
Type: string
propertyKey (required)
the key of the property to return.
Type: string
$body
Type: object
{ }
set_default_share_scope
Sets the default share scope of the logged-in user. Available values are GLOBAL and PRIVATE.
Parameters
$body
Type: object
{
"scope" : "string. Possible values: GLOBAL | AUTHENTICATED | PRIVATE"
}
set_filter_columns
Sets the default columns for the given filter.
Parameters
id (required)
id of the filter
Type: integer
$body
Type: object
{ }
set_issue_navigator_default_columns
Sets the default system columns for issue navigator. Admin permission will be required.
Parameters
$body
Type: object
{ }
set_issue_property
Sets the value of the specified issue's property. You can use this resource to store a custom data against the issue identified by the key or by the id. The user who stores the data is required to have permissions to edit the issue.
Parameters
issueIdOrKey (required)
the issue from which keys will be returned.
Type: string
propertyKey (required)
the key of the property to return.
Type: string
$body
Type: object
{ }
set_issue_type_for_draft_scheme
Set the issue type mapping for the passed draft scheme. The passed representation can have its updateDraftIfNeeded flag set to true to indicate that the draft should be created/updated when the actual scheme cannot be edited.
Parameters
id (required)
the id of the parent scheme.
Type: integer
issueType (required)
the issue type being set.
Type: string
$body
Type: object
{
"issueType" : "string",
"workflow" : "string",
"updateDraftIfNeeded" : "boolean"
}
set_issue_type_for_scheme
Set the issue type mapping for the passed scheme. The passed representation can have its updateDraftIfNeeded flag set to true to indicate that the draft should be created/updated when the actual scheme cannot be edited.
Parameters
id (required)
the id of the scheme.
Type: integer
issueType (required)
the issue type being set.
Type: string
$body
Type: object
{
"issueType" : "string",
"workflow" : "string",
"updateDraftIfNeeded" : "boolean"
}
set_issue_type_property
Sets the value of the specified issue type's property.
Parameters
issueTypeId (required)
the issue type from which the keys will be returned
Type: string
propertyKey (required)
the key of the property to return
Type: string
$body
Type: object
{ }
set_permission_scheme_attribute
Updates or inserts the attribute for a permission scheme specified by permission scheme id. The attribute consists of the key and the value. The value will be converted to Boolean using Boolean#valueOf.
Parameters
attributeKey (required)
permission scheme attribute key
Type: string
permissionSchemeId (required)
permission scheme id
Type: integer
$body
Type: object
{ }
set_preference
Sets preference of the currently logged in user. Preference key must be provided as input parameters (key). Value must be provided as post body. If key or value parameter is not provided - status code 404. If preference is set - status code 204.
Parameters
$body
Type: object
{ }
key
- key of the preference to be set.
Type: string
set_project_property
Sets the value of the specified project's property. You can use this resource to store a custom data against the project identified by the key or by the id. The user who stores the data is required to have permissions to administer the project.
Parameters
projectIdOrKey (required)
the project from which keys will be returned.
Type: string
propertyKey (required)
the key of the property to return.
Type: string
$body
Type: object
{ }
set_user_columns
Sets the default columns for the given user. Admin permission will be required to get columns for a user other than the currently logged in user.
Parameters
$body
Type: object
{ }
set_user_property
Sets the value of the specified user's property. You can use this resource to store a custom data against the user identified by the key or by the id. The user who stores the data is required to have permissions to administer the user.
Parameters
propertyKey (required)
Type: string
$body
Type: object
{ }
userKey
key of the user whose property is to be set
Type: string
username
username of the user whose property is to be set
Type: string
start_exposing_jmx_metrics
This operation has no parameters
start_reindex
Kicks off a reindex. Need Admin permissions to perform this reindex.
Parameters
$body
Type: object
{ }
indexChangeHistory
Indicates that changeHistory should also be reindexed. Not relevant for foreground reindex, where changeHistory is always reindexed.
Type: boolean
indexComments
Indicates that comments should also be reindexed. Not relevant for foreground reindex, where comments are always reindexed.
Type: boolean
indexWorklogs
Indicates that changeHistory should also be reindexed. Not relevant for foreground reindex, where changeHistory is always reindexed.
Type: boolean
type
Case insensitive String indicating type of reindex. If omitted, then defaults to BACKGROUND_PREFERRED.
Type: string
start_reindex_issues
Reindexes one or more individual issues. Indexing is performed synchronously - the call returns when indexing of the issues has completed or a failure occurs. Use either explicitly specified issue IDs or a JQL query to select issues to reindex.
Parameters
$body
Type: object
{ }
indexChangeHistory
Indicates that changeHistory should also be reindexed.
Type: boolean
indexComments
Indicates that comments should also be reindexed.
Type: boolean
indexWorklogs
Indicates that changeHistory should also be reindexed.
Type: boolean
issueId
the IDs or keys of one or more issues to reindex.
Type: string
stop_exposing_jmx_metrics
This operation has no parameters
update_application_role
Updates the ApplicationRole with the passed data. Only the groups and default groups setting of the role may be updated. Requests to change the key or the name of the role will be silently ignored. Optional: If versionHash is passed through the If-Match header the request will be rejected if not the same as server
Parameters
key (required)
the key of the role to update.
Type: string
$body
Type: object
{
"numberOfSeats" : "integer",
"userCount" : "integer",
"userCountDescription" : "string",
"defaultGroups" : [ "string" ],
"hasUnlimitedSeats" : "boolean",
"name" : "string",
"groups" : [ "string" ],
"remainingSeats" : "integer",
"key" : "string",
"selectedByDefault" : "boolean",
"defined" : "boolean",
"platform" : "boolean"
}
If-Match
the hash of the version to update. Optional Param
Type: string
update_comment
Updates an existing comment using its JSON representation.
Parameters
id (required)
the ID of the comment to request
Type: string
issueIdOrKey (required)
of the issue the comment belongs to
Type: string
$body
Type: object
{
"renderedBody" : "The rendered version of the comment.",
"visibility" : {
"type" : "string. Possible values: group | role",
"value" : "string"
},
"author" : {
"emailAddress" : "string",
"avatarUrls" : { },
"displayName" : "string",
"name" : "string",
"active" : "boolean",
"timeZone" : "string",
"key" : "string"
},
"created" : "The date and time at which the comment was created.",
"updateAuthor" : {
"emailAddress" : "string",
"avatarUrls" : { },
"displayName" : "string",
"name" : "string",
"active" : "boolean",
"timeZone" : "string",
"key" : "string"
},
"self" : "The URL of the comment.",
"id" : "The ID of the comment.",
"body" : "The comment text.",
"updated" : "The date and time at which the comment was updated last.",
"properties" : [ {
"value" : { },
"key" : "string"
} ]
}
expand
optional flags: renderedBody (provides body rendered in HTML)
Type: string
update_component
Modify a component via PUT. Any fields present in the PUT will override existing values. As a convenience, if a field is not present, it is silently ignored. If leadUserName is an empty string ("") the component lead will be removed.
Parameters
id (required)
The component to delete.
Type: string
$body
Type: object
{
"archived" : "boolean",
"leadUserName" : "string",
"isAssigneeTypeValid" : "Required boolean",
"realAssigneeType" : "string. Possible values: PROJECT_DEFAULT | COMPONENT_LEAD | PROJECT_LEAD | UNASSIGNED",
"name" : "string",
"description" : "string",
"project" : "string",
"realAssignee" : {
"emailAddress" : "string",
"avatarUrls" : { },
"displayName" : "string",
"name" : "string",
"active" : "boolean",
"timeZone" : "string",
"key" : "string"
},
"assigneeType" : "string. Possible values: PROJECT_DEFAULT | COMPONENT_LEAD | PROJECT_LEAD | UNASSIGNED",
"assignee" : {
"emailAddress" : "string",
"avatarUrls" : { },
"displayName" : "string",
"name" : "string",
"active" : "boolean",
"timeZone" : "string",
"key" : "string"
},
"projectId" : "integer",
"lead" : {
"emailAddress" : "string",
"avatarUrls" : { },
"displayName" : "string",
"name" : "string",
"active" : "boolean",
"timeZone" : "string",
"key" : "string"
}
}
update_current_user
Modify currently logged user. The "value" fields present will override the existing value. Fields skipped in request will not be changed. Only email and display name can be change that way. Requires user password.
Parameters
$body
Type: object
{
"applicationKeys" : [ "string" ],
"notification" : "string",
"password" : "string",
"emailAddress" : "string",
"displayName" : "string",
"name" : "string",
"active" : "boolean",
"key" : "string"
}
update_current_user_password
Modify caller password.
Parameters
$body
Type: object
{
"password" : "string",
"currentPassword" : "string"
}
update_default_workflow_for_draft_scheme
Set the default workflow for the passed draft workflow scheme.
Parameters
id (required)
the id of the parent scheme.
Type: integer
$body
Type: object
{
"workflow" : "string",
"updateDraftIfNeeded" : "boolean"
}
update_default_workflow_for_scheme
Set the default workflow for the passed workflow scheme. The passed representation can have its updateDraftIfNeeded flag set to true to indicate that the draft should be created/updated when the actual scheme cannot be edited.
Parameters
id (required)
the id of the scheme.
Type: integer
$body
Type: object
{
"workflow" : "string",
"updateDraftIfNeeded" : "boolean"
}
update_draft_workflow_mapping
Update the draft scheme to include the passed mapping. The body is a representation of the workflow mapping. Values not passed are assumed to indicate no change for that field.
Parameters
id (required)
the id of the parent scheme.
Type: integer
$body
Type: object
{
"workflow" : "string",
"updateDraftIfNeeded" : "boolean",
"defaultMapping" : "boolean",
"issueTypes" : [ "string" ]
}
workflowName
the name of the workflow mapping to update.
Type: string
update_draft_workflow_scheme
Update a draft workflow scheme. The draft will created if necessary. The body is a representation of the workflow scheme. Values not passed are assumed to indicate no change for that field.
Parameters
id (required)
the id of the parent scheme.
Type: integer
$body
Type: object
{
"originalIssueTypeMappings" : { },
"defaultWorkflow" : "string",
"updateDraftIfNeeded" : "boolean",
"draft" : "boolean",
"name" : "string",
"originalDefaultWorkflow" : "string",
"description" : "string",
"lastModifiedUser" : {
"emailAddress" : "string",
"avatarUrls" : { },
"displayName" : "string",
"name" : "string",
"active" : "Required boolean",
"timeZone" : "string",
"groups" : {
"size" : "Required integer",
"max-results" : "integer",
"items" : [ {
"name" : "string"
} ]
},
"locale" : "string",
"key" : "string",
"applicationRoles" : {
"size" : "Required integer",
"max-results" : "integer",
"items" : [ {
"name" : "string"
} ]
}
},
"id" : "integer",
"lastModified" : "string",
"issueTypeMappings" : { },
"issueTypes" : { }
}
update_issue_link_type
Update the specified issue link type.
Parameters
issueLinkTypeId (required)
Type: string
$body
Type: object
{
"inward" : "string",
"name" : "string",
"id" : "string",
"outward" : "string"
}
update_issue_type
Updates the specified issue type from a JSON representation.
Parameters
id (required)
the id of the issue type to update.
Type: string
$body
Type: object
{
"avatarId" : "integer",
"name" : "string",
"description" : "string"
}
update_issue_worklog
Updates an existing worklog entry.
Parameters
id (required)
id of the worklog to be deleted
Type: string
issueIdOrKey (required)
a string containing the issue id or key the worklog belongs to
Type: string
$body
Type: object
{
"issueId" : "string",
"timeSpentSeconds" : "integer",
"visibility" : {
"type" : "string. Possible values: group | role",
"value" : "string"
},
"timeSpent" : "string",
"author" : {
"emailAddress" : "string",
"avatarUrls" : { },
"displayName" : "string",
"name" : "string",
"active" : "boolean",
"timeZone" : "string",
"key" : "string"
},
"created" : "string",
"updateAuthor" : {
"emailAddress" : "string",
"avatarUrls" : { },
"displayName" : "string",
"name" : "string",
"active" : "boolean",
"timeZone" : "string",
"key" : "string"
},
"comment" : "string",
"started" : "string",
"id" : "string",
"updated" : "string"
}
adjustEstimate
(optional) allows you to provide specific instructions to update the remaining time estimate of the issue.
Type: string
newEstimate
(required when "new" is selected for adjustEstimate) the new value for the remaining estimate field.
Type: string
update_permission_scheme
Updates a permission scheme. If the permissions list is present then it will be set in the permission scheme, which basically means it will overwrite any permission grants that existed in the permission scheme. Sending an empty list will remove all permission grants from the permission scheme.
Parameters
schemeId (required)
Type: integer
$body
Type: object
{
"permissions" : [ {
"holder" : {
"parameter" : "string",
"type" : "string"
},
"permission" : "string"
} ],
"name" : "string",
"description" : "string"
}
expand
Type: string
update_project
Updates a project. Only non null values sent in JSON will be updated in the project.
Parameters
projectIdOrKey (required)
the project id or project key
Type: string
$body
Type: object
{
"notificationScheme" : "integer",
"description" : "string",
"lead" : "string",
"url" : "string",
"projectTemplateKey" : "string",
"avatarId" : "integer",
"issueSecurityScheme" : "integer",
"name" : "string",
"permissionScheme" : "integer",
"assigneeType" : "string. Possible values: PROJECT_LEAD | UNASSIGNED",
"projectTypeKey" : "string",
"key" : "string",
"categoryId" : "integer"
}
expand
the parameters to expand in returned project
Type: string
update_project_avatar
Update project avatar
Parameters
projectIdOrKey (required)
Type: string
$body
Type: object
{
"owner" : "string",
"isDeletable" : "Required boolean",
"urls" : "string",
"isSystemAvatar" : "Required boolean",
"isSelected" : "Required boolean",
"id" : "string",
"selected" : "Required boolean"
}
update_project_category
Modify a project category via PUT. Any fields present in the PUT will override existing values. As a convenience, if a field is not present, it is silently ignored.
Parameters
id (required)
Type: integer
$body
Type: object
{
"name" : "string",
"description" : "string",
"id" : "string"
}
update_project_type
Updates the type of a project.
Parameters
newProjectTypeKey (required)
The key of the new project type
Type: string
projectIdOrKey (required)
identity of the project to update
Type: string
$body
Type: object
{ }
update_remote_issue_link
Updates a remote issue link from a JSON representation. Any fields not provided are set to null.
Parameters
issueIdOrKey (required)
the issue to create the remote issue link for
Type: string
linkId (required)
the id of the remote issue link
Type: string
$body
Type: object
{
"application" : {
"name" : "string",
"type" : "string"
},
"globalId" : "string",
"relationship" : "string",
"object" : {
"summary" : "string",
"icon" : {
"url16x16" : "string",
"link" : "string",
"title" : "string"
},
"title" : "string",
"url" : "string",
"status" : {
"icon" : {
"url16x16" : "string",
"link" : "string",
"title" : "string"
},
"resolved" : "boolean"
}
}
}
update_user
Modify user. The "value" fields present will override the existing value. Fields skipped in request will not be changed.
Parameters
$body
Type: object
{
"applicationKeys" : [ "string" ],
"notification" : "string",
"password" : "string",
"emailAddress" : "string",
"displayName" : "string",
"name" : "string",
"active" : "boolean",
"key" : "string"
}
key
user key
Type: string
username
the username
Type: string
update_user_avatar
Update user avatar
Parameters
$body
Type: object
{
"owner" : "string",
"isDeletable" : "Required boolean",
"urls" : "string",
"isSystemAvatar" : "Required boolean",
"isSelected" : "Required boolean",
"id" : "string",
"selected" : "Required boolean"
}
username
Type: string
update_version
Modify a version via PUT. Any fields present in the PUT will override existing values. As a convenience, if a field is not present, it is silently ignored.
Parameters
id (required)
The version to delete
Type: string
$body
Type: object
{
"description" : "string",
"project" : "string",
"archived" : "boolean",
"operations" : [ {
"weight" : "integer",
"id" : "string",
"label" : "string",
"href" : "string",
"styleClass" : "string",
"title" : "string",
"iconClass" : "string"
} ],
"overdue" : "boolean",
"remotelinks" : [ {
"name" : "string",
"link" : { }
} ],
"name" : "string",
"moveUnfixedIssuesTo" : "uri",
"userReleaseDate" : "string",
"id" : "string",
"userStartDate" : "string",
"projectId" : "integer",
"released" : "boolean"
}
update_workflow
Update the scheme to include the passed mapping. The body is a representation of the workflow mapping. Values not passed are assumed to indicate no change for that field. The passed representation can have its updateDraftIfNeeded flag set to true to indicate that the draft should be created/updated when the actual scheme cannot be edited.
Parameters
id (required)
the id of the scheme.
Type: integer
$body
Type: object
{
"workflow" : "string",
"updateDraftIfNeeded" : "boolean",
"defaultMapping" : "boolean",
"issueTypes" : [ "string" ]
}
workflowName
the name of the workflow mapping to update.
Type: string
update_workflow_property
Update/add new property to a transition. Trying to update a property that does not exist will result in a new property being added.
Parameters
id (required)
the ID of the transition within the workflow.
Type: integer
$body
Type: object
{
"key" : "string"
}
key
the name of the property to add.
Type: string
workflowMode
the type of workflow to use. Can either be "live" or "draft".
Type: string
workflowName
the name of the workflow to use.
Type: string
update_workflow_scheme
Update the passed workflow scheme. The body of the request is a representation of the workflow scheme. Values not passed are assumed to indicate no change for that field. The passed representation can have its updateDraftIfNeeded flag set to true to indicate that the draft should be created and/or updated when the actual scheme cannot be edited (e.g. when the scheme is being used by a project). Values not appearing the body will not be touched.
Parameters
id (required)
the id of the scheme.
Type: integer
$body
Type: object
{
"originalIssueTypeMappings" : { },
"defaultWorkflow" : "string",
"updateDraftIfNeeded" : "boolean",
"draft" : "boolean",
"name" : "string",
"originalDefaultWorkflow" : "string",
"description" : "string",
"lastModifiedUser" : {
"emailAddress" : "string",
"avatarUrls" : { },
"displayName" : "string",
"name" : "string",
"active" : "Required boolean",
"timeZone" : "string",
"groups" : {
"size" : "Required integer",
"max-results" : "integer",
"items" : [ {
"name" : "string"
} ]
},
"locale" : "string",
"key" : "string",
"applicationRoles" : {
"size" : "Required integer",
"max-results" : "integer",
"items" : [ {
"name" : "string"
} ]
}
},
"id" : "integer",
"lastModified" : "string",
"issueTypeMappings" : { },
"issueTypes" : { }
}
validate_license
A REST endpoint to provide simple validation services for a JIRA license. Typically used by the setup phase of the JIRA application. This will return an object with a list of errors as key, value pairs
Parameters
$body
Type: object
{ }
validate_project_key
Validates a project key.
Parameters
key
the project key
Type: string
zdu_acknowledge_errors
Acknowledge ZDU Upgrade Errors
Parameters
$body
Type: object
{ }
zdu_approve_upgrade
Approve ZDU Upgrade
Parameters
$body
Type: object
{ }
zdu_cancel_upgrade
Cancel ZDU Upgrade
Parameters
$body
Type: object
{ }
zdu_get_state
This operation has no parameters
zdu_set_ready_to_upgrade
Set ready for ZDU Upgrade
Parameters
$body
Type: object
{ }