Module jira

ballerinax/jira Ballerina library

1.5.1

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
1. Log into Atlassian Account
2. 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 to Account 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

Isolated

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

Isolated FunctionRemote Function

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

Isolated FunctionRemote Function

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

Isolated FunctionRemote Function

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 with projectKeys.

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 with projectIds.

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 with issuetypeNames.

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 with issuetypeIds.

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 the fields and update fields in Create issue and Create issues.

Return Type

IssueCreateMetadata|error - Returned if the request is successful.

getIssue

Isolated FunctionRemote Function

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, the fields 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 except prop1. * prop1,prop2 Returns prop1 and prop2 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.

Return Type

IssueBean|error - Returned if the request is successful.

editIssue

Isolated FunctionRemote Function

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

Isolated FunctionRemote Function

function deleteIssue(string issueIdOrKey, string deleteSubtasks) returns Response|error

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.

Return Type

Response|error - Returned if the request is successful.

assignIssue

Isolated FunctionRemote Function

function assignIssue(string issueIdOrKey, User payload) returns json|error

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

Isolated FunctionRemote Function

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

Isolated FunctionRemote Function

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

Isolated FunctionRemote Function

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

Isolated FunctionRemote Function

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

Isolated FunctionRemote Function

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 the fields and update 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

Isolated FunctionRemote Function

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

Isolated FunctionRemote Function

function bulkSetIssuesProperties(IssueEntityProperties payload) returns Response|error

Bulk set issues properties

Parameters

payload IssueEntityProperties - Issue properties to be set or updated with values.

Return Type

Response|error - Returned if the operation is successful.

bulkSetIssueProperty

Isolated FunctionRemote Function

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.

Return Type

Response|error - Returned if the request is successful.

bulkDeleteIssueProperty

Isolated FunctionRemote Function

function bulkDeleteIssueProperty(string propertyKey) returns Response|error

Bulk delete issue property

Parameters

propertyKey string - The key of the property.

Return Type

Response|error - Returned if the request is successful.

getIssuePropertyKeys

Isolated FunctionRemote Function

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

Isolated FunctionRemote Function

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

Isolated FunctionRemote Function

function setIssueProperty(string issueIdOrKey, string propertyKey, json payload) returns json|error

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

Isolated FunctionRemote Function

function deleteIssueProperty(string issueIdOrKey, string propertyKey) returns Response|error

Delete issue property

Parameters

issueIdOrKey string - The key or ID of the issue.

propertyKey string - The key of the property.

Return Type

Response|error - Returned if the request is successful.

getAttachmentMeta

Isolated FunctionRemote Function

function getAttachmentMeta() returns AttachmentSettings|error

Get Jira attachment settings

Return Type

AttachmentSettings|error - Returned if the request is successful.

getAttachment

Isolated FunctionRemote Function

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

Isolated FunctionRemote Function

function removeAttachment(string id) returns Response|error

Delete attachment

Parameters

id string - The ID of the attachment.

Return Type

Response|error - Returned if the request is successful.

expandAttachmentForHumans

Isolated FunctionRemote Function

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

Isolated FunctionRemote Function

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

Isolated FunctionRemote Function

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

Isolated FunctionRemote Function

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

Isolated FunctionRemote Function

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

Isolated FunctionRemote Function

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

Isolated FunctionRemote Function

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

Isolated FunctionRemote Function

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

Isolated FunctionRemote Function

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

Isolated FunctionRemote Function

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

Isolated FunctionRemote Function

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

Isolated FunctionRemote Function

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

Isolated FunctionRemote Function

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

Isolated FunctionRemote Function

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

Isolated FunctionRemote Function

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

Isolated FunctionRemote Function

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

Isolated FunctionRemote Function

function deleteCustomFieldContext(string fieldId, int contextId) returns json|error

Delete custom field context

Parameters

fieldId string - The ID of the custom field.

contextId int - The ID of the context.

Return Type

json|error - Returned if the context is deleted.

addIssueTypesToContext

Isolated FunctionRemote Function

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

Isolated FunctionRemote Function

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

Isolated FunctionRemote Function

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

Isolated FunctionRemote Function

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

Isolated FunctionRemote Function

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

Isolated FunctionRemote Function

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

Isolated FunctionRemote Function

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

Isolated FunctionRemote Function

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

Isolated FunctionRemote Function

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

Isolated FunctionRemote Function

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.

Return Type

Response|error - Returned if the option is deleted.

getIssueLinkTypes

Isolated FunctionRemote Function

function getIssueLinkTypes() returns IssueLinkTypes|error

Get issue link types

Return Type

IssueLinkTypes|error - Returned if the request is successful.

createIssueLinkType

Isolated FunctionRemote Function

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

Isolated FunctionRemote Function

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

Isolated FunctionRemote Function

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

Isolated FunctionRemote Function

function deleteIssueLinkType(string issueLinkTypeId) returns Response|error

Delete issue link type

Parameters

issueLinkTypeId string - The ID of the issue link type.

Return Type

Response|error - Returned if the request is successful.

getIssueNavigatorDefaultColumns

Isolated FunctionRemote Function

function getIssueNavigatorDefaultColumns() returns ColumnItem[]|error

Get issue navigator default columns

Return Type

ColumnItem[]|error - Returned if the request is successful.

setIssueNavigatorDefaultColumns

Isolated FunctionRemote Function

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

Isolated FunctionRemote Function

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

Isolated FunctionRemote Function

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

Isolated FunctionRemote Function

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.

Return Type

Response|error - Returned if the request is successful.

getRemoteIssueLinkById

Isolated FunctionRemote Function

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

Isolated FunctionRemote Function

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

Isolated FunctionRemote Function

function deleteRemoteIssueLinkById(string issueIdOrKey, string linkId) returns Response|error

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.

Return Type

Response|error - Returned if the request is successful.

getResolutions

Isolated FunctionRemote Function

function getResolutions() returns Resolution[]|error

Get resolutions

Return Type

Resolution[]|error - Returned if the request is successful.

getResolution

Isolated FunctionRemote Function

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

Isolated FunctionRemote Function

function getIssueAllTypes() returns IssueTypeDetails[]|error

Get all issue types for user

Return Type

IssueTypeDetails[]|error - Returned if the request is successful.

createIssueType

Isolated FunctionRemote Function

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

Isolated FunctionRemote Function

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

Isolated FunctionRemote Function

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

Isolated FunctionRemote Function

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

Isolated FunctionRemote Function

function deleteIssueType(string id, string? alternativeIssueTypeId) returns Response|error

Delete issue type

Parameters

id string - The ID of the issue type.

alternativeIssueTypeId string? (default ()) - The ID of the replacement issue type.

Return Type

Response|error - Returned if the request is successful.

getAlternativeIssueTypes

Isolated FunctionRemote Function

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

Isolated FunctionRemote Function

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.

Return Type

Avatar|error - Returned if the request is successful.

getIssueTypePropertyKeys

Isolated FunctionRemote Function

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

Isolated FunctionRemote Function

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

Isolated FunctionRemote Function

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

Isolated FunctionRemote Function

function deleteIssueTypeProperty(string issueTypeId, string propertyKey) returns Response|error

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.

Return Type

Response|error - Returned if the issue type property is deleted.

getAutoComplete

Isolated FunctionRemote Function

function getAutoComplete() returns JQLReferenceData|error

Get field reference data (GET)

Return Type

JQLReferenceData|error - Returned if the request is successful.

getAutoCompletePost

Isolated FunctionRemote Function

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

Isolated FunctionRemote Function

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

Isolated FunctionRemote Function

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

Isolated FunctionRemote Function

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

DeprecatedIsolated FunctionRemote Function

function getAllProjects(string? expand, int? recent, string[]? properties) returns Project[]|error

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.

Return Type

Project[]|error - Returned if the request is successful.
Deprecated

createProject

Isolated FunctionRemote Function

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

Isolated FunctionRemote Function

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 or name 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, and software.

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

Isolated FunctionRemote Function

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.

Return Type

Project|error - Returned if successful.

updateProject

Isolated FunctionRemote Function

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.

Return Type

Project|error - Returned if the project is updated.

deleteProject

Isolated FunctionRemote Function

function deleteProject(string projectIdOrKey, boolean enableUndo) returns Response|error

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.

Return Type

Response|error - Returned if the project is deleted.

archiveProject

Isolated FunctionRemote Function

function archiveProject(string projectIdOrKey) returns json|error

Archive project

Parameters

projectIdOrKey string - The project ID or project key (case sensitive).

Return Type

json|error - Returned if the request is successful.

deleteProjectAsynchronously

Isolated FunctionRemote Function

function deleteProjectAsynchronously(string projectIdOrKey) returns Response|error

Delete project asynchronously

Parameters

projectIdOrKey string - The project ID or project key (case sensitive).

Return Type

Response|error - Returned if the request is successful.

restore

Isolated FunctionRemote Function

function restore(string projectIdOrKey) returns Project|error

Restore deleted project

Parameters

projectIdOrKey string - The project ID or project key (case sensitive).

Return Type

Project|error - Returned if the request is successful.

getAllStatuses

Isolated FunctionRemote Function

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

DeprecatedIsolated FunctionRemote Function

function updateProjectType(string projectIdOrKey, string newProjectTypeKey) returns Project|error

Update project type

Parameters

projectIdOrKey string - The project ID or project key (case sensitive).

newProjectTypeKey string - The key of the new project type.

Return Type

Project|error - Returned if the project type is updated.
Deprecated

getHierarchy

DeprecatedIsolated FunctionRemote Function

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

Isolated FunctionRemote Function

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

Isolated FunctionRemote Function

function getAllProjectTypes() returns ProjectType[]|error

Get all project types

Return Type

ProjectType[]|error - Returned if the request is successful.

getAllAccessibleProjectTypes

Isolated FunctionRemote Function

function getAllAccessibleProjectTypes() returns ProjectType[]|error

Get licensed project types

Return Type

ProjectType[]|error - Returned if the request is successful.

getProjectTypeByKey

Isolated FunctionRemote Function

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

Isolated FunctionRemote Function

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

Isolated FunctionRemote Function

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 or description 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, and archived.

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

Isolated FunctionRemote Function

function getProjectVersions(string projectIdOrKey, string? expand) returns Version[]|error

Get project versions

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 operations, which returns actions that can be performed on the version.

Return Type

Version[]|error - Returned if the request is successful.

getProjectEmail

Isolated FunctionRemote Function

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

Isolated FunctionRemote Function

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

Isolated FunctionRemote Function

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

Isolated FunctionRemote Function

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

Isolated FunctionRemote Function

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

Isolated FunctionRemote Function

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

DeprecatedIsolated FunctionRemote Function

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

Isolated FunctionRemote Function

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

Isolated FunctionRemote Function

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

Isolated FunctionRemote Function

function deleteInactiveWorkflow(string entityId) returns Response|error

Delete inactive workflow

Parameters

entityId string - The entity ID of the workflow.

Return Type

Response|error - Returned if the workflow is deleted.

getCommentsByIds

Isolated FunctionRemote Function

function getCommentsByIds(IssueCommentListRequestBean payload, string? expand) returns PageBeanComment|error

Get comments by IDs

Parameters

payload IssueCommentListRequestBean - The list of comment IDs.

expand string? (default ()) - Use expand to include additional information about comments in the response. This parameter accepts a comma-separated list. Expand options include: * renderedBody Returns the comment body rendered in HTML. * properties Returns the comment's properties.

Return Type

PageBeanComment|error - Returned if the request is successful.

getComments

Isolated FunctionRemote Function

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.

orderBy string? (default ()) - Order the results by a field. Accepts created to sort comments by their created date.

expand string? (default ()) - Use expand to include additional information about comments in the response. This parameter accepts renderedBody, which returns the comment body rendered in HTML.

Return Type

PageOfComments|error - Returned if the request is successful.

addComment

Isolated FunctionRemote Function

function addComment(string issueIdOrKey, Comment payload, string? expand) returns Comment|error

Add comment

Parameters

issueIdOrKey string - The ID or key of the issue.

payload Comment - The request payload to add comment.

expand string? (default ()) - Use expand to include additional information about comments in the response. This parameter accepts renderedBody, which returns the comment body rendered in HTML.

Return Type

Comment|error - Returned if the request is successful.

getComment

Isolated FunctionRemote Function

function getComment(string issueIdOrKey, string id, string? expand) returns Comment|error

Get comment

Parameters

issueIdOrKey string - The ID or key of the issue.

id string - The ID of the comment.

expand string? (default ()) - Use expand to include additional information about comments in the response. This parameter accepts renderedBody, which returns the comment body rendered in HTML.

Return Type

Comment|error - Returned if the request is successful.

updateComment

Isolated FunctionRemote Function

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.

expand string? (default ()) - Use expand to include additional information about comments in the response. This parameter accepts renderedBody, which returns the comment body rendered in HTML.

Return Type

Comment|error - Returned if the request is successful.

deleteComment

Isolated FunctionRemote Function

function deleteComment(string issueIdOrKey, string id) returns Response|error

Delete comment

Parameters

issueIdOrKey string - The ID or key of the issue.

id string - The ID of the comment.

Return Type

Response|error - Returned if the request is successful.

getCommentPropertyKeys

Isolated FunctionRemote Function

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

Isolated FunctionRemote Function

function getCommentProperty(string commentId, string propertyKey) returns EntityProperty|error

Get comment property

Parameters

commentId string - The ID of the comment.

propertyKey string - The key of the property.

Return Type

EntityProperty|error - Returned if the request is successful.

setCommentProperty

Isolated FunctionRemote Function

function setCommentProperty(string commentId, string propertyKey, json payload) returns json|error

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

Isolated FunctionRemote Function

function deleteCommentProperty(string commentId, string propertyKey) returns Response|error

Delete comment property

Parameters

commentId string - The ID of the comment.

propertyKey string - The key of the property.

Return Type

Response|error - Returned if the request is successful.

getPriorities

Isolated FunctionRemote Function

function getPriorities() returns Priority[]|error

Get priorities

Return Type

Priority[]|error - Returned if the request is successful.

getPriority

Isolated FunctionRemote Function

function getPriority(string id) returns Priority|error

Get priority

Parameters

id string - The ID of the issue priority.

Return Type

Priority|error - Returned if the request is successful.

linkIssues

Isolated FunctionRemote Function

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

Isolated FunctionRemote Function

function getIssueLink(string linkId) returns IssueLink|error

Get issue link

Parameters

linkId string - The ID of the issue link.

Return Type

IssueLink|error - Returned if the request is successful.

deleteIssueLink

Isolated FunctionRemote Function

function deleteIssueLink(string linkId) returns Response|error

Delete issue link

Parameters

linkId string - The ID of the issue link.

Return Type

Response|error - 200 response

getFields

Isolated FunctionRemote Function

function getFields() returns FieldDetails[]|error

Get fields

Return Type

FieldDetails[]|error - Returned if the request is successful.

createCustomField

Isolated FunctionRemote Function

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

Isolated FunctionRemote Function

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.

orderBy string? (default ()) - Order the results by a field: * contextsCount Sorts by the number of contexts related to a field. * lastUsed Sorts by the date when the value of the field last changed. * name Sorts by the field name. * screensCount Sorts by the number of screens related to a field.

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

Isolated FunctionRemote Function

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

Isolated FunctionRemote Function

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 and userkey cannot be used as search terms for this parameter, due to privacy reasons. Use accountId 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

Isolated FunctionRemote Function

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

Isolated FunctionRemote Function

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 and userkey cannot be used as search terms due to privacy reasons. Use accountId 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 or key 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 for strict. * false Deprecated A legacy synonym for warn. Note: If the JQL is not correctly formed a 400 response code is returned, regardless of the validateQuery 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 of fields, returns versionedRepresentations 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

Isolated FunctionRemote Function

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

Isolated FunctionRemote Function

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

Isolated FunctionRemote Function

function getAllPermissions() returns Permissions|error

Get all permissions

Return Type

Permissions|error - Returned if the request is successful.

getBulkPermissions

Isolated FunctionRemote Function

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

Isolated FunctionRemote Function

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

Isolated FunctionRemote Function

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

Isolated FunctionRemote Function

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

Isolated FunctionRemote Function

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

Isolated FunctionRemote Function

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

Isolated FunctionRemote Function

function deletePermissionScheme(int schemeId) returns Response|error

Delete permission scheme

Parameters

schemeId int - The ID of the permission scheme being deleted.

Return Type

Response|error - Returned if the permission scheme is deleted.

getPermissionSchemeGrants

Isolated FunctionRemote Function

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

Isolated FunctionRemote Function

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

Isolated FunctionRemote Function

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

Isolated FunctionRemote Function

function deletePermissionSchemeEntity(int schemeId, int permissionId) returns Response|error

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.

Return Type

Response|error - Returned if the permission grant is deleted.

getSelectedTimeTrackingImplementation

Isolated FunctionRemote Function

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

Isolated FunctionRemote Function

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

Isolated FunctionRemote Function

function getAvailableTimeTrackingImplementations() returns TimeTrackingProvider[]|error

Get all time tracking providers

Return Type

TimeTrackingProvider[]|error - Returned if the request is successful.

getSharedTimeTrackingConfiguration

Isolated FunctionRemote Function

function getSharedTimeTrackingConfiguration() returns TimeTrackingConfiguration|error

Get time tracking settings

Return Type

TimeTrackingConfiguration|error - Returned if the request is successful.

setSharedTimeTrackingConfiguration

Isolated FunctionRemote Function

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

Isolated FunctionRemote Function

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.

expand string (default "") - Use expand to include additional information about worklogs in the response. This parameter acceptsproperties, which returns worklog properties.

Return Type

PageOfWorklogs|error - Returned if the request is successful

addWorklog

Isolated FunctionRemote Function

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 in newEstimate. * leave Leaves the estimate unchanged. * manual Reduces the estimate by amount specified in reduceBy. * auto Reduces the estimate by the value of timeSpent 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 is new.

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 is manual.

expand string (default "") - Use expand to include additional information about work logs in the response. This parameter accepts properties, which returns worklog properties.

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.

Return Type

Worklog|error - Returned if the request is successful.

getWorklog

Isolated FunctionRemote Function

function getWorklog(string issueIdOrKey, string id, string expand) returns Worklog|error

Get worklog

Parameters

issueIdOrKey string - The ID or key of the issue.

id string - The ID of the worklog.

expand string (default "") - Use expand to include additional information about work logs in the response. This parameter accepts properties, which returns worklog properties.

Return Type

Worklog|error - Returned if the request is successful.

updateWorklog

Isolated FunctionRemote Function

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 in newEstimate. * leave Leaves the estimate unchanged. * auto Updates the estimate by the difference between the original and updated value of timeSpent or timeSpentSeconds.

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 is new.

expand string (default "") - Use expand to include additional information about worklogs in the response. This parameter accepts properties, which returns worklog properties.

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.

Return Type

Worklog|error - Returned if the request is successful

deleteWorklog

Isolated FunctionRemote Function

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 in newEstimate. * leave Leaves the estimate unchanged. * manual Increases the estimate by amount specified in increaseBy. * auto Reduces the estimate by the value of timeSpent 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 is new.

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 is manual.

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.

Return Type

Response|error - Returned if the request is successful.

getIdsOfWorklogsDeletedSince

Isolated FunctionRemote Function

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

Isolated FunctionRemote Function

function getWorklogsForIds(WorklogIdsRequestBean payload, string expand) returns Worklog[]|error

Get worklogs

Parameters

payload WorklogIdsRequestBean - A JSON object containing a list of worklog IDs.

expand string (default "") - Use expand to include additional information about worklogs in the response. This parameter accepts properties that returns the properties of each worklog.

Return Type

Worklog[]|error - Returned if the request is successful.

getIdsOfWorklogsModifiedSince

Isolated FunctionRemote Function

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.

expand string (default "") - Use expand to include additional information about worklogs in the response. This parameter accepts properties that returns the properties of each worklog.

Return Type

ChangedWorklogs|error - Returned if the request is successful.

getWorklogPropertyKeys

Isolated FunctionRemote Function

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

Isolated FunctionRemote Function

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

Isolated FunctionRemote Function

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

Isolated FunctionRemote Function

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.

Return Type

Response|error - Returned if the worklog property is removed.

getWorkflowTransitionRuleConfigurations

Isolated FunctionRemote Function

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.

expand string? (default ()) - Use expand to include additional information in the response. This parameter accepts transition, which, for each rule, returns information about the transition the rule is assigned to.

Return Type

PageBeanWorkflowTransitionRules|error - Returned if the request is successful.

updateWorkflowTransitionRuleConfigurations

Isolated FunctionRemote Function

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

Isolated FunctionRemote Function

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

Isolated FunctionRemote Function

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

Isolated FunctionRemote Function

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 or draft for draft workflows. Active workflows cannot be edited.

Return Type

WorkflowTransitionProperty|error - 200 response

createWorkflowTransitionProperty

Isolated FunctionRemote Function

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

Isolated FunctionRemote Function

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 or draft for draft workflows. Active workflows cannot be edited.

Return Type

Response|error - 200 response

getAllWorkflowSchemes

Isolated FunctionRemote Function

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

Isolated FunctionRemote Function

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

Isolated FunctionRemote Function

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

Isolated FunctionRemote Function

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

Isolated FunctionRemote Function

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

Isolated FunctionRemote Function

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

Isolated FunctionRemote Function

function deleteWorkflowScheme(int id) returns Response|error

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.

Return Type

Response|error - Returned if the request is successful.

createWorkflowSchemeDraftFromParent

Isolated FunctionRemote Function

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

Isolated FunctionRemote Function

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

Isolated FunctionRemote Function

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

Isolated FunctionRemote Function

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

Isolated FunctionRemote Function

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

Isolated FunctionRemote Function

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

Isolated FunctionRemote Function

function deleteWorkflowSchemeDraft(int id) returns Response|error

Delete draft workflow scheme

Parameters

id int - The ID of the active workflow scheme that the draft was created from.

Return Type

Response|error - Returned if the request is successful.

getDraftDefaultWorkflow

Isolated FunctionRemote Function

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

Isolated FunctionRemote Function

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

Isolated FunctionRemote Function

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

Isolated FunctionRemote Function

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

Isolated FunctionRemote Function

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

Isolated FunctionRemote Function

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

Isolated FunctionRemote Function

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.

Return Type

Response|error - Returned if the request is only for validation and is successful.

getDraftWorkflow

Isolated FunctionRemote Function

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

Isolated FunctionRemote Function

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

Isolated FunctionRemote Function

function deleteDraftWorkflowMapping(int id, string workflowName) returns Response|error

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.

Return Type

Response|error - Returned if the request is successful.

getWorkflowSchemeIssueType

Isolated FunctionRemote Function

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

Isolated FunctionRemote Function

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

Isolated FunctionRemote Function

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

Isolated FunctionRemote Function

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

Isolated FunctionRemote Function

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

Isolated FunctionRemote Function

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.

Return Type

Response|error - Returned if the request is successful.

getStatuses

Isolated FunctionRemote Function

function getStatuses() returns StatusDetails[]|error

Get all statuses

Return Type

StatusDetails[]|error - Returned if the request is successful.

getStatus

Isolated FunctionRemote Function

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

Isolated FunctionRemote Function

function getStatusCategories() returns StatusCategory[]|error

Get all status categories

Return Type

StatusCategory[]|error - Returned if the request is successful.

getStatusCategory

Isolated FunctionRemote Function

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

Isolated FunctionRemote Function

function getAllProjectCategories() returns ProjectCategory[]|error

Get all project categories

Return Type

ProjectCategory[]|error - Returned if the request is successful.

createProjectCategory

Isolated FunctionRemote Function

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

Isolated FunctionRemote Function

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

Isolated FunctionRemote Function

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

Isolated FunctionRemote Function

function removeProjectCategory(int id) returns Response|error

Delete project category

Parameters

id int - ID of the project category to delete.

Return Type

Response|error - Returned if the request is successful.

createComponent

Isolated FunctionRemote Function

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

Isolated FunctionRemote Function

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

Isolated FunctionRemote Function

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

Isolated FunctionRemote Function

function deleteComponent(string id, string? moveIssuesTo) returns Response|error

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.

Return Type

Response|error - Returned if the request is successful.

getComponentRelatedIssues

Isolated FunctionRemote Function

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

Isolated FunctionRemote Function

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.

orderBy string? (default ()) - Order the results by a field: * description Sorts by the component description. * issueCount Sorts by the count of issues associated with the component. * lead Sorts by the user key of the component's project lead. * name Sorts by component name.

query string? (default ()) - Filter the results using a literal string. Components with a matching name or description are returned (case insensitive).

Return Type

PageBeanComponentWithIssueCount|error - Returned if the request is successful.

getProjectComponents

Isolated FunctionRemote Function

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

Isolated FunctionRemote Function

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

Isolated FunctionRemote Function

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

Isolated FunctionRemote Function

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

Isolated FunctionRemote Function

function deleteProjectProperty(string projectIdOrKey, string propertyKey) returns Response|error

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.

Return Type

Response|error - Returned if the project property is deleted.

getProjectRoles

Isolated FunctionRemote Function

function getProjectRoles(string projectIdOrKey) returns json|error

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

Isolated FunctionRemote Function

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

Isolated FunctionRemote Function

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

Isolated FunctionRemote Function

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

Isolated FunctionRemote Function

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.

Return Type

Response|error - Returned if the request is successful.

getProjectRoleDetails

Isolated FunctionRemote Function

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

Isolated FunctionRemote Function

function getAllProjectRoles() returns ProjectRole[]|error

Get all project roles

Return Type

ProjectRole[]|error - Returned if the request is successful.

createProjectRole

Isolated FunctionRemote Function

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

Isolated FunctionRemote Function

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

Isolated FunctionRemote Function

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

Isolated FunctionRemote Function

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

Isolated FunctionRemote Function

function deleteProjectRole(int id, int? swap) returns Response|error

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.

Return Type

Response|error - Returned if the request is successful.

getProjectRoleActorsForRole

Isolated FunctionRemote Function

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

Isolated FunctionRemote Function

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

Isolated FunctionRemote Function

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

Isolated FunctionRemote Function

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.

Return Type

User|error - Returned if the request is successful.

createUser

Isolated FunctionRemote Function

function createUser(UserWriteBean payload) returns User|error

Create user

Parameters

payload UserWriteBean - Details about the user to be created.

Return Type

User|error - Returned if the request is successful.

removeUser

Isolated FunctionRemote Function

function removeUser(string accountId, string? username, string? 'key) returns Response|error

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.

Return Type

Response|error - Returned if the request is successful.

bulkGetUsers

Isolated FunctionRemote Function

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

Isolated FunctionRemote Function

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 if key isn't provided. Cannot be provided if key 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 if username isn't provided. Cannot be provided if username is present.

Return Type

UserMigrationBean[]|error - Returned if the request is successful.

getUserDefaultColumns

Isolated FunctionRemote Function

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

Isolated FunctionRemote Function

function setUserColumns(byte[] payload, string? accountId) returns json|error

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

Isolated FunctionRemote Function

function resetUserColumns(string? accountId, string? username) returns Response|error

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.

Return Type

Response|error - Returned if the request is successful.

getUserEmail

Isolated FunctionRemote Function

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

Isolated FunctionRemote Function

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

Isolated FunctionRemote Function

function getUserGroups(string accountId, string? username, string? 'key) returns GroupName[]|error

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.

Return Type

GroupName[]|error - Returned if the request is successful.

getAllUsersDefault

Isolated FunctionRemote Function

function getAllUsersDefault(int startAt, int maxResults) returns User[]|error

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.

Return Type

User[]|error - Returned if the request is successful.

getAllUsers

Isolated FunctionRemote Function

function getAllUsers(int startAt, int maxResults) returns User[]|error

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.

Return Type

User[]|error - Returned if the request is successful.

getUserPropertyKeys

Isolated FunctionRemote Function

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

Isolated FunctionRemote Function

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

Isolated FunctionRemote Function

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

Isolated FunctionRemote Function

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.

Return Type

Response|error - Returned if the user property is deleted.

findBulkAssignableUsers

Isolated FunctionRemote Function

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 and emailAddress, to find relevant users. The string can match the prefix of the attribute's value. For example, query=john matches a user with a displayName of John Smith and a user with an emailAddress of johnson@example.com. Required, unless accountId 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, unless query 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.

Return Type

User[]|error - Returned if the request is successful.

findAssignableUsers

Isolated FunctionRemote Function

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, and emailAddress, to find relevant users. The string can match the prefix of the attribute's value. For example, query=john matches a user with a displayName of John Smith and a user with an emailAddress of johnson@example.com. Required, unless username or accountId 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, unless query 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.

Return Type

User[]|error - Returned if the request is successful.

findUsersWithAllPermissions

Isolated FunctionRemote Function

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 and emailAddress, to find relevant users. The string can match the prefix of the attribute's value. For example, query=john matches a user with a displayName of John Smith and a user with an emailAddress of johnson@example.com. Required, unless accountId 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, unless query 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.

Return Type

User[]|error - Returned if the request is successful.

findUsersForPicker

Isolated FunctionRemote Function

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, and emailAddress, to find relevant users. The string can match the prefix of the attribute's value. For example, query=john matches a user with a displayName of John Smith and a user with an emailAddress 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 with exclude.

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

Isolated FunctionRemote Function

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, and emailAddress) to find relevant users. The string can match the prefix of the attribute's value. For example, query=john matches a user with a displayName of John Smith and a user with an emailAddress of johnson@example.com. Required, unless accountId or property 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, unless query or property 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}} use thepropertykey.something.nested=1. Required, unless accountId or query is specified.

Return Type

User[]|error - Returned if the request is successful.

findUsersByQuery

Isolated FunctionRemote Function

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

Isolated FunctionRemote Function

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

Isolated FunctionRemote Function

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 and emailAddress, to find relevant users. The string can match the prefix of the attribute's value. For example, query=john matches a user with a displayName of John Smith and a user with an emailAddress of johnson@example.com. Required, unless accountId 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, unless query 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.

Return Type

User[]|error - Returned if the request is successful.

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 or predicateValue 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 and user. 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

Closed record

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. See realAssignee 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 the assigneeType is set to COMPONENT_LEAD but the component lead is not set, then false 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 to COMPONENT_LEAD but no component lead is set. This property is set to one of the following values:
- PROJECT_LEAD when assigneeType is PROJECT_LEAD and the project lead has permission to be assigned issues in the project that the component is in.
- COMPONENT_LEAD when assigneeType is COMPONENT_LEAD and the component lead has permission to be assigned issues in the project that the component is in.
- UNASSIGNED when assigneeType is UNASSIGNED 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

Closed record

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. Either lead or leadAccountId must be set when creating a project. Cannot be provided with leadAccountId.

leadAccountId string? - The account ID of the project lead. Either lead or leadAccountId must be set when creating a project. Cannot be provided with lead.

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 the projectTypeKey.

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.
All the transition statuses must be included in 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)
To create a field based on a Forge custom field type, use the ID of the Forge custom field type as the value. For example, 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 or numberrange
- grouppicker: grouppickersearcher
- importid: exactnumber or numberrange
- 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
If no searcher is provided, the field isn't searchable. However, Forge custom fields have a searcher set automatically, so are always searchable.

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 the accountId field.
- group – the value must be an object that contains the group name field.
A list of appropriate values must be provided if the field is of the 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 as AUTHENTICATED 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 The parameter is the user account ID.
- Group The parameter is the group name.
- ProjectRole The parameter is the project role ID.
- UserCustomField The parameter is the ID of the custom field.
- GroupCustomField The parameter 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].

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

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.

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 record {}? - The versions of each field on the issue.

fieldsToInclude IncludedFields? - Record define the included fields.

fields record {}? -

jira: IssueChangelogIds

A list of changelog IDs.

Fields

changelogIds int[] - The list of changelog IDs.

jira: IssueCommentListRequestBean

Fields

ids int[] - The list of comment IDs. A maximum of 1000 IDs can be specified.

jira: IssueCreateMetadata

The wrapper for the issue creation metadata for a list of projects.

Fields

expand string? - Expand options that include additional project details in the response.

projects ProjectIssueCreateMetadata[]? - List of projects and their issue creation metadata.

jira: IssueEntityProperties

Lists of issues and entity properties. See Entity properties for more information.

Fields

entitiesIds int[]? - A list of entity property IDs.

properties record {}? - A list of entity property keys and values.

jira: IssueFieldOptionConfiguration

Details of the projects the option is available in.

Fields

scope IssueFieldOptionScopeBean? - Defines the projects that the option is available in. If the scope is not defined, then the option is available in all projects.

attributes string[]? - DEPRECATED

jira: IssueFieldOptionCreateBean

Fields

value string - The option's name, which is displayed in Jira.

properties record {}? - The properties of the option as arbitrary key-value pairs. These properties can be searched using JQL, if the extractions (see https://developer.atlassian.com/cloud/jira/platform/modules/issue-field-option-property-index/) are defined in the descriptor for the issue field module.

config IssueFieldOptionConfiguration? - Details of the projects the option is available in.

jira: IssueFieldOptionScopeBean

Fields

projects int[]? - DEPRECATED

projects2 ProjectScopeBean[]? - Defines the projects in which the option is available and the behavior of the option within each project. Specify one object per project. The behavior of the option in a project context overrides the behavior in the global context.

global GlobalScopeBean? - Defines the behavior of the option within the global context. If this property is set, even if set to an empty object, then the option is available in all projects.

jira: IssueFilterForBulkPropertyDelete

Bulk operation filter details.

Fields

entityIds int[]? - List of issues to perform the bulk delete operation on.

currentValue anydata? - The value of properties to perform the bulk operation on.

jira: IssueFilterForBulkPropertySet

Bulk operation filter details.

Fields

entityIds int[]? - List of issues to perform the bulk operation on.

currentValue anydata? - The value of properties to perform the bulk operation on.

hasProperty boolean? - Whether the bulk operation occurs only when the property is present on or absent from an issue.

jira: IssueLink

Details of a link between issues.

Fields

id string? - The ID of the issue link.

self string? - The URL of the issue link.

'type IssueLinkType - The type of link between the issues.

inwardIssue LinkedIssue - The issue the link joins to.

outwardIssue LinkedIssue - The issue the link originates from.

jira: IssueLinkType

This object is used as follows:

In the issueLink resource it defines and reports on the type of link between the issues. Find a list of issue link types with Get issue link types.
In the issueLinkType resource it defines and reports on issue link types.

Fields

id string? - The ID of the issue link type and is used as follows:
- In the issueLink resource it is the type of issue link. Required on create when name isn't provided. Otherwise, read only.
- In the issueLinkType resource it is read only.

name string? - The name of the issue link type and is used as follows:
- In the issueLink resource it is the type of issue link. Required on create when id isn't provided. Otherwise, read only.
- In the issueLinkType resource it is required on create and optional on update. Otherwise, read only.

inward string? - The description of the issue link type inward link and is used as follows:
- In the issueLink resource it is read only.
- In the issueLinkType resource it is required on create and optional on update. Otherwise, read only.

outward string? - The description of the issue link type outward link and is used as follows:
- In the issueLink resource it is read only.
- In the issueLinkType resource it is required on create and optional on update. Otherwise, read only.

self string? - The URL of the issue link type. Read only.

jira: IssueLinkTypes

A list of issue link type beans.

Fields

issueLinkTypes IssueLinkType[]? - The issue link type bean.

jira: IssueMatches

A list of matched issues or errors for each JQL query, in the order the JQL queries were passed.

Fields

matches IssueMatchesForJQL[] - Array of matched issues.

jira: IssueMatchesForJQL

A list of the issues matched to a JQL query or details of errors encountered during matching.

Fields

matchedIssues int[] - A list of issue IDs.

errors string[] - A list of errors.

jira: IssuePickerSuggestions

A list of issues suggested for use in auto-completion.

Fields

sections IssuePickerSuggestionsIssueType[]? - A list of issues for an issue type suggested for use in auto-completion.

jira: IssuePickerSuggestionsIssueType

A type of issue suggested for use in auto-completion.

Fields

label string? - The label of the type of issues suggested for use in auto-completion.

sub string? - If issue suggestions are found, returns a message indicating the number of issues suggestions found and returned.

id string? - The ID of the type of issues suggested for use in auto-completion.

msg string? - If no issue suggestions are found, returns a message indicating no suggestions were found,

issues SuggestedIssue[]? - A list of issues suggested for use in auto-completion.

jira: IssuesAndJQLQueries

List of issues and JQL queries.

Fields

jqls string[] - A list of JQL queries.

issueIds int[] - A list of issue IDs.

jira: IssueSecurityLevelMember

Issue security level member.

Fields

id int - The ID of the issue security level member.

issueSecurityLevelId int - The ID of the issue security level.

holder PermissionHolder - The user or group being granted the permission. It consists of a type and a type-dependent parameter. See Holder object in Get all permission schemes for more information.

jira: IssuesJqlMetaDataBean

The description of the page of issues loaded by the provided JQL query.

Fields

startAt int - The index of the first issue.

maxResults int - The maximum number of issues that could be loaded in this evaluation.

count int - The number of issues that were loaded in this evaluation.

totalCount int - The total number of issues the JQL returned.

validationWarnings string[]? - Any warnings related to the JQL query. Present only if the validation mode was set to warn.

jira: IssuesMetaBean

Meta data describing the issues context variable.

Fields

jql IssuesJqlMetaDataBean? - The description of the page of issues loaded by the provided JQL query.

jira: IssuesUpdateBean

Fields

issueUpdates IssueUpdateDetails[]? -

jira: IssueTransition

Details of an issue transition.

Fields

id string? - The ID of the issue transition. Required when specifying a transition to undertake.

name string? - The name of the issue transition.

to StatusDetails? - Details of the issue status after the transition.

hasScreen boolean? - Whether there is a screen associated with the issue transition.

isGlobal boolean? - Whether the issue transition is global, that is, the transition is applied to issues regardless of their status.

isInitial boolean? - Whether this is the initial issue transition for the workflow.

isAvailable boolean? - Whether the transition is available to be performed.

isConditional boolean? - Whether the issue has to meet criteria before the issue transition is applied.

fields record {}? - Details of the fields associated with the issue transition screen. Use this information to populate fields and update in a transition request.

expand string? - Expand options that include additional transition details in the response.

looped boolean? - Whether looped or not

jira: IssueTypeCreateBean

Fields

name string - The unique name for the issue type. The maximum length is 60 characters.

description string? - The description of the issue type.

'type string? - Deprecated. Use hierarchyLevel instead. Whether the issue type is subtype or standard. Defaults to standard.

hierarchyLevel int? - The hierarchy level of the issue type. Use:
- -1 for Subtask.
- 0 for Base.
Defaults to 0.

jira: IssueTypeDetails

Details about an issue type.

Fields

self string? - The URL of these issue type details.

id string? - The ID of the issue type.

description string? - The description of the issue type.

iconUrl string? - The URL of the issue type's avatar.

name string? - The name of the issue type.

subtask boolean? - Whether this issue type is used to create subtasks.

avatarId int? - The ID of the issue type's avatar.

entityId string? - Unique ID for next-gen projects.

hierarchyLevel int? - Hierarchy level of the issue type.

scope Scope? - Details of the next-gen projects the issue type is available in.

jira: IssueTypeIds

The list of issue type IDs.

Fields

issueTypeIds string[] - The list of issue type IDs.

jira: IssueTypeInfo

Details of an issue type.

Fields

id int? - The ID of the issue type.

name string? - The name of the issue type.

avatarId int? - The avatar of the issue type.

jira: IssueTypeIssueCreateMetadata

Details of the issue creation metadata for an issue type.

Fields

self string? - The URL of these issue type details.

id string? - The ID of the issue type.

description string? - The description of the issue type.

iconUrl string? - The URL of the issue type's avatar.

name string? - The name of the issue type.

subtask boolean? - Whether this issue type is used to create subtasks.

avatarId int? - The ID of the issue type's avatar.

entityId string? - Unique ID for next-gen projects.

hierarchyLevel int? - Hierarchy level of the issue type.

scope Scope? - Details of the next-gen projects the issue type is available in.

expand string? - Expand options that include additional issue type metadata details in the response.

fields record {}? - List of the fields available when creating an issue for the issue type.

jira: IssueTypeScheme

Details of an issue type scheme.

Fields

id string - The ID of the issue type scheme.

name string - The name of the issue type scheme.

description string? - The description of the issue type scheme.

defaultIssueTypeId string? - The ID of the default issue type of the issue type scheme.

isDefault boolean? - Whether the issue type scheme is the default.

jira: IssueTypeSchemeDetails

Details of an issue type scheme and its associated issue types.

Fields

name string - The name of the issue type scheme. The name must be unique. The maximum length is 255 characters.

description string? - The description of the issue type scheme. The maximum length is 4000 characters.

defaultIssueTypeId string? - The ID of the default issue type of the issue type scheme. This ID must be included in issueTypeIds.

issueTypeIds string[] - The list of issue types IDs of the issue type scheme. At least one standard issue type ID is required.

jira: IssueTypeSchemeID

The ID of an issue type scheme.

Fields

issueTypeSchemeId string - The ID of the issue type scheme.

jira: IssueTypeSchemeMapping

Issue type scheme item.

Fields

issueTypeSchemeId string - The ID of the issue type scheme.

issueTypeId string - The ID of the issue type.

jira: IssueTypeSchemeProjectAssociation

Details of the association between an issue type scheme and project.

Fields

issueTypeSchemeId string - The ID of the issue type scheme.

projectId string - The ID of the project.

jira: IssueTypeSchemeProjects

Issue type scheme with a list of the projects that use it.

Fields

issueTypeScheme IssueTypeScheme - Details of an issue type scheme.

projectIds string[] - The IDs of the projects using the issue type scheme.

jira: IssueTypeSchemeUpdateDetails

Details of the name, description, and default issue type for an issue type scheme.

Fields

name string? - The name of the issue type scheme. The name must be unique. The maximum length is 255 characters.

description string? - The description of the issue type scheme. The maximum length is 4000 characters.

defaultIssueTypeId string? - The ID of the default issue type of the issue type scheme.

jira: IssueTypeScreenScheme

Details of an issue type screen scheme.

Fields

id string - The ID of the issue type screen scheme.

name string - The name of the issue type screen scheme.

description string? - The description of the issue type screen scheme.

jira: IssueTypeScreenSchemeDetails

The details of an issue type screen scheme.

Fields

name string - The name of the issue type screen scheme. The name must be unique. The maximum length is 255 characters.

description string? - The description of the issue type screen scheme. The maximum length is 255 characters.

issueTypeMappings IssueTypeScreenSchemeMapping[] - The IDs of the screen schemes for the issue type IDs and default. A default entry is required to create an issue type screen scheme, it defines the mapping for all issue types without a screen scheme.

jira: IssueTypeScreenSchemeId

The ID of an issue type screen scheme.

Fields

id string - The ID of the issue type screen scheme.

jira: IssueTypeScreenSchemeItem

The screen scheme for an issue type.

Fields

issueTypeScreenSchemeId string - The ID of the issue type screen scheme.

issueTypeId string - The ID of the issue type or default. Only issue types used in classic projects are accepted. When creating an issue screen scheme, an entry for default must be provided and defines the mapping for all issue types without a screen scheme. Otherwise, a default entry can't be provided.

screenSchemeId string - The ID of the screen scheme.

jira: IssueTypeScreenSchemeMapping

The IDs of the screen schemes for the issue type IDs.

Fields

issueTypeId string - The ID of the issue type or default. Only issue types used in classic projects are accepted. An entry for default must be provided and defines the mapping for all issue types without a screen scheme.

screenSchemeId string - The ID of the screen scheme. Only screen schemes used in classic projects are accepted.

jira: IssueTypeScreenSchemeMappingDetails

A list of issue type screen scheme mappings.

Fields

issueTypeMappings IssueTypeScreenSchemeMapping[] - The list of issue type to screen scheme mappings. A default entry cannot be specified because a default entry is added when an issue type screen scheme is created.

jira: IssueTypeScreenSchemeProjectAssociation

Associated issue type screen scheme and project.

Fields

issueTypeScreenSchemeId string? - The ID of the issue type screen scheme.

projectId string? - The ID of the project.

jira: IssueTypeScreenSchemesProjects

Issue type screen scheme with a list of the projects that use it.

Fields

issueTypeScreenScheme IssueTypeScreenScheme - Details of an issue type screen scheme.

projectIds string[] - The IDs of the projects using the issue type screen scheme.

jira: IssueTypeScreenSchemeUpdateDetails

Details of an issue type screen scheme.

Fields

name string? - The name of the issue type screen scheme. The name must be unique. The maximum length is 255 characters.

description string? - The description of the issue type screen scheme. The maximum length is 255 characters.

jira: IssueTypesWorkflowMapping

Details about the mapping between issue types and a workflow.

Fields

workflow string? - The name of the workflow. Optional if updating the workflow-issue types mapping.

issueTypes string[]? - The list of issue type IDs.

defaultMapping boolean? - Whether the workflow is the default workflow for the workflow scheme.

updateDraftIfNeeded boolean? - Whether a draft workflow scheme is created or updated when updating an active workflow scheme. The draft is updated with the new workflow-issue types mapping. Defaults to false.

jira: IssueTypeToContextMapping

Mapping of an issue type to a context.

Fields

contextId string - The ID of the context.

issueTypeId string? - The ID of the issue type.

isAnyIssueType boolean? - Whether the context is mapped to any issue type.

jira: IssueTypeUpdateBean

Fields

name string? - The unique name for the issue type. The maximum length is 60 characters.

description string? - The description of the issue type.

avatarId int? - The ID of an issue type avatar.

jira: IssueTypeWithStatus

Status details for an issue type.

Fields

self string - The URL of the issue type's status details.

id string - The ID of the issue type.

name string - The name of the issue type.

subtask boolean - Whether this issue type represents subtasks.

statuses StatusDetails[] - List of status details for the issue type.

jira: IssueTypeWorkflowMapping

Details about the mapping between an issue type and a workflow.

Fields

issueType string? - The ID of the issue type. Not required if updating the issue type-workflow mapping.

workflow string? - The name of the workflow.

updateDraftIfNeeded boolean? - 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. Only applicable when updating the workflow-issue types mapping.

jira: IssueUpdateDetails

Details of an issue update request.

Fields

transition IssueTransition? - Details of a transition. Required when performing a transition, optional when creating or editing an issue.

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

update record {}? - List of operations to perform on issue screen fields. Note that fields included in here cannot be included in fields.

historyMetadata HistoryMetadata? - Additional issue history details.

properties EntityProperty[]? - Details of issue properties to be add or update.

jira: IssueUpdateMetadata

A list of editable field details.

Fields

fields record {}? - A list of editable field details.

jira: JexpIssues

The JQL specifying the issues available in the evaluated Jira expression under the issues context variable.

Fields

jql JexpJqlIssues? - The JQL query that specifies the set of issues available in the Jira expression.

jira: JexpJqlIssues

The JQL specifying the issues available in the evaluated Jira expression under the issues context variable. Not all issues returned by the JQL query are loaded, only those described by the startAt and maxResults properties. To determine whether it is necessary to iterate to ensure all the issues returned by the JQL query are evaluated, inspect meta.issues.jql.count in the response.

Fields

query string? - The JQL query.

startAt int? - The index of the first issue to return from the JQL query.

maxResults int? - The maximum number of issues to return from the JQL query. Inspect meta.issues.jql.maxResults in the response to ensure the maximum value has not been exceeded.

validation string? - Determines how to validate the JQL query and treat the validation results.

jira: JiraExpressionEvalContextBean

Fields

issue IdOrKeyBean? - The issue that is available under the issue variable when evaluating the expression.

issues JexpIssues? - The collection of issues that is available under the issues variable when evaluating the expression.

project IdOrKeyBean? - The project that is available under the project variable when evaluating the expression.

sprint int? - The ID of the sprint that is available under the sprint variable when evaluating the expression.

board int? - The ID of the board that is available under the board variable when evaluating the expression.

serviceDesk int? - The ID of the service desk that is available under the serviceDesk variable when evaluating the expression.

customerRequest int? - The ID of the customer request that is available under the customerRequest variable when evaluating the expression. This is the same as the ID of the underlying Jira issue, but the customer request context variable will have a different type.

jira: JiraExpressionEvalRequestBean

Fields

expression string - The Jira expression to evaluate.

context JiraExpressionEvalContextBean? - The context in which the Jira expression is evaluated.

jira: JiraExpressionEvaluationMetaDataBean

Record defines a bean for about the expression complexity metadata.

Fields

complexity JiraExpressionsComplexityBean? - Contains information about the expression complexity. For example, the number of steps it took to evaluate the expression.

issues IssuesMetaBean? - Contains information about the issues variable in the context. For example, is the issues were loaded with JQL, information about the page will be included here.

jira: JiraExpressionForAnalysis

Details of Jira expressions for analysis.

Fields

expressions string[] - The list of Jira expressions to analyse.

contextVariables record {}? - Context variables and their types. The type checker assumes that common context variables, such as issue or project, are available in context and sets their type. Use this property to override the default types or provide details of new variables.

jira: JiraExpressionResult

The result of evaluating a Jira expression.

Fields

value anydata - The value of the evaluated expression. It may be a primitive JSON value or a Jira REST API object. (Some expressions do not produce any meaningful results—for example, an expression that returns a lambda function—if that's the case a simple string representation is returned. These string representations should not be relied upon and may change without notice.)

meta JiraExpressionEvaluationMetaDataBean? - Contains various characteristics of the performed expression evaluation.

jira: JiraExpressionsComplexityBean

Fields

steps JiraExpressionsComplexityValueBean - The number of steps it took to evaluate the expression, where a step is a high-level operation performed by the expression. A step is an operation such as arithmetic, accessing a property, accessing a context variable, or calling a function.

expensiveOperations JiraExpressionsComplexityValueBean - The number of expensive operations executed while evaluating the expression. Expensive operations are those that load additional data, such as entity properties, comments, or custom fields.

beans JiraExpressionsComplexityValueBean - The number of Jira REST API beans returned in the response.

primitiveValues JiraExpressionsComplexityValueBean - The number of primitive values returned in the response.

jira: JiraExpressionsComplexityValueBean

Fields

value int - The complexity value of the current expression.

'limit int - The maximum allowed complexity. The evaluation will fail if this value is exceeded.

jira: JiraExpressionValidationError

Details about syntax and type errors. The error details apply to the entire expression, unless the object includes:

line and column
expression

Fields

line int? - The text line in which the error occurred.

column int? - The text column in which the error occurred.

expression string? - The part of the expression in which the error occurred.

message string - Details about the error.

'type string - The error type.

jira: JQLPersonalDataMigrationRequest

The JQL queries to be converted.

Fields

queryStrings string[]? - A list of queries with user identifiers. Maximum of 100 queries.

jira: JqlQueriesToParse

A list of JQL queries to parse.

Fields

queries JqlqueriestoparseQueriesItemsString[] - A list of queries to parse.

jira: JqlQuery

A parsed JQL query.

Fields

'where JqlQueryClause? - A JQL query clause.

orderBy JqlQueryOrderByClause? - Details of the order-by JQL clause.

jira: JqlQueryClauseTimePredicate

A time predicate for a temporal JQL clause.

Fields

operator string - The operator between the field and the operand.

operand JqlQueryClauseOperand - Details of an operand in a JQL clause.

jira: JqlQueryField

A field used in a JQL query. See Advanced searching - fields reference for more information about fields in JQL queries.

Fields

name string - The name of the field.

property JqlQueryFieldEntityProperty[]? - When the field refers to a value in an entity property, details of the entity property value.

jira: JqlQueryFieldEntityProperty

Details of an entity property.

Fields

entity string - The object on which the property is set.

'key string - The key of the property.

path string - The path in the property value to query.

'type string? - The type of the property value extraction. Not available if the extraction for the property is not registered on the instance with the Entity property module.

jira: JqlQueryOrderByClause

Details of the order-by JQL clause.

Fields

fields JqlQueryOrderByClauseElement[] - The list of order-by clause fields and their ordering directives.

jira: JqlQueryOrderByClauseElement

An element of the order-by JQL clause.

Fields

'field JqlQueryField - A field used in a JQL query. See Advanced searching - fields reference for more information about fields in JQL queries.

direction string? - The direction in which to order the results.

jira: JQLQueryWithUnknownUsers

JQL queries that contained users that could not be found

Fields

originalQuery string? - The original query, for reference

convertedQuery string? - The converted query, with accountIDs instead of user identifiers, or 'unknown' for users that could not be found

jira: JQLReferenceData

Lists of JQL reference data.

Fields

visibleFieldNames FieldReferenceData[]? - List of fields usable in JQL queries.

visibleFunctionNames FunctionReferenceData[]? - List of functions usable in JQL queries.

jqlReservedWords string[]? - List of JQL query reserved words.

jira: JsonNode

Record defines a json node.

Fields

floatingPointNumber boolean? - Existance of floating point numbers in node.

elements record {}? - Elements in node.

pojo boolean? - Existance of pojo in node.

number boolean? - Existance of numbers in node.

integralNumber boolean? - Existance of integral numbers in node.

'int boolean? - Existance of integers in node.

long boolean? - Existance of long type in node.

double boolean? - Existance of double type in node.

bigDecimal boolean? - Existance of big decimal numbers in node.

bigInteger boolean? - Existance of big integers in node.

textual boolean? - Existance of textual representation in node.

'boolean boolean? - Existance of boolean in node.

binary boolean? - Existance of binary numbers in node.

containerNode boolean? - Existance of container nodes.

missingNode boolean? - Existance of missing nodes.

'object boolean? - Existance of objects in node.

valueNode boolean? - Values in node.

numberValue decimal? - Number value in node.

numberType string? - Number type in node.

intValue int? - Integer value in node.

longValue int? - Long value in node.

bigIntegerValue int? - Big integer value in node.

doubleValue decimal? - Double value in node.

decimalValue decimal? - Decimal value in node.

booleanValue boolean? - Boolean value in node.

binaryValue string[]? - Binary values in node.

valueAsInt int? - Integer representation of value in node.

valueAsLong int? - Long representation of value in node.

valueAsDouble decimal? - :Double representation of value in node.

valueAsBoolean boolean? - Boolean representation of value in node.

fieldNames record {}? - Field names in node.

textValue string? - Text value in node.

valueAsText string? - Text representation of value in node.

array boolean? - Existance of array in node.

fields record {}? - Fields in node.

'null boolean? - Null type in node.

jira: JsonTypeBean

The schema of a field.

Fields

'type string - The data type of the field.

items string? - When the data type is an array, the name of the field items within the array.

system string? - If the field is a system field, the name of the field.

custom string? - If the field is a custom field, the URI of the field.

customId int? - If the field is a custom field, the custom ID of the field.

configuration record {}? - If the field is a custom field, the configuration of the field.

jira: KeywordOperand

An operand that is a JQL keyword. See Advanced searching - keywords reference for more information about operand keywords.

Fields

keyword string - The keyword that is the operand value.

jira: License

Details about a license for the Jira instance.

Fields

applications LicensedApplication[] - The applications under this license.

jira: LicensedApplication

Details about a licensed Jira application.

Fields

id string - The ID of the application.

plan string - The licensing plan.

jira: LinkedIssue

The ID or key of a linked issue.

Fields

id string? - The ID of an issue. Required if key isn't provided.

'key string? - The key of an issue. Required if id isn't provided.

self string? - The URL of the issue.

fields Fields? - The fields associated with the issue.

jira: LinkGroup

Details a link group, which defines issue operations.

Fields

id string? - The ID of a link group.

styleClass string? - The style class of a link group.

weight int? - The weighted score of a link group.

links SimpleLink[]? - The links of a link group.

groups LinkGroup[]? - The groups related to a link group.

jira: LinkIssueRequestJsonBean

Fields

'type IssueLinkType - This object is used as follows:
- In the issueLink resource it defines and reports on the type of link between the issues. Find a list of issue link types with Get issue link types.
- In the issueLinkType resource it defines and reports on issue link types.

inwardIssue LinkedIssue - The ID or key of a linked issue.

outwardIssue LinkedIssue - The ID or key of a linked issue.

comment Comment? - A comment.

jira: ListOperand

An operand that is a list of values.

Fields

values JqlQueryUnitaryOperand[] - The list of operand values.

jira: ListWrapperCallbackApplicationRole

jira: ListWrapperCallbackGroupName

A callback.

jira: Locale

Details of a locale.

Fields

locale string? - The locale code. The Java the locale format is used: a two character language code (ISO 639), an underscore, and two letter country code (ISO 3166). For example, en_US represents a locale of English (United States). Required on create.

jira: MoveFieldBean

Fields

after string? - The ID of the screen tab field after which to place the moved screen tab field. Required if position isn't provided.

position string? - The named position to which the screen tab field should be moved. Required if after isn't provided.

jira: NestedResponse

Fields

status int? -

errorCollection ErrorCollection? - Error messages from an operation.

jira: Notification

Details about a notification.

Fields

subject string? - The subject of the email notification for the issue. If this is not specified, then the subject is set to the issue key and summary.

textBody string? - The plain text body of the email notification for the issue.

htmlBody string? - The HTML body of the email notification for the issue.

to NotificationRecipients? - The recipients of the email notification for the issue.

restrict NotificationRecipientsRestrictions? - Restricts the notifications to users with the specified permissions.

jira: NotificationEvent

Details about a notification event.

Fields

id int? - The ID of the event. The event can be a Jira system event or a custom event.

name string? - The name of the event.

description string? - The description of the event.

templateEvent NotificationEvent? - The template of the event. Only custom events configured by Jira administrators have template.

jira: NotificationRecipients

Details of the users and groups to receive the notification.

Fields

reporter boolean? - Whether the notification should be sent to the issue's reporter.

assignee boolean? - Whether the notification should be sent to the issue's assignees.

watchers boolean? - Whether the notification should be sent to the issue's watchers.

voters boolean? - Whether the notification should be sent to the issue's voters.

users UserDetails[]? - List of users to receive the notification.

groups GroupName[]? - List of groups to receive the notification.

jira: NotificationRecipientsRestrictions

Details of the group membership or permissions needed to receive the notification.

Fields

groups GroupName[]? - List of group memberships required to receive the notification.

permissions RestrictedPermission[]? - List of permissions required to receive the notification.

jira: NotificationScheme

Details about a notification scheme.

Fields

expand string? - Expand options that include additional notification scheme details in the response.

id int? - The ID of the notification scheme.

self string? - The self of the notification scheme.

name string? - The name of the notification scheme.

description string? - The description of the notification scheme.

notificationSchemeEvents NotificationSchemeEvent[]? - The notification events and associated recipients.

scope Scope? - The scope of the notification scheme.

jira: NotificationSchemeEvent

Details about a notification scheme event.

Fields

event NotificationEvent? - Details about a notification event.

notifications EventNotification[]? - Details about notifications.

jira: OAuth2RefreshTokenGrantConfig

Closed record

OAuth2 Refresh Token Grant Configs

Fields

Fields Included from * OAuth2RefreshTokenGrantConfig

refreshUrl string
refreshToken string
clientId string
clientSecret string
scopes string|string[]
defaultTokenExpTime decimal
clockSkew decimal
optionalParams map<string>
credentialBearer CredentialBearer
clientConfig ClientConfiguration

refreshUrl string(default "https://auth.atlassian.com/oauth/token") - Refresh URL

jira: OperationMessage

Fields

message string - The human-readable message that describes the result.

statusCode int - The status code of the response.

jira: Operations

Details of the operations that can be performed on the issue.

Fields

linkGroups LinkGroup[]? - Details of the link groups defining issue operations.

jira: OrderOfCustomFieldOptions

An ordered list of custom field option IDs and information on where to move them.

Fields

customFieldOptionIds string[] - A list of IDs of custom field options to move. The order of the custom field option IDs in the list is the order they are given after the move. The list must contain custom field options or cascading options, but not both.

after string? - The ID of the custom field option or cascading option to place the moved options after. Required if position isn't provided.

position string? - The position the custom field options should be moved to. Required if after isn't provided.

jira: OrderOfIssueTypes

An ordered list of issue type IDs and information about where to move them.

Fields

issueTypeIds string[] - A list of the issue type IDs to move. The order of the issue type IDs in the list is the order they are given after the move.

after string? - The ID of the issue type to place the moved issue types after. Required if position isn't provided.

position string? - The position the issue types should be moved to. Required if after isn't provided.

jira: PageBeanChangelog

A page of items.

Fields

self string? - The URL of the page.

nextPage string? - If there is another page of results, the URL of the next page.

maxResults int? - The maximum number of items that could be returned.

startAt int? - The index of the first item returned.

total int? - The number of items returned.

isLast boolean? - Whether this is the last page.

values Changelog[]? - The list of items.

jira: PageBeanComment

A page of items.

Fields

self string? - The URL of the page.

nextPage string? - If there is another page of results, the URL of the next page.

maxResults int? - The maximum number of items that could be returned.

startAt int? - The index of the first item returned.

total int? - The number of items returned.

isLast boolean? - Whether this is the last page.

values Comment[]? - The list of items.

jira: PageBeanComponentWithIssueCount

A page of items.

Fields

self string? - The URL of the page.

nextPage string? - If there is another page of results, the URL of the next page.

maxResults int? - The maximum number of items that could be returned.

startAt int? - The index of the first item returned.

total int? - The number of items returned.

isLast boolean? - Whether this is the last page.

values ComponentWithIssueCount[]? - The list of items.

jira: PageBeanContext

A page of items.

Fields

self string? - The URL of the page.

nextPage string? - If there is another page of results, the URL of the next page.

maxResults int? - The maximum number of items that could be returned.

startAt int? - The index of the first item returned.

total int? - The number of items returned.

isLast boolean? - Whether this is the last page.

values Context[]? - The list of items.

jira: PageBeanContextForProjectAndIssueType

A page of items.

Fields

self string? - The URL of the page.

nextPage string? - If there is another page of results, the URL of the next page.

maxResults int? - The maximum number of items that could be returned.

startAt int? - The index of the first item returned.

total int? - The number of items returned.

isLast boolean? - Whether this is the last page.

values ContextForProjectAndIssueType[]? - The list of items.

jira: PageBeanContextualConfiguration

A page of items.

Fields

self string? - The URL of the page.

nextPage string? - If there is another page of results, the URL of the next page.

maxResults int? - The maximum number of items that could be returned.

startAt int? - The index of the first item returned.

total int? - The number of items returned.

isLast boolean? - Whether this is the last page.

values ContextualConfiguration[]? - The list of items.

jira: PageBeanCustomFieldContext

A page of items.

Fields

self string? - The URL of the page.

nextPage string? - If there is another page of results, the URL of the next page.

maxResults int? - The maximum number of items that could be returned.

startAt int? - The index of the first item returned.

total int? - The number of items returned.

isLast boolean? - Whether this is the last page.

values CustomFieldContext[]? - The list of items.

jira: PageBeanCustomFieldContextDefaultValue

A page of items.

Fields

self string? - The URL of the page.

nextPage string? - If there is another page of results, the URL of the next page.

maxResults int? - The maximum number of items that could be returned.

startAt int? - The index of the first item returned.

total int? - The number of items returned.

isLast boolean? - Whether this is the last page.

values CustomFieldContextDefaultValue[]? - The list of items.

jira: PageBeanCustomFieldContextOption

A page of items.

Fields

self string? - The URL of the page.

nextPage string? - If there is another page of results, the URL of the next page.

maxResults int? - The maximum number of items that could be returned.

startAt int? - The index of the first item returned.

total int? - The number of items returned.

isLast boolean? - Whether this is the last page.

values CustomFieldContextOption[]? - The list of items.

jira: PageBeanCustomFieldContextProjectMapping

A page of items.

Fields

self string? - The URL of the page.

nextPage string? - If there is another page of results, the URL of the next page.

maxResults int? - The maximum number of items that could be returned.

startAt int? - The index of the first item returned.

total int? - The number of items returned.

isLast boolean? - Whether this is the last page.

values CustomFieldContextProjectMapping[]? - The list of items.

jira: PageBeanDashboard

A page of items.

Fields

self string? - The URL of the page.

nextPage string? - If there is another page of results, the URL of the next page.

maxResults int? - The maximum number of items that could be returned.

startAt int? - The index of the first item returned.

total int? - The number of items returned.

isLast boolean? - Whether this is the last page.

values Dashboard[]? - The list of items.

jira: PageBeanField

A page of items.

Fields

self string? - The URL of the page.

nextPage string? - If there is another page of results, the URL of the next page.

maxResults int? - The maximum number of items that could be returned.

startAt int? - The index of the first item returned.

total int? - The number of items returned.

isLast boolean? - Whether this is the last page.

values Field[]? - The list of items.

jira: PageBeanFieldConfiguration

A page of items.

Fields

self string? - The URL of the page.

nextPage string? - If there is another page of results, the URL of the next page.

maxResults int? - The maximum number of items that could be returned.

startAt int? - The index of the first item returned.

total int? - The number of items returned.

isLast boolean? - Whether this is the last page.

values FieldConfiguration[]? - The list of items.

jira: PageBeanFieldConfigurationIssueTypeItem

A page of items.

Fields

self string? - The URL of the page.

nextPage string? - If there is another page of results, the URL of the next page.

maxResults int? - The maximum number of items that could be returned.

startAt int? - The index of the first item returned.

total int? - The number of items returned.

isLast boolean? - Whether this is the last page.

values FieldConfigurationIssueTypeItem[]? - The list of items.

jira: PageBeanFieldConfigurationItem

A page of items.

Fields

self string? - The URL of the page.

nextPage string? - If there is another page of results, the URL of the next page.

maxResults int? - The maximum number of items that could be returned.

startAt int? - The index of the first item returned.

total int? - The number of items returned.

isLast boolean? - Whether this is the last page.

values FieldConfigurationItem[]? - The list of items.

jira: PageBeanFieldConfigurationScheme

A page of items.

Fields

self string? - The URL of the page.

nextPage string? - If there is another page of results, the URL of the next page.

maxResults int? - The maximum number of items that could be returned.

startAt int? - The index of the first item returned.

total int? - The number of items returned.

isLast boolean? - Whether this is the last page.

values FieldConfigurationScheme[]? - The list of items.

jira: PageBeanFieldConfigurationSchemeProjects

A page of items.

Fields

self string? - The URL of the page.

nextPage string? - If there is another page of results, the URL of the next page.

maxResults int? - The maximum number of items that could be returned.

startAt int? - The index of the first item returned.

total int? - The number of items returned.

isLast boolean? - Whether this is the last page.

values FieldConfigurationSchemeProjects[]? - The list of items.

jira: PageBeanFilterDetails

A page of items.

Fields

self string? - The URL of the page.

nextPage string? - If there is another page of results, the URL of the next page.

maxResults int? - The maximum number of items that could be returned.

startAt int? - The index of the first item returned.

total int? - The number of items returned.

isLast boolean? - Whether this is the last page.

values FilterDetails[]? - The list of items.

jira: PageBeanGroupDetails

A page of items.

Fields

self string? - The URL of the page.

nextPage string? - If there is another page of results, the URL of the next page.

maxResults int? - The maximum number of items that could be returned.

startAt int? - The index of the first item returned.

total int? - The number of items returned.

isLast boolean? - Whether this is the last page.

values GroupDetails[]? - The list of items.

jira: PageBeanIssueSecurityLevelMember

A page of items.

Fields

self string? - The URL of the page.

nextPage string? - If there is another page of results, the URL of the next page.

maxResults int? - The maximum number of items that could be returned.

startAt int? - The index of the first item returned.

total int? - The number of items returned.

isLast boolean? - Whether this is the last page.

values IssueSecurityLevelMember[]? - The list of items.

jira: PageBeanIssueTypeScheme

A page of items.

Fields

self string? - The URL of the page.

nextPage string? - If there is another page of results, the URL of the next page.

maxResults int? - The maximum number of items that could be returned.

startAt int? - The index of the first item returned.

total int? - The number of items returned.

isLast boolean? - Whether this is the last page.

values IssueTypeScheme[]? - The list of items.

jira: PageBeanIssueTypeSchemeMapping

A page of items.

Fields

self string? - The URL of the page.

nextPage string? - If there is another page of results, the URL of the next page.

maxResults int? - The maximum number of items that could be returned.

startAt int? - The index of the first item returned.

total int? - The number of items returned.

isLast boolean? - Whether this is the last page.

values IssueTypeSchemeMapping[]? - The list of items.

jira: PageBeanIssueTypeSchemeProjects

A page of items.

Fields

self string? - The URL of the page.

nextPage string? - If there is another page of results, the URL of the next page.

maxResults int? - The maximum number of items that could be returned.

startAt int? - The index of the first item returned.

total int? - The number of items returned.

isLast boolean? - Whether this is the last page.

values IssueTypeSchemeProjects[]? - The list of items.

jira: PageBeanIssueTypeScreenScheme

A page of items.

Fields

self string? - The URL of the page.

nextPage string? - If there is another page of results, the URL of the next page.

maxResults int? - The maximum number of items that could be returned.

startAt int? - The index of the first item returned.

total int? - The number of items returned.

isLast boolean? - Whether this is the last page.

values IssueTypeScreenScheme[]? - The list of items.

jira: PageBeanIssueTypeScreenSchemeItem

A page of items.

Fields

self string? - The URL of the page.

nextPage string? - If there is another page of results, the URL of the next page.

maxResults int? - The maximum number of items that could be returned.

startAt int? - The index of the first item returned.

total int? - The number of items returned.

isLast boolean? - Whether this is the last page.

values IssueTypeScreenSchemeItem[]? - The list of items.

jira: PageBeanIssueTypeScreenSchemesProjects

A page of items.

Fields

self string? - The URL of the page.

nextPage string? - If there is another page of results, the URL of the next page.

maxResults int? - The maximum number of items that could be returned.

startAt int? - The index of the first item returned.

total int? - The number of items returned.

isLast boolean? - Whether this is the last page.

values IssueTypeScreenSchemesProjects[]? - The list of items.

jira: PageBeanIssueTypeToContextMapping

A page of items.

Fields

self string? - The URL of the page.

nextPage string? - If there is another page of results, the URL of the next page.

maxResults int? - The maximum number of items that could be returned.

startAt int? - The index of the first item returned.

total int? - The number of items returned.

isLast boolean? - Whether this is the last page.

values IssueTypeToContextMapping[]? - The list of items.

jira: PageBeanNotificationScheme

A page of items.

Fields

self string? - The URL of the page.

nextPage string? - If there is another page of results, the URL of the next page.

maxResults int? - The maximum number of items that could be returned.

startAt int? - The index of the first item returned.

total int? - The number of items returned.

isLast boolean? - Whether this is the last page.

values NotificationScheme[]? - The list of items.

jira: PageBeanProject

A page of items.

Fields

self string? - The URL of the page.

nextPage string? - If there is another page of results, the URL of the next page.

maxResults int? - The maximum number of items that could be returned.

startAt int? - The index of the first item returned.

total int? - The number of items returned.

isLast boolean? - Whether this is the last page.

values Project[]? - The list of items.

jira: PageBeanScreen

A page of items.

Fields

self string? - The URL of the page.

nextPage string? - If there is another page of results, the URL of the next page.

maxResults int? - The maximum number of items that could be returned.

startAt int? - The index of the first item returned.

total int? - The number of items returned.

isLast boolean? - Whether this is the last page.

values Screen[]? - The list of items.

jira: PageBeanScreenScheme

A page of items.

Fields

self string? - The URL of the page.

nextPage string? - If there is another page of results, the URL of the next page.

maxResults int? - The maximum number of items that could be returned.

startAt int? - The index of the first item returned.

total int? - The number of items returned.

isLast boolean? - Whether this is the last page.

values ScreenScheme[]? - The list of items.

jira: PageBeanScreenWithTab

A page of items.

Fields

self string? - The URL of the page.

nextPage string? - If there is another page of results, the URL of the next page.

maxResults int? - The maximum number of items that could be returned.

startAt int? - The index of the first item returned.

total int? - The number of items returned.

isLast boolean? - Whether this is the last page.

values ScreenWithTab[]? - The list of items.

jira: PageBeanString

A page of items.

Fields

self string? - The URL of the page.

nextPage string? - If there is another page of results, the URL of the next page.

maxResults int? - The maximum number of items that could be returned.

startAt int? - The index of the first item returned.

total int? - The number of items returned.

isLast boolean? - Whether this is the last page.

values string[]? - The list of items.

jira: PageBeanUser

A page of items.

Fields

self string? - The URL of the page.

nextPage string? - If there is another page of results, the URL of the next page.

maxResults int? - The maximum number of items that could be returned.

startAt int? - The index of the first item returned.

total int? - The number of items returned.

isLast boolean? - Whether this is the last page.

values User[]? - The list of items.

jira: PageBeanUserDetails

A page of items.

Fields

self string? - The URL of the page.

nextPage string? - If there is another page of results, the URL of the next page.

maxResults int? - The maximum number of items that could be returned.

startAt int? - The index of the first item returned.

total int? - The number of items returned.

isLast boolean? - Whether this is the last page.

values UserDetails[]? - The list of items.

jira: PageBeanUserKey

A page of items.

Fields

self string? - The URL of the page.

nextPage string? - If there is another page of results, the URL of the next page.

maxResults int? - The maximum number of items that could be returned.

startAt int? - The index of the first item returned.

total int? - The number of items returned.

isLast boolean? - Whether this is the last page.

values UserKey[]? - The list of items.

jira: PageBeanVersion

A page of items.

Fields

self string? - The URL of the page.

nextPage string? - If there is another page of results, the URL of the next page.

maxResults int? - The maximum number of items that could be returned.

startAt int? - The index of the first item returned.

total int? - The number of items returned.

isLast boolean? - Whether this is the last page.

values Version[]? - The list of items.

jira: PageBeanWebhook

A page of items.

Fields

self string? - The URL of the page.

nextPage string? - If there is another page of results, the URL of the next page.

maxResults int? - The maximum number of items that could be returned.

startAt int? - The index of the first item returned.

total int? - The number of items returned.

isLast boolean? - Whether this is the last page.

values Webhook[]? - The list of items.

jira: PageBeanWorkflow

A page of items.

Fields

self string? - The URL of the page.

nextPage string? - If there is another page of results, the URL of the next page.

maxResults int? - The maximum number of items that could be returned.

startAt int? - The index of the first item returned.

total int? - The number of items returned.

isLast boolean? - Whether this is the last page.

values Workflow[]? - The list of items.

jira: PageBeanWorkflowScheme

A page of items.

Fields

self string? - The URL of the page.

nextPage string? - If there is another page of results, the URL of the next page.

maxResults int? - The maximum number of items that could be returned.

startAt int? - The index of the first item returned.

total int? - The number of items returned.

isLast boolean? - Whether this is the last page.

values WorkflowScheme[]? - The list of items.

jira: PageBeanWorkflowTransitionRules

A page of items.

Fields

self string? - The URL of the page.

nextPage string? - If there is another page of results, the URL of the next page.

maxResults int? - The maximum number of items that could be returned.

startAt int? - The index of the first item returned.

total int? - The number of items returned.

isLast boolean? - Whether this is the last page.

values WorkflowTransitionRules[]? - The list of items.

jira: PagedListUserDetailsApplicationUser

A paged list. To access additional details append [start-index:end-index] to the expand request. For example, ?expand=sharedUsers[10:40] returns a list starting at item 10 and finishing at item 40.

Fields

size int? - The number of items on the page.

items UserDetails[]? - 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: PageOfChangelogs

A page of changelogs.

Fields

startAt int? - The index of the first item returned on the page.

maxResults int? - The maximum number of results that could be on the page.

total int? - The number of results on the page.

histories Changelog[]? - The list of changelogs.

jira: PageOfComments

A page of comments.

Fields

startAt int? - The index of the first item returned.

maxResults int? - The maximum number of items that could be returned.

total int? - The number of items returned.

comments Comment[]? - The list of comments.

jira: PageOfDashboards

A page containing dashboard details.

Fields

startAt int? - The index of the first item returned on the page.

maxResults int? - The maximum number of results that could be on the page.

total int? - The number of results on the page.

prev string? - The URL of the previous page of results, if any.

next string? - The URL of the next page of results, if any.

dashboards Dashboard[]? - List of dashboards.

jira: PageOfWorklogs

Paginated list of worklog details

Fields

startAt int? - The index of the first item returned on the page.

maxResults int? - The maximum number of results that could be on the page.

total int? - The number of results on the page.

worklogs Worklog[]? - List of worklogs.

jira: PaginatedResponseComment

Fields

total int? -

maxResults int? -

startAt int? -

results Comment[]? -

jira: ParsedJqlQueries

A list of parsed JQL queries.

Fields

queries ParsedJqlQuery[] - A list of parsed JQL queries.

jira: ParsedJqlQuery

Details of a parsed JQL query.

Fields

query string - The JQL query that was parsed and validated.

structure JqlQuery? - The syntax tree of the query. Empty if the query was invalid.

errors string[]? - The list of syntax or validation errors.

jira: PermissionGrant

Details about a permission granted to a user or group.

Fields

id int? - The ID of the permission granted details.

self string? - The URL of the permission granted details.

holder PermissionHolder? - The user or group being granted the permission. It consists of a type and a type-dependent parameter. See Holder object in Get all permission schemes for more information.

permission string? - The permission to grant. This permission can be one of the built-in permissions or a custom permission added by an app. See Built-in permissions in Get all permission schemes for more information about the built-in permissions. See the project permission and global permission module documentation for more information about custom permissions.

jira: PermissionGrants

List of permission grants.

Fields

permissions PermissionGrant[]? - Permission grants list.

expand string? - Expand options that include additional permission grant details in the response.

jira: PermissionHolder

Details of a user, group, field, or project role that holds a permission. See Holder object in Get all permission schemes for more information.

Fields

'type string - The type of permission holder.

'parameter string? - The identifier of permission holder.

expand string? - Expand options that include additional permission holder details in the response.

jira: Permissions

Details about permissions.

Fields

permissions record {}? - List of permissions.

jira: PermissionScheme

Details of a permission scheme.

Fields

expand string? - The expand options available for the permission scheme.

id int? - The ID of the permission scheme.

self string? - The URL of the permission scheme.

name string - The name of the permission scheme. Must be unique.

description string? - A description for the permission scheme.

scope Scope? - The scope of the permission scheme.

permissions PermissionGrant[]? - The permission scheme to create or update. See About permission schemes and grants for more information.

jira: PermissionSchemes

List of all permission schemes.

Fields

permissionSchemes PermissionScheme[]? - Permission schemes list.

jira: PermissionsKeysBean

Record define the permission bean.

Fields

permissions string[] - A list of permission keys.

jira: PermittedProjects

A list of projects in which a user is granted permissions.

Fields

projects ProjectIdentifierBean[]? - A list of projects.

jira: Priority

An issue priority.

Fields

self string? - The URL of the issue priority.

statusColor string? - The color used to indicate the issue priority.

description string? - The description of the issue priority.

iconUrl string? - The URL of the icon for the issue priority.

name string? - The name of the issue priority.

id string? - The ID of the issue priority.

jira: Project

Details about a project.

Fields

expand string? - Expand options that include additional project details in the response.

self string? - The URL of the project details.

id string? - The ID of the project.

'key string? - The key of the project.

description string? - A brief description of the project.

lead User? - The username of the project lead.

components ProjectComponent[]? - List of the components contained in the project.

issueTypes IssueTypeDetails[]? - List of the issue types available in the project.

url string? - A link to information about this project, such as project documentation.

email string? - An email address associated with the project.

assigneeType string? - The default assignee when creating issues for this project.

versions Version[]? - The versions defined in the project. For more information, see Create version.

name string? - The name of the project.

roles record {}? - The name and self URL for each role defined in the project. For more information, see Create project role.

avatarUrls AvatarUrlsBean? - The URLs of the project's avatars.

projectCategory ProjectCategory? - The category the project belongs to.

projectTypeKey string? - The project type of the project.

simplified boolean? - Whether the project is simplified.

style string? - The type of the project.

favourite boolean? - Whether the project is selected as a favorite.

isPrivate boolean? - Whether the project is private.

issueTypeHierarchy Hierarchy? - The issue type hierarchy for the project.

permissions ProjectPermissions? - User permissions on the project

properties record {}? - Map of project properties

uuid string? - Unique ID for next-gen projects.

insight ProjectInsight? - Insights about the project.

deleted boolean? - Whether the project is marked as deleted.

retentionTillDate string? - The date when the project is deleted permanently.

deletedDate string? - The date when the project was marked as deleted.

deletedBy User? - The user who marked the project as deleted.

archived boolean? - Whether the project is archived.

archivedDate string? - The date when the project was archived.

archivedBy User? - The user who archived the project.

landingPageInfo ProjectLandingPageInfo? - The project landing page info.

jira: ProjectAvatars

List of project avatars.

Fields

system Avatar[]? - List of avatars included with Jira. These avatars cannot be deleted.

custom Avatar[]? - List of avatars added to Jira. These avatars may be deleted.

jira: ProjectCategory

A project category.

Fields

self string? - The URL of the project category.

id string? - The ID of the project category.

name string? - The name of the project category. Required on create, optional on update.

description string? - The description of the project category.

jira: ProjectComponent

Details about a project component.

Fields

self string? - The URL of the component.

id string? - The unique identifier for the component.

name string? - The unique name for the component in the project. Required when creating a component. Optional when updating a component. The maximum length is 255 characters.

description string? - The description for the component. Optional when creating or updating a component.

lead User? - The user details for the component's lead user.

leadUserName string? - This property is no longer available and will be removed from the documentation soon. See the deprecation notice for details.

leadAccountId string? - The accountId of the component's lead user. The accountId uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5.

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. Can take 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.
Default value: PROJECT_DEFAULT.
Optional when creating or updating a component.

assignee User? - The details of the user associated with assigneeType, if any. See realAssignee for details of the user assigned to issues created with this component.

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 to COMPONENT_LEAD but no component lead is set. This property is set to one of the following values:
- PROJECT_LEAD when assigneeType is PROJECT_LEAD and the project lead has permission to be assigned issues in the project that the component is in.
- COMPONENT_LEAD when assigneeType is COMPONENT_LEAD and the component lead has permission to be assigned issues in the project that the component is in.
- UNASSIGNED when assigneeType is UNASSIGNED and Jira is configured to allow unassigned issues.
- PROJECT_DEFAULT when none of the preceding cases are true.

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 the assigneeType is set to COMPONENT_LEAD but the component lead is not set, then false is returned.

project string? - The key of the project the component is assigned to. Required when creating a component. Can't be updated.

projectId int? - The ID of the project the component is assigned to.

jira: ProjectEmailAddress

A project's sender email address.

Fields

emailAddress string? - The email address.

jira: ProjectForScope

Details about a next-gen project.

Fields

self string? - The URL of the project details.

id string? - The ID of the project.

'key string? - The key of the project.

name string? - The name of the project.

projectTypeKey string? - The project type of the project.

simplified boolean? - Whether or not the project is simplified.

avatarUrls AvatarUrlsBean? - The URLs of the project's avatars.

projectCategory UpdatedProjectCategory? - The category the project belongs to.

jira: ProjectIdentifierBean

The identifiers for a project.

Fields

id int? - The ID of the project.

'key string? - The key of the project.

jira: ProjectIdentifiers

Identifiers for a project.

Fields

self string - The URL of the created project.

id int - The ID of the created project.

'key string - The key of the created project.

jira: ProjectIds

A list of project IDs.

Fields

projectIds string[] - The IDs of projects.

jira: ProjectInsight

Additional details about a project.

Fields

totalIssueCount int? - Total issue count.

lastIssueUpdateTime string? - The last issue update time.

jira: ProjectIssueCreateMetadata

Details of the issue creation metadata for a project.

Fields

expand string? - Expand options that include additional project issue create metadata details in the response.

self string? - The URL of the project.

id string? - The ID of the project.

'key string? - The key of the project.

name string? - The name of the project.

avatarUrls AvatarUrlsBean? - List of the project's avatars, returning the avatar size and associated URL.

issuetypes IssueTypeIssueCreateMetadata[]? - List of the issue types supported by the project.

jira: ProjectIssueSecurityLevels

List of issue level security items in a project.

Fields

levels SecurityLevel[] - Issue level security items list.

jira: ProjectIssueTypeHierarchy

The hierarchy of issue types within a project.

Fields

projectId int? - The ID of the project.

hierarchy ProjectIssueTypesHierarchyLevel[]? - Details of an issue type hierarchy level.

jira: ProjectIssueTypeMapping

The project and issue type mapping.

Fields

projectId string - The ID of the project.

issueTypeId string - The ID of the issue type.

jira: ProjectIssueTypeMappings

The project and issue type mappings.

Fields

mappings ProjectIssueTypeMapping[] - The project and issue type mappings.

jira: ProjectIssueTypesHierarchyLevel

Details of an issue type hierarchy level.

Fields

entityId string? - The ID of the issue type hierarchy level. This property is deprecated, see Change notice: Removing hierarchy level IDs from next-gen APIs.

level int? - The level of the issue type hierarchy level.

name string? - The name of the issue type hierarchy level.

issueTypes IssueTypeInfo[]? - The list of issue types in the hierarchy level.

jira: ProjectLandingPageInfo

Details about a project landing page.

Fields

url string? - Project landing page url.

projectKey string? - Unique project key.

projectType string? - Type of a project.

boardId int? - Board ID of project landing page.

simplified boolean? - Whether project landing page is simplified.

jira: ProjectPermissions

Permissions which a user has on a project.

Fields

canEdit boolean? - Whether the logged user can edit the project.

jira: ProjectRole

Details about the roles in a project.

Fields

self string? - The URL the project role details.

name string? - The name of the project role.

id int? - The ID of the project role.

description string? - The description of the project role.

actors RoleActor[]? - The list of users who act in this role.

scope Scope? - The scope of the role. Indicated for roles associated with next-gen projects.

translatedName string? - The translated name of the project role.

currentUserRole boolean? - Whether the calling user is part of this role.

admin boolean? - Whether this role is the admin role for the project.

roleConfigurable boolean? - Whether the roles are configurable for this project.

default boolean? - Whether this role is the default role for the project

jira: ProjectRoleActorsUpdateBean

Fields

id int? - The ID of the project role. Use Get all project roles to get a list of project role IDs.

categorisedActors record {}? - The actors to add to the project role. Add groups using atlassian-group-role-actor and a list of group names. For example, "atlassian-group-role-actor":["another","administrators"]}. Add users using atlassian-user-role-actor and a list of account IDs. For example, "atlassian-user-role-actor":["12345678-9abc-def1-2345-6789abcdef12", "abcdef12-3456-789a-bcde-f123456789ab"].

jira: ProjectRoleDetails

Details about a project role.

Fields

self string? - The URL the project role details.

name string? - The name of the project role.

id int? - The ID of the project role.

description string? - The description of the project role.

admin boolean? - Whether this role is the admin role for the project.

scope Scope? - The scope of the role. Indicated for roles associated with next-gen projects.

roleConfigurable boolean? - Whether the roles are configurable for this project.

translatedName string? - The translated name of the project role.

default boolean? - Whether this role is the default role for the project.

jira: ProjectRoleGroup

Details of the group associated with the role.

Fields

displayName string? - The display name of the group.

name string? - The name of the group

jira: ProjectRoleUser

Details of the user associated with the role.

Fields

accountId string? - The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5. Returns unknown if the record is deleted and corrupted, for example, as the result of a server import.

jira: ProjectScopeBean

Record defining a project scope bean.

Fields

id int? - The ID of the project that the option's behavior applies to.

attributes string[]? - Defines the behavior of the option in the project.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: ProjectType

Details about a project type.

Fields

'key string? - The key of the project type.

formattedKey string? - The formatted key of the project type.

descriptionI18nKey string? - The key of the project type's description.

icon string? - The icon of the project type.

color string? - The color of the project type.

jira: PropertyKey

Property key details.

Fields

self string? - The URL of the property.

'key string? - The key of the property.

jira: PropertyKeys

List of property keys.

Fields

keys PropertyKey[]? - Property key details.

jira: ProxyConfig

Closed record

Proxy server configurations to be used with the HTTP client endpoint.

Fields

host string(default "") - Host name of the proxy server

port int(default 0) - Proxy server port

userName string(default "") - Proxy server username

password string(default "") - Proxy server password

jira: PublishDraftWorkflowScheme

Details about the status mappings for publishing a draft workflow scheme.

Fields

statusMappings StatusMapping[]? - Mappings of statuses to new statuses for issue types.

jira: PublishedWorkflowId

Properties that identify a published workflow.

Fields

name string - The name of the workflow.

entityId string? - The entity ID of the workflow.

jira: RegisteredWebhook

ID of a registered webhook or error messages explaining why a webhook wasn't registered.

Fields

createdWebhookId int? - The ID of the webhook. Returned if the webhook is created.

errors string[]? - Error messages specifying why the webhook creation failed.

jira: RemoteIssueLink

Details of an issue remote link.

Fields

id int? - The ID of the link.

self string? - The URL of the link.

globalId string? - The global ID of the link, such as the ID of the item on the remote system.

application Application? - Details of the remote application the linked item is in.

relationship string? - Description of the relationship between the issue and the linked item.

'object RemoteObject? - Details of the item linked to.

jira: RemoteIssueLinkIdentifies

Details of the identifiers for a created or updated remote issue link.

Fields

id int? - The ID of the remote issue link, such as the ID of the item on the remote system.

self string? - The URL of the remote issue link.

jira: RemoteIssueLinkRequest

Details of a remote issue link.

Fields

globalId string? - An identifier for the remote item in the remote system. For example, the global ID for a remote item in Confluence would consist of the app ID and page ID, like this: appId=456&pageId=123. Setting this field enables the remote issue link details to be updated or deleted using remote system and item details as the record identifier, rather than using the record's Jira ID. The maximum length is 255 characters.

application Application? - Details of the remote application the linked item is in. For example, trello.

relationship string? - Description of the relationship between the issue and the linked item. If not set, the relationship description "links to" is used in Jira.

'object RemoteObject - Details of the item linked to.

jira: RemoteObject

The linked item.

Fields

url string - The URL of the item.

title string - The title of the item.

summary string? - The summary details of the item.

icon Icon? - Details of the icon for the item. If no icon is defined, the default link icon is used in Jira.

status Status? - The status of the item.

jira: RemoveOptionFromIssuesResult

Fields

modifiedIssues int[]? - The IDs of the modified issues.

unmodifiedIssues int[]? - The IDs of the unchanged issues, those issues where errors prevent modification.

errors SimpleErrorCollection? - A collection of errors related to unchanged issues. The collection size is limited, which means not all errors may be returned.

jira: Resolution

Details of an issue resolution.

Fields

self string? - The URL of the issue resolution.

id string? - The ID of the issue resolution.

description string? - The description of the issue resolution.

name string? - The name of the issue resolution.

jira: RestrictedPermission

Details of the permission.

Fields

id string? - The ID of the permission. Either id or key must be specified. Use Get all permissions to get the list of permissions.

'key string? - The key of the permission. Either id or key must be specified. Use Get all permissions to get the list of permissions.

jira: RichText

Fields

emptyAdf boolean? -

finalised boolean? -

valueSet boolean? -

jira: RoleActor

Details about a user assigned to a project role.

Fields

id int? - The ID of the role actor.

displayName string? - The display name of the role actor. For users, depending on the user’s privacy setting, this may return an alternative value for the user's name.

'type string? - The type of role actor.

name string? - This property is no longer available and will be removed from the documentation soon. See the deprecation notice for details.

avatarUrl string? - The avatar of the role actor.

actorUser ProjectRoleUser? - The project role related to the role actor.

actorGroup ProjectRoleGroup? - The project role group related to the role actor.

jira: RuleConfiguration

A rule configuration.

Fields

value string - Configuration of the rule, as it is stored by the Connect app on the rule configuration page.

jira: Scope

The projects the item is associated with. Indicated for items associated with next-gen projects.

Fields

'type string? - The type of scope.

project ProjectForScope? - The project the item has scope in.

jira: Screen

A screen.

Fields

id int? - The ID of the screen.

name string? - The name of the screen.

description string? - The description of the screen.

scope Scope? - The scope of the screen.

jira: ScreenableField

A screen tab field.

Fields

id string? - The ID of the screen tab field.

name string? - The name of the screen tab field. Required on create and update. The maximum length is 255 characters.

jira: ScreenableTab

A screen tab.

Fields

id int? - The ID of the screen tab.

name string - The name of the screen tab. The maximum length is 255 characters.

jira: ScreenDetails

Details of a screen.

Fields

name string - The name of the screen. The name must be unique. The maximum length is 255 characters.

description string? - The description of the screen. The maximum length is 255 characters.

jira: ScreenID

ID of a screen.

Fields

id string - The ID of the screen.

jira: ScreenScheme

A screen scheme.

Fields

id int? - The ID of the screen scheme.

name string? - The name of the screen scheme.

description string? - The description of the screen scheme.

screens ScreenTypes? - The IDs of the screens for the screen types of the screen scheme.

issueTypeScreenSchemes PageBeanIssueTypeScreenScheme? - Details of the issue type screen schemes associated with the screen scheme.

jira: ScreenSchemeDetails

Details of a screen scheme.

Fields

name string - The name of the screen scheme. The name must be unique. The maximum length is 255 characters.

description string? - The description of the screen scheme. The maximum length is 255 characters.

screens ScreenTypes - The IDs of the screens for the screen types of the screen scheme. Only screens used in classic projects are accepted.

jira: ScreenSchemeId

The ID of a screen scheme.

Fields

id int - The ID of the screen scheme.

jira: ScreenTypes

The IDs of the screens for the screen types of the screen scheme.

Fields

edit int? - The ID of the edit screen.

create int? - The ID of the create screen.

view int? - The ID of the view screen.

default int? - The ID of the default screen. Required when creating a screen scheme.

jira: ScreenWithTab

A screen with tab details.

Fields

id int? - The ID of the screen.

name string? - The name of the screen.

description string? - The description of the screen.

scope Scope? - The scope of the screen.

tab ScreenableTab? - The tab for the screen

jira: SearchAutoCompleteFilter

Details of how to filter and list search auto complete information.

Fields

projectIds int[]? - List of project IDs used to filter the visible field details returned.

includeCollapsedFields boolean? - Include collapsed fields for fields that have non-unique names.

jira: SearchRequestBean

Fields

jql string? - A JQL expression.

startAt int? - The index of the first item to return in the page of results (page offset). The base index is 0.

maxResults int? - The maximum number of items to return per page.

fields string[]? - 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.
The default is *navigable. Examples:
- summary,comment Returns the summary and comments fields only.
- -description Returns all navigable (default) fields except description.
- *all,-comment Returns all fields except comments.
Multiple fields parameters can be included in a request. Note: All navigable fields are returned by default. This differs from GET issue where the default is all fields.

validateQuery string? - Determines how to validate the JQL query and treat the validation results. Supported values:
- 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 for strict.
- false Deprecated A legacy synonym for warn.
The default is strict. Note: If the JQL is not correctly formed a 400 response code is returned, regardless of the validateQuery value.

expand string[]? - Use expand to include additional information about issues in the response. Note that, unlike the majority of instances where expand is specified, expand is defined as a list of values. The expand options are:
- 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 of fields, returns versionedRepresentations a JSON array containing each version of a field's value, with the highest numbered item representing the most recent version.

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

fieldsByKeys boolean? - Reference fields by their key (rather than ID). The default is false.

jira: SearchResults

The result of a JQL search.

Fields

expand string? - Expand options that include additional search result details in the response.

startAt int? - The index of the first item returned on the page.

maxResults int? - The maximum number of results that could be on the page.

total int? - The number of results on the page.

issues IssueBean[]? - The list of issues found by the search.

warningMessages string[]? - Any warnings related to the JQL query.

names record {}? - The ID and name of each field in the search results.

schema record {}? - The schema describing the field types in the search results.

jira: SecurityLevel

Details of an issue level security item.

Fields

self string? - The URL of the issue level security item.

id string? - The ID of the issue level security item.

description string? - The description of the issue level security item.

name string? - The name of the issue level security item.

jira: SecurityScheme

Details about a security scheme.

Fields

self string? - The URL of the issue security scheme.

id int? - The ID of the issue security scheme.

name string? - The name of the issue security scheme.

description string? - The description of the issue security scheme.

defaultSecurityLevelId int? - The ID of the default security level.

levels SecurityLevel[]? - Level of security.

jira: SecuritySchemes

List of security schemes.

Fields

issueSecuritySchemes SecurityScheme[]? - List of security schemes.

jira: ServerInformation

Details about the Jira instance.

Fields

baseUrl string? - The base URL of the Jira instance.

'version string? - The version of Jira.

versionNumbers int[]? - The major, minor, and revision version numbers of the Jira version.

deploymentType string? - The type of server deployment. This is always returned as Cloud.

buildNumber int? - The build number of the Jira version.

buildDate string? - The timestamp when the Jira version was built.

serverTime string? - The time in Jira when this request was responded to.

scmInfo string? - The unique identifier of the Jira version.

serverTitle string? - The name of the Jira instance.

healthChecks HealthCheckResult[]? - Jira instance health check results. Deprecated and no longer returned.

jira: SharePermission

Details of a share permission for the filter.

Fields

id int? - The unique identifier of the share permission.

'type string - The type of share permission:
- group Shared with a group. If set in a request, then specify sharePermission.group as well.
- project Shared with a project. If set in a request, then specify sharePermission.project as well.
- projectRole Share with a project role in a project. This value is not returned in responses. It is used in requests, where it needs to be specify with projectId and projectRoleId.
- global Shared globally. If set in a request, no other sharePermission properties need to be specified.
- loggedin Shared with all logged-in users. Note: This value is set in a request by specifying authenticated as the type.
- project-unknown Shared with a project that the user does not have access to. Cannot be set in a request.

project Project? - The project that the filter is shared with. This is similar to the project object returned by Get project but it contains a subset of the properties, which are: self, id, key, assigneeType, name, roles, avatarUrls, projectType, simplified.
For a request, specify the id for the project.

role ProjectRole? - The project role that the filter is shared with.
For a request, specify the id for the role. You must also specify the project object and id for the project that the role is in.

group GroupName? - The group that the filter is shared with. For a request, specify the name property for the group.

jira: SharePermissionInputBean

Fields

'type string - The type of the share permission.Specify the type as follows:
- group Share with a group. Specify groupname as well.
- project Share with a project. Specify projectId as well.
- projectRole Share with a project role in a project. Specify projectId and projectRoleId as well.
- global Share globally, including anonymous users. If set, this type overrides all existing share permissions and must be deleted before any non-global share permissions is set.
- authenticated Share with all logged-in users. This shows as loggedin in the response. If set, this type overrides all existing share permissions and must be deleted before any non-global share permissions is set.

projectId string? - The ID of the project to share the filter with. Set type to project.

groupname string? - The name of the group to share the filter with. Set type to group.

projectRoleId string? - The ID of the project role to share the filter with. Set type to projectRole and the projectId for the project that the role is in.

jira: SimpleApplicationPropertyBean

Details about application property.

Fields

id string? - The ID of the application property.

value string? - The new value.

jira: SimpleErrorCollection

Record defines a collection of simple errors.

Fields

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."

errorMessages string[]? - The list of error messages produced by this operation. For example, "input parameter 'key' must be provided"

httpStatusCode int? - Error status codes.

jira: SimpleLink

Details about the operations available in this version.

Fields

id string? - The ID of a operations available.

styleClass string? - The style class of a operations available.

iconClass string? - The icon class of a operations available.

label string? - The label of a operations available.

title string? - The title of a operations available.

href string? - The URL of a operations available.

weight int? - The weighted score of a operations available.

jira: SimpleListWrapperApplicationRole

Fields

size int? -

items ApplicationRole[]? -

pagingCallback ListWrapperCallbackApplicationRole? -

callback ListWrapperCallbackApplicationRole? -

'max\-results int? -

jira: SimpleListWrapperGroupName

A simple wrapper group name.

Fields

size int? - list wrapper group size

items GroupName[]? - Array of list wrapper group names.

pagingCallback ListWrapperCallbackGroupName? - A callback.

callback ListWrapperCallbackGroupName? - A callback.

'max\-results int? - Maximum possible results.

jira: Status

The status of the item.

Fields

resolved boolean? - Whether the item is resolved. If set to "true", the link to the issue is displayed in a strikethrough font, otherwise the link displays in normal font.

icon Icon? - Details of the icon representing the status. If not provided, no status icon displays in Jira.

jira: StatusCategory

A status category.

Fields

self string? - The URL of the status category.

id int? - The ID of the status category.

'key string? - The key of the status category.

colorName string? - The name of the color used to represent the status category.

name string? - The name of the status category.

jira: StatusDetails

A status.

Fields

self string? - The URL of the status.

description string? - The description of the status.

iconUrl string? - The URL of the icon used to represent the status.

name string? - The name of the status.

id string? - The ID of the status.

statusCategory StatusCategory? - The category assigned to the status.

jira: StatusMapping

Details about the mapping from a status to a new status for an issue type.

Fields

issueTypeId string - The ID of the issue type.

statusId string - The ID of the status.

newStatusId string - The ID of the new status.

jira: StringList

jira: SuggestedIssue

An issue suggested for use in the issue picker auto-completion.

Fields

id int? - The ID of the issue.

'key string? - The key of the issue.

keyHtml string? - The key of the issue in HTML format.

img string? - The URL of the issue type's avatar.

summary string? - The phrase containing the query string in HTML format, with the string highlighted with HTML bold tags.

summaryText string? - The phrase containing the query string, as plain text.

jira: SystemAvatars

List of system avatars.

Fields

system Avatar[]? - A list of avatar details.

jira: TaskProgressBeanObject

Details about a task.

Fields

self string - The URL of the task.

id string - The ID of the task.

description string? - The description of the task.

status string - The status of the task.

message string? - Information about the progress of the task.

result anydata? - The result of the task execution.

submittedBy int - The ID of the user who submitted the task.

progress int - The progress of the task, as a percentage complete.

elapsedRuntime int - The execution time of the task, in milliseconds.

submitted int - A timestamp recording when the task was submitted.

started int? - A timestamp recording when the task was started.

finished int? - A timestamp recording when the task was finished.

lastUpdate int - A timestamp recording when the task progress was last updated.

jira: TaskProgressBeanRemoveOptionFromIssuesResult

Details about a task.

Fields

self string - The URL of the task.

id string - The ID of the task.

description string? - The description of the task.

status string - The status of the task.

message string? - Information about the progress of the task.

result RemoveOptionFromIssuesResult? - The result of the task execution.

submittedBy int - The ID of the user who submitted the task.

progress int - The progress of the task, as a percentage complete.

elapsedRuntime int - The execution time of the task, in milliseconds.

submitted int - A timestamp recording when the task was submitted.

started int? - A timestamp recording when the task was started.

finished int? - A timestamp recording when the task was finished.

lastUpdate int - A timestamp recording when the task progress was last updated.

jira: TimeTrackingConfiguration

Details of the time tracking configuration.

Fields

workingHoursPerDay decimal - The number of hours in a working day.

workingDaysPerWeek decimal - The number of days in a working week.

timeFormat string - The format that will appear on an issue's Time Spent field.

defaultUnit string - The default unit of time applied to logged time.

jira: TimeTrackingDetails

Time tracking details.

Fields

originalEstimate string? - The original estimate of time needed for this issue in readable format.

remainingEstimate string? - The remaining estimate of time needed for this issue in readable format.

timeSpent string? - Time worked on this issue in readable format.

originalEstimateSeconds int? - The original estimate of time needed for this issue in seconds.

remainingEstimateSeconds int? - The remaining estimate of time needed for this issue in seconds.

timeSpentSeconds int? - Time worked on this issue in seconds.

jira: TimeTrackingProvider

Details about the time tracking provider.

Fields

'key string - The key for the time tracking provider. For example, JIRA.

name string? - The name of the time tracking provider. For example, JIRA provided time tracking.

url string? - The URL of the configuration page for the time tracking provider app. For example, /example/config/url. This property is only returned if the adminPageKey property is set in the module descriptor of the time tracking provider app.

jira: Transition

Details of a workflow transition.

Fields

id string - The ID of the transition.

name string - The name of the transition.

description string - The description of the transition.

'from string[] - The statuses the transition can start from.

to string - The status the transition goes to.

'type string - The type of the transition.

screen ScreenID? - ID of a screen.

rules WorkflowRules? - A collection of transition rules.

jira: Transitions

List of issue transitions.

Fields

expand string? - Expand options that include additional transitions details in the response.

transitions IssueTransition[]? - List of issue transitions.

jira: UnrestrictedUserEmail

Fields

accountId string? - The accountId of the user

email string? - The email of the user

jira: UpdateCustomFieldDetails

Details of a custom field.

Fields

name string? - The name of the custom field. It doesn't have to be unique. The maximum length is 255 characters.

description string? - The description of the custom field. The maximum length is 40000 characters.

searcherKey string? - The searcher that defines the way the field is searched in Jira. It can be set to null, otherwise you must specify the valid searcher for the field type, as listed below (abbreviated values shown):
- cascadingselect: cascadingselectsearcher
- datepicker: daterange
- datetime: datetimerange
- float: exactnumber or numberrange
- grouppicker: grouppickersearcher
- importid: exactnumber or numberrange
- 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: UpdateDefaultScreenScheme

The ID of a screen scheme.

Fields

screenSchemeId string - The ID of the screen scheme.

jira: UpdatedProjectCategory

A project category.

Fields

self string? - The URL of the project category.

id string? - The ID of the project category.

description string? - The name of the project category.

name string? - The description of the project category.

jira: UpdateProjectDetails

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. Cannot be provided with leadAccountId.

leadAccountId string? - The account ID of the project lead. Cannot be provided with lead.

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.

jira: UpdateScreenDetails

Details of a screen.

Fields

name string? - The name of the screen. The name must be unique. The maximum length is 255 characters.

description string? - The description of the screen. The maximum length is 255 characters.

jira: UpdateScreenSchemeDetails

Details of a screen scheme.

Fields

name string? - The name of the screen scheme. The name must be unique. The maximum length is 255 characters.

description string? - The description of the screen scheme. The maximum length is 255 characters.

screens UpdateScreenTypes? - The IDs of the screens for the screen types of the screen scheme. Only screens used in classic projects are accepted.

jira: UpdateScreenTypes

The IDs of the screens for the screen types of the screen scheme.

Fields

edit string? - The ID of the edit screen. To remove the screen association, pass a null.

create string? - The ID of the create screen. To remove the screen association, pass a null.

view string? - The ID of the view screen. To remove the screen association, pass a null.

default string? - The ID of the default screen. When specified, must include a screen ID as a default screen is required.

jira: UpdateUserToGroupBean

Fields

name string? - This property is no longer available and will be removed from the documentation soon. See the deprecation notice for details.

accountId string? - The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5.

jira: User

A user with details as permitted by the user's Atlassian Account privacy settings. However, be aware of these exceptions:

User record deleted from Atlassian: This occurs as the result of a right to be forgotten request. In this case, displayName provides an indication and other parameters have default values or are blank (for example, email is blank).
User record corrupted: This occurs as a results of events such as a server import and can only happen to deleted users. In this case, accountId returns unknown and all other parameters have fallback values.
User record unavailable: This usually occurs due to an internal service outage. In this case, all parameters have fallback values.

Fields

self string? - The URL of the user.

'key string? - This property is no longer available and will be removed from the documentation soon. See the deprecation notice for details.

accountId string? - The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5. Required in requests.

accountType string? - The user account type. Can take the following values:
- atlassian regular Atlassian user account
- app system account used for Connect applications and OAuth to represent external systems
- customer Jira Service Desk account representing an external service desk

name string? - This property is no longer available and will be removed from the documentation soon. See the deprecation notice for details.

emailAddress string? - The email address of the user. Depending on the user’s privacy setting, this may be returned as null.

avatarUrls AvatarUrlsBean? - The avatars of the user.

displayName string? - The display name of the user. Depending on the user’s privacy setting, this may return an alternative value.

active boolean? - Whether the user is active.

timeZone string? - The time zone specified in the user's profile. Depending on the user’s privacy setting, this may be returned as null.

locale string? - The locale of the user. Depending on the user’s privacy setting, this may be returned as null.

groups SimpleListWrapperGroupName? - The groups that the user belongs to.

applicationRoles SimpleListWrapperApplicationRole? - The application roles the user is assigned to.

expand string? - Expand options that include additional user details in the response.

jira: UserBean

Record defining a user bean.

Fields

'key string? - This property is deprecated in favor of accountId because of privacy changes. See the migration guide for details.
The key of the user.

self string? - The URL of the user.

name string? - This property is deprecated in favor of accountId because of privacy changes. See the migration guide for details.
The username of the user.

displayName string? - The display name of the user. Depending on the user’s privacy setting, this may return an alternative value.

active boolean? - Whether the user is active.

accountId string? - The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5.

avatarUrls UserBeanAvatarUrls? - The avatars of the user.

jira: UserBeanAvatarUrls

Fields

'48x48 string? - The URL of the user's 48x48 pixel avatar.

'24x24 string? - The URL of the user's 24x24 pixel avatar.

'16x16 string? - The URL of the user's 16x16 pixel avatar.

'32x32 string? - The URL of the user's 32x32 pixel avatar.

jira: UserDetails

User details permitted by the user's Atlassian Account privacy settings. However, be aware of these exceptions:

User record deleted from Atlassian: This occurs as the result of a right to be forgotten request. In this case, displayName provides an indication and other parameters have default values or are blank (for example, email is blank).
User record corrupted: This occurs as a results of events such as a server import and can only happen to deleted users. In this case, accountId returns unknown and all other parameters have fallback values.
User record unavailable: This usually occurs due to an internal service outage. In this case, all parameters have fallback values.

Fields

self string? - The URL of the user.

name string? - This property is no longer available and will be removed from the documentation soon. See the deprecation notice for details.

'key string? - This property is no longer available and will be removed from the documentation soon. See the deprecation notice for details.

accountId string? - The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5.

emailAddress string? - The email address of the user. Depending on the user’s privacy settings, this may be returned as null.

avatarUrls AvatarUrlsBean? - The avatars of the user.

displayName string? - The display name of the user. Depending on the user’s privacy settings, this may return an alternative value.

active boolean? - Whether the user is active.

timeZone string? - The time zone specified in the user's profile. Depending on the user’s privacy settings, this may be returned as null.

accountType string? - The type of account represented by this user. This will be one of 'atlassian' (normal users), 'app' (application user) or 'customer' (Jira Service Desk customer user)

jira: UserKey

List of user account IDs.

Fields

'key string? - This property is no longer available and will be removed from the documentation soon. See the deprecation notice for details.

accountId string? - The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5. Returns unknown if the record is deleted and corrupted, for example, as the result of a server import.

jira: UserList

A paginated list of users sharing the filter. This includes users that are members of the groups or can browse the projects that the filter is shared with.

Fields

size int? - The number of items on the page.

items User[]? - 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: UserMigrationBean

Fields

'key string? -

username string? -

accountId string? -

jira: UserPermission

Details of a permission and its availability to a user.

Fields

id string? - The ID of the permission. Either id or key must be specified. Use Get all permissions to get the list of permissions.

'key string? - The key of the permission. Either id or key must be specified. Use Get all permissions to get the list of permissions.

name string? - The name of the permission.

'type string? - The type of the permission.

description string? - The description of the permission.

havePermission boolean? - Whether the permission is available to the user in the queried context.

deprecatedKey boolean? - Indicate whether the permission key is deprecated. Note that deprecated keys cannot be used in the permissions parameter of Get my permissions. Deprecated keys are not returned by Get all permissions.

jira: UserPickerUser

A user found in a search.

Fields

accountId string? - The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5.

name string? - This property is no longer available and will be removed from the documentation soon. See the deprecation notice for details.

'key string? - This property is no longer available and will be removed from the documentation soon. See the deprecation notice for details.

html string? - The display name, email address, and key of the user with the matched query string highlighted with the HTML bold tag.

displayName string? - The display name of the user. Depending on the user’s privacy setting, this may be returned as null.

avatarUrl string? - The avatar URL of the user.

jira: UserWriteBean

Fields

self string? - The URL of the user.

'key string? - This parameter is no longer available. See the migration guide for details.

name string? - This parameter is no longer available. See the migration guide for details.

password string? - This parameter is no longer available. If the user has an Atlassian account, their password is not changed. If the user does not have an Atlassian account, they are sent an email asking them set up an account.

emailAddress string - The email address for the user.

displayName string - A suggested display name for the user. If the user has an Atlassian account, their display name is not changed. If the user does not have an Atlassian account, this display name is used as a suggestion for creating an account. The user is sent an email asking them to set their display name and privacy preferences.

applicationKeys string[]? - Deprecated, do not use.

jira: ValueOperand

An operand that is a user-provided value.

Fields

value string - The operand value.

jira: Version

Details about a project version.

Fields

expand string? - Use expand to include additional information about version in the response. This parameter accepts a comma-separated list. Expand options include:
- operations Returns the list of operations available for this version.
- issuesstatus Returns the count of issues in this version for each of the status categories to do, in progress, done, and unmapped. The unmapped property contains a count of issues with a status other than to do, in progress, and done.
Optional for create and update.

self string? - The URL of the version.

id string? - The ID of the version.

description string? - The description of the version. Optional when creating or updating a version.

name string? - The unique name of the version. Required when creating a version. Optional when updating a version. The maximum length is 255 characters.

archived boolean? - Indicates that the version is archived. Optional when creating or updating a version.

released boolean? - Indicates that the version is released. If the version is released a request to release again is ignored. Not applicable when creating a version. Optional when updating a version.

startDate string? - The start date of the version. Expressed in ISO 8601 format (yyyy-mm-dd). Optional when creating or updating a version.

releaseDate string? - The release date of the version. Expressed in ISO 8601 format (yyyy-mm-dd). Optional when creating or updating a version.

overdue boolean? - Indicates that the version is overdue.

userStartDate string? - The date on which work on this version is expected to start, expressed in the instance's Day/Month/Year Format date format.

userReleaseDate string? - The date on which work on this version is expected to finish, expressed in the instance's Day/Month/Year Format date format.

project string? - Deprecated. Use projectId.

projectId int? - The ID of the project to which this version is attached. Required when creating a version. Not applicable when updating a version.

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

operations SimpleLink[]? - If the expand option operations is used, returns the list of operations available for this version.

issuesStatusForFixVersion VersionIssuesStatus? - If the expand option issuesstatus is used, returns the count of issues in this version for each of the status categories to do, in progress, done, and unmapped. The unmapped property contains a count of issues with a status other than to do, in progress, and done.

jira: VersionIssueCounts

Various counts of issues within a version.

Fields

self string? - The URL of these count details.

issuesFixedCount int? - Count of issues where the fixVersion is set to the version.

issuesAffectedCount int? - Count of issues where the affectedVersion is set to the version.

issueCountWithCustomFieldsShowingVersion int? - Count of issues where a version custom field is set to the version.

customFieldUsage VersionUsageInCustomField[]? - List of custom fields using the version.

jira: VersionIssuesStatus

Counts of the number of issues in various statuses.

Fields

unmapped int? - Count of issues with a status other than to do, in progress, and done.

toDo int? - Count of issues with status to do.

inProgress int? - Count of issues with status in progress.

done int? - Count of issues with status done.

jira: VersionMoveBean

Fields

after string? - The URL (self link) of the version after which to place the moved version. Cannot be used with position.

position string? - An absolute position in which to place the moved version. Cannot be used with after.

jira: VersionUnresolvedIssuesCount

Count of a version's unresolved issues.

Fields

self string? - The URL of these count details.

issuesUnresolvedCount int? - Count of unresolved issues.

issuesCount int? - Count of issues.

jira: VersionUsageInCustomField

List of custom fields using the version.

Fields

fieldName string? - The name of the custom field.

customFieldId int? - The ID of the custom field.

issueCountWithVersionInCustomField int? - Count of the issues where the custom field contains the version.

jira: Visibility

The group or role to which this item is visible.

Fields

'type string? - Whether visibility of this item is restricted to a group or role.

value string? - The name of the group or role to which visibility of this item is restricted.

jira: Votes

The details of votes on an issue.

Fields

self string? - The URL of these issue vote details.

votes int? - The number of votes on the issue.

hasVoted boolean? - Whether the user making this request has voted on the issue.

voters User[]? - List of the users who have voted on this issue. An empty list is returned when the calling user doesn't have the View voters and watchers project permission.

jira: Watchers

The details of watchers on an issue.

Fields

self string? - The URL of these issue watcher details.

isWatching boolean? - Whether the calling user is watching this issue.

watchCount int? - The number of users watching this issue.

watchers UserDetails[]? - Details of the users watching this issue.

jira: Webhook

A webhook.

Fields

id int - The ID of the webhook.

jqlFilter string - The JQL filter that specifies which issues the webhook is sent for.

fieldIdsFilter string[]? - A list of field IDs. When the issue changelog contains any of the fields, the webhook jira:issue_updated is sent. If this parameter is not present, the app is notified about all field updates.

issuePropertyKeysFilter string[]? - A list of issue property keys. A change of those issue properties triggers the issue_property_set or issue_property_deleted webhooks. If this parameter is not present, the app is notified about all issue property updates.

events string[] - The Jira events that trigger the webhook.

expirationDate int? - The expiration date of the webhook.

jira: WebhookDetails

A list of webhooks.

Fields

jqlFilter string - The JQL filter that specifies which issues the webhook is sent for. Only a subset of JQL can be used. The supported elements are:
- Fields: issueKey, project, issuetype, status, assignee, reporter, issue.property, and cf[id]. For custom fields (cf[id]), only the epic label custom field is supported.".
- Operators: =, !=, IN, and NOT IN.

fieldIdsFilter string[]? - A list of field IDs. When the issue changelog contains any of the fields, the webhook jira:issue_updated is sent. If this parameter is not present, the app is notified about all field updates.

issuePropertyKeysFilter string[]? - A list of issue property keys. A change of those issue properties triggers the issue_property_set or issue_property_deleted webhooks. If this parameter is not present, the app is notified about all issue property updates.

events string[] - The Jira events that trigger the webhook.

jira: WebhookRegistrationDetails

Details of webhooks to register.

Fields

webhooks WebhookDetails[] - A list of webhooks.

url string - The URL that specifies where to send the webhooks. This URL must use the same base URL as the Connect app.

jira: WebhooksExpirationDate

The date the newly refreshed webhooks expire.

Fields

expirationDate int - Expiration date.

jira: Workflow

Details about a workflow.

Fields

id PublishedWorkflowId - Properties that identify a published workflow.

description string - The description of the workflow.

transitions Transition[]? - The transitions of the workflow.

statuses WorkflowStatus[]? - The statuses of the workflow.

isDefault boolean? - Whether this is the default workflow.

jira: WorkflowCompoundCondition

A compound workflow transition rule condition. This object returns nodeType as compound.

Fields

operator string - The compound condition operator.

conditions WorkflowCondition[] - The list of workflow conditions.

nodeType string - The node type of workflow conditions.

jira: WorkflowId

Properties that identify a workflow.

Fields

name string - The name of the workflow.

draft boolean - Whether the workflow is in the draft state.

jira: WorkflowIDs

The classic workflow identifiers.

Fields

name string - The name of the workflow.

entityId string? - The entity ID of the workflow.

jira: WorkflowRules

A collection of transition rules.

Fields

conditions WorkflowTransitionRule[]? - The workflow conditions. (Deprecated)

conditionsTree WorkflowCondition? - The workflow transition rule conditions tree.

validators WorkflowTransitionRule[]? - The workflow validators.

postFunctions WorkflowTransitionRule[]? - The workflow post functions.

jira: WorkflowScheme

Details about a workflow scheme.

Fields

id int? - The ID of the workflow scheme.

name string? - The name of the workflow scheme. The name must be unique. The maximum length is 255 characters. Required when creating a workflow scheme.

description string? - The description of the workflow scheme.

defaultWorkflow string? - The name of the default workflow for the workflow scheme. The default workflow has All Unassigned Issue Types assigned to it in Jira. If defaultWorkflow is not specified when creating a workflow scheme, it is set to Jira Workflow (jira).

issueTypeMappings record {}? - The issue type to workflow mappings, where each mapping is an issue type ID and workflow name pair. Note that an issue type can only be mapped to one workflow in a workflow scheme.

originalDefaultWorkflow string? - For draft workflow schemes, this property is the name of the default workflow for the original workflow scheme. The default workflow has All Unassigned Issue Types assigned to it in Jira.

originalIssueTypeMappings record {}? - For draft workflow schemes, this property is the issue type to workflow mappings for the original workflow scheme, where each mapping is an issue type ID and workflow name pair. Note that an issue type can only be mapped to one workflow in a workflow scheme.

draft boolean? - Whether the workflow scheme is a draft or not.

lastModifiedUser User? - The user that last modified the draft workflow scheme. A modification is a change to the issue type-project mappings only. This property does not apply to non-draft workflows.

lastModified string? - The date-time that the draft workflow scheme was last modified. A modification is a change to the issue type-project mappings only. This property does not apply to non-draft workflows.

self string? - The self of the workflow scheme.

updateDraftIfNeeded boolean? - Whether to create or update a draft workflow scheme when updating an active workflow scheme. An active workflow scheme is a workflow scheme that is used by at least one project. The following examples show how this property works:
- Update an active workflow scheme with updateDraftIfNeeded set to true: If a draft workflow scheme exists, it is updated. Otherwise, a draft workflow scheme is created.
- Update an active workflow scheme with updateDraftIfNeeded set to false: An error is returned, as active workflow schemes cannot be updated.
- Update an inactive workflow scheme with updateDraftIfNeeded set to true: The workflow scheme is updated, as inactive workflow schemes do not require drafts to update.
Defaults to false.

issueTypes record {}? - The issue types available in Jira.

jira: WorkflowSchemeAssociations

A workflow scheme along with a list of projects that use it.

Fields

projectIds string[] - The list of projects that use the workflow scheme.

workflowScheme WorkflowScheme - The workflow scheme.

jira: WorkflowSchemeProjectAssociation

An associated workflow scheme and project.

Fields

workflowSchemeId string? - The ID of the workflow scheme. If the workflow scheme ID is null, the operation assigns the default workflow scheme.

projectId string - The ID of the project.

jira: WorkflowSimpleCondition

A workflow transition rule condition. This object returns nodeType as simple.

Fields

'type string - The type of the transition rule.

configuration anydata? - EXPERIMENTAL. The configuration of the transition rule.

nodeType string - The node type of the transition rule.

jira: WorkflowStatus

Details of a workflow status.

Fields

id string - The ID of the issue status.

name string - The name of the status in the workflow.

properties WorkflowStatusProperties? - Properties of a workflow status.

jira: WorkflowStatusProperties

Properties of a workflow status.

Fields

issueEditable boolean - Whether issues are editable in this status.

jira: WorkflowsWithTransitionRulesDetails

Details of workflows and their transition rules to delete.

Fields

workflows WorkflowTransitionRulesDetails[] - The list of workflows with transition rules to delete.

jira: WorkflowTransition

A workflow transition.

Fields

id int - The transition ID.

name string - The transition name.

jira: WorkflowTransitionProperty

Details about the server Jira is running on.

Fields

'key string? - The key of the transition property. Also known as the name of the transition property.

value string - The value of the transition property.

id string? - The ID of the transition property.

jira: WorkflowTransitionRule

A workflow transition rule.

Fields

'type string - The type of the transition rule.

configuration anydata? - EXPERIMENTAL. The configuration of the transition rule.

jira: WorkflowTransitionRules

A workflow with transition rules.

Fields

workflowId WorkflowId - Properties that identify a workflow.

postFunctions ConnectWorkflowTransitionRule[] - The list of post functions within the workflow.

conditions ConnectWorkflowTransitionRule[] - The list of conditions within the workflow.

validators ConnectWorkflowTransitionRule[] - The list of validators within the workflow.

jira: WorkflowTransitionRulesDetails

Details about a workflow configuration update request.

Fields

workflowId WorkflowId - Properties that identify a workflow.

workflowRuleIds string[] - The list of connect workflow rule IDs.

jira: WorkflowTransitionRulesUpdate

Details about a workflow configuration update request.

Fields

workflows WorkflowTransitionRules[] - The list of workflows with transition rules to update.

jira: WorkflowTransitionRulesUpdateErrorDetails

Details of any errors encountered while updating workflow transition rules for a workflow.

Fields

workflowId WorkflowId - Properties that identify a workflow.

ruleUpdateErrors record {} - A list of transition rule update errors, indexed by the transition rule ID. Any transition rule that appears here wasn't updated.

updateErrors string[] - The list of errors that specify why the workflow update failed. The workflow was not updated if the list contains any entries.

jira: WorkflowTransitionRulesUpdateErrors

Details of any errors encountered while updating workflow transition rules.

Fields

updateResults WorkflowTransitionRulesUpdateErrorDetails[] - A list of workflows.

jira: Worklog

Details of a worklog.

Fields

self string? - The URL of the worklog item.

author UserDetails? - Details of the user who created the worklog.

updateAuthor UserDetails? - Details of the user who last updated the worklog.

comment string? - A comment about the worklog. Optional when creating or updating a worklog.

created string? - The datetime on which the worklog was created.

updated string? - The datetime on which the worklog was last updated.

visibility Visibility? - Details about any restrictions in the visibility of the worklog. Optional when creating or updating a worklog.

started string? - The datetime on which the worklog effort was started. Required when creating a worklog. Optional when updating a worklog.

timeSpent string? - The time spent working on the issue as days (#d), hours (#h), or minutes (#m or #). Required when creating a worklog if timeSpentSeconds isn't provided. Optional when updating a worklog. Cannot be provided if timeSpentSecond is provided.

timeSpentSeconds int? - The time in seconds spent working on the issue. Required when creating a worklog if timeSpent isn't provided. Optional when updating a worklog. Cannot be provided if timeSpent is provided.

id string? - The ID of the worklog record.

issueId string? - The ID of the issue this worklog is for.

properties EntityProperty[]? - Details of properties for the worklog. Optional when creating or updating a worklog.

jira: WorklogIdsRequestBean

Fields

ids int[] - A list of worklog IDs.

Union types

jira: CustomFieldContextDefaultValue

CustomFieldContextDefaultValueCascadingOption|CustomFieldContextDefaultValueMultipleOption|CustomFieldContextDefaultValueSingleOption

CustomFieldContextDefaultValue

jira: JqlQueryClause

CompoundClause|FieldValueClause|FieldWasClause|FieldChangedClause

JqlQueryClause

A JQL query clause.

jira: JqlQueryClauseOperand

ListOperand|ValueOperand|FunctionOperand|KeywordOperand

JqlQueryClauseOperand

Details of an operand in a JQL clause.

jira: JqlQueryUnitaryOperand

ValueOperand|FunctionOperand|KeywordOperand

JqlQueryUnitaryOperand

An operand that can be part of a list operand.

jira: WorkflowCondition

WorkflowSimpleCondition|WorkflowCompoundCondition

WorkflowCondition

The workflow transition rule conditions tree.

String types

jira: JqlqueriestoparseQueriesItemsString

string

JqlqueriestoparseQueriesItemsString

Import

import ballerinax/jira;

Metadata

Released date: 12 months ago

Version: 1.5.1

License: Apache-2.0

Compatibility

Platform: any

Ballerina version: 2201.4.1

GraalVM compatible: Yes

Pull count

Total: 13

Current verison: 4

Weekly downloads

Source repository

Keywords

Productivity/Project Management

Cost/Freemium

Contributors

Other versions

1.5.1

1.5.0 1.4.0 1.2.0 1.1.0

Dependencies

ballerina/url/2.2.3 ballerina/constraint/1.1.0 ballerina/http/2.6.1

Cookie policy

Delete policy

clients

records

unionTypes

stringTypes

ballerinax/jira Ballerina library

Overview

Prerequisites

Quickstart

Step 1: Import Jira module

Step 2: Configure the connection credentials.

Step 3: Invoke connector operation

Quick reference

Clients

jira: Client

Constructor

createIssue

Parameters

Return Type

createIssues

Parameters

Return Type

getCreateIssueMeta

Parameters

Return Type

getIssue

Parameters

Return Type

editIssue

Parameters

Return Type

deleteIssue

Parameters

Return Type

assignIssue

Parameters

Return Type

getChangeLogs

Parameters

Return Type

getChangeLogsByIds

Parameters

Return Type

getEditIssueMeta

Parameters

Return Type

notify

Parameters

Return Type

getTransitions

Parameters

Return Type

doTransition

Parameters

Return Type

bulkSetIssuesProperties

Parameters

Return Type

bulkSetIssueProperty

Parameters

Return Type

bulkDeleteIssueProperty

Parameters

Return Type

getIssuePropertyKeys

Parameters

Return Type

getIssueProperty

Parameters

Return Type

setIssueProperty

Parameters

Return Type

deleteIssueProperty

Parameters

Return Type

getAttachmentMeta

Return Type

getAttachment

Parameters

Return Type