Module jira
API
Definitions

ballerinax/jira Ballerina library
Overview
This is a generated connector for Jira Cloud platform API v2 OpenAPI specification.
Jira Cloud platform API provide capability to access Jira operations related to projects, issues and user related operations.
Prerequisites
Before using this connector in your Ballerina application, complete the following:
- Create Atlassian Account
- Obtaining tokens
- Log into Atlassian Account
- If you are using basic authentication navigate to
Account Settings
->Security and click
->Create and manage API tokens
and create API token. If you are using OAuth authentication navigate toAccount Settings
->Security and click
->Manage two-step verification
and create and obtain client credentials
Quickstart
Step 1: Import Jira module
First, import the ballerinax/jira module into the Ballerina project.
import ballerinax/jira;
Step 2: Configure the connection credentials.
jira:ClientConfig clientConfig = { auth : { username : "<your_atlassian_account_email>", password : "<atlassian_account_api_key>" } }; jira:Client myclient = check new (clientConfig, "https://<your_domain>.atlassian.net");
Step 3: Invoke connector operation
- You can use this function to get project by providing project key as a parameter.
jira:Project result = check myclient->getProject("<Project_Key>"); log:printInfo(result.toString());
- Use
bal run
command to compile and run the Ballerina program
Quick reference
- Get project using project key
jira:Project result = check myclient->getProject("<Project_Key>");
- List all projects
jira:ProjectArr result = check myclient->getAllProjects();
- Create a project
jira:CreateProjectDetails details = { name : "<Project_Name>", 'key : "<Project_Key>", projectTypeKey : "software", leadAccountId: "<Lead_Account_ID>" }; jira:ProjectIdentifiers result = check myclient->createProject(details);
Clients
jira: Client
This is a generated connector for Jira Cloud platform API OpenAPI specification. Jira Cloud platform API provide capability to access Jira operations related to projects, issues and user related operations.
Constructor
Gets invoked to initialize the connector
.
The connector initialization requires setting the API credentials.
Create an Atlassian Account
and obtain tokens by following this guide.
init (ConnectionConfig config, string serviceUrl)
- config ConnectionConfig - The configurations to be used when initializing the
connector
- serviceUrl string "https://your-domain.atlassian.net" - URL of the target service
createIssue
function createIssue(IssueUpdateDetails payload, boolean updateHistory) returns CreatedIssue|error
Create issue
Parameters
- payload IssueUpdateDetails - The request payload to create issue.
- updateHistory boolean (default false) - Whether the project in which the issue is created is added to the user's Recently viewed project list, as shown under Projects in Jira. When provided, the issue type and request type are added to the user's history for a project. These values are then used to provide defaults on the issue create screen.
Return Type
- CreatedIssue|error - Returned if the request is successful.
createIssues
function createIssues(IssuesUpdateBean payload) returns CreatedIssues|error
Bulk create issue
Parameters
- payload IssuesUpdateBean - The request payload to bulk create issue.
Return Type
- CreatedIssues|error - Returned if any of the issue or subtask creation requests were successful. A request may be unsuccessful when it: * is missing required fields. * contains invalid field values. * contains fields that cannot be set for the issue type. * is by a user who does not have the necessary permission. * is to create a subtype in a project different that of the parent issue. * is for a subtask when the option to create subtasks is disabled. * is invalid for any other reason.
getCreateIssueMeta
function getCreateIssueMeta(string[]? projectIds, string[]? projectKeys, string[]? issuetypeIds, string[]? issuetypeNames, string? expand) returns IssueCreateMetadata|error
Get create issue metadata
Parameters
- projectIds string[]? (default ()) - List of project IDs. This parameter accepts a comma-separated list. Multiple project IDs can also be provided using an ampersand-separated list. For example,
projectIds=10000,10001&projectIds=10020,10021
. This parameter may be provided withprojectKeys
.
- projectKeys string[]? (default ()) - List of project keys. This parameter accepts a comma-separated list. Multiple project keys can also be provided using an ampersand-separated list. For example,
projectKeys=proj1,proj2&projectKeys=proj3
. This parameter may be provided withprojectIds
.
- issuetypeIds string[]? (default ()) - List of issue type IDs. This parameter accepts a comma-separated list. Multiple issue type IDs can also be provided using an ampersand-separated list. For example,
issuetypeIds=10000,10001&issuetypeIds=10020,10021
. This parameter may be provided withissuetypeNames
.
- issuetypeNames string[]? (default ()) - List of issue type names. This parameter accepts a comma-separated list. Multiple issue type names can also be provided using an ampersand-separated list. For example,
issuetypeNames=name1,name2&issuetypeNames=name3
. This parameter may be provided withissuetypeIds
.
- expand string? (default ()) - Use expand to include additional information about issue metadata in the response. This parameter accepts
projects.issuetypes.fields
, which returns information about the fields in the issue creation screen for each issue type. Fields hidden from the screen are not returned. Use the information to populate thefields
andupdate
fields in Create issue and Create issues.
Return Type
- IssueCreateMetadata|error - Returned if the request is successful.
getIssue
function getIssue(string issueIdOrKey, string[]? fields, boolean fieldsByKeys, string? expand, string[]? properties, boolean updateHistory) returns IssueBean|error
Get issue
Parameters
- issueIdOrKey string - The ID or key of the issue.
- fields string[]? (default ()) - A list of fields to return for the issue. This parameter accepts a comma-separated list. Use it to retrieve a subset of fields. Allowed values: *
*all
Returns all fields. **navigable
Returns navigable fields. * Any issue field, prefixed with a minus to exclude. Examples: *summary,comment
Returns only the summary and comments fields. *-description
Returns all (default) fields except description. **navigable,-comment
Returns all navigable fields except comment. This parameter may be specified multiple times. For example,fields=field1,field2& fields=field3
. Note: All fields are returned by default. This differs from Search for issues using JQL (GET) and Search for issues using JQL (POST) where the default is all navigable fields.
- fieldsByKeys boolean (default false) - Whether fields in
fields
are referenced by keys rather than IDs. This parameter is useful where fields have been added by a connect app and a field's key may differ from its ID.
- expand string? (default ()) - Use expand to include additional information about the issues in the response. This parameter accepts a comma-separated list. Expand options include: *
renderedFields
Returns field values rendered in HTML format. *names
Returns the display name of each field. *schema
Returns the schema describing a field type. *transitions
Returns all possible transitions for the issue. *editmeta
Returns information about how each field can be edited. *changelog
Returns a list of recent updates to an issue, sorted by date, starting from the most recent. *versionedRepresentations
Returns a JSON array for each version of a field's value, with the highest number representing the most recent version. Note: When included in the request, thefields
parameter is ignored.
- properties string[]? (default ()) - A list of issue properties to return for the issue. This parameter accepts a comma-separated list. Allowed values: *
*all
Returns all issue properties. * Any issue property key, prefixed with a minus to exclude. Examples: **all
Returns all properties. **all,-prop1
Returns all properties exceptprop1
. *prop1,prop2
Returnsprop1
andprop2
properties. This parameter may be specified multiple times. For example,properties=prop1,prop2& properties=prop3
.
- updateHistory boolean (default false) - Whether the project in which the issue is created is added to the user's Recently viewed project list, as shown under Projects in Jira. This also populates the JQL issues search
lastViewed
field.
editIssue
function editIssue(string issueIdOrKey, IssueUpdateDetails payload, boolean notifyUsers, boolean overrideScreenSecurity, boolean overrideEditableFlag) returns json|error
Edit issue
Parameters
- issueIdOrKey string - The ID or key of the issue.
- payload IssueUpdateDetails - The request payload to edit issue.
- notifyUsers boolean (default true) - Whether a notification email about the issue update is sent to all watchers. To disable the notification, administer Jira or administer project permissions are required. If the user doesn't have the necessary permission the request is ignored.
- overrideScreenSecurity boolean (default false) - Whether screen security should be overridden to enable hidden fields to be edited. Available to Connect app users with admin permissions.
- overrideEditableFlag boolean (default false) - Whether screen security should be overridden to enable uneditable fields to be edited. Available to Connect app users with admin permissions.
Return Type
- json|error - Returned if the request is successful.
deleteIssue
Delete issue
Parameters
- issueIdOrKey string - The ID or key of the issue.
- deleteSubtasks string (default "false") - Whether the issue's subtasks are deleted when the issue is deleted.
assignIssue
Assign issue
Parameters
- issueIdOrKey string - The ID or key of the issue to be assigned.
- payload User - The request object with the user that the issue is assigned to.
Return Type
- json|error - Returned if the request is successful.
getChangeLogs
function getChangeLogs(string issueIdOrKey, int startAt, int maxResults) returns PageBeanChangelog|error
Get change logs
Parameters
- issueIdOrKey string - The ID or key of the issue.
- startAt int (default 0) - The index of the first item to return in a page of results (page offset).
- maxResults int (default 100) - The maximum number of items to return per page.
Return Type
- PageBeanChangelog|error - Returned if the request is successful.
getChangeLogsByIds
function getChangeLogsByIds(string issueIdOrKey, IssueChangelogIds payload) returns PageOfChangelogs|error
Get changelogs by IDs
Parameters
- issueIdOrKey string - The ID or key of the issue.
- payload IssueChangelogIds - The request payload to get changelogs by IDs.
Return Type
- PageOfChangelogs|error - Returned if the request is successful.
getEditIssueMeta
function getEditIssueMeta(string issueIdOrKey, boolean overrideScreenSecurity, boolean overrideEditableFlag) returns IssueUpdateMetadata|error
Get edit issue metadata
Parameters
- issueIdOrKey string - The ID or key of the issue.
- overrideScreenSecurity boolean (default false) - Whether hidden fields should be returned. Available to connect app users with admin permissions.
- overrideEditableFlag boolean (default false) - Whether non-editable fields should be returned. Available to connect app users with admin permissions.
Return Type
- IssueUpdateMetadata|error - Returned if the request is successful.
notify
function notify(string issueIdOrKey, Notification payload) returns json|error
Send notification for issue
Parameters
- issueIdOrKey string - ID or key of the issue that the notification is sent for.
- payload Notification - The request object for the notification and recipients.
Return Type
- json|error - Returned if the email is queued for sending.
getTransitions
function getTransitions(string issueIdOrKey, string? expand, string? transitionId, boolean skipRemoteOnlyCondition, boolean includeUnavailableTransitions, boolean sortByOpsBarAndStatus) returns Transitions|error
Get transitions
Parameters
- issueIdOrKey string - The ID or key of the issue.
- expand string? (default ()) - Use expand to include additional information about transitions in the response. This parameter accepts
transitions.fields
, which returns information about the fields in the transition screen for each transition. Fields hidden from the screen are not returned. Use this information to populate thefields
andupdate
fields in Transition issue.
- transitionId string? (default ()) - The ID of the transition.
- skipRemoteOnlyCondition boolean (default false) - Whether transitions with the condition Hide From User Condition are included in the response.
- includeUnavailableTransitions boolean (default false) - Whether details of transitions that fail a condition are included in the response
- sortByOpsBarAndStatus boolean (default false) - Whether the transitions are sorted by ops-bar sequence value first then category order (Todo, In Progress, Done) or only by ops-bar sequence value.
Return Type
- Transitions|error - Returned if the request is successful.
doTransition
function doTransition(string issueIdOrKey, IssueUpdateDetails payload) returns json|error
Transition issue
Parameters
- issueIdOrKey string - The ID or key of the issue.
- payload IssueUpdateDetails - The request payload to update the fields from the transition screen.
Return Type
- json|error - Returned if the request is successful.
bulkSetIssuesProperties
function bulkSetIssuesProperties(IssueEntityProperties payload) returns Response|error
Bulk set issues properties
Parameters
- payload IssueEntityProperties - Issue properties to be set or updated with values.
bulkSetIssueProperty
function bulkSetIssueProperty(string propertyKey, BulkIssuePropertyUpdateRequest payload) returns Response|error
Bulk set issue property
Parameters
- propertyKey string - The key of the property. The maximum length is 255 characters.
- payload BulkIssuePropertyUpdateRequest - The request payload to bulk set issue property.
bulkDeleteIssueProperty
Bulk delete issue property
Parameters
- propertyKey string - The key of the property.
getIssuePropertyKeys
function getIssuePropertyKeys(string issueIdOrKey) returns PropertyKeys|error
Get issue property keys
Parameters
- issueIdOrKey string - The key or ID of the issue.
Return Type
- PropertyKeys|error - Returned if the request is successful.
getIssueProperty
function getIssueProperty(string issueIdOrKey, string propertyKey) returns EntityProperty|error
Get issue property
Parameters
- issueIdOrKey string - The key or ID of the issue.
- propertyKey string - The key of the property.
Return Type
- EntityProperty|error - Returned if the request is successful.
setIssueProperty
Set issue property
Parameters
- issueIdOrKey string - The ID or key of the issue.
- propertyKey string - The key of the issue property. The maximum length is 255 characters.
- payload json - The request payload to set issue property.
Return Type
- json|error - Returned if the issue property is updated.
deleteIssueProperty
Delete issue property
Parameters
- issueIdOrKey string - The key or ID of the issue.
- propertyKey string - The key of the property.
getAttachmentMeta
function getAttachmentMeta() returns AttachmentSettings|error
Get Jira attachment settings
Return Type
- AttachmentSettings|error - Returned if the request is successful.
getAttachment
function getAttachment(string id) returns AttachmentMetadata|error
Get attachment metadata
Parameters
- id string - The ID of the attachment.
Return Type
- AttachmentMetadata|error - Returned if the request is successful.
removeAttachment
Delete attachment
Parameters
- id string - The ID of the attachment.
expandAttachmentForHumans
function expandAttachmentForHumans(string id) returns AttachmentArchiveMetadataReadable|error
Get all metadata for an expanded attachment
Parameters
- id string - The ID of the attachment.
Return Type
- AttachmentArchiveMetadataReadable|error - Returned if the request is successful. If an empty list is returned in the response, the attachment is empty, corrupt, or not an archive.
expandAttachmentForMachines
function expandAttachmentForMachines(string id) returns AttachmentArchiveImpl|error
Get contents metadata for an expanded attachment
Parameters
- id string - The ID of the attachment.
Return Type
- AttachmentArchiveImpl|error - Returned if the request is successful. If an empty list is returned in the response, the attachment is empty, corrupt, or not an archive.
getAllFieldConfigurations
function getAllFieldConfigurations(int startAt, int maxResults, int[]? id, boolean isDefault, string query) returns PageBeanFieldConfiguration|error
Get all field configurations
Parameters
- startAt int (default 0) - The index of the first item to return in a page of results (page offset).
- maxResults int (default 50) - The maximum number of items to return per page.
- id int[]? (default ()) - The list of field configuration IDs. To include multiple IDs, provide an ampersand-separated list. For example,
id=10000&id=10001
.
- isDefault boolean (default false) - If true returns default field configurations only.
- query string (default "") - The query string used to match against field configuration names and descriptions.
Return Type
- PageBeanFieldConfiguration|error - Returned if the request is successful.
getFieldConfigurationItems
function getFieldConfigurationItems(int id, int startAt, int maxResults) returns PageBeanFieldConfigurationItem|error
Get field configuration items
Parameters
- id int - The ID of the field configuration.
- startAt int (default 0) - The index of the first item to return in a page of results (page offset).
- maxResults int (default 50) - The maximum number of items to return per page.
Return Type
- PageBeanFieldConfigurationItem|error - Returned if the request is successful.
getAllFieldConfigurationSchemes
function getAllFieldConfigurationSchemes(int startAt, int maxResults, int[]? id) returns PageBeanFieldConfigurationScheme|error
Get all field configuration schemes
Parameters
- startAt int (default 0) - The index of the first item to return in a page of results (page offset).
- maxResults int (default 50) - The maximum number of items to return per page.
- id int[]? (default ()) - The list of field configuration scheme IDs. To include multiple IDs, provide an ampersand-separated list. For example,
id=10000&id=10001
.
Return Type
- PageBeanFieldConfigurationScheme|error - Returned if the request is successful.
getFieldConfigurationSchemeMappings
function getFieldConfigurationSchemeMappings(int startAt, int maxResults, int[]? fieldConfigurationSchemeId) returns PageBeanFieldConfigurationIssueTypeItem|error
Get field configuration issue type items
Parameters
- startAt int (default 0) - The index of the first item to return in a page of results (page offset).
- maxResults int (default 50) - The maximum number of items to return per page.
- fieldConfigurationSchemeId int[]? (default ()) - The list of field configuration scheme IDs. To include multiple field configuration schemes separate IDs with ampersand:
fieldConfigurationSchemeId=10000&fieldConfigurationSchemeId=10001
.
Return Type
- PageBeanFieldConfigurationIssueTypeItem|error - Returned if the request is successful.
getFieldConfigurationSchemeProjectMapping
function getFieldConfigurationSchemeProjectMapping(int[] projectId, int startAt, int maxResults) returns PageBeanFieldConfigurationSchemeProjects|error
Get field configuration schemes for projects
Parameters
- projectId int[] - The list of project IDs. To include multiple projects, separate IDs with ampersand:
projectId=10000&projectId=10001
.
- startAt int (default 0) - The index of the first item to return in a page of results (page offset).
- maxResults int (default 50) - The maximum number of items to return per page.
Return Type
- PageBeanFieldConfigurationSchemeProjects|error - Returned if the request is successful.
assignFieldConfigurationSchemeToProject
function assignFieldConfigurationSchemeToProject(FieldConfigurationSchemeProjectAssociation payload) returns json|error
Assign field configuration scheme to project
Parameters
- payload FieldConfigurationSchemeProjectAssociation - The request payload to assign field configuration scheme to project.
Return Type
- json|error - Returned if the request is successful.
getContextsForField
function getContextsForField(string fieldId, boolean? isAnyIssueType, boolean? isGlobalContext, int[]? contextId, int startAt, int maxResults) returns PageBeanCustomFieldContext|error
Get custom field contexts
Parameters
- fieldId string - The ID of the custom field.
- isAnyIssueType boolean? (default ()) - Whether to return contexts that apply to all issue types.
- isGlobalContext boolean? (default ()) - Whether to return contexts that apply to all projects.
- contextId int[]? (default ()) - The list of context IDs. To include multiple contexts, separate IDs with ampersand:
contextId=10000&contextId=10001
.
- startAt int (default 0) - The index of the first item to return in a page of results (page offset).
- maxResults int (default 50) - The maximum number of items to return per page.
Return Type
- PageBeanCustomFieldContext|error - Returned if the request is successful.
createCustomFieldContext
function createCustomFieldContext(string fieldId, CreateCustomFieldContext payload) returns CreateCustomFieldContext|error
Create custom field context
Parameters
- fieldId string - The ID of the custom field.
- payload CreateCustomFieldContext - The request payload to create a custom field context.
Return Type
- CreateCustomFieldContext|error - Returned if the custom field context is created.
getDefaultValues
function getDefaultValues(string fieldId, int[]? contextId, int startAt, int maxResults) returns PageBeanCustomFieldContextDefaultValue|error
Get custom field contexts default values
Parameters
- fieldId string - The ID of the custom field, for example
customfield\_10000
.
- contextId int[]? (default ()) - The IDs of the contexts.
- startAt int (default 0) - The index of the first item to return in a page of results (page offset).
- maxResults int (default 50) - The maximum number of items to return per page.
Return Type
- PageBeanCustomFieldContextDefaultValue|error - Returned if the request is successful.
setDefaultValues
function setDefaultValues(string fieldId, CustomFieldContextDefaultValueUpdate payload) returns json|error
Set custom field contexts default values
Parameters
- fieldId string - The ID of the custom field.
- payload CustomFieldContextDefaultValueUpdate - The request payload to set default for contexts of a custom field.
Return Type
- json|error - Returned if operation is successful.
getIssueTypeMappingsForContexts
function getIssueTypeMappingsForContexts(string fieldId, int[]? contextId, int startAt, int maxResults) returns PageBeanIssueTypeToContextMapping|error
Get issue types for custom field context
Parameters
- fieldId string - The ID of the custom field.
- contextId int[]? (default ()) - The ID of the context. To include multiple contexts, provide an ampersand-separated list. For example,
contextId=10001&contextId=10002
.
- startAt int (default 0) - The index of the first item to return in a page of results (page offset).
- maxResults int (default 50) - The maximum number of items to return per page.
Return Type
- PageBeanIssueTypeToContextMapping|error - Returned if operation is successful.
getCustomFieldContextsForProjectsAndIssueTypes
function getCustomFieldContextsForProjectsAndIssueTypes(string fieldId, ProjectIssueTypeMappings payload, int startAt, int maxResults) returns PageBeanContextForProjectAndIssueType|error
Get custom field contexts for projects and issue types
Parameters
- fieldId string - The ID of the custom field.
- payload ProjectIssueTypeMappings - The list of project and issue type mappings.
- startAt int (default 0) - The index of the first item to return in a page of results (page offset).
- maxResults int (default 50) - The maximum number of items to return per page.
Return Type
- PageBeanContextForProjectAndIssueType|error - Returned if the request is successful.
getProjectContextMapping
function getProjectContextMapping(string fieldId, int[]? contextId, int startAt, int maxResults) returns PageBeanCustomFieldContextProjectMapping|error
Get project mappings for custom field context
Parameters
- fieldId string - The ID of the custom field, for example
customfield\_10000
.
- contextId int[]? (default ()) - The list of context IDs. To include multiple context, separate IDs with ampersand:
contextId=10000&contextId=10001
.
- startAt int (default 0) - The index of the first item to return in a page of results (page offset).
- maxResults int (default 50) - The maximum number of items to return per page.
Return Type
- PageBeanCustomFieldContextProjectMapping|error - Returned if the request is successful.
updateCustomFieldContext
function updateCustomFieldContext(string fieldId, int contextId, CustomFieldContextUpdateDetails payload) returns json|error
Update custom field context
Parameters
- fieldId string - The ID of the custom field.
- contextId int - The ID of the context.
- payload CustomFieldContextUpdateDetails - The request payload to update a custom field context.
Return Type
- json|error - Returned if the context is updated.
deleteCustomFieldContext
Delete custom field context
Return Type
- json|error - Returned if the context is deleted.
addIssueTypesToContext
function addIssueTypesToContext(string fieldId, int contextId, IssueTypeIds payload) returns json|error
Add issue types to context
Parameters
- fieldId string - The ID of the custom field.
- contextId int - The ID of the context.
- payload IssueTypeIds - The request payload to add issue types to a custom field context.
Return Type
- json|error - Returned if operation is successful.
removeIssueTypesFromContext
function removeIssueTypesFromContext(string fieldId, int contextId, IssueTypeIds payload) returns json|error
Remove issue types from context
Parameters
- fieldId string - The ID of the custom field.
- contextId int - The ID of the context.
- payload IssueTypeIds - The request payload to remove issue types from a custom field context.
Return Type
- json|error - Returned if operation is successful.
assignProjectsToCustomFieldContext
function assignProjectsToCustomFieldContext(string fieldId, int contextId, ProjectIds payload) returns json|error
Assign custom field context to projects
Parameters
- fieldId string - The ID of the custom field.
- contextId int - The ID of the context.
- payload ProjectIds - The request payload to assign custom field context to projects.
Return Type
- json|error - Returned if operation is successful.
removeCustomFieldContextFromProjects
function removeCustomFieldContextFromProjects(string fieldId, int contextId, ProjectIds payload) returns json|error
Remove custom field context from projects
Parameters
- fieldId string - The ID of the custom field.
- contextId int - The ID of the context.
- payload ProjectIds - The request payload to remove custom field context from projects.
Return Type
- json|error - Returned if the custom field context is removed from the projects.
getCustomFieldOption
function getCustomFieldOption(string id) returns CustomFieldOption|error
Get custom field option
Parameters
- id string - The ID of the custom field option.
Return Type
- CustomFieldOption|error - Returned if the request is successful.
getOptionsForContext
function getOptionsForContext(string fieldId, int contextId, int? optionId, boolean onlyOptions, int startAt, int maxResults) returns PageBeanCustomFieldContextOption|error
Get custom field options (context)
Parameters
- fieldId string - The ID of the custom field.
- contextId int - The ID of the context.
- optionId int? (default ()) - The ID of the option.
- onlyOptions boolean (default false) - Whether only options are returned.
- startAt int (default 0) - The index of the first item to return in a page of results (page offset).
- maxResults int (default 100) - The maximum number of items to return per page.
Return Type
- PageBeanCustomFieldContextOption|error - Returned if the request is successful.
updateCustomFieldOption
function updateCustomFieldOption(string fieldId, int contextId, BulkCustomFieldOptionUpdateRequest payload) returns CustomFieldUpdatedContextOptionsList|error
Update custom field options (context)
Parameters
- fieldId string - The ID of the custom field.
- contextId int - The ID of the context.
- payload BulkCustomFieldOptionUpdateRequest - The request payload to update issue types to a custom field context.
Return Type
- CustomFieldUpdatedContextOptionsList|error - Returned if the request is successful.
createCustomFieldOption
function createCustomFieldOption(string fieldId, int contextId, BulkCustomFieldOptionCreateRequest payload) returns CustomFieldCreatedContextOptionsList|error
Create custom field options (context)
Parameters
- fieldId string - The ID of the custom field.
- contextId int - The ID of the context.
- payload BulkCustomFieldOptionCreateRequest - The request payolad to create custom field options (context).
Return Type
- CustomFieldCreatedContextOptionsList|error - Returned if the request is successful.
reorderCustomFieldOptions
function reorderCustomFieldOptions(string fieldId, int contextId, OrderOfCustomFieldOptions payload) returns json|error
Reorder custom field options (context)
Parameters
- fieldId string - The ID of the custom field.
- contextId int - The ID of the context.
- payload OrderOfCustomFieldOptions - The request payload to reorder custom field options (context).
Return Type
- json|error - Returned if options are reordered.
deleteCustomFieldOption
function deleteCustomFieldOption(string fieldId, int contextId, int optionId) returns Response|error
Delete custom field options (context)
Parameters
- fieldId string - The ID of the custom field.
- contextId int - The ID of the context from which an option should be deleted.
- optionId int - The ID of the option to delete.
getIssueLinkTypes
function getIssueLinkTypes() returns IssueLinkTypes|error
Get issue link types
Return Type
- IssueLinkTypes|error - Returned if the request is successful.
createIssueLinkType
function createIssueLinkType(IssueLinkType payload) returns IssueLinkType|error
Create issue link type
Parameters
- payload IssueLinkType - The request payload to create issue link type.
Return Type
- IssueLinkType|error - Returned if the request is successful.
getIssueLinkType
function getIssueLinkType(string issueLinkTypeId) returns IssueLinkType|error
Get issue link type
Parameters
- issueLinkTypeId string - The ID of the issue link type.
Return Type
- IssueLinkType|error - Returned if the request is successful.
updateIssueLinkType
function updateIssueLinkType(string issueLinkTypeId, IssueLinkType payload) returns IssueLinkType|error
Update issue link type
Parameters
- issueLinkTypeId string - The ID of the issue link type.
- payload IssueLinkType - The request payload to update issue link type.
Return Type
- IssueLinkType|error - Returned if the request is successful.
deleteIssueLinkType
Delete issue link type
Parameters
- issueLinkTypeId string - The ID of the issue link type.
getIssueNavigatorDefaultColumns
function getIssueNavigatorDefaultColumns() returns ColumnItem[]|error
Get issue navigator default columns
Return Type
- ColumnItem[]|error - Returned if the request is successful.
setIssueNavigatorDefaultColumns
function setIssueNavigatorDefaultColumns(byte[] payload) returns json|error
Set issue navigator default columns
Parameters
- payload byte[] - A navigable field value.
Return Type
- json|error - Returned if the request is successful.
getRemoteIssueLinks
function getRemoteIssueLinks(string issueIdOrKey, string? globalId) returns RemoteIssueLink|error
Get remote issue links
Parameters
- issueIdOrKey string - The ID or key of the issue.
- globalId string? (default ()) - The global ID of the remote issue link.
Return Type
- RemoteIssueLink|error - Returned if the request is successful.
createOrUpdateRemoteIssueLink
function createOrUpdateRemoteIssueLink(string issueIdOrKey, RemoteIssueLinkRequest payload) returns RemoteIssueLinkIdentifies|error
Create or update remote issue link
Parameters
- issueIdOrKey string - The ID or key of the issue.
- payload RemoteIssueLinkRequest - The request payload to create or update remote issue link.
Return Type
- RemoteIssueLinkIdentifies|error - Returned if the remote issue link is updated.
deleteRemoteIssueLinkByGlobalId
function deleteRemoteIssueLinkByGlobalId(string issueIdOrKey, string globalId) returns Response|error
Delete remote issue link by global ID
Parameters
- issueIdOrKey string - The ID or key of the issue.
- globalId string - The global ID of a remote issue link.
getRemoteIssueLinkById
function getRemoteIssueLinkById(string issueIdOrKey, string linkId) returns RemoteIssueLink|error
Get remote issue link by ID
Parameters
- issueIdOrKey string - The ID or key of the issue.
- linkId string - The ID of the remote issue link.
Return Type
- RemoteIssueLink|error - Returned if the request is successful.
updateRemoteIssueLink
function updateRemoteIssueLink(string issueIdOrKey, string linkId, RemoteIssueLinkRequest payload) returns json|error
Update remote issue link by ID
Parameters
- issueIdOrKey string - The ID or key of the issue.
- linkId string - The ID of the remote issue link.
- payload RemoteIssueLinkRequest - The request payload to update remote issue link by ID.
Return Type
- json|error - Returned if the request is successful.
deleteRemoteIssueLinkById
Delete remote issue link by ID
Parameters
- issueIdOrKey string - The ID or key of the issue.
- linkId string - The ID of a remote issue link.
getResolutions
function getResolutions() returns Resolution[]|error
Get resolutions
Return Type
- Resolution[]|error - Returned if the request is successful.
getResolution
function getResolution(string id) returns Resolution|error
Get resolution
Parameters
- id string - The ID of the issue resolution value.
Return Type
- Resolution|error - Returned if the request is successful.
getIssueAllTypes
function getIssueAllTypes() returns IssueTypeDetails[]|error
Get all issue types for user
Return Type
- IssueTypeDetails[]|error - Returned if the request is successful.
createIssueType
function createIssueType(IssueTypeCreateBean payload) returns IssueTypeDetails|error
Create issue type
Parameters
- payload IssueTypeCreateBean - The request payload to create issue type.
Return Type
- IssueTypeDetails|error - Returned if the request is successful.
getIssueTypesForProject
function getIssueTypesForProject(int projectId, int? level) returns IssueTypeDetails[]|error
Get issue types for project
Parameters
- projectId int - The ID of the project.
- level int? (default ()) - The level of the issue type to filter by. Use: *
-1
for Subtask. *0
for Base. *1
for Epic.
Return Type
- IssueTypeDetails[]|error - Returned if the request is successful.
getIssueType
function getIssueType(string id) returns IssueTypeDetails|error
Get issue type
Parameters
- id string - The ID of the issue type.
Return Type
- IssueTypeDetails|error - Returned if the request is successful.
updateIssueType
function updateIssueType(string id, IssueTypeUpdateBean payload) returns IssueTypeDetails|error
Update issue type
Parameters
- id string - The ID of the issue type.
- payload IssueTypeUpdateBean - The request payload to update issue type.
Return Type
- IssueTypeDetails|error - Returned if the request is successful.
deleteIssueType
Delete issue type
Parameters
- id string - The ID of the issue type.
- alternativeIssueTypeId string? (default ()) - The ID of the replacement issue type.
getAlternativeIssueTypes
function getAlternativeIssueTypes(string id) returns IssueTypeDetails[]|error
Get alternative issue types
Parameters
- id string - The ID of the issue type.
Return Type
- IssueTypeDetails[]|error - Returned if the request is successful.
createIssueTypeAvatar
function createIssueTypeAvatar(string id, int size, byte[] payload, int x, int y) returns Avatar|error
Load issue type avatar
Parameters
- id string - The ID of the issue type.
- size int - The length of each side of the crop region.
- payload byte[] - The request payload to load issue type avatar.
- x int (default 0) - The X coordinate of the top-left corner of the crop region.
- y int (default 0) - The Y coordinate of the top-left corner of the crop region.
getIssueTypePropertyKeys
function getIssueTypePropertyKeys(string issueTypeId) returns PropertyKeys|error
Get issue type property keys
Parameters
- issueTypeId string - The ID of the issue type.
Return Type
- PropertyKeys|error - Returned if the request is successful.
getIssueTypeProperty
function getIssueTypeProperty(string issueTypeId, string propertyKey) returns EntityProperty|error
Get issue type property
Parameters
- issueTypeId string - The ID of the issue type.
- propertyKey string - The key of the property. Use Get issue type property keys to get a list of all issue type property keys.
Return Type
- EntityProperty|error - Returned if the request is successful.
setIssueTypeProperty
function setIssueTypeProperty(string issueTypeId, string propertyKey, json payload) returns json|error
Set issue type property
Parameters
- issueTypeId string - The ID of the issue type.
- propertyKey string - The key of the issue type property. The maximum length is 255 characters.
- payload json - The request payload to set issue type property.
Return Type
- json|error - Returned if the issue type property is updated.
deleteIssueTypeProperty
Delete issue type property
Parameters
- issueTypeId string - The ID of the issue type.
- propertyKey string - The key of the property. Use Get issue type property keys to get a list of all issue type property keys.
getAutoComplete
function getAutoComplete() returns JQLReferenceData|error
Get field reference data (GET)
Return Type
- JQLReferenceData|error - Returned if the request is successful.
getAutoCompletePost
function getAutoCompletePost(SearchAutoCompleteFilter payload) returns JQLReferenceData|error
Get field reference data (POST)
Parameters
- payload SearchAutoCompleteFilter - The request payload to get field reference data.
Return Type
- JQLReferenceData|error - Returned if the request is successful.
getFieldAutoCompleteForQueryString
function getFieldAutoCompleteForQueryString(string? fieldName, string? fieldValue, string? predicateName, string? predicateValue) returns AutoCompleteSuggestions|error
Get field auto complete suggestions
Parameters
- fieldName string? (default ()) - The name of the field.
- fieldValue string? (default ()) - The partial field item name entered by the user.
- predicateName string? (default ()) - The name of the CHANGED operator predicate for which the suggestions are generated. The valid predicate operators are by, from, and to.
- predicateValue string? (default ()) - The partial predicate item name entered by the user.
Return Type
- AutoCompleteSuggestions|error - Returned if the request is successful.
parseJqlQueries
function parseJqlQueries(JqlQueriesToParse payload, string validation) returns ParsedJqlQueries|error
Parse JQL query
Parameters
- payload JqlQueriesToParse - The request payload to parse JQL query.
- validation string (default "strict") - How to validate the JQL query and treat the validation results. Validation options include: *
strict
Returns all errors. If validation fails, the query structure is not returned. *warn
Returns all errors. If validation fails but the JQL query is correctly formed, the query structure is returned. *none
No validation is performed. If JQL query is correctly formed, the query structure is returned.
Return Type
- ParsedJqlQueries|error - Returned if the request is successful.
migrateQueries
function migrateQueries(JQLPersonalDataMigrationRequest payload) returns ConvertedJQLQueries|error
Convert user identifiers to account IDs in JQL queries
Parameters
- payload JQLPersonalDataMigrationRequest - The request payload to convert user identifiers to account IDs in JQL queries.
Return Type
- ConvertedJQLQueries|error - Returned if the request is successful. Note that the JQL queries are returned in the same order that they were passed.
getAllProjects
Get all projects
Parameters
- expand string? (default ()) - Use expand to include additional information in the response. This parameter accepts a comma-separated list. Expanded options include: *
description
Returns the project description. *issueTypes
Returns all issue types associated with the project. *lead
Returns information about the project lead. *projectKeys
Returns all project keys associated with the project.
- recent int? (default ()) - Returns the user's most recently accessed projects. You may specify the number of results to return up to a maximum of 20. If access is anonymous, then the recently accessed projects are based on the current HTTP session.
- properties string[]? (default ()) - A list of project properties to return for the project. This parameter accepts a comma-separated list.
createProject
function createProject(CreateProjectDetails payload) returns ProjectIdentifiers|error
Create project
Parameters
- payload CreateProjectDetails - The JSON representation of the project being created.
Return Type
- ProjectIdentifiers|error - Returned if the project is created.
searchProjects
function searchProjects(int startAt, int maxResults, string orderBy, int[]? id, string? query, string? typeKey, int? categoryId, string action, string? expand, string[]? status, StringList[]? properties, string? propertyQuery) returns PageBeanProject|error
Get projects paginated
Parameters
- startAt int (default 0) - The index of the first item to return in a page of results (page offset).
- maxResults int (default 50) - The maximum number of items to return per page.
- orderBy string (default "key") - Order the results by a field. *
category
Sorts by project category. A complete list of category IDs is found using Get all project categories. *issueCount
Sorts by the total number of issues in each project. *key
Sorts by project key. *lastIssueUpdatedTime
Sorts by the last issue update time. *name
Sorts by project name. *owner
Sorts by project lead. *archivedDate
EXPERIMENTAL. Sorts by project archived date. *deletedDate
EXPERIMENTAL. Sorts by project deleted date.
- id int[]? (default ()) - The project IDs to filter the results by. To include multiple IDs, provide an ampersand-separated list. For example,
id=10000&id=10001
. Up to 50 project IDs can be provided.
- query string? (default ()) - Filter the results using a literal string. Projects with a matching
key
orname
are returned (case insensitive).
- typeKey string? (default ()) - Orders results by the project type. This parameter accepts a comma-separated list. Valid values are
business
,service_desk
, andsoftware
.
- categoryId int? (default ()) - The ID of the project's category. A complete list of category IDs is found using the Get all project categories operation.
- action string (default "view") - Filter results by projects for which the user can: *
view
the project, meaning that they have one of the following permissions: * Browse projects project permission for the project. * Administer projects project permission for the project. * Administer Jira global permission. *browse
the project, meaning that they have the Browse projects project permission for the project. *edit
the project, meaning that they have one of the following permissions: * Administer projects project permission for the project. * Administer Jira global permission.
- expand string? (default ()) - Use expand to include additional information in the response. This parameter accepts a comma-separated list. Expanded options include: *
description
Returns the project description. *projectKeys
Returns all project keys associated with a project. *lead
Returns information about the project lead. *issueTypes
Returns all issue types associated with the project. *url
Returns the URL associated with the project. *insight
EXPERIMENTAL. Returns the insight details of total issue count and last issue update time for the project.
- status string[]? (default ()) - EXPERIMENTAL. Filter results by project status: *
live
Search live projects. *archived
Search archived projects. *deleted
Search deleted projects, those in the recycle bin.
- properties StringList[]? (default ()) - EXPERIMENTAL. A list of project properties to return for the project. This parameter accepts a comma-separated list.
- propertyQuery string? (default ()) - EXPERIMENTAL. A query string used to search properties. The query string cannot be specified using a JSON object. For example, to search for the value of
nested
from{"something":{"nested":1,"other":2}}
use[thepropertykey].something.nested=1
. Note that the propertyQuery key is enclosed in square brackets to enable searching where the propertyQuery key includes dot (.) or equals (=) characters.
Return Type
- PageBeanProject|error - Returned if the request is successful.
getProject
function getProject(string projectIdOrKey, string? expand, string[]? properties) returns Project|error
Get project
Parameters
- projectIdOrKey string - The project ID or project key (case sensitive).
- expand string? (default ()) - Use expand to include additional information in the response. This parameter accepts a comma-separated list. Note that the project description, issue types, and project lead are included in all responses by default. Expand options include: *
description
The project description. *issueTypes
The issue types associated with the project. *lead
The project lead. *projectKeys
All project keys associated with the project. *issueTypeHierarchy
The project issue type hierarchy.
- properties string[]? (default ()) - A list of project properties to return for the project. This parameter accepts a comma-separated list.
updateProject
function updateProject(string projectIdOrKey, UpdateProjectDetails payload, string? expand) returns Project|error
Update project
Parameters
- projectIdOrKey string - The project ID or project key (case sensitive).
- payload UpdateProjectDetails - The project details to be updated.
- expand string? (default ()) - Use expand to include additional information in the response. This parameter accepts a comma-separated list. Note that the project description, issue types, and project lead are included in all responses by default. Expand options include: *
description
The project description. *issueTypes
The issue types associated with the project. *lead
The project lead. *projectKeys
All project keys associated with the project.
deleteProject
Delete project
Parameters
- projectIdOrKey string - The project ID or project key (case sensitive).
- enableUndo boolean (default false) - Whether this project is placed in the Jira recycle bin where it will be available for restoration.
archiveProject
Archive project
Parameters
- projectIdOrKey string - The project ID or project key (case sensitive).
Return Type
- json|error - Returned if the request is successful.
deleteProjectAsynchronously
Delete project asynchronously
Parameters
- projectIdOrKey string - The project ID or project key (case sensitive).
restore
Restore deleted project
Parameters
- projectIdOrKey string - The project ID or project key (case sensitive).
getAllStatuses
function getAllStatuses(string projectIdOrKey) returns IssueTypeWithStatus[]|error
Get all statuses for project
Parameters
- projectIdOrKey string - The project ID or project key (case sensitive).
Return Type
- IssueTypeWithStatus[]|error - Returned if the request is successful.
updateProjectType
Update project type
Parameters
- projectIdOrKey string - The project ID or project key (case sensitive).
- newProjectTypeKey string - The key of the new project type.
getHierarchy
function getHierarchy(int projectId) returns ProjectIssueTypeHierarchy|error
Get project issue type hierarchy
Parameters
- projectId int - The ID of the project.
Return Type
- ProjectIssueTypeHierarchy|error - Returned if the request is successful.
Deprecated
getNotificationSchemeForProject
function getNotificationSchemeForProject(string projectKeyOrId, string? expand) returns NotificationScheme|error
Get project notification scheme
Parameters
- projectKeyOrId string - The project ID or project key (case sensitive).
- expand string? (default ()) - Use expand to include additional information in the response. This parameter accepts a comma-separated list. Expand options include: *
all
Returns all expandable information. *field
Returns information about any custom fields assigned to receive an event. *group
Returns information about any groups assigned to receive an event. *notificationSchemeEvents
Returns a list of event associations. This list is returned for all expandable information. *projectRole
Returns information about any project roles assigned to receive an event. *user
Returns information about any users assigned to receive an event.
Return Type
- NotificationScheme|error - Returned if the request is successful.
getAllProjectTypes
function getAllProjectTypes() returns ProjectType[]|error
Get all project types
Return Type
- ProjectType[]|error - Returned if the request is successful.
getAllAccessibleProjectTypes
function getAllAccessibleProjectTypes() returns ProjectType[]|error
Get licensed project types
Return Type
- ProjectType[]|error - Returned if the request is successful.
getProjectTypeByKey
function getProjectTypeByKey(string projectTypeKey) returns ProjectType|error
Get project type by key
Parameters
- projectTypeKey string - The key of the project type.
Return Type
- ProjectType|error - Returned if the request is successful.
getAccessibleProjectTypeByKey
function getAccessibleProjectTypeByKey(string projectTypeKey) returns ProjectType|error
Get accessible project type by key
Parameters
- projectTypeKey string - The key of the project type.
Return Type
- ProjectType|error - Returned if the request is successful.
getProjectVersionsPaginated
function getProjectVersionsPaginated(string projectIdOrKey, int startAt, int maxResults, string? orderBy, string? query, string? status, string? expand) returns PageBeanVersion|error
Get project versions paginated
Parameters
- projectIdOrKey string - The project ID or project key (case sensitive).
- startAt int (default 0) - The index of the first item to return in a page of results (page offset).
- maxResults int (default 50) - The maximum number of items to return per page.
- orderBy string? (default ()) - Order the results by a field: *
description
Sorts by version description. *name
Sorts by version name. *releaseDate
Sorts by release date, starting with the oldest date. Versions with no release date are listed last. *sequence
Sorts by the order of appearance in the user interface. *startDate
Sorts by start date, starting with the oldest date. Versions with no start date are listed last.
- query string? (default ()) - Filter the results using a literal string. Versions with matching
name
ordescription
are returned (case insensitive).
- status string? (default ()) - A list of status values used to filter the results by version status. This parameter accepts a comma-separated list. The status values are
released
,unreleased
, andarchived
.
- expand string? (default ()) - Use expand to include additional information in the response. This parameter accepts a comma-separated list. Expand options include: *
issuesstatus
Returns the number of issues in each status category for each version. *operations
Returns actions that can be performed on the specified version.
Return Type
- PageBeanVersion|error - Returned if the request is successful.
getProjectVersions
Get project versions
Parameters
- projectIdOrKey string - The project ID or project key (case sensitive).
getProjectEmail
function getProjectEmail(int projectId) returns ProjectEmailAddress|error
Get project's sender email
Parameters
- projectId int - The project ID.
Return Type
- ProjectEmailAddress|error - Returned if the request is successful.
updateProjectEmail
function updateProjectEmail(int projectId, ProjectEmailAddress payload) returns json|error
Set project's sender email
Parameters
- projectId int - The project ID.
- payload ProjectEmailAddress - The project's sender email address to be set.
Return Type
- json|error - Returned if the project's sender email address is successfully set.
getProjectIssueSecurityScheme
function getProjectIssueSecurityScheme(string projectKeyOrId) returns SecurityScheme|error
Get project issue security scheme
Parameters
- projectKeyOrId string - The project ID or project key (case sensitive).
Return Type
- SecurityScheme|error - Returned if the request is successful.
getAssignedPermissionScheme
function getAssignedPermissionScheme(string projectKeyOrId, string? expand) returns PermissionScheme|error
Get assigned permission scheme
Parameters
- projectKeyOrId string - The project ID or project key (case sensitive).
- expand string? (default ()) - Use expand to include additional information in the response. This parameter accepts a comma-separated list. Note that permissions are included when you specify any value. Expand options include: *
all
Returns all expandable information. *field
Returns information about the custom field granted the permission. *group
Returns information about the group that is granted the permission. *permissions
Returns all permission grants for each permission scheme. *projectRole
Returns information about the project role granted the permission. *user
Returns information about the user who is granted the permission.
Return Type
- PermissionScheme|error - Returned if the request is successful.
assignPermissionScheme
function assignPermissionScheme(string projectKeyOrId, IdBean payload, string? expand) returns PermissionScheme|error
Assign permission scheme
Parameters
- projectKeyOrId string - The project ID or project key (case sensitive).
- payload IdBean - The request payload to assign permission scheme.
- expand string? (default ()) - Use expand to include additional information in the response. This parameter accepts a comma-separated list. Note that permissions are included when you specify any value. Expand options include: *
all
Returns all expandable information. *field
Returns information about the custom field granted the permission. *group
Returns information about the group that is granted the permission. *permissions
Returns all permission grants for each permission scheme. *projectRole
Returns information about the project role granted the permission. *user
Returns information about the user who is granted the permission.
Return Type
- PermissionScheme|error - Returned if the request is successful.
getSecurityLevelsForProject
function getSecurityLevelsForProject(string projectKeyOrId) returns ProjectIssueSecurityLevels|error
Get project issue security levels
Parameters
- projectKeyOrId string - The project ID or project key (case sensitive).
Return Type
- ProjectIssueSecurityLevels|error - Returned if the request is successful.
getAllWorkflows
function getAllWorkflows(string? workflowName) returns DeprecatedWorkflow[]|error
Get all workflows
Parameters
- workflowName string? (default ()) - The name of the workflow to be returned. Only one workflow can be specified.
Return Type
- DeprecatedWorkflow[]|error - Returned if the request is successful.
Deprecated
createWorkflow
function createWorkflow(CreateWorkflowDetails payload) returns WorkflowIDs|error
Create workflow
Parameters
- payload CreateWorkflowDetails - The workflow details.
Return Type
- WorkflowIDs|error - Returned if the workflow is created.
getWorkflowsPaginated
function getWorkflowsPaginated(int startAt, int maxResults, string[]? workflowName, string? expand) returns PageBeanWorkflow|error
Get workflows paginated
Parameters
- startAt int (default 0) - The index of the first item to return in a page of results (page offset).
- maxResults int (default 50) - The maximum number of items to return per page.
- workflowName string[]? (default ()) - The name of a workflow to return.
- expand string? (default ()) - Use expand to include additional information in the response. This parameter accepts a comma-separated list. Expand options include: *
transitions
For each workflow, returns information about the transitions inside the workflow. *transitions.rules
For each workflow transition, returns information about its rules. Transitions are included automatically if this expand is requested. *statuses
For each workflow, returns information about the statuses inside the workflow. *statuses.properties
For each workflow status, returns information about its properties. Statuses are included automatically if this expand is requested. *default
For each workflow, returns information about whether this is the default workflow.
Return Type
- PageBeanWorkflow|error - Returned if the request is successful.
deleteInactiveWorkflow
Delete inactive workflow
Parameters
- entityId string - The entity ID of the workflow.
getCommentsByIds
function getCommentsByIds(IssueCommentListRequestBean payload, string? expand) returns PageBeanComment|error
Get comments by IDs
Parameters
- payload IssueCommentListRequestBean - The list of comment IDs.
Return Type
- PageBeanComment|error - Returned if the request is successful.
getComments
function getComments(string issueIdOrKey, int startAt, int maxResults, string? orderBy, string? expand) returns PageOfComments|error
Get comments
Parameters
- issueIdOrKey string - The ID or key of the issue.
- startAt int (default 0) - The index of the first item to return in a page of results (page offset).
- maxResults int (default 50) - The maximum number of items to return per page.
Return Type
- PageOfComments|error - Returned if the request is successful.
addComment
Add comment
Parameters
- issueIdOrKey string - The ID or key of the issue.
- payload Comment - The request payload to add comment.
getComment
Get comment
updateComment
function updateComment(string issueIdOrKey, string id, Comment payload, string? expand) returns Comment|error
Update comment
Parameters
- issueIdOrKey string - The ID or key of the issue.
- id string - The ID of the comment.
- payload Comment - The request payload to update comment.
deleteComment
Delete comment
getCommentPropertyKeys
function getCommentPropertyKeys(string commentId) returns PropertyKeys|error
Get comment property keys
Parameters
- commentId string - The ID of the comment.
Return Type
- PropertyKeys|error - Returned if the request is successful.
getCommentProperty
function getCommentProperty(string commentId, string propertyKey) returns EntityProperty|error
Get comment property
Return Type
- EntityProperty|error - Returned if the request is successful.
setCommentProperty
Set comment property
Parameters
- commentId string - The ID of the comment.
- propertyKey string - The key of the property. The maximum length is 255 characters.
- payload json - The request payload value of a property for a comment to update.
Return Type
- json|error - Returned if the comment property is updated.
deleteCommentProperty
Delete comment property
getPriorities
Get priorities
getPriority
Get priority
Parameters
- id string - The ID of the issue priority.
linkIssues
function linkIssues(LinkIssueRequestJsonBean payload) returns json|error
Create issue link
Parameters
- payload LinkIssueRequestJsonBean - The issue link request.
Return Type
- json|error - Returned if the request is successful.
getIssueLink
Get issue link
Parameters
- linkId string - The ID of the issue link.
deleteIssueLink
Delete issue link
Parameters
- linkId string - The ID of the issue link.
getFields
function getFields() returns FieldDetails[]|error
Get fields
Return Type
- FieldDetails[]|error - Returned if the request is successful.
createCustomField
function createCustomField(CustomFieldDefinitionJsonBean payload) returns FieldDetails|error
Create custom field
Parameters
- payload CustomFieldDefinitionJsonBean - Definition of the custom field to be created
Return Type
- FieldDetails|error - Returned if the custom field is created.
getFieldsPaginated
function getFieldsPaginated(int startAt, int maxResults, string[]? 'type, string[]? id, string? query, string? orderBy, string? expand) returns PageBeanField|error
Get fields paginated
Parameters
- startAt int (default 0) - The index of the first item to return in a page of results (page offset).
- maxResults int (default 50) - The maximum number of items to return per page.
- 'type string[]? (default ()) - The type of fields to search.
- id string[]? (default ()) - The IDs of the custom fields to return or, where
query
is specified, filter.
- query string? (default ()) - String used to perform a case-insensitive partial match with field names or descriptions.
- expand string? (default ()) - Use expand to include additional information in the response. This parameter accepts a comma-separated list. Expand options include: *
key
Returns the key for each field. *lastUsed
Returns the date when the value of the field last changed. *screensCount
Returns the number of screens related to a field. *contextsCount
Returns the number of contexts related to a field. *isLocked
Returns information about whether the field is locked. *searcherKey
Returns the searcher key for each custom field.
Return Type
- PageBeanField|error - Returned if the request is successful.
updateCustomField
function updateCustomField(string fieldId, UpdateCustomFieldDetails payload) returns json|error
Update custom field
Parameters
- fieldId string - The ID of the custom field.
- payload UpdateCustomFieldDetails - The custom field update details.
Return Type
- json|error - Returned if the request is successful.
getIssuePickerResource
function getIssuePickerResource(string? query, string? currentJQL, string? currentIssueKey, string? currentProjectId, boolean? showSubTasks, boolean? showSubTaskParent) returns IssuePickerSuggestions|error
Get issue picker suggestions
Parameters
- query string? (default ()) - A string to match against text fields in the issue such as title, description, or comments.
- currentJQL string? (default ()) - A JQL query defining a list of issues to search for the query term. Note that
username
anduserkey
cannot be used as search terms for this parameter, due to privacy reasons. UseaccountId
instead.
- currentIssueKey string? (default ()) - The key of an issue to exclude from search results. For example, the issue the user is viewing when they perform this query.
- currentProjectId string? (default ()) - The ID of a project that suggested issues must belong to.
- showSubTasks boolean? (default ()) - Indicate whether to include subtasks in the suggestions list.
- showSubTaskParent boolean? (default ()) - When
currentIssueKey
is a subtask, whether to include the parent issue in the suggestions if it matches the query.
Return Type
- IssuePickerSuggestions|error - Returned if the request is successful.
matchIssues
function matchIssues(IssuesAndJQLQueries payload) returns IssueMatches|error
Check issues against JQL
Parameters
- payload IssuesAndJQLQueries - The request payload to check issues against JQL.
Return Type
- IssueMatches|error - Returned if the request is successful.
searchForIssuesUsingJql
function searchForIssuesUsingJql(string? jql, int startAt, int maxResults, string validateQuery, string[]? fields, string? expand, string[]? properties, boolean fieldsByKeys) returns SearchResults|error
Search for issues using JQL (GET)
Parameters
- jql string? (default ()) - The JQL that defines the search. Note: * If no JQL expression is provided, all issues are returned. *
username
anduserkey
cannot be used as search terms due to privacy reasons. UseaccountId
instead. * If a user has hidden their email address in their user profile, partial matches of the email address will not find the user. An exact match is required.
- startAt int (default 0) - The index of the first item to return in a page of results (page offset).
- maxResults int (default 50) - The maximum number of items to return per page. To manage page size, Jira may return fewer items per page where a large number of fields are requested. The greatest number of items returned per page is achieved when requesting
id
orkey
only.
- validateQuery string (default "strict") - Determines how to validate the JQL query and treat the validation results. Supported values are: *
strict
Returns a 400 response code if any errors are found, along with a list of all errors (and warnings). *warn
Returns all errors as warnings. *none
No validation is performed. *true
Deprecated A legacy synonym forstrict
. *false
Deprecated A legacy synonym forwarn
. Note: If the JQL is not correctly formed a 400 response code is returned, regardless of thevalidateQuery
value.
- fields string[]? (default ()) - A list of fields to return for each issue, use it to retrieve a subset of fields. This parameter accepts a comma-separated list. Expand options include: *
*all
Returns all fields. **navigable
Returns navigable fields. * Any issue field, prefixed with a minus to exclude. Examples: *summary,comment
Returns only the summary and comments fields. *-description
Returns all navigable (default) fields except description. **all,-comment
Returns all fields except comments. This parameter may be specified multiple times. For example,fields=field1,field2&fields=field3
. Note: All navigable fields are returned by default. This differs from GET issue where the default is all fields.
- expand string? (default ()) - Use expand to include additional information about issues in the response. This parameter accepts a comma-separated list. Expand options include: *
renderedFields
Returns field values rendered in HTML format. *names
Returns the display name of each field. *schema
Returns the schema describing a field type. *transitions
Returns all possible transitions for the issue. *operations
Returns all possible operations for the issue. *editmeta
Returns information about how each field can be edited. *changelog
Returns a list of recent updates to an issue, sorted by date, starting from the most recent. *versionedRepresentations
Instead offields
, returnsversionedRepresentations
a JSON array containing each version of a field's value, with the highest numbered item representing the most recent version.
- properties string[]? (default ()) - A list of issue property keys for issue properties to include in the results. This parameter accepts a comma-separated list. Multiple properties can also be provided using an ampersand separated list. For example,
properties=prop1,prop2&properties=prop3
. A maximum of 5 issue property keys can be specified.
- fieldsByKeys boolean (default false) - Reference fields by their key (rather than ID).
Return Type
- SearchResults|error - Returned if the request is successful.
searchForIssuesUsingJqlPost
function searchForIssuesUsingJqlPost(SearchRequestBean payload) returns SearchResults|error
Search for issues using JQL (POST)
Parameters
- payload SearchRequestBean - A JSON object containing the search request.
Return Type
- SearchResults|error - Returned if the request is successful.
getMyPermissions
function getMyPermissions(string? projectKey, string? projectId, string? issueKey, string? issueId, string? permissions, string? projectUuid, string? projectConfigurationUuid) returns Permissions|error
Get my permissions
Parameters
- projectKey string? (default ()) - The key of project. Ignored if
projectId
is provided.
- projectId string? (default ()) - The ID of project.
- issueKey string? (default ()) - The key of the issue. Ignored if
issueId
is provided.
- issueId string? (default ()) - The ID of the issue.
- permissions string? (default ()) - A list of permission keys. (Required) This parameter accepts a comma-separated list. To get the list of available permissions, use Get all permissions.
- projectUuid string? (default ()) - UUID of a project.
- projectConfigurationUuid string? (default ()) - UUID of a project configuration.
Return Type
- Permissions|error - Returned if the request is successful.
getAllPermissions
function getAllPermissions() returns Permissions|error
Get all permissions
Return Type
- Permissions|error - Returned if the request is successful.
getBulkPermissions
function getBulkPermissions(BulkPermissionsRequestBean payload) returns BulkPermissionGrants|error
Get bulk permissions
Parameters
- payload BulkPermissionsRequestBean - Details of the permissions to check.
Return Type
- BulkPermissionGrants|error - Returned if the request is successful.
getPermittedProjects
function getPermittedProjects(PermissionsKeysBean payload) returns PermittedProjects|error
Get permitted projects
Parameters
- payload PermissionsKeysBean - The request payload to get permitted projects.
Return Type
- PermittedProjects|error - Returned if the request is successful.
getAllPermissionSchemes
function getAllPermissionSchemes(string? expand) returns PermissionSchemes|error
Get all permission schemes
Parameters
- expand string? (default ()) - Use expand to include additional information in the response. This parameter accepts a comma-separated list. Note that permissions are included when you specify any value. Expand options include: *
all
Returns all expandable information. *field
Returns information about the custom field granted the permission. *group
Returns information about the group that is granted the permission. *permissions
Returns all permission grants for each permission scheme. *projectRole
Returns information about the project role granted the permission. *user
Returns information about the user who is granted the permission.
Return Type
- PermissionSchemes|error - Returned if the request is successful.
createPermissionScheme
function createPermissionScheme(PermissionScheme payload, string? expand) returns PermissionScheme|error
Create permission scheme
Parameters
- payload PermissionScheme - The permission scheme to create.
- expand string? (default ()) - Use expand to include additional information in the response. This parameter accepts a comma-separated list. Note that permissions are always included when you specify any value. Expand options include: *
all
Returns all expandable information. *field
Returns information about the custom field granted the permission. *group
Returns information about the group that is granted the permission. *permissions
Returns all permission grants for each permission scheme. *projectRole
Returns information about the project role granted the permission. *user
Returns information about the user who is granted the permission.
Return Type
- PermissionScheme|error - Returned if the permission scheme is created.
getPermissionScheme
function getPermissionScheme(int schemeId, string? expand) returns PermissionScheme|error
Get permission scheme
Parameters
- schemeId int - The ID of the permission scheme to return.
- expand string? (default ()) - Use expand to include additional information in the response. This parameter accepts a comma-separated list. Note that permissions are included when you specify any value. Expand options include: *
all
Returns all expandable information. *field
Returns information about the custom field granted the permission. *group
Returns information about the group that is granted the permission. *permissions
Returns all permission grants for each permission scheme. *projectRole
Returns information about the project role granted the permission. *user
Returns information about the user who is granted the permission.
Return Type
- PermissionScheme|error - Returned if the request is successful.
updatePermissionScheme
function updatePermissionScheme(int schemeId, PermissionScheme payload, string? expand) returns PermissionScheme|error
Update permission scheme
Parameters
- schemeId int - The ID of the permission scheme to update.
- payload PermissionScheme - The request payload to update permission scheme.
- expand string? (default ()) - Use expand to include additional information in the response. This parameter accepts a comma-separated list. Note that permissions are always included when you specify any value. Expand options include: *
all
Returns all expandable information. *field
Returns information about the custom field granted the permission. *group
Returns information about the group that is granted the permission. *permissions
Returns all permission grants for each permission scheme. *projectRole
Returns information about the project role granted the permission. *user
Returns information about the user who is granted the permission.
Return Type
- PermissionScheme|error - Returned if the scheme is updated.
deletePermissionScheme
Delete permission scheme
Parameters
- schemeId int - The ID of the permission scheme being deleted.
getPermissionSchemeGrants
function getPermissionSchemeGrants(int schemeId, string? expand) returns PermissionGrants|error
Get permission scheme grants
Parameters
- schemeId int - The ID of the permission scheme.
- expand string? (default ()) - Use expand to include additional information in the response. This parameter accepts a comma-separated list. Note that permissions are always included when you specify any value. Expand options include: *
permissions
Returns all permission grants for each permission scheme. *user
Returns information about the user who is granted the permission. *group
Returns information about the group that is granted the permission. *projectRole
Returns information about the project role granted the permission. *field
Returns information about the custom field granted the permission. *all
Returns all expandable information.
Return Type
- PermissionGrants|error - Returned if the request is successful.
createPermissionGrant
function createPermissionGrant(int schemeId, PermissionGrant payload, string? expand) returns PermissionGrant|error
Create permission grant
Parameters
- schemeId int - The ID of the permission scheme in which to create a new permission grant.
- payload PermissionGrant - The permission grant to create.
- expand string? (default ()) - Use expand to include additional information in the response. This parameter accepts a comma-separated list. Note that permissions are always included when you specify any value. Expand options include: *
permissions
Returns all permission grants for each permission scheme. *user
Returns information about the user who is granted the permission. *group
Returns information about the group that is granted the permission. *projectRole
Returns information about the project role granted the permission. *field
Returns information about the custom field granted the permission. *all
Returns all expandable information.
Return Type
- PermissionGrant|error - Returned if the scheme permission is created.
getPermissionSchemeGrant
function getPermissionSchemeGrant(int schemeId, int permissionId, string? expand) returns PermissionGrant|error
Get permission scheme grant
Parameters
- schemeId int - The ID of the permission scheme.
- permissionId int - The ID of the permission grant.
- expand string? (default ()) - Use expand to include additional information in the response. This parameter accepts a comma-separated list. Note that permissions are always included when you specify any value. Expand options include: *
all
Returns all expandable information. *field
Returns information about the custom field granted the permission. *group
Returns information about the group that is granted the permission. *permissions
Returns all permission grants for each permission scheme. *projectRole
Returns information about the project role granted the permission. *user
Returns information about the user who is granted the permission.
Return Type
- PermissionGrant|error - Returned if the request is successful.
deletePermissionSchemeEntity
Delete permission scheme grant
Parameters
- schemeId int - The ID of the permission scheme to delete the permission grant from.
- permissionId int - The ID of the permission grant to delete.
getSelectedTimeTrackingImplementation
function getSelectedTimeTrackingImplementation() returns json|TimeTrackingProvider|error
Get selected time tracking provider
Return Type
- json|TimeTrackingProvider|error - Returned if the request is successful and time tracking is enabled.
selectTimeTrackingImplementation
function selectTimeTrackingImplementation(TimeTrackingProvider payload) returns json|error
Select time tracking provider
Parameters
- payload TimeTrackingProvider - The request payload to select a time tracking provider.
Return Type
- json|error - Returned if the request is successful.
getAvailableTimeTrackingImplementations
function getAvailableTimeTrackingImplementations() returns TimeTrackingProvider[]|error
Get all time tracking providers
Return Type
- TimeTrackingProvider[]|error - Returned if the request is successful.
getSharedTimeTrackingConfiguration
function getSharedTimeTrackingConfiguration() returns TimeTrackingConfiguration|error
Get time tracking settings
Return Type
- TimeTrackingConfiguration|error - Returned if the request is successful.
setSharedTimeTrackingConfiguration
function setSharedTimeTrackingConfiguration(TimeTrackingConfiguration payload) returns TimeTrackingConfiguration|error
Set time tracking settings
Parameters
- payload TimeTrackingConfiguration - The request payload to set time tracking settings.
Return Type
- TimeTrackingConfiguration|error - Returned if the request is successful.
getIssueWorklog
function getIssueWorklog(string issueIdOrKey, int startAt, int maxResults, int? startedAfter, string expand) returns PageOfWorklogs|error
Get issue worklogs
Parameters
- issueIdOrKey string - The ID or key of the issue.
- startAt int (default 0) - The index of the first item to return in a page of results (page offset).
- maxResults int (default 1048576) - The maximum number of items to return per page.
- startedAfter int? (default ()) - The worklog start date and time, as a UNIX timestamp in milliseconds, after which worklogs are returned.
Return Type
- PageOfWorklogs|error - Returned if the request is successful
addWorklog
function addWorklog(string issueIdOrKey, Worklog payload, boolean notifyUsers, string adjustEstimate, string? newEstimate, string? reduceBy, string expand, boolean overrideEditableFlag) returns Worklog|error
Add worklog
Parameters
- issueIdOrKey string - The ID or key the issue.
- payload Worklog - The request payload to add worklog.
- notifyUsers boolean (default true) - Whether users watching the issue are notified by email.
- adjustEstimate string (default "auto") - Defines how to update the issue's time estimate, the options are: *
new
Sets the estimate to a specific value, defined innewEstimate
. *leave
Leaves the estimate unchanged. *manual
Reduces the estimate by amount specified inreduceBy
. *auto
Reduces the estimate by the value oftimeSpent
in the worklog.
- newEstimate string? (default ()) - The value to set as the issue's remaining time estimate, as days (#d), hours (#h), or minutes (#m or #). For example, 2d. Required when
adjustEstimate
isnew
.
- reduceBy string? (default ()) - The amount to reduce the issue's remaining estimate by, as days (#d), hours (#h), or minutes (#m). For example, 2d. Required when
adjustEstimate
ismanual
.
- overrideEditableFlag boolean (default false) - Whether the worklog entry should be added to the issue even if the issue is not editable, because jira.issue.editable set to false or missing. For example, the issue is closed. Only connect app users with admin scope permission can use this flag.
getWorklog
Get worklog
updateWorklog
function updateWorklog(string issueIdOrKey, string id, Worklog payload, boolean notifyUsers, string adjustEstimate, string? newEstimate, string expand, boolean overrideEditableFlag) returns Worklog|error
Update worklog
Parameters
- issueIdOrKey string - The ID or key the issue.
- id string - The ID of the worklog.
- payload Worklog - The request payload to update worklog.
- notifyUsers boolean (default true) - Whether users watching the issue are notified by email.
- adjustEstimate string (default "auto") - Defines how to update the issue's time estimate, the options are: *
new
Sets the estimate to a specific value, defined innewEstimate
. *leave
Leaves the estimate unchanged. *auto
Updates the estimate by the difference between the original and updated value oftimeSpent
ortimeSpentSeconds
.
- newEstimate string? (default ()) - The value to set as the issue's remaining time estimate, as days (#d), hours (#h), or minutes (#m or #). For example, 2d. Required when
adjustEstimate
isnew
.
- overrideEditableFlag boolean (default false) - Whether the worklog should be added to the issue even if the issue is not editable. For example, because the issue is closed. Only connect app users with admin permissions can use this flag.
deleteWorklog
function deleteWorklog(string issueIdOrKey, string id, boolean notifyUsers, string adjustEstimate, string? newEstimate, string? increaseBy, boolean overrideEditableFlag) returns Response|error
Delete worklog
Parameters
- issueIdOrKey string - The ID or key of the issue.
- id string - The ID of the worklog.
- notifyUsers boolean (default true) - Whether users watching the issue are notified by email.
- adjustEstimate string (default "auto") - Defines how to update the issue's time estimate, the options are: *
new
Sets the estimate to a specific value, defined innewEstimate
. *leave
Leaves the estimate unchanged. *manual
Increases the estimate by amount specified inincreaseBy
. *auto
Reduces the estimate by the value oftimeSpent
in the worklog.
- newEstimate string? (default ()) - The value to set as the issue's remaining time estimate, as days (#d), hours (#h), or minutes (#m or #). For example, 2d. Required when
adjustEstimate
isnew
.
- increaseBy string? (default ()) - The amount to increase the issue's remaining estimate by, as days (#d), hours (#h), or minutes (#m or #). For example, 2d. Required when
adjustEstimate
ismanual
.
- overrideEditableFlag boolean (default false) - Whether the work log entry should be added to the issue even if the issue is not editable, because jira.issue.editable set to false or missing. For example, the issue is closed. Only connect app users with admin permissions can use this flag.
getIdsOfWorklogsDeletedSince
function getIdsOfWorklogsDeletedSince(int since) returns ChangedWorklogs|error
Get IDs of deleted worklogs
Parameters
- since int (default 0) - The date and time, as a UNIX timestamp in milliseconds, after which deleted worklogs are returned.
Return Type
- ChangedWorklogs|error - Returned if the request is successful.
getWorklogsForIds
function getWorklogsForIds(WorklogIdsRequestBean payload, string expand) returns Worklog[]|error
Get worklogs
Parameters
- payload WorklogIdsRequestBean - A JSON object containing a list of worklog IDs.
getIdsOfWorklogsModifiedSince
function getIdsOfWorklogsModifiedSince(int since, string expand) returns ChangedWorklogs|error
Get IDs of updated worklogs
Parameters
- since int (default 0) - The date and time, as a UNIX timestamp in milliseconds, after which updated worklogs are returned.
Return Type
- ChangedWorklogs|error - Returned if the request is successful.
getWorklogPropertyKeys
function getWorklogPropertyKeys(string issueIdOrKey, string worklogId) returns PropertyKeys|error
Get worklog property keys
Parameters
- issueIdOrKey string - The ID or key of the issue.
- worklogId string - The ID of the worklog.
Return Type
- PropertyKeys|error - Returned if the request is successful.
getWorklogProperty
function getWorklogProperty(string issueIdOrKey, string worklogId, string propertyKey) returns EntityProperty|error
Get worklog property
Parameters
- issueIdOrKey string - The ID or key of the issue.
- worklogId string - The ID of the worklog.
- propertyKey string - The key of the property.
Return Type
- EntityProperty|error - Returned if the request is successful.
setWorklogProperty
function setWorklogProperty(string issueIdOrKey, string worklogId, string propertyKey, json payload) returns json|error
Set worklog property
Parameters
- issueIdOrKey string - The ID or key of the issue.
- worklogId string - The ID of the worklog.
- propertyKey string - The key of the issue property. The maximum length is 255 characters.
- payload json - The request payload to set worklog property.
Return Type
- json|error - Returned if the worklog property is updated.
deleteWorklogProperty
function deleteWorklogProperty(string issueIdOrKey, string worklogId, string propertyKey) returns Response|error
Delete worklog property
Parameters
- issueIdOrKey string - The ID or key of the issue.
- worklogId string - The ID of the worklog.
- propertyKey string - The key of the property.
getWorkflowTransitionRuleConfigurations
function getWorkflowTransitionRuleConfigurations(string[] types, int startAt, int maxResults, string[]? keys, string? expand) returns PageBeanWorkflowTransitionRules|error
Get workflow transition rule configurations
Parameters
- types string[] - The types of the transition rules to return.
- startAt int (default 0) - The index of the first item to return in a page of results (page offset).
- maxResults int (default 10) - The maximum number of items to return per page.
- keys string[]? (default ()) - The transition rule class keys, as defined in the Connect app descriptor, of the transition rules to return.
Return Type
- PageBeanWorkflowTransitionRules|error - Returned if the request is successful.
updateWorkflowTransitionRuleConfigurations
function updateWorkflowTransitionRuleConfigurations(WorkflowTransitionRulesUpdate payload) returns WorkflowTransitionRulesUpdateErrors|error
Update workflow transition rule configurations
Parameters
- payload WorkflowTransitionRulesUpdate - The request payload to update configuration of workflow transition rules.
Return Type
- WorkflowTransitionRulesUpdateErrors|error - Returned if the request is successful.
deleteWorkflowTransitionRuleConfigurations
function deleteWorkflowTransitionRuleConfigurations(WorkflowsWithTransitionRulesDetails payload) returns WorkflowTransitionRulesUpdateErrors|error
Delete workflow transition rule configurations
Parameters
- payload WorkflowsWithTransitionRulesDetails - The request payload to delete configuration of workflow transition rules.
Return Type
- WorkflowTransitionRulesUpdateErrors|error - Returned if the request is successful.
getWorkflowTransitionProperties
function getWorkflowTransitionProperties(int transitionId, string workflowName, boolean includeReservedKeys, string? 'key, string workflowMode) returns WorkflowTransitionProperty|error
Get workflow transition properties
Parameters
- transitionId int - The ID of the transition. To get the ID, view the workflow in text mode in the Jira administration console. The ID is shown next to the transition.
- workflowName string - The name of the workflow that the transition belongs to.
- includeReservedKeys boolean (default false) - Some properties with keys that have the jira. prefix are reserved, which means they are not editable. To include these properties in the results, set this parameter to true.
- 'key string? (default ()) - The key of the property being returned, also known as the name of the property. If this parameter is not specified, all properties on the transition are returned.
- workflowMode string (default "live") - The workflow status. Set to live for active and inactive workflows, or draft for draft workflows.
Return Type
- WorkflowTransitionProperty|error - 200 response
updateWorkflowTransitionProperty
function updateWorkflowTransitionProperty(int transitionId, string 'key, string workflowName, WorkflowTransitionProperty payload, string? workflowMode) returns WorkflowTransitionProperty|error
Update workflow transition property
Parameters
- transitionId int - The ID of the transition. To get the ID, view the workflow in text mode in the Jira admin settings. The ID is shown next to the transition.
- 'key string - The key of the property being updated, also known as the name of the property. Set this to the same value as the
key
defined in the request body.
- workflowName string - The name of the workflow that the transition belongs to.
- payload WorkflowTransitionProperty - The request payload to update configuration of workflow transition property.
- workflowMode string? (default ()) - The workflow status. Set to
live
for inactive workflows ordraft
for draft workflows. Active workflows cannot be edited.
Return Type
- WorkflowTransitionProperty|error - 200 response
createWorkflowTransitionProperty
function createWorkflowTransitionProperty(int transitionId, string 'key, string workflowName, WorkflowTransitionProperty payload, string workflowMode) returns WorkflowTransitionProperty|error
Create workflow transition property
Parameters
- transitionId int - The ID of the transition. To get the ID, view the workflow in text mode in the Jira admin settings. The ID is shown next to the transition.
- 'key string - The key of the property being added, also known as the name of the property. Set this to the same value as the
key
defined in the request body.
- workflowName string - The name of the workflow that the transition belongs to.
- payload WorkflowTransitionProperty - The request payload to create configuration of workflow transition property.
- workflowMode string (default "live") - The workflow status. Set to live for inactive workflows or draft for draft workflows. Active workflows cannot be edited.
Return Type
- WorkflowTransitionProperty|error - 200 response
deleteWorkflowTransitionProperty
function deleteWorkflowTransitionProperty(int transitionId, string 'key, string workflowName, string? workflowMode) returns Response|error
Delete workflow transition property
Parameters
- transitionId int - The ID of the transition. To get the ID, view the workflow in text mode in the Jira admin settings. The ID is shown next to the transition.
- 'key string - The name of the transition property to delete, also known as the name of the property.
- workflowName string - The name of the workflow that the transition belongs to.
- workflowMode string? (default ()) - The workflow status. Set to
live
for inactive workflows ordraft
for draft workflows. Active workflows cannot be edited.
getAllWorkflowSchemes
function getAllWorkflowSchemes(int startAt, int maxResults) returns PageBeanWorkflowScheme|error
Get all workflow schemes
Parameters
- startAt int (default 0) - The index of the first item to return in a page of results (page offset).
- maxResults int (default 50) - The maximum number of items to return per page.
Return Type
- PageBeanWorkflowScheme|error - Returned if the request is successful.
createWorkflowScheme
function createWorkflowScheme(WorkflowScheme payload) returns WorkflowScheme|error
Create workflow scheme
Parameters
- payload WorkflowScheme - The request payload to create workflow scheme.
Return Type
- WorkflowScheme|error - Returned if the request is successful.
getWorkflowSchemeProjectAssociations
function getWorkflowSchemeProjectAssociations(int[] projectId) returns ContainerOfWorkflowSchemeAssociations|error
Get workflow scheme project associations
Parameters
- projectId int[] - The ID of a project to return the workflow schemes for. To include multiple projects, provide an ampersand-Jim: oneseparated list. For example,
projectId=10000&projectId=10001
.
Return Type
- ContainerOfWorkflowSchemeAssociations|error - Returned if the request is successful.
assignSchemeToProject
function assignSchemeToProject(WorkflowSchemeProjectAssociation payload) returns json|error
Assign workflow scheme to project
Parameters
- payload WorkflowSchemeProjectAssociation - The request payload to assign workflow scheme to project.
Return Type
- json|error - Returned if the request is successful.
getWorkflowScheme
function getWorkflowScheme(int id, boolean returnDraftIfExists) returns WorkflowScheme|error
Get workflow scheme
Parameters
- id int - The ID of the workflow scheme. Find this ID by editing the desired workflow scheme in Jira. The ID is shown in the URL as
schemeId
. For example, schemeId=10301.
- returnDraftIfExists boolean (default false) - Returns the workflow scheme's draft rather than scheme itself, if set to true. If the workflow scheme does not have a draft, then the workflow scheme is returned.
Return Type
- WorkflowScheme|error - Returned if the request is successful.
updateWorkflowScheme
function updateWorkflowScheme(int id, WorkflowScheme payload) returns WorkflowScheme|error
Update workflow scheme
Parameters
- id int - The ID of the workflow scheme. Find this ID by editing the desired workflow scheme in Jira. The ID is shown in the URL as
schemeId
. For example, schemeId=10301.
- payload WorkflowScheme - The request payload to update workflow scheme.
Return Type
- WorkflowScheme|error - Returned if the request is successful.
deleteWorkflowScheme
Delete workflow scheme
Parameters
- id int - The ID of the workflow scheme. Find this ID by editing the desired workflow scheme in Jira. The ID is shown in the URL as
schemeId
. For example, schemeId=10301.
createWorkflowSchemeDraftFromParent
function createWorkflowSchemeDraftFromParent(int id) returns WorkflowScheme|error
Create draft workflow scheme
Parameters
- id int - The ID of the active workflow scheme that the draft is created from.
Return Type
- WorkflowScheme|error - Returned if the request is successful.
getDefaultWorkflow
function getDefaultWorkflow(int id, boolean returnDraftIfExists) returns DefaultWorkflow|error
Get default workflow
Parameters
- id int - The ID of the workflow scheme.
- returnDraftIfExists boolean (default false) - Set to
true
to return the default workflow for the workflow scheme's draft rather than scheme itself. If the workflow scheme does not have a draft, then the default workflow for the workflow scheme is returned.
Return Type
- DefaultWorkflow|error - Returned if the request is successful.
updateDefaultWorkflow
function updateDefaultWorkflow(int id, DefaultWorkflow payload) returns WorkflowScheme|error
Update default workflow
Parameters
- id int - The ID of the workflow scheme.
- payload DefaultWorkflow - The new default workflow.
Return Type
- WorkflowScheme|error - Returned if the request is successful.
deleteDefaultWorkflow
function deleteDefaultWorkflow(int id, boolean? updateDraftIfNeeded) returns WorkflowScheme|error
Delete default workflow
Parameters
- id int - The ID of the workflow scheme.
- updateDraftIfNeeded boolean? (default ()) - Set to true to create or update the draft of a workflow scheme and delete the mapping from the draft, when the workflow scheme cannot be edited. Defaults to
false
.
Return Type
- WorkflowScheme|error - Returned if the request is successful.
getWorkflowSchemeDraft
function getWorkflowSchemeDraft(int id) returns WorkflowScheme|error
Get draft workflow scheme
Parameters
- id int - The ID of the active workflow scheme that the draft was created from.
Return Type
- WorkflowScheme|error - Returned if the request is successful.
updateWorkflowSchemeDraft
function updateWorkflowSchemeDraft(int id, WorkflowScheme payload) returns WorkflowScheme|error
Update draft workflow scheme
Parameters
- id int - The ID of the active workflow scheme that the draft was created from.
- payload WorkflowScheme - The request payload to update workflow scheme draft.
Return Type
- WorkflowScheme|error - Returned if the request is successful.
deleteWorkflowSchemeDraft
Delete draft workflow scheme
Parameters
- id int - The ID of the active workflow scheme that the draft was created from.
getDraftDefaultWorkflow
function getDraftDefaultWorkflow(int id) returns DefaultWorkflow|error
Get draft default workflow
Parameters
- id int - The ID of the workflow scheme that the draft belongs to.
Return Type
- DefaultWorkflow|error - Returned if the request is successful.
updateDraftDefaultWorkflow
function updateDraftDefaultWorkflow(int id, DefaultWorkflow payload) returns WorkflowScheme|error
Update draft default workflow
Parameters
- id int - The ID of the workflow scheme that the draft belongs to.
- payload DefaultWorkflow - The object for the new default workflow.
Return Type
- WorkflowScheme|error - Returned if the request is successful.
deleteDraftDefaultWorkflow
function deleteDraftDefaultWorkflow(int id) returns WorkflowScheme|error
Delete draft default workflow
Parameters
- id int - The ID of the workflow scheme that the draft belongs to.
Return Type
- WorkflowScheme|error - Returned if the request is successful.
getWorkflowSchemeDraftIssueType
function getWorkflowSchemeDraftIssueType(int id, string issueType) returns IssueTypeWorkflowMapping|error
Get workflow for issue type in draft workflow scheme
Parameters
- id int - The ID of the workflow scheme that the draft belongs to.
- issueType string - The ID of the issue type.
Return Type
- IssueTypeWorkflowMapping|error - Returned if the request is successful.
setWorkflowSchemeDraftIssueType
function setWorkflowSchemeDraftIssueType(int id, string issueType, IssueTypeWorkflowMapping payload) returns WorkflowScheme|error
Set workflow for issue type in draft workflow scheme
Parameters
- id int - The ID of the workflow scheme that the draft belongs to.
- issueType string - The ID of the issue type.
- payload IssueTypeWorkflowMapping - The issue type-project mapping.
Return Type
- WorkflowScheme|error - Returned if the request is successful.
deleteWorkflowSchemeDraftIssueType
function deleteWorkflowSchemeDraftIssueType(int id, string issueType) returns WorkflowScheme|error
Delete workflow for issue type in draft workflow scheme
Parameters
- id int - The ID of the workflow scheme that the draft belongs to.
- issueType string - The ID of the issue type.
Return Type
- WorkflowScheme|error - Returned if the request is successful.
publishDraftWorkflowScheme
function publishDraftWorkflowScheme(int id, PublishDraftWorkflowScheme payload, boolean validateOnly) returns Response|error
Publish draft workflow scheme
Parameters
- id int - The ID of the workflow scheme that the draft belongs to.
- payload PublishDraftWorkflowScheme - Details of the status mappings.
- validateOnly boolean (default false) - Whether the request only performs a validation.
getDraftWorkflow
function getDraftWorkflow(int id, string? workflowName) returns IssueTypesWorkflowMapping|error
Get issue types for workflows in draft workflow scheme
Parameters
- id int - The ID of the workflow scheme that the draft belongs to.
- workflowName string? (default ()) - The name of a workflow in the scheme. Limits the results to the workflow-issue type mapping for the specified workflow.
Return Type
- IssueTypesWorkflowMapping|error - Returned if the request is successful.
updateDraftWorkflowMapping
function updateDraftWorkflowMapping(int id, string workflowName, IssueTypesWorkflowMapping payload) returns WorkflowScheme|error
Set issue types for workflow in workflow scheme
Parameters
- id int - The ID of the workflow scheme that the draft belongs to.
- workflowName string - The name of the workflow.
- payload IssueTypesWorkflowMapping - The request payload to set issue types in workflow scheme draft.
Return Type
- WorkflowScheme|error - Returned if the request is successful.
deleteDraftWorkflowMapping
Delete issue types for workflow in draft workflow scheme
Parameters
- id int - The ID of the workflow scheme that the draft belongs to.
- workflowName string - The name of the workflow.
getWorkflowSchemeIssueType
function getWorkflowSchemeIssueType(int id, string issueType, boolean returnDraftIfExists) returns IssueTypeWorkflowMapping|error
Get workflow for issue type in workflow scheme
Parameters
- id int - The ID of the workflow scheme.
- issueType string - The ID of the issue type.
- returnDraftIfExists boolean (default false) - Returns the mapping from the workflow scheme's draft rather than the workflow scheme, if set to true. If no draft exists, the mapping from the workflow scheme is returned.
Return Type
- IssueTypeWorkflowMapping|error - Returned if the request is successful.
setWorkflowSchemeIssueType
function setWorkflowSchemeIssueType(int id, string issueType, IssueTypeWorkflowMapping payload) returns WorkflowScheme|error
Set workflow for issue type in workflow scheme
Parameters
- id int - The ID of the workflow scheme.
- issueType string - The ID of the issue type.
- payload IssueTypeWorkflowMapping - The issue type-project mapping.
Return Type
- WorkflowScheme|error - Returned if the request is successful.
deleteWorkflowSchemeIssueType
function deleteWorkflowSchemeIssueType(int id, string issueType, boolean? updateDraftIfNeeded) returns WorkflowScheme|error
Delete workflow for issue type in workflow scheme
Parameters
- id int - The ID of the workflow scheme.
- issueType string - The ID of the issue type.
- updateDraftIfNeeded boolean? (default ()) - Set to true to create or update the draft of a workflow scheme and update the mapping in the draft, when the workflow scheme cannot be edited. Defaults to
false
.
Return Type
- WorkflowScheme|error - Returned if the request is successful.
getWorkflow
function getWorkflow(int id, string? workflowName, boolean returnDraftIfExists) returns IssueTypesWorkflowMapping|error
Get issue types for workflows in workflow scheme
Parameters
- id int - The ID of the workflow scheme.
- workflowName string? (default ()) - The name of a workflow in the scheme. Limits the results to the workflow-issue type mapping for the specified workflow.
- returnDraftIfExists boolean (default false) - Returns the mapping from the workflow scheme's draft rather than the workflow scheme, if set to true. If no draft exists, the mapping from the workflow scheme is returned.
Return Type
- IssueTypesWorkflowMapping|error - Returned if the request is successful.
updateWorkflowMapping
function updateWorkflowMapping(int id, string workflowName, IssueTypesWorkflowMapping payload) returns WorkflowScheme|error
Set issue types for workflow in workflow scheme
Parameters
- id int - The ID of the workflow scheme.
- workflowName string - The name of the workflow.
- payload IssueTypesWorkflowMapping - The request payload to set issue types in workflow scheme.
Return Type
- WorkflowScheme|error - Returned if the request is successful.
deleteWorkflowMapping
function deleteWorkflowMapping(int id, string workflowName, boolean? updateDraftIfNeeded) returns Response|error
Delete issue types for workflow in workflow scheme
Parameters
- id int - The ID of the workflow scheme.
- workflowName string - The name of the workflow.
- updateDraftIfNeeded boolean? (default ()) - Set to true to create or update the draft of a workflow scheme and delete the mapping from the draft, when the workflow scheme cannot be edited. Defaults to
false
.
getStatuses
function getStatuses() returns StatusDetails[]|error
Get all statuses
Return Type
- StatusDetails[]|error - Returned if the request is successful.
getStatus
function getStatus(string idOrName) returns StatusDetails|error
Get status
Parameters
- idOrName string - The ID or name of the status.
Return Type
- StatusDetails|error - Returned if the request is successful.
getStatusCategories
function getStatusCategories() returns StatusCategory[]|error
Get all status categories
Return Type
- StatusCategory[]|error - Returned if the request is successful.
getStatusCategory
function getStatusCategory(string idOrKey) returns StatusCategory|error
Get status category
Parameters
- idOrKey string - The ID or key of the status category.
Return Type
- StatusCategory|error - Returned if the request is successful.
getAllProjectCategories
function getAllProjectCategories() returns ProjectCategory[]|error
Get all project categories
Return Type
- ProjectCategory[]|error - Returned if the request is successful.
createProjectCategory
function createProjectCategory(ProjectCategory payload) returns ProjectCategory|error
Create project category
Parameters
- payload ProjectCategory - The request payload to create project category.
Return Type
- ProjectCategory|error - Returned if the request is successful.
getProjectCategoryById
function getProjectCategoryById(int id) returns ProjectCategory|error
Get project category by ID
Parameters
- id int - The ID of the project category.
Return Type
- ProjectCategory|error - Returned if the request is successful.
updateProjectCategory
function updateProjectCategory(int id, ProjectCategory payload) returns UpdatedProjectCategory|error
Update project category
Parameters
- id int - Project category ID.
- payload ProjectCategory - The request payload to update a project category.
Return Type
- UpdatedProjectCategory|error - Returned if the request is successful.
removeProjectCategory
Delete project category
Parameters
- id int - ID of the project category to delete.
createComponent
function createComponent(ProjectComponent payload) returns ProjectComponent|error
Create component
Parameters
- payload ProjectComponent - The request payload to create a component.
Return Type
- ProjectComponent|error - Returned if the request is successful.
getComponent
function getComponent(string id) returns ProjectComponent|error
Get component
Parameters
- id string - The ID of the component.
Return Type
- ProjectComponent|error - Returned if the request is successful.
updateComponent
function updateComponent(string id, ProjectComponent payload) returns ProjectComponent|error
Update component
Parameters
- id string - The ID of the component.
- payload ProjectComponent - The request payload to update a component.
Return Type
- ProjectComponent|error - Returned if the request is successful.
deleteComponent
Delete component
Parameters
- id string - The ID of the component.
- moveIssuesTo string? (default ()) - The ID of the component to replace the deleted component. If this value is null no replacement is made.
getComponentRelatedIssues
function getComponentRelatedIssues(string id) returns ComponentIssuesCount|error
Get component issues count
Parameters
- id string - The ID of the component.
Return Type
- ComponentIssuesCount|error - Returned if the request is successful.
getProjectComponentsPaginated
function getProjectComponentsPaginated(string projectIdOrKey, int startAt, int maxResults, string? orderBy, string? query) returns PageBeanComponentWithIssueCount|error
Get project components paginated
Parameters
- projectIdOrKey string - The project ID or project key (case sensitive).
- startAt int (default 0) - The index of the first item to return in a page of results (page offset).
- maxResults int (default 50) - The maximum number of items to return per page.
- query string? (default ()) - Filter the results using a literal string. Components with a matching
name
ordescription
are returned (case insensitive).
Return Type
- PageBeanComponentWithIssueCount|error - Returned if the request is successful.
getProjectComponents
function getProjectComponents(string projectIdOrKey) returns ProjectComponent[]|error
Get project components
Parameters
- projectIdOrKey string - The project ID or project key (case sensitive).
Return Type
- ProjectComponent[]|error - Returned if the request is successful.
getProjectPropertyKeys
function getProjectPropertyKeys(string projectIdOrKey) returns PropertyKeys|error
Get project property keys
Parameters
- projectIdOrKey string - The project ID or project key (case sensitive).
Return Type
- PropertyKeys|error - Returned if the request is successful.
getProjectProperty
function getProjectProperty(string projectIdOrKey, string propertyKey) returns EntityProperty|error
Get project property
Parameters
- projectIdOrKey string - The project ID or project key (case sensitive).
- propertyKey string - The project property key. Use Get project property keys to get a list of all project property keys.
Return Type
- EntityProperty|error - Returned if the request is successful.
setProjectProperty
function setProjectProperty(string projectIdOrKey, string propertyKey, json payload) returns json|error
Set project property
Parameters
- projectIdOrKey string - The project ID or project key (case sensitive).
- propertyKey string - The key of the project property. The maximum length is 255 characters.
- payload json - The request payload to set project property.
Return Type
- json|error - Returned if the project property is updated.
deleteProjectProperty
Delete project property
Parameters
- projectIdOrKey string - The project ID or project key (case sensitive).
- propertyKey string - The project property key. Use Get project property keys to get a list of all project property keys.
getProjectRoles
Get project roles for project
Parameters
- projectIdOrKey string - The project ID or project key (case sensitive).
Return Type
- json|error - Returned if the request is successful.
getProjectRole
function getProjectRole(string projectIdOrKey, int id) returns ProjectRole|error
Get project role for project
Parameters
- projectIdOrKey string - The project ID or project key (case sensitive).
- id int - The ID of the project role. Use Get all project roles to get a list of project role IDs.
Return Type
- ProjectRole|error - Returned if the request is successful.
setActors
function setActors(string projectIdOrKey, int id, ProjectRoleActorsUpdateBean payload) returns ProjectRole|error
Set actors for project role
Parameters
- projectIdOrKey string - The project ID or project key (case sensitive).
- id int - The ID of the project role. Use Get all project roles to get a list of project role IDs.
- payload ProjectRoleActorsUpdateBean - The groups or users to associate with the project role for this project. Provide the user account ID or group name.
Return Type
- ProjectRole|error - Returned if the request is successful. The complete list of actors for the project is returned.
addActorUsers
function addActorUsers(string projectIdOrKey, int id, ActorsMap payload) returns ProjectRole|error
Add actors to project role
Parameters
- projectIdOrKey string - The project ID or project key (case sensitive).
- id int - The ID of the project role. Use Get all project roles to get a list of project role IDs.
- payload ActorsMap - The groups or users to associate with the project role for this project. Provide the user account ID or group name.
Return Type
- ProjectRole|error - Returned if the request is successful. The complete list of actors for the project is returned. For example, the cURL request above adds a group, jira-developers. For the response below to be returned as a result of that request, the user Mia Krystof would have previously been added as a
user
actor for this project.
deleteActor
function deleteActor(string projectIdOrKey, int id, string? user, string? group) returns Response|error
Delete actors from project role
Parameters
- projectIdOrKey string - The project ID or project key (case sensitive).
- id int - The ID of the project role. Use Get all project roles to get a list of project role IDs.
- user string? (default ()) - The user account ID of the user to remove from the project role.
- group string? (default ()) - The name of the group to remove from the project role.
getProjectRoleDetails
function getProjectRoleDetails(string projectIdOrKey, boolean currentMember, boolean excludeConnectAddons) returns ProjectRoleDetails[]|error
Get project role details
Parameters
- projectIdOrKey string - The project ID or project key (case sensitive).
- currentMember boolean (default false) - Whether the roles should be filtered to include only those the user is assigned to.
- excludeConnectAddons boolean (default false) - Whether to exclude connect addons.
Return Type
- ProjectRoleDetails[]|error - Returned if the request is successful.
getAllProjectRoles
function getAllProjectRoles() returns ProjectRole[]|error
Get all project roles
Return Type
- ProjectRole[]|error - Returned if the request is successful.
createProjectRole
function createProjectRole(CreateUpdateRoleRequestBean payload) returns ProjectRole|error
Create project role
Parameters
- payload CreateUpdateRoleRequestBean - The request payload to create a new project role.
Return Type
- ProjectRole|error - Returned if the request is successful.
getProjectRoleById
function getProjectRoleById(int id) returns ProjectRole|error
Get project role by ID
Parameters
- id int - The ID of the project role. Use Get all project roles to get a list of project role IDs.
Return Type
- ProjectRole|error - Returned if the request is successful.
fullyUpdateProjectRole
function fullyUpdateProjectRole(int id, CreateUpdateRoleRequestBean payload) returns ProjectRole|error
Fully update project role
Parameters
- id int - The ID of the project role. Use Get all project roles to get a list of project role IDs.
- payload CreateUpdateRoleRequestBean - The request payload to fully update a project role.
Return Type
- ProjectRole|error - Returned if the request is successful.
partialUpdateProjectRole
function partialUpdateProjectRole(int id, CreateUpdateRoleRequestBean payload) returns ProjectRole|error
Partial update project role
Parameters
- id int - The ID of the project role. Use Get all project roles to get a list of project role IDs.
- payload CreateUpdateRoleRequestBean - The request payload to partial update a project role.
Return Type
- ProjectRole|error - Returned if the request is successful.
deleteProjectRole
Delete project role
Parameters
- id int - The ID of the project role to delete. Use Get all project roles to get a list of project role IDs.
- swap int? (default ()) - The ID of the project role that will replace the one being deleted.
getProjectRoleActorsForRole
function getProjectRoleActorsForRole(int id) returns ProjectRole|error
Get default actors for project role
Parameters
- id int - The ID of the project role. Use Get all project roles to get a list of project role IDs.
Return Type
- ProjectRole|error - Returned if the request is successful.
addProjectRoleActorsToRole
function addProjectRoleActorsToRole(int id, ActorInputBean payload) returns ProjectRole|error
Add default actors to project role
Parameters
- id int - The ID of the project role. Use Get all project roles to get a list of project role IDs.
- payload ActorInputBean - The request payload to add default users to project role.
Return Type
- ProjectRole|error - Returned if the request is successful.
deleteProjectRoleActorsFromRole
function deleteProjectRoleActorsFromRole(int id, string? user, string? group) returns ProjectRole|error
Delete default actors from project role
Parameters
- id int - The ID of the project role. Use Get all project roles to get a list of project role IDs.
- user string? (default ()) - The user account ID of the user to remove as a default actor.
- group string? (default ()) - The group name of the group to be removed as a default actor.
Return Type
- ProjectRole|error - Returned if the request is successful.
getUser
function getUser(string? accountId, string? username, string? 'key, string? expand) returns User|error
Get user
Parameters
- accountId string? (default ()) - The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5. Required.
- username string? (default ()) - This parameter is no longer available and will be removed from the documentation soon. See the deprecation notice for details.
- 'key string? (default ()) - This parameter is no longer available and will be removed from the documentation soon. See the deprecation notice for details.
- expand string? (default ()) - Use expand to include additional information about users in the response. This parameter accepts a comma-separated list. Expand options include: *
groups
includes all groups and nested groups to which the user belongs. *applicationRoles
includes details of all the applications to which the user has access.
createUser
function createUser(UserWriteBean payload) returns User|error
Create user
Parameters
- payload UserWriteBean - Details about the user to be created.
removeUser
Delete user
Parameters
- accountId string - The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5.
- username string? (default ()) - This parameter is no longer available and will be removed from the documentation soon. See the deprecation notice for details.
- 'key string? (default ()) - This parameter is no longer available and will be removed from the documentation soon. See the deprecation notice for details.
bulkGetUsers
function bulkGetUsers(string[] accountId, int startAt, int maxResults, string[]? username, string[]? 'key) returns PageBeanUser|error
Bulk get users
Parameters
- accountId string[] - The account ID of a user. To specify multiple users, pass multiple
accountId
parameters. For example,accountId=5b10a2844c20165700ede21g&accountId=5b10ac8d82e05b22cc7d4ef5
.
- startAt int (default 0) - The index of the first item to return in a page of results (page offset).
- maxResults int (default 10) - The maximum number of items to return per page.
- username string[]? (default ()) - This parameter is no longer available and will be removed from the documentation soon. See the deprecation notice for details.
- 'key string[]? (default ()) - This parameter is no longer available and will be removed from the documentation soon. See the deprecation notice for details.
Return Type
- PageBeanUser|error - Returned if the request is successful.
bulkGetUsersMigration
function bulkGetUsersMigration(int startAt, int maxResults, string[]? username, string[]? 'key) returns UserMigrationBean[]|error
Get account IDs for users
Parameters
- startAt int (default 0) - The index of the first item to return in a page of results (page offset).
- maxResults int (default 10) - The maximum number of items to return per page.
- username string[]? (default ()) - Username of a user. To specify multiple users, pass multiple copies of this parameter. For example,
username=fred&username=barney
. Required ifkey
isn't provided. Cannot be provided ifkey
is present.
- 'key string[]? (default ()) - Key of a user. To specify multiple users, pass multiple copies of this parameter. For example,
key=fred&key=barney
. Required ifusername
isn't provided. Cannot be provided ifusername
is present.
Return Type
- UserMigrationBean[]|error - Returned if the request is successful.
getUserDefaultColumns
function getUserDefaultColumns(string? accountId, string? username) returns ColumnItem[]|error
Get user default columns
Parameters
- accountId string? (default ()) - The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5.
- username string? (default ()) - This parameter is no longer available and will be removed from the documentation soon. See the deprecation notice for details.
Return Type
- ColumnItem[]|error - Returned if the request is successful.
setUserColumns
Set user default columns
Parameters
- payload byte[] - The ID of a column to set. To set multiple columns, send multiple
columns
parameters.
- accountId string? (default ()) - The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5.
Return Type
- json|error - Returned if the request is successful.
resetUserColumns
Reset user default columns
Parameters
- accountId string? (default ()) - The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5.
- username string? (default ()) - This parameter is no longer available and will be removed from the documentation soon. See the deprecation notice for details.
getUserEmail
function getUserEmail(string accountId) returns UnrestrictedUserEmail|error
Get user email
Parameters
- accountId string - The account ID of the user, which uniquely identifies the user across all Atlassian products. For example,
5b10ac8d82e05b22cc7d4ef5
.
Return Type
- UnrestrictedUserEmail|error - Returned if the request is successful.
getUserEmailBulk
function getUserEmailBulk(string[] accountId) returns UnrestrictedUserEmail|error
Get user email bulk
Parameters
- accountId string[] - The account IDs of the users for which emails are required. An
accountId
is an identifier that uniquely identifies the user across all Atlassian products. For example,5b10ac8d82e05b22cc7d4ef5
. Note, this should be treated as an opaque identifier (that is, do not assume any structure in the value).
Return Type
- UnrestrictedUserEmail|error - Returned if the request is successful.
getUserGroups
Get user groups
Parameters
- accountId string - The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5.
- username string? (default ()) - This parameter is no longer available and will be removed from the documentation soon. See the deprecation notice for details.
- 'key string? (default ()) - This parameter is no longer available and will be removed from the documentation soon. See the deprecation notice for details.
getAllUsersDefault
Get all users default
Parameters
- startAt int (default 0) - The index of the first item to return.
- maxResults int (default 50) - The maximum number of items to return.
getAllUsers
Get all users
Parameters
- startAt int (default 0) - The index of the first item to return.
- maxResults int (default 50) - The maximum number of items to return.
getUserPropertyKeys
function getUserPropertyKeys(string? accountId, string? userKey, string? username) returns PropertyKeys|error
Get user property keys
Parameters
- accountId string? (default ()) - The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5.
- userKey string? (default ()) - This parameter is no longer available and will be removed from the documentation soon. See the deprecation notice for details.
- username string? (default ()) - This parameter is no longer available and will be removed from the documentation soon. See the deprecation notice for details.
Return Type
- PropertyKeys|error - Returned if the request is successful.
getUserProperty
function getUserProperty(string propertyKey, string? accountId, string? userKey, string? username) returns EntityProperty|error
Get user property
Parameters
- propertyKey string - The key of the user's property.
- accountId string? (default ()) - The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5.
- userKey string? (default ()) - This parameter is no longer available and will be removed from the documentation soon. See the deprecation notice for details.
- username string? (default ()) - This parameter is no longer available and will be removed from the documentation soon. See the deprecation notice for details.
Return Type
- EntityProperty|error - Returned if the request is successful.
setUserProperty
function setUserProperty(string propertyKey, json payload, string? accountId, string? userKey, string? username) returns json|error
Set user property
Parameters
- propertyKey string - The key of the user's property. The maximum length is 255 characters.
- payload json - The request payload to set the value of a user's property.
- accountId string? (default ()) - The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5.
- userKey string? (default ()) - This parameter is no longer available and will be removed from the documentation soon. See the deprecation notice for details.
- username string? (default ()) - This parameter is no longer available and will be removed from the documentation soon. See the deprecation notice for details.
Return Type
- json|error - Returned if the user property is updated.
deleteUserProperty
function deleteUserProperty(string propertyKey, string? accountId, string? userKey, string? username) returns Response|error
Delete user property
Parameters
- propertyKey string - The key of the user's property.
- accountId string? (default ()) - The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5.
- userKey string? (default ()) - This parameter is no longer available and will be removed from the documentation soon. See the deprecation notice for details.
- username string? (default ()) - This parameter is no longer available and will be removed from the documentation soon. See the deprecation notice for details.
findBulkAssignableUsers
function findBulkAssignableUsers(string projectKeys, string? query, string? username, string? accountId, int startAt, int maxResults) returns User[]|error
Find users assignable to projects
Parameters
- projectKeys string - A list of project keys (case sensitive). This parameter accepts a comma-separated list.
- query string? (default ()) - A query string that is matched against user attributes, such as
displayName
andemailAddress
, to find relevant users. The string can match the prefix of the attribute's value. For example, query=john matches a user with adisplayName
of John Smith and a user with anemailAddress
of johnson@example.com. Required, unlessaccountId
is specified.
- username string? (default ()) - This parameter is no longer available and will be removed from the documentation soon. See the deprecation notice for details.
- accountId string? (default ()) - A query string that is matched exactly against user
accountId
. Required, unlessquery
is specified.
- startAt int (default 0) - The index of the first item to return in a page of results (page offset).
- maxResults int (default 50) - The maximum number of items to return per page.
findAssignableUsers
function findAssignableUsers(string? query, string? sessionId, string? username, string? accountId, string? project, string? issueKey, int startAt, int maxResults, int? actionDescriptorId, boolean recommend) returns User[]|error
Find users assignable to issues
Parameters
- query string? (default ()) - A query string that is matched against user attributes, such as
displayName
, andemailAddress
, to find relevant users. The string can match the prefix of the attribute's value. For example, query=john matches a user with adisplayName
of John Smith and a user with anemailAddress
of johnson@example.com. Required, unlessusername
oraccountId
is specified.
- sessionId string? (default ()) - The sessionId of this request. SessionId is the same until the assignee is set.
- username string? (default ()) - This parameter is no longer available and will be removed from the documentation soon. See the deprecation notice for details.
- accountId string? (default ()) - A query string that is matched exactly against user
accountId
. Required, unlessquery
is specified.
- project string? (default ()) - The project ID or project key (case sensitive). Required, unless
issueKey
is specified.
- issueKey string? (default ()) - The key of the issue. Required, unless
project
is specified.
- startAt int (default 0) - The index of the first item to return in a page of results (page offset).
- maxResults int (default 50) - The maximum number of items to return. This operation may return less than the maximum number of items even if more are available. The operation fetches users up to the maximum and then, from the fetched users, returns only the users that can be assigned to the issue.
- actionDescriptorId int? (default ()) - The ID of the transition.
- recommend boolean (default false) - Whether recommended or not.
findUsersWithAllPermissions
function findUsersWithAllPermissions(string permissions, string? query, string? username, string? accountId, string? issueKey, string? projectKey, int startAt, int maxResults) returns User[]|error
Find users with permissions
Parameters
- permissions string - A comma separated list of permissions. Permissions can be specified as any: * permission returned by Get all permissions. * custom project permission added by Connect apps. * (deprecated) one of the following: * ASSIGNABLE_USER * ASSIGN_ISSUE * ATTACHMENT_DELETE_ALL * ATTACHMENT_DELETE_OWN * BROWSE * CLOSE_ISSUE * COMMENT_DELETE_ALL * COMMENT_DELETE_OWN * COMMENT_EDIT_ALL * COMMENT_EDIT_OWN * COMMENT_ISSUE * CREATE_ATTACHMENT * CREATE_ISSUE * DELETE_ISSUE * EDIT_ISSUE * LINK_ISSUE * MANAGE_WATCHER_LIST * MODIFY_REPORTER * MOVE_ISSUE * PROJECT_ADMIN * RESOLVE_ISSUE * SCHEDULE_ISSUE * SET_ISSUE_SECURITY * TRANSITION_ISSUE * VIEW_VERSION_CONTROL * VIEW_VOTERS_AND_WATCHERS * VIEW_WORKFLOW_READONLY * WORKLOG_DELETE_ALL * WORKLOG_DELETE_OWN * WORKLOG_EDIT_ALL * WORKLOG_EDIT_OWN * WORK_ISSUE
- query string? (default ()) - A query string that is matched against user attributes, such as
displayName
andemailAddress
, to find relevant users. The string can match the prefix of the attribute's value. For example, query=john matches a user with adisplayName
of John Smith and a user with anemailAddress
of johnson@example.com. Required, unlessaccountId
is specified.
- username string? (default ()) - This parameter is no longer available and will be removed from the documentation soon. See the deprecation notice for details.
- accountId string? (default ()) - A query string that is matched exactly against user
accountId
. Required, unlessquery
is specified.
- issueKey string? (default ()) - The issue key for the issue.
- projectKey string? (default ()) - The project key for the project (case sensitive).
- startAt int (default 0) - The index of the first item to return in a page of results (page offset).
- maxResults int (default 50) - The maximum number of items to return per page.
findUsersForPicker
function findUsersForPicker(string query, int maxResults, boolean showAvatar, string[]? exclude, string[]? excludeAccountIds, string? avatarSize, boolean excludeConnectUsers) returns FoundUsers|error
Find users for picker
Parameters
- query string - A query string that is matched against user attributes, such as
displayName
, andemailAddress
, to find relevant users. The string can match the prefix of the attribute's value. For example, query=john matches a user with adisplayName
of John Smith and a user with anemailAddress
of johnson@example.com.
- maxResults int (default 50) - The maximum number of items to return. The total number of matched users is returned in
total
.
- showAvatar boolean (default false) - Include the URI to the user's avatar.
- exclude string[]? (default ()) - This parameter is no longer available and will be removed from the documentation soon. See the deprecation notice for details.
- excludeAccountIds string[]? (default ()) - A list of account IDs to exclude from the search results. This parameter accepts a comma-separated list. Multiple account IDs can also be provided using an ampersand-separated list. For example,
excludeAccountIds=5b10a2844c20165700ede21g,5b10a0effa615349cb016cd8&excludeAccountIds=5b10ac8d82e05b22cc7d4ef5
. Cannot be provided withexclude
.
- avatarSize string? (default ()) - Avatar size of user.
- excludeConnectUsers boolean (default false) - Whether to exclude connector users.
Return Type
- FoundUsers|error - Returned if the request is successful.
findUsers
function findUsers(string? query, string? username, string? accountId, int startAt, int maxResults, string? property) returns User[]|error
Find users
Parameters
- query string? (default ()) - A query string that is matched against user attributes (
displayName
, andemailAddress
) to find relevant users. The string can match the prefix of the attribute's value. For example, query=john matches a user with adisplayName
of John Smith and a user with anemailAddress
of johnson@example.com. Required, unlessaccountId
orproperty
is specified.
- username string? (default ()) - Username assigned to a user.
- accountId string? (default ()) - A query string that is matched exactly against a user
accountId
. Required, unlessquery
orproperty
is specified.
- startAt int (default 0) - The index of the first item to return in a page of results (page offset).
- maxResults int (default 50) - The maximum number of items to return per page.
- property string? (default ()) - A query string used to search properties. Property keys are specified by path, so property keys containing dot (.) or equals (=) characters cannot be used. The query string cannot be specified using a JSON object. Example: To search for the value of
nested
from{"something":{"nested":1,"other":2}}
usethepropertykey.something.nested=1
. Required, unlessaccountId
orquery
is specified.
findUsersByQuery
function findUsersByQuery(string query, int startAt, int maxResults) returns PageBeanUser|error
Find users by query
Parameters
- query string - The search query.
- startAt int (default 0) - The index of the first item to return in a page of results (page offset).
- maxResults int (default 100) - The maximum number of items to return per page.
Return Type
- PageBeanUser|error - Returned if the request is successful.
findUserKeysByQuery
function findUserKeysByQuery(string query, int startAt, int maxResults) returns PageBeanUserKey|error
Find user keys by query
Parameters
- query string - The search query.
- startAt int (default 0) - The index of the first item to return in a page of results (page offset).
- maxResults int (default 100) - The maximum number of items to return per page.
Return Type
- PageBeanUserKey|error - Returned if the request is successful.
findUsersWithBrowsePermission
function findUsersWithBrowsePermission(string? query, string? username, string? accountId, string? issueKey, string? projectKey, int startAt, int maxResults) returns User[]|error
Find users with browse permission
Parameters
- query string? (default ()) - A query string that is matched against user attributes, such as
displayName
andemailAddress
, to find relevant users. The string can match the prefix of the attribute's value. For example, query=john matches a user with adisplayName
of John Smith and a user with anemailAddress
of johnson@example.com. Required, unlessaccountId
is specified.
- username string? (default ()) - This parameter is no longer available and will be removed from the documentation soon. See the deprecation notice for details.
- accountId string? (default ()) - A query string that is matched exactly against user
accountId
. Required, unlessquery
is specified.
- issueKey string? (default ()) - The issue key for the issue. Required, unless
projectKey
is specified.
- projectKey string? (default ()) - The project key for the project (case sensitive). Required, unless
issueKey
is specified.
- startAt int (default 0) - The index of the first item to return in a page of results (page offset).
- maxResults int (default 50) - The maximum number of items to return per page.
Records
jira: ActorInputBean
Fields
- user string[]? - The account IDs of the users to add as default actors. This parameter accepts a comma-separated list. For example,
"user":["5b10a2844c20165700ede21g", "5b109f2e9729b51b54dc274d"]
.
- group string[]? - The name of the group to add as a default actor. This parameter accepts a comma-separated list. For example,
"group":["project-admin", "jira-developers"]
.
jira: ActorsMap
Fields
- user string[]? - The user account ID of the user to add.
- group string[]? - The name of the group to add.
jira: AddFieldBean
Fields
- fieldId string - The ID of the field to add.
jira: AddGroupBean
Record defines to add a json node.
Fields
- name string - The name of the group.
jira: Application
The application the linked item is in.
Fields
- 'type string? - The name-spaced type of the application, used by registered rendering apps.
- name string? - The name of the application. Used in conjunction with the (remote) object icon title to display a tooltip for the link's icon. The tooltip takes the format "[application name] icon title". Blank items are excluded from the tooltip title. If both items are blank, the icon tooltop displays as "Web Link". Grouping and sorting of links may place links without an application name last.
jira: ApplicationProperty
Details of an application property.
Fields
- id string? - The ID of the application property. The ID and key are the same.
- 'key string? - The key of the application property. The ID and key are the same.
- value string? - The new value.
- name string? - The name of the application property.
- desc string? - The description of the application property.
- 'type string? - The data type of the application property.
- defaultValue string? - The default value of the application property.
- example string? - The example of application property.
- allowedValues string[]? - The allowed values, if applicable.
jira: ApplicationRole
Details of an application role.
Fields
- 'key string? - The key of the application role.
- groups string[]? - The groups associated with the application role.
- name string? - The display name of the application role.
- defaultGroups string[]? - The groups that are granted default access for this application role.
- selectedByDefault boolean? - Determines whether this application role should be selected by default on user creation.
- defined boolean? - Deprecated.
- numberOfSeats int? - The maximum count of users on your license.
- remainingSeats int? - The count of users remaining on your license.
- userCount int? - The number of users counting against your license.
- userCountDescription string? - The type of users being counted against your license.
- hasUnlimitedSeats boolean? - Whether has unlimited remaining on your license or not.
- platform boolean? - Indicates if the application role belongs to Jira platform (
jira-core
).
jira: AssociatedItemBean
Details of an item associated with the changed record.
Fields
- id string? - The ID of the associated record.
- name string? - The name of the associated record.
- typeName string? - The type of the associated record.
- parentId string? - The ID of the associated parent record.
- parentName string? - The name of the associated parent record.
jira: Attachment
Details about an attachment.
Fields
- self string? - The URL of the attachment details response.
- id string? - The ID of the attachment.
- filename string? - The file name of the attachment.
- author UserDetails? - Details of the user who added the attachment.
- created string? - The datetime the attachment was created.
- size int? - The size of the attachment.
- mimeType string? - The MIME type of the attachment.
- content string? - The content of the attachment.
- thumbnail string? - The URL of a thumbnail representing the attachment.
jira: AttachmentArchive
Fields
- moreAvailable boolean? -
- totalNumberOfEntriesAvailable int? -
- totalEntryCount int? -
- entries AttachmentArchiveEntry[]? -
jira: AttachmentArchiveEntry
Record defining attachment archieve entry.
Fields
- entryIndex int? - Entry index of attachment archive entry.
- abbreviatedName string? - Abbreviated name of attachment archive entry.
- mediaType string? - Media type of attachment archive entry.
- name string? - Name of attachment archive entry.
- size int? - Size of attachment archive entry.
jira: AttachmentArchiveImpl
Fields
- entries AttachmentArchiveEntry[]? - The list of the items included in the archive.
- totalEntryCount int? - The number of items in the archive.
jira: AttachmentArchiveItemReadable
Metadata for an item in an attachment archive.
Fields
- path string? - The path of the archive item.
- index int? - The position of the item within the archive.
- size string? - The size of the archive item.
- mediaType string? - The MIME type of the archive item.
- label string? - The label for the archive item.
jira: AttachmentArchiveMetadataReadable
Metadata for an archive (for example a zip) and its contents.
Fields
- id int? - The ID of the attachment.
- name string? - The name of the archive file.
- entries AttachmentArchiveItemReadable[]? - The list of the items included in the archive.
- totalEntryCount int? - The number of items included in the archive.
- mediaType string? - The MIME type of the attachment.
jira: AttachmentMetadata
Metadata for an issue attachment.
Fields
- id int? - The ID of the attachment.
- self string? - The URL of the attachment metadata details.
- filename string? - The name of the attachment file.
- author User? - Details of the user who attached the file.
- created string? - The datetime the attachment was created.
- size int? - The size of the attachment.
- mimeType string? - The MIME type of the attachment.
- properties record {}? - Additional properties of the attachment.
- content string? - The URL of the attachment.
- thumbnail string? - The URL of a thumbnail representing the attachment.
jira: AttachmentSettings
Details of the instance's attachment settings.
Fields
- enabled boolean? - Whether the ability to add attachments is enabled.
- uploadLimit int? - The maximum size of attachments permitted, in bytes.
jira: AuditRecordBean
An audit record.
Fields
- id int? - The ID of the audit record.
- summary string? - The summary of the audit record.
- remoteAddress string? - The URL of the computer where the creation of the audit record was initiated.
- authorKey string? - Deprecated, use
authorAccountId
instead. The key of the user who created the audit record.
- created string? - The date and time on which the audit record was created.
- category string? - The category of the audit record. For a list of these categories, see the help article Auditing in Jira applications.
- eventSource string? - The event the audit record originated from.
- description string? - The description of the audit record.
- objectItem AssociatedItemBean? - Details of an item associated with the changed record.
- changedValues ChangedValueBean[]? - The list of values changed in the record event.
- associatedItems AssociatedItemBean[]? - The list of items associated with the changed record.
jira: AuditRecords
Container for a list of audit records.
Fields
- offset int? - The number of audit items skipped before the first item in this list.
- 'limit int? - The requested or default limit on the number of audit items to be returned.
- total int? - The total number of audit items returned.
- records AuditRecordBean[]? - The list of audit items.
jira: AutoCompleteSuggestion
A field auto-complete suggestion.
Fields
- value string? - The value of a suggested item.
- displayName string? - The display name of a suggested item. If
fieldValue
orpredicateValue
are provided, the matching text is highlighted with the HTML bold tag.
jira: AutoCompleteSuggestions
The results from a JQL query.
Fields
- results AutoCompleteSuggestion[]? - The list of suggested item.
jira: Avatar
Details of an avatar.
Fields
- id string - The ID of the avatar.
- owner string? - The owner of the avatar. For a system avatar the owner is null (and nothing is returned). For non-system avatars this is the appropriate identifier, such as the ID for a project or the account ID for a user.
- isSystemAvatar boolean? - Whether the avatar is a system avatar.
- isSelected boolean? - Whether the avatar is used in Jira. For example, shown as a project's avatar.
- isDeletable boolean? - Whether the avatar can be deleted.
- fileName string? - The file name of the avatar icon. Returned for system avatars.
- urls record {}? - The list of avatar icon URLs.
jira: Avatars
Details about system and custom avatars.
Fields
- system Avatar[]? - System avatars list.
- custom Avatar[]? - Custom avatars list.
jira: AvatarUrlsBean
Fields
- '16x16 string? - The URL of the item's 16x16 pixel avatar.
- '24x24 string? - The URL of the item's 24x24 pixel avatar.
- '32x32 string? - The URL of the item's 32x32 pixel avatar.
- '48x48 string? - The URL of the item's 48x48 pixel avatar.
jira: BulkCustomFieldOptionCreateRequest
Details of the options to create for a custom field.
Fields
- options CustomFieldOptionCreate[]? - Details of options to create.
jira: BulkCustomFieldOptionUpdateRequest
Details of the options to update for a custom field.
Fields
- options CustomFieldOptionUpdate[]? - Details of the options to update.
jira: BulkIssuePropertyUpdateRequest
Bulk issue property update request details.
Fields
- value anydata? - The value of the property. The value must be a valid, non-empty JSON blob. The maximum length is 32768 characters.
- expression string? - EXPERIMENTAL. The Jira expression to calculate the value of the property. The value of the expression must be an object that can be converted to JSON, such as a number, boolean, string, list, or map. The context variables available to the expression are
issue
anduser
. Issues for which the expression returns a value whose JSON representation is longer than 32768 characters are ignored.
- filter IssueFilterForBulkPropertySet? - The bulk operation filter.
jira: BulkOperationErrorResult
Details bulk operation error result.
Fields
- status int? - Bulk operation error result status.
- elementErrors ErrorCollection? - Error messages from an operation.
- failedElementNumber int? - Bulk operation error failed element number.
jira: BulkPermissionGrants
Details of global and project permissions granted to the user.
Fields
- projectPermissions BulkProjectPermissionGrants[] - List of project permissions and the projects and issues those permissions provide access to.
- globalPermissions string[] - List of permissions granted to the user.
jira: BulkPermissionsRequestBean
Details of global permissions to look up and project permissions with associated projects and issues to look up.
Fields
- projectPermissions BulkProjectPermissions[]? - Project permissions with associated projects and issues to look up.
- globalPermissions string[]? - Global permissions to look up.
- accountId string? - The account ID of a user.
jira: BulkProjectPermissionGrants
List of project permissions and the projects and issues those permissions grant access to.
Fields
- permission string - A project permission,
- issues int[] - IDs of the issues the user has the permission for.
- projects int[] - IDs of the projects the user has the permission for.
jira: BulkProjectPermissions
Details of project permissions and associated issues and projects to look up.
Fields
- issues int[]? - List of issue IDs.
- projects int[]? - List of project IDs.
- permissions string[] - List of project permissions.
jira: ChangeDetails
A change item.
Fields
- 'field string? - The name of the field changed.
- fieldtype string? - The type of the field changed.
- fieldId string? - The ID of the field changed.
- 'from string? - The details of the original value.
- fromString string? - The details of the original value as a string.
- to string? - The details of the new value.
- toString string? - The details of the new value as a string.
jira: ChangedValueBean
Details of names changed in the record event.
Fields
- fieldName string? - The name of the field changed.
- changedFrom string? - The value of the field before the change.
- changedTo string? - The value of the field after the change.
jira: ChangedWorklog
Details of a changed worklog.
Fields
- worklogId int? - The ID of the worklog.
- updatedTime int? - The datetime of the change.
- properties EntityProperty[]? - Details of properties associated with the change.
jira: ChangedWorklogs
List of changed worklogs.
Fields
- values ChangedWorklog[]? - Changed worklog list.
- since int? - The datetime of the first worklog item in the list.
- until int? - The datetime of the last worklog item in the list.
- self string? - The URL of this changed worklogs list.
- nextPage string? - The URL of the next list of changed worklogs.
- lastPage boolean? - Whether it is the langepage or not.
jira: Changelog
A changelog.
Fields
- id string? - The ID of the changelog.
- author UserDetails? - The user who made the change.
- created string? - The date on which the change took place.
- items ChangeDetails[]? - The list of items changed.
- historyMetadata HistoryMetadata? - The history metadata associated with the changed.
jira: ClientHttp1Settings
Provides settings related to HTTP/1.x protocol.
Fields
- keepAlive KeepAlive(default http:KEEPALIVE_AUTO) - Specifies whether to reuse a connection for multiple requests
- chunking Chunking(default http:CHUNKING_AUTO) - The chunking behaviour of the request
- proxy ProxyConfig? - Proxy server related options
jira: ColumnItem
Details of an issue navigator column item.
Fields
- label string? - The issue navigator column label.
- value string? - The issue navigator column value.
jira: Comment
A comment.
Fields
- self string? - The URL of the comment.
- id string? - The ID of the comment.
- author UserDetails? - The ID of the user who created the comment.
- body string? - The comment text.
- renderedBody string? - The rendered version of the comment.
- updateAuthor UserDetails? - The ID of the user who updated the comment last.
- created string? - The date and time at which the comment was created.
- updated string? - The date and time at which the comment was updated last.
- visibility Visibility? - The group or role to which this comment is visible. Optional on create and update.
- jsdPublic boolean? - Whether the comment is visible in Jira Service Desk. Defaults to true when comments are created in the Jira Cloud Platform. This includes when the site doesn't use Jira Service Desk or the project isn't a Jira Service Desk project and, therefore, there is no Jira Service Desk for the issue to be visible on. To create a comment with its visibility in Jira Service Desk set to false, use the Jira Service Desk REST API Create request comment operation.
- properties EntityProperty[]? - A list of comment properties. Optional on create and update.
jira: ComponentIssuesCount
Count of issues assigned to a component.
Fields
- self string? - The URL for this count of issues for a component.
- issueCount int? - The count of issues assigned to a component.
jira: ComponentWithIssueCount
Details about a component with a count of the issues it contains.
Fields
- issueCount int? - Count of issues for the component.
- description string? - The description for the component.
- self string? - The URL for this count of the issues contained in the component.
- project string? - The key of the project to which the component is assigned.
- lead User? - The user details for the component's lead user.
- assigneeType string? - The nominal user type used to determine the assignee for issues created with this component. See
realAssigneeType
for details on how the type of the user, and hence the user, assigned to issues is determined. Takes the following values:PROJECT_LEAD
the assignee to any issues created with this component is nominally the lead for the project the component is in.COMPONENT_LEAD
the assignee to any issues created with this component is nominally the lead for the component.UNASSIGNED
an assignee is not set for issues created with this component.PROJECT_DEFAULT
the assignee to any issues created with this component is nominally the default assignee for the project that the component is in.
- projectId int? - Not used.
- assignee User? - The details of the user associated with
assigneeType
, if any. SeerealAssignee
for details of the user assigned to issues created with this component.
- realAssignee User? - The user assigned to issues created with this component, when
assigneeType
does not identify a valid assignee.
- isAssigneeTypeValid boolean? - Whether a user is associated with
assigneeType
. For example, if theassigneeType
is set toCOMPONENT_LEAD
but the component lead is not set, thenfalse
is returned.
- realAssigneeType string? - The type of the assignee that is assigned to issues created with this component, when an assignee cannot be set from the
assigneeType
. For example,assigneeType
is set toCOMPONENT_LEAD
but no component lead is set. This property is set to one of the following values:PROJECT_LEAD
whenassigneeType
isPROJECT_LEAD
and the project lead has permission to be assigned issues in the project that the component is in.COMPONENT_LEAD
whenassignee
Type isCOMPONENT_LEAD
and the component lead has permission to be assigned issues in the project that the component is in.UNASSIGNED
whenassigneeType
isUNASSIGNED
and Jira is configured to allow unassigned issues.PROJECT_DEFAULT
when none of the preceding cases are true.
- name string? - The name for the component.
- id string? - The unique identifier for the component.
jira: CompoundClause
A JQL query clause that consists of nested clauses. For example, (labels in (urgent, blocker) OR lastCommentedBy = currentUser()). Note that, where nesting is not defined, the parser nests JQL clauses based on the operator precedence. For example, "A OR B AND C" is parsed as "(A OR B) AND C". See Setting the precedence of operators for more information about precedence in JQL queries.
Fields
- clauses JqlQueryClause[] - The list of nested clauses.
- operator string - The operator between the clauses.
jira: Configuration
Details about the configuration of Jira.
Fields
- votingEnabled boolean? - Whether the ability for users to vote on issues is enabled. See Configuring Jira application options for details.
- watchingEnabled boolean? - Whether the ability for users to watch issues is enabled. See Configuring Jira application options for details.
- unassignedIssuesAllowed boolean? - Whether the ability to create unassigned issues is enabled. See Configuring Jira application options for details.
- subTasksEnabled boolean? - Whether the ability to create subtasks for issues is enabled.
- issueLinkingEnabled boolean? - Whether the ability to link issues is enabled.
- timeTrackingEnabled boolean? - Whether the ability to track time is enabled. This property is deprecated.
- attachmentsEnabled boolean? - Whether the ability to add attachments to issues is enabled.
- timeTrackingConfiguration TimeTrackingConfiguration? - The configuration of time tracking.
jira: ConnectionConfig
Provides a set of configurations for controlling the behaviours when communicating with a remote HTTP endpoint.
Fields
- auth BearerTokenConfig|OAuth2RefreshTokenGrantConfig|CredentialsConfig - Configurations related to client authentication
- httpVersion HttpVersion(default http:HTTP_2_0) - The HTTP version understood by the client
- http1Settings ClientHttp1Settings? - Configurations related to HTTP/1.x protocol
- http2Settings ClientHttp2Settings? - Configurations related to HTTP/2 protocol
- timeout decimal(default 60) - The maximum time to wait (in seconds) for a response before closing the connection
- forwarded string(default "disable") - The choice of setting
forwarded
/x-forwarded
header
- poolConfig PoolConfiguration? - Configurations associated with request pooling
- cache CacheConfig? - HTTP caching related configurations
- compression Compression(default http:COMPRESSION_AUTO) - Specifies the way of handling compression (
accept-encoding
) header
- circuitBreaker CircuitBreakerConfig? - Configurations associated with the behaviour of the Circuit Breaker
- retryConfig RetryConfig? - Configurations associated with retrying
- responseLimits ResponseLimitConfigs? - Configurations associated with inbound response size limits
- secureSocket ClientSecureSocket? - SSL/TLS-related options
- proxy ProxyConfig? - Proxy server related options
- validation boolean(default true) - Enables the inbound payload validation functionality which provided by the constraint package. Enabled by default
jira: ConnectModule
A Connect module in the same format as in the app descriptor.
jira: ConnectModules
Fields
- modules ConnectModule[] - A list of app modules in the same format as the
modules
property in the app descriptor.
jira: ConnectWorkflowTransitionRule
A workflow transition rule.
Fields
- id string - The ID of the transition rule.
- 'key string - The key of the rule, as defined in the Connect app descriptor.
- configuration RuleConfiguration - A rule configuration.
- transition WorkflowTransition? - A workflow transition.
jira: ContainerForRegisteredWebhooks
Container for a list of registered webhooks. Webhook details are returned in the same order as the request.
Fields
- webhookRegistrationResult RegisteredWebhook[]? - A list of registered webhooks.
jira: ContainerForWebhookIDs
Container for a list of webhook IDs.
Fields
- webhookIds int[] - A list of webhook IDs.
jira: ContainerOfWorkflowSchemeAssociations
A container for a list of workflow schemes together with the projects they are associated with.
Fields
- values WorkflowSchemeAssociations[] - A list of workflow schemes together with projects they are associated with.
jira: Context
A context.
Fields
- id int? - The ID of the context.
- name string? - The name of the context.
- scope Scope? - The scope of the context.
jira: ContextForProjectAndIssueType
The project and issue type mapping with a matching custom field context.
Fields
- projectId string - The ID of the project.
- issueTypeId string - The ID of the issue type.
- contextId string - The ID of the custom field context.
jira: ContextualConfiguration
Details of the contextual configuration for a custom field.
Fields
- contextId int - The ID of the context the configuration is associated with.
- configuration anydata? - The configuration associated with the context.
jira: ConvertedJQLQueries
The converted JQL queries.
Fields
- queryStrings string[]? - The list of converted query strings with account IDs in place of user identifiers.
- queriesWithUnknownUsers JQLQueryWithUnknownUsers[]? - List of queries containing user information that could not be mapped to an existing user
jira: CreateCustomFieldContext
The details of a created custom field context.
Fields
- id string? - The ID of the context.
- name string - The name of the context.
- description string? - The description of the context.
- projectIds string[]? - The list of project IDs associated with the context. If the list is empty, the context is global.
- issueTypeIds string[]? - The list of issue types IDs for the context. If the list is empty, the context refers to all issue types.
jira: CreatedIssue
Details about a created issue or subtask.
Fields
- id string? - The ID of the created issue or subtask.
- 'key string? - The key of the created issue or subtask.
- self string? - The URL of the created issue or subtask.
- transition NestedResponse? - The response code and messages related to any requested transition.
jira: CreatedIssues
Details about the issues created and the errors for requests that failed.
Fields
- issues CreatedIssue[]? - Details of the issues created.
- errors BulkOperationErrorResult[]? - Error details for failed issue creation requests.
jira: CreateProjectDetails
Details about the project.
Fields
- 'key string - Project keys must be unique and start with an uppercase letter followed by one or more uppercase alphanumeric characters. The maximum length is 10 characters.
- name string - The name of the project.
- description string? - A brief description of the project.
- lead string? - This parameter is deprecated because of privacy changes. Use
leadAccountId
instead. See the migration guide for details. The user name of the project lead. Eitherlead
orleadAccountId
must be set when creating a project. Cannot be provided withleadAccountId
.
- leadAccountId string? - The account ID of the project lead. Either
lead
orleadAccountId
must be set when creating a project. Cannot be provided withlead
.
- url string? - A link to information about this project, such as project documentation
- assigneeType string? - The default assignee when creating issues for this project.
- avatarId int? - An integer value for the project's avatar.
- issueSecurityScheme int? - The ID of the issue security scheme for the project, which enables you to control who can and cannot view issues. Use the Get issue security schemes resource to get all issue security scheme IDs.
- permissionScheme int? - The ID of the permission scheme for the project. Use the Get all permission schemes resource to see a list of all permission scheme IDs.
- notificationScheme int? - The ID of the notification scheme for the project. Use the Get notification schemes resource to get a list of notification scheme IDs.
- categoryId int? - The ID of the project's category. A complete list of category IDs is found using the Get all project categories operation.
- projectTypeKey string? - The project type, which defines the application-specific feature set. If you don't specify the project template you have to specify the project type.
- projectTemplateKey string? - A predefined configuration for a project. The type of the
projectTemplateKey
must match with the type of theprojectTypeKey
.
- workflowScheme int? - The ID of the workflow scheme for the project. Use the Get all workflow schemes operation to get a list of workflow scheme IDs. If you specify the workflow scheme you cannot specify the project template key.
- issueTypeScreenScheme int? - The ID of the issue type screen scheme for the project. Use the Get all issue type screen schemes operation to get a list of issue type screen scheme IDs. If you specify the issue type screen scheme you cannot specify the project template key.
- issueTypeScheme int? - The ID of the issue type scheme for the project. Use the Get all issue type schemes operation to get a list of issue type scheme IDs. If you specify the issue type scheme you cannot specify the project template key.
- fieldConfigurationScheme int? - The ID of the field configuration scheme for the project. Use the Get all field configuration schemes operation to get a list of field configuration scheme IDs. If you specify the field configuration scheme you cannot specify the project template key.
jira: CreateUpdateRoleRequestBean
Record defines a bean for create or update role request.
Fields
- name string? - The name of the project role. Must be unique. Cannot begin or end with whitespace. The maximum length is 255 characters. Required when creating a project role. Optional when partially updating a project role.
- description string? - A description of the project role. Required when fully updating a project role. Optional when creating or partially updating a project role.
jira: CreateWorkflowDetails
The details of a workflow.
Fields
- name string - The name of the workflow. The name must be unique. The maximum length is 255 characters. Characters can be separated by a whitespace but the name cannot start or end with a whitespace.
- description string? - The description of the workflow. The maximum length is 1000 characters.
- transitions CreateWorkflowTransitionDetails[] - The transitions of the workflow. For the request to be valid, these transitions must:
- include one initial transition.
- not use the same name for a global and directed transition.
- have a unique name for each global transition.
- have a unique 'to' status for each global transition.
- have unique names for each transition from a status.
- not have a 'from' status on initial and global transitions.
- have a 'from' status on directed transitions.
statuses
.
- statuses CreateWorkflowStatusDetails[] - The statuses of the workflow. Any status that does not include a transition is added to the workflow without a transition.
jira: CreateWorkflowStatusDetails
The details of a transition status.
Fields
- id string - The ID of the status.
jira: CreateWorkflowTransitionDetails
The details of a workflow transition.
Fields
- name string - The name of the transition. The maximum length is 60 characters.
- description string? - The description of the transition. The maximum length is 1000 characters.
- 'from string[]? - The statuses the transition can start from.
- to string - The status the transition goes to.
- 'type string - The type of the transition.
jira: CustomFieldConfigurations
Details of configurations for a custom field.
Fields
- configurations ContextualConfiguration[] - The list of custom field configuration details.
jira: CustomFieldContext
The details of a custom field context.
Fields
- id string - The ID of the context.
- name string - The name of the context.
- description string - The description of the context.
- isGlobalContext boolean - Whether the context is global.
- isAnyIssueType boolean - Whether the context apply to all issue types.
jira: CustomFieldContextDefaultValueCascadingOption
Default value for a cascading select custom field.
Fields
- contextId string - The ID of the context.
- optionId string - The ID of the default option.
- cascadingOptionId string? - The ID of the default cascading option.
- 'type string - The type of the default cascading option.
jira: CustomFieldContextDefaultValueMultipleOption
Default value for a multi-select custom field.
Fields
- contextId string - The ID of the context.
- optionIds string[] - The list of IDs of the default options.
- 'type string - The type of multi-select custom field
jira: CustomFieldContextDefaultValueSingleOption
Default value for a single select custom field.
Fields
- contextId string - The ID of the context.
- optionId string - The ID of the default option.
- 'type string - The type of the default option.
jira: CustomFieldContextDefaultValueUpdate
Default values to update.
Fields
- defaultValues CustomFieldContextDefaultValue[]? - Default values of custom field.
jira: CustomFieldContextOption
Details of the custom field options for a context.
Fields
- id string - The ID of the custom field option.
- value string - The value of the custom field option.
- optionId string? - For cascading options, the ID of the custom field option containing the cascading option.
- disabled boolean - Whether the option is disabled.
jira: CustomFieldContextProjectMapping
Details of context to project associations.
Fields
- contextId string - The ID of the context.
- projectId string? - The ID of the project.
- isGlobalContext boolean? - Whether context is global.
jira: CustomFieldContextUpdateDetails
Details of a custom field context.
Fields
- name string? - The name of the custom field context. The name must be unique. The maximum length is 255 characters.
- description string? - The description of the custom field context. The maximum length is 255 characters.
jira: CustomFieldCreatedContextOptionsList
A list of custom field options for a context.
Fields
- options CustomFieldContextOption[]? - The created custom field options.
jira: CustomFieldDefinitionJsonBean
Fields
- name string - The name of the custom field, which is displayed in Jira. This is not the unique identifier.
- description string? - The description of the custom field, which is displayed in Jira.
- 'type string - The type of the custom field. These built-in custom field types are available:
cascadingselect
: Enables values to be selected from two levels of select lists (value:com.atlassian.jira.plugin.system.customfieldtypes:cascadingselect
)datepicker
: Stores a date using a picker control (value:com.atlassian.jira.plugin.system.customfieldtypes:datepicker
)datetime
: Stores a date with a time component (value:com.atlassian.jira.plugin.system.customfieldtypes:datetime
)float
: Stores and validates a numeric (floating point) input (value:com.atlassian.jira.plugin.system.customfieldtypes:float
)grouppicker
: Stores a user group using a picker control (value:com.atlassian.jira.plugin.system.customfieldtypes:grouppicker
)importid
: A read-only field that stores the ID the issue had in the system it was imported from (value:com.atlassian.jira.plugin.system.customfieldtypes:importid
)labels
: Stores labels (value:com.atlassian.jira.plugin.system.customfieldtypes:labels
)multicheckboxes
: Stores multiple values using checkboxes (value:) MISSING[
] *multigrouppicker
: Stores multiple user groups using a picker control (value:) MISSING[
]*multiselect
: Stores multiple values using a select list (value:com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes
)multiuserpicker
: Stores multiple users using a picker control (value:com.atlassian.jira.plugin.system.customfieldtypes:multigrouppicker
)multiversion
: Stores multiple versions from the versions available in a project using a picker control (value:com.atlassian.jira.plugin.system.customfieldtypes:multiversion
)project
: Stores a project from a list of projects that the user is permitted to view (value:com.atlassian.jira.plugin.system.customfieldtypes:project
)radiobuttons
: Stores a value using radio buttons (value:com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons
)readonlyfield
: Stores a read-only text value, which can only be populated via the API (value:com.atlassian.jira.plugin.system.customfieldtypes:readonlyfield
)select
: Stores a value from a configurable list of options (value:com.atlassian.jira.plugin.system.customfieldtypes:select
)textarea
: Stores a long text string using a multiline text area (value:com.atlassian.jira.plugin.system.customfieldtypes:textarea
)textfield
: Stores a text string using a single-line text box (value:com.atlassian.jira.plugin.system.customfieldtypes:textfield
)url
: Stores a URL (value:com.atlassian.jira.plugin.system.customfieldtypes:url
)userpicker
: Stores a user using a picker control (value:com.atlassian.jira.plugin.system.customfieldtypes:userpicker
)version
: Stores a version using a picker control (value:com.atlassian.jira.plugin.system.customfieldtypes:version
)
ari:cloud:ecosystem::extension/e62f20a2-4b61-4dbe-bfb9-9a88b5e3ac84/548c5df1-24aa-4f7c-bbbb-3038d947cb05/static/my-cf-type-key
.
- searcherKey string? - The searcher defines the way the field is searched in Jira. For example, com.atlassian.jira.plugin.system.customfieldtypes:grouppickersearcher.
The search UI (basic search and JQL search) will display different operations and values for the field, based on the field searcher. You must specify a searcher that is valid for the field type, as listed below (abbreviated values shown):cascadingselect
:cascadingselectsearcher
datepicker
:daterange
datetime
:datetimerange
float
:exactnumber
ornumberrange
grouppicker
:grouppickersearcher
importid
:exactnumber
ornumberrange
labels
:labelsearcher
multicheckboxes
:multiselectsearcher
multigrouppicker
:multiselectsearcher
multiselect
:multiselectsearcher
multiuserpicker
:userpickergroupsearcher
multiversion
:versionsearcher
project
:projectsearcher
radiobuttons
:multiselectsearcher
readonlyfield
:textsearcher
select
:multiselectsearcher
textarea
:textsearcher
textfield
:textsearcher
url
:exacttextsearcher
userpicker
:userpickergroupsearcher
version
:versionsearcher
jira: CustomFieldOption
Details of a custom option for a field.
Fields
- self string? - The URL of these custom field option details.
- value string? - The value of the custom field option.
jira: CustomFieldOptionCreate
Details of a custom field option to create.
Fields
- value string - The value of the custom field option.
- optionId string? - For cascading options, the ID of the custom field object containing the cascading option.
- disabled boolean? - Whether the option is disabled.
jira: CustomFieldOptionUpdate
Details of a custom field option for a context.
Fields
- id string - The ID of the custom field option.
- value string? - The value of the custom field option.
- disabled boolean? - Whether the option is disabled.
jira: CustomFieldReplacement
Details about the replacement for a deleted version.
Fields
- customFieldId int? - The ID of the custom field in which to replace the version number.
- moveTo int? - The version number to use as a replacement for the deleted version.
jira: CustomFieldUpdatedContextOptionsList
A list of custom field options for a context.
Fields
- options CustomFieldOptionUpdate[]? - The updated custom field options.
jira: CustomFieldValueUpdate
A list of issue IDs and the value to update a custom field to.
Fields
- issueIds int[] - The list of issue IDs.
- value anydata - The value for the custom field. The value must be compatible with the custom field type as follows:
string
– the value must be a string.number
– the value must be a number.datetime
– the value must be a string that represents a date in the ISO format, for example"2021-01-18T12:00:00-03:00"
.user
– the value must be an object that contains theaccountId
field.group
– the value must be an object that contains the groupname
field.
list
collection type.
jira: CustomFieldValueUpdateRequest
Details of updates for a custom field.
Fields
- updates CustomFieldValueUpdate[]? - The list of custom field update details.
jira: Dashboard
Details of a dashboard.
Fields
- description string? - The description about the dashboard.
- id string? - The ID of the dashboard.
- isFavourite boolean? - Whether the dashboard is selected as a favorite by the user.
- name string? - The name of the dashboard.
- owner UserBean? - The owner of the dashboard.
- popularity int? - The number of users who have this dashboard as a favorite.
- rank int? - The rank of this dashboard.
- self string? - The URL of these dashboard details.
- sharePermissions SharePermission[]? - The details of any view share permissions for the dashboard.
- editPermissions SharePermission[]? - The details of any edit share permissions for the dashboard.
- view string? - The URL of the dashboard.
jira: DashboardDetails
Details of a dashboard.
Fields
- name string - The name of the dashboard.
- description string? - The description of the dashboard.
- sharePermissions SharePermission[] - The details of any share permissions for the dashboard.
jira: DefaultShareScope
Details of the scope of the default sharing for new filters and dashboards.
Fields
- scope string - The scope of the default sharing for new filters and dashboards:
AUTHENTICATED
Shared with all logged-in users.GLOBAL
Shared with all logged-in users. This shows asAUTHENTICATED
in the response.PRIVATE
Not shared with any users.
jira: DefaultWorkflow
Details about the default workflow.
Fields
- workflow string - The name of the workflow to set as the default workflow.
- updateDraftIfNeeded boolean? - Whether a draft workflow scheme is created or updated when updating an active workflow scheme. The draft is updated with the new default workflow. Defaults to
false
.
jira: DeleteAndReplaceVersionBean
Fields
- moveFixIssuesTo int? - The ID of the version to update
fixVersion
to when the field contains the deleted version.
- moveAffectedIssuesTo int? - The ID of the version to update
affectedVersion
to when the field contains the deleted version.
- customFieldReplacementList CustomFieldReplacement[]? - An array of custom field IDs (
customFieldId
) and version IDs (moveTo
) to update when the fields contain the deleted version.
jira: DeprecatedWorkflow
Details about a workflow.
Fields
- name string? - The name of the workflow.
- description string? - The description of the workflow.
- lastModifiedDate string? - The datetime the workflow was last modified.
- lastModifiedUser string? - This property is no longer available and will be removed from the documentation soon. See the deprecation notice for details.
- lastModifiedUserAccountId string? - The account ID of the user that last modified the workflow.
- steps int? - The number of steps included in the workflow.
- scope Scope? - The scope where this workflow applies
- default boolean? - Whether default or not
jira: EntityProperty
An entity property, for more information see Entity properties.
Fields
- 'key string? - The key of the property. Required on create and update.
- value anydata? - The value of the property. Required on create and update.
jira: EntityPropertyDetails
Fields
- entityId decimal - The entity property ID.
- 'key string - The entity property key.
- value string - The new value of the entity property.
jira: ErrorCollection
Error messages from an operation.
Fields
- errorMessages string[]? - The list of error messages produced by this operation. For example, "input parameter 'key' must be provided"
- errors record {}? - The list of errors by parameter returned by the operation. For example,"projectKey": "Project keys must start with an uppercase letter, followed by one or more uppercase alphanumeric characters."
- status int? - Status of error
jira: ErrorMessage
Record defining an error message.
Fields
- message string - The error message.
jira: EventNotification
Details about a notification associated with an event.
Fields
- expand string? - Expand options that include additional event notification details in the response.
- id int? - The ID of the notification.
- notificationType string? - Identifies the recipients of the notification.
- 'parameter string? - The value of the
notificationType
:User
Theparameter
is the user account ID.Group
Theparameter
is the group name.ProjectRole
Theparameter
is the project role ID.UserCustomField
Theparameter
is the ID of the custom field.GroupCustomField
Theparameter
is the ID of the custom field.
- group GroupName? - The specified group.
- 'field FieldDetails? - The custom user or group field.
- emailAddress string? - The email address.
- projectRole ProjectRole? - The specified project role.
- user UserDetails? - The specified user.
jira: FailedWebhook
Details about a failed webhook.
Fields
- id string - The webhook ID, as sent in the
X-Atlassian-Webhook-Identifier
header with the webhook.
- body string? - The webhook body.
- url string - The original webhook destination.
- failureTime int - The time the webhook was added to the list of failed webhooks (that is, the time of the last failed retry).
jira: FailedWebhooks
A page of failed webhooks.
Fields
- values FailedWebhook[] - The list of webhooks.
- maxResults int - The maximum number of items on the page. If the list of values is shorter than this number, then there are no more pages.
- next string? - The URL to the next page of results. Present only if the request returned at least one result.The next page may be empty at the time of receiving the response, but new failed webhooks may appear in time. You can save the URL to the next page and query for new results periodically (for example, every hour).
jira: Field
Details of a field.
Fields
- id string - The ID of the field.
- name string - The name of the field.
- schema JsonTypeBean - The schema of a field.
- description string? - The description of the field.
- 'key string? - The key of the field.
- isLocked boolean? - Whether the field is locked.
- searcherKey string? - The searcher key of the field. Returned for custom fields.
- screensCount int? - Number of screens where the field is used.
- contextsCount int? - Number of contexts where the field is used.
- lastUsed FieldLastUsed? - Information about the most recent use of a field.
jira: FieldChangedClause
A clause that asserts whether a field was changed. For example, status CHANGED AFTER startOfMonth(-1M)
.See CHANGED for more information about the CHANGED operator.
Fields
- 'field JqlQueryField - A field used in a JQL query. See Advanced searching - fields reference for more information about fields in JQL queries.
- operator string - The operator applied to the field.
- predicates JqlQueryClauseTimePredicate[] - The list of time predicates.
jira: FieldConfiguration
Details of a field configuration.
Fields
- id int - The ID of the field configuration.
- name string - The name of the field configuration.
- description string - The description of the field configuration.
- isDefault boolean? - Whether the field configuration is the default.
jira: FieldConfigurationIssueTypeItem
The field configuration for an issue type.
Fields
- fieldConfigurationSchemeId string - The ID of the field configuration scheme.
- issueTypeId string - The ID of the issue type or default. When set to default this field configuration issue type item applies to all issue types without a field configuration.
- fieldConfigurationId string - The ID of the field configuration.
jira: FieldConfigurationItem
A field within a field configuration.
Fields
- id string - The ID of the field within the field configuration.
- description string? - The description of the field within the field configuration.
- isHidden boolean? - Whether the field is hidden in the field configuration.
- isRequired boolean? - Whether the field is required in the field configuration.
jira: FieldConfigurationScheme
Details of a field configuration scheme.
Fields
- id string - The ID of the field configuration scheme.
- name string - The name of the field configuration scheme.
- description string? - The description of the field configuration scheme.
jira: FieldConfigurationSchemeProjectAssociation
Associated field configuration scheme and project.
Fields
- fieldConfigurationSchemeId string? - The ID of the field configuration scheme. If the field configuration scheme ID is
null
, the operation assigns the default field configuration scheme.
- projectId string - The ID of the project.
jira: FieldConfigurationSchemeProjects
Project list with assigned field configuration schema.
Fields
- fieldConfigurationScheme FieldConfigurationScheme? - Details of a field configuration scheme.
- projectIds string[] - The IDs of projects using the field configuration scheme.
jira: FieldDetails
Details about a field.
Fields
- id string? - The ID of the field.
- 'key string? - The key of the field.
- name string? - The name of the field.
- custom boolean? - Whether the field is a custom field.
- orderable boolean? - Whether the content of the field can be used to order lists.
- navigable boolean? - Whether the field can be used as a column on the issue navigator.
- searchable boolean? - Whether the content of the field can be searched.
- clauseNames string[]? - The names that can be used to reference the field in an advanced search. For more information, see Advanced searching - fields reference.
- scope Scope? - The scope of the field.
- schema JsonTypeBean? - The data schema for the field.
jira: FieldLastUsed
Information about the most recent use of a field.
Fields
- 'type string? - Last used value type:
- TRACKED: field is tracked and a last used date is available.
- NOT_TRACKED: field is not tracked, last used date is not available.
- NO_INFORMATION: field is tracked, but no last used date is available.
- value string? - The date when the value of the field last changed.
jira: FieldMetadata
The metadata describing an issue field.
Fields
- required boolean - Whether the field is required.
- schema JsonTypeBean - The data type of the field.
- name string - The name of the field.
- 'key string - The key of the field.
- autoCompleteUrl string? - The URL that can be used to automatically complete the field.
- hasDefaultValue boolean? - Whether the field has a default value.
- operations string[] - The list of operations that can be performed on the field.
- allowedValues anydata[]? - The list of values allowed in the field.
- defaultValue anydata? - The default value of the field.
jira: FieldReferenceData
Details of a field that can be used in advanced searches.
Fields
- value string? - The field identifier.
- displayName string? - The display name contains the following:
- for system fields, the field name. For example,
Summary
. - for collapsed custom fields, the field name followed by a hyphen and then the field name and field type. For example,
Component - Component[Dropdown]
. - for other custom fields, the field name followed by a hyphen and then the custom field ID. For example,
Component - cf[10061]
.
- for system fields, the field name. For example,
- orderable string? - Whether the field can be used in a query's
ORDER BY
clause.
- searchable string? - Whether the content of this field can be searched.
- auto string? - Whether the field provide auto-complete suggestions.
- cfid string? - If the item is a custom field, the ID of the custom field.
- operators string[]? - The valid search operators for the field.
- types string[]? - The data types of items in the field.
jira: Fields
Key fields from the linked issue.
Fields
- summary string? - The summary description of the linked issue.
- status StatusDetails? - The status of the linked issue.
- priority Priority? - The priority of the linked issue.
- assignee UserDetails? - The assignee of the linked issue.
- timetracking TimeTrackingDetails? - The time tracking of the linked issue.
- issuetype IssueTypeDetails? - Details about an issue type.
- issueType IssueTypeDetails? - The type of the linked issue.
jira: FieldUpdateOperation
Details of an operation to perform on a field.
Fields
- add anydata? - A map containing the name of a field and the value to add to it.
- set anydata? - A map containing the name of a field and the value to set in it.
- remove anydata? - A map containing the name of a field and the value to removed from it.
- edit anydata? - A map containing the name of a field and the value to edit in it.
jira: FieldValueClause
A clause that asserts the current value of a field. For example, summary ~ test
.
Fields
- 'field JqlQueryField - A field used in a JQL query. See Advanced searching - fields reference for more information about fields in JQL queries.
- operator string - The operator between the field and operand.
- operand JqlQueryClauseOperand - Details of an operand in a JQL clause.
jira: FieldWasClause
A clause that asserts a previous value of a field. For example, status WAS "Resolved" BY currentUser() BEFORE "2019/02/02"
. See WAS for more information about the WAS operator.
Fields
- 'field JqlQueryField - A field used in a JQL query. See Advanced searching - fields reference for more information about fields in JQL queries.
- operator string - The operator between the field and operand.
- operand JqlQueryClauseOperand - Details of an operand in a JQL clause.
- predicates JqlQueryClauseTimePredicate[] - The list of time predicates.
jira: Filter
Details about a filter.
Fields
- self string? - The URL of the filter.
- id string? - The unique identifier for the filter.
- name string - The name of the filter. Must be unique.
- description string? - A description of the filter.
- owner User? - The user who owns the filter. This is defaulted to the creator of the filter, however Jira administrators can change the owner of a shared filter in the admin settings.
- jql string? - The JQL query for the filter. For example, project = SSP AND issuetype = Bug.
- viewUrl string? - A URL to view the filter results in Jira, using the ID of the filter. For example, https://your-domain.atlassian.net/issues/?filter=10100.
- searchUrl string? - A URL to view the filter results in Jira, using the Search for issues using JQL operation with the filter's JQL string to return the filter results. For example, https://your-domain.atlassian.net/rest/api/2/search?jql=project+%3D+SSP+AND+issuetype+%3D+Bug.
- favourite boolean? - Whether the filter is selected as a favorite.
- favouritedCount int? - The count of how many users have selected this filter as a favorite, including the filter owner.
- sharePermissions SharePermission[]? - The groups and projects that the filter is shared with.
- sharedUsers UserList? - A paginated list of the users that the filter is shared with. This includes users that are members of the groups or can browse the projects that the filter is shared with.
- subscriptions FilterSubscriptionsList? - A paginated list of the users that are subscribed to the filter.
jira: FilterDetails
Details of a filter.
Fields
- self string? - The URL of the filter.
- id string? - The unique identifier for the filter.
- name string - The name of the filter. Must be unique.
- description string? - A description of the filter.
- owner User? - The user who owns the filter. This is defaulted to the creator of the filter, however Jira administrators can change the owner of a shared filter in the admin settings.
- jql string? - The JQL query for the filter. For example, project = SSP AND issuetype = Bug.
- viewUrl string? - A URL to view the filter results in Jira, using the ID of the filter. For example, https://your-domain.atlassian.net/issues/?filter=10100.
- searchUrl string? - A URL to view the filter results in Jira, using the Search for issues using JQL operation with the filter's JQL string to return the filter results. For example, https://your-domain.atlassian.net/rest/api/2/search?jql=project+%3D+SSP+AND+issuetype+%3D+Bug.
- favourite boolean? - Whether the filter is selected as a favorite by any users, not including the filter owner.
- favouritedCount int? - The count of how many users have selected this filter as a favorite, including the filter owner.
- sharePermissions SharePermission[]? - The groups and projects that the filter is shared with. This can be specified when updating a filter, but not when creating a filter.
- subscriptions FilterSubscription[]? - The users that are subscribed to the filter.
jira: FilterSubscription
Details of a user or group subscribing to a filter.
Fields
- id int? - The ID of the filter subscription.
- user User? - The user subscribing to filter.
- group GroupName? - The group subscribing to filter.
jira: FilterSubscriptionsList
A paginated list of subscriptions to a filter.
Fields
- size int? - The number of items on the page.
- items FilterSubscription[]? - The list of items.
- 'max\-results int? - The maximum number of results that could be on the page.
- 'start\-index int? - The index of the first item returned on the page.
- 'end\-index int? - The index of the last item returned on the page.
jira: FoundGroup
A group found in a search.
Fields
- name string? - The name of the group.
- html string? - The group name with the matched query string highlighted with the HTML bold tag.
- labels GroupLabel[]? - The group labels.
- groupId string? - The ID of the group, if available, which uniquely identifies the group across all Atlassian products. For example, 952d12c3-5b5b-4d04-bb32-44d383afc4b2.
jira: FoundGroups
The list of groups found in a search, including header text (Showing X of Y matching groups) and total of matched groups.
Fields
- header string? - Header text indicating the number of groups in the response and the total number of groups found in the search.
- total int? - The total number of groups found in the search.
- groups FoundGroup[]? - The array of groups found in the search.
jira: FoundUsers
The list of users found in a search, including header text (Showing X of Y matching users) and total of matched users.
Fields
- users UserPickerUser[]? - The array of users found in the search.
- total int? - The total number of users found in the search.
- header string? - Header text indicating the number of users in the response and the total number of users found in the search.
jira: FoundUsersAndGroups
List of users and groups found in a search.
Fields
- users FoundUsers? - The list of users found in a search, including header text (Showing X of Y matching users) and total of matched users.
- groups FoundGroups? - The list of groups found in a search, including header text (Showing X of Y matching groups) and total of matched groups.
jira: FunctionOperand
An operand that is a function. See Advanced searching - functions reference for more information about JQL functions.
Fields
- 'function string - The name of the function.
- arguments string[] - The list of function arguments.
jira: FunctionReferenceData
Details of functions that can be used in advanced searches.
Fields
- value string? - The function identifier.
- displayName string? - The display name of the function.
- isList string? - Whether the function can take a list of arguments.
- types string[]? - The data types returned by the function.
jira: GlobalScopeBean
Fields
- attributes string[]? - Defines the behavior of the option in the global context.If notSelectable is set, the option cannot be set as the field's value. This is useful for archiving an option that has previously been selected but shouldn't be used anymore.If defaultValue is set, the option is selected by default.
jira: Group
Fields
- name string? - The name of group.
- self string? - The URL for these group details.
- users PagedListUserDetailsApplicationUser? - A paginated list of the users that are members of the group. A maximum of 50 users is returned in the list, to access additional users append
[start-index:end-index]
to the expand request. For example, to access the next 50 users, use?expand=users[51:100]
.
- expand string? - Expand options that include additional group details in the response.
jira: GroupDetails
Details about a group.
Fields
- name string? - The name of the group.
- groupId string? - The ID of the group, if available, which uniquely identifies the group across all Atlassian products. For example, 952d12c3-5b5b-4d04-bb32-44d383afc4b2.
jira: GroupLabel
A group label.
Fields
- text string? - The group label name.
- title string? - The title of the group label.
- 'type string? - The type of the group label.
jira: GroupName
Details about a group name.
Fields
- name string? - The name of group.
- self string? - The URL for these group details.
jira: HealthCheckResult
Jira instance health check results. Deprecated and no longer returned.
Fields
- name string? - The name of the Jira health check item.
- description string? - The description of the Jira health check item.
- passed boolean? - Whether the Jira health check item passed or failed.
jira: Hierarchy
The project issue type hierarchy.
Fields
- baseLevelId int? - The ID of the base level. This property is deprecated, see Change notice: Removing hierarchy level IDs from next-gen APIs.
- levels HierarchyLevel[]? - Details about the hierarchy level.
jira: HierarchyLevel
Fields
- id int? - The ID of the hierarchy level. This property is deprecated, see Change notice: Removing hierarchy level IDs from next-gen APIs.
- name string? - The name of this hierarchy level.
- aboveLevelId int? - The ID of the level above this one in the hierarchy. This property is deprecated, see Change notice: Removing hierarchy level IDs from next-gen APIs.
- belowLevelId int? - The ID of the level below this one in the hierarchy. This property is deprecated, see Change notice: Removing hierarchy level IDs from next-gen APIs.
- projectConfigurationId int? - The ID of the project configuration. This property is deprecated, see Change oticen: Removing hierarchy level IDs from next-gen APIs.
- level int? - The level of this item in the hierarchy.
- issueTypeIds int[]? - The issue types available in this hierarchy level.
- externalUuid string? - The external UUID of the hierarchy level. This property is deprecated, see Change notice: Removing hierarchy level IDs from next-gen APIs.
- globalHierarchyLevel string? -
jira: HistoryMetadata
Details of issue history metadata.
Fields
- 'type string? - The type of the history record.
- description string? - The description of the history record.
- descriptionKey string? - The description key of the history record.
- activityDescription string? - The activity described in the history record.
- activityDescriptionKey string? - The key of the activity described in the history record.
- emailDescription string? - The description of the email address associated the history record.
- emailDescriptionKey string? - The description key of the email address associated the history record.
- actor HistoryMetadataParticipant? - Details of the user whose action created the history record.
- generator HistoryMetadataParticipant? - Details of the system that generated the history record.
- cause HistoryMetadataParticipant? - Details of the cause that triggered the creation the history record.
- extraData record {}? - Additional arbitrary information about the history record.
jira: HistoryMetadataParticipant
Details of user or system associated with a issue history metadata item.
Fields
- id string? - The ID of the user or system associated with a history record.
- displayName string? - The display name of the user or system associated with a history record.
- displayNameKey string? - The key of the display name of the user or system associated with a history record.
- 'type string? - The type of the user or system associated with a history record.
- avatarUrl string? - The URL to an avatar for the user or system associated with a history record.
- url string? - The URL of the user or system associated with a history record.
jira: Icon
An icon. If no icon is defined:
- for a status icon, no status icon displays in Jira.
- for the remote object icon, the default link icon displays in Jira.
Fields
- url16x16 string? - The URL of an icon that displays at 16x16 pixel in Jira.
- title string? - The title of the icon. This is used as follows:
- For a status icon it is used as a tooltip on the icon. If not set, the status icon doesn't display a tooltip in Jira.
- For the remote object icon it is used in conjunction with the application name to display a tooltip for the link's icon. The tooltip takes the format "[application name] icon title". Blank itemsare excluded from the tooltip title. If both items are blank, the icon tooltop displays as "Web Link".
- link string? - The URL of the tooltip, used only for a status icon. If not set, the status icon in Jira is not clickable.
jira: IconBean
An icon.
Fields
- url16x16 string? - The URL of a 16x16 pixel icon.
- title string? - The title of the icon, for use as a tooltip on the icon.
- link string? - The URL of the tooltip, used only for a status icon.
jira: IdBean
Fields
- id int - The ID of the permission scheme to associate with the project. Use the Get all permission schemes resource to get a list of permission scheme IDs.
jira: IdOrKeyBean
Fields
- id int? - The ID of the referenced item.
- 'key string? - The key of the referenced item.
jira: IncludedFields
Record define the included fields.
Fields
- included string[]? - Fields which are included.
- excluded string[]? - Fields which are included.
- actuallyIncluded string[]? - Fields which are actuually included.
jira: IssueBean
Fields
- expand string? - Expand options that include additional issue details in the response.
- id string? - The ID of the issue.
- self string? - The URL of the issue details.
- 'key string? - The key of the issue.
- renderedFields record {}? - The rendered value of each field present on the issue.
- properties record {}? - Details of the issue properties identified in the request.
- names record {}? - The ID and name of each field present on the issue.
- schema record {}? - The schema describing each field present on the issue.
- transitions IssueTransition[]? - The transitions that can be performed on the issue.
- operations Operations? - The operations that can be performed on the issue.
- editmeta IssueUpdateMetadata? - The metadata for the fields on the issue that can be amended.
- changelog PageOfChangelogs? - Details of changelogs associated with the issue.
- versionedRepresentations recor