Skip to content

Main Navigation Guide API

English

English

Appearance

Sidebar Navigation

API Reference

agile

api

backlog

Functions

moveIssuesToBacklog

moveIssuesToBacklogForBoard

board

Functions

createBoard

deleteBoard

deleteBoardProperty

getAllBoards

getAllQuickFilters

getAllSprints

getAllVersions

getApproximateIssueCountForBacklog

getApproximateIssueCountForBoard

getBoard

getBoardByFilterId

getBoardIssuesForEpic

getBoardIssuesForSprint

getBoardProperty

getBoardPropertyKeys

getConfiguration

getEpics

getFeaturesForBoard

getIssuesForBacklog

getIssuesForBoard

getIssuesWithoutEpicForBoard

getProjects

getProjectsFull

getQuickFilter

getReportsForBoard

moveIssuesToBoard

setBoardProperty

toggleFeatures

builds

Functions

deleteBuildByKey

deleteBuildsByProperty

getBuildByKey

submitBuilds

deployments

Functions

deleteDeploymentByKey

deleteDeploymentsByProperty

getDeploymentByKey

getDeploymentGatingStatusByKey

submitDeployments

developmentInformation

Functions

deleteByProperties

deleteEntity

deleteRepository

existsByProperties

getRepository

storeDevelopmentInformation

devopsComponents

Functions

deleteComponentById

deleteComponentsByProperty

getComponentById

submitComponents

epic

Functions

getEpic

getIssuesForEpic

getIssuesWithoutEpic

moveIssuesToEpic

partiallyUpdateEpic

rankEpics

removeIssuesFromEpic

featureFlags

Functions

deleteFeatureFlagById

deleteFeatureFlagsByProperty

getFeatureFlagById

submitFeatureFlags

issue

Functions

estimateIssueForBoard

getIssue

getIssueEstimationForBoard

rankIssues

operations

Functions

deleteEntityByProperty

deleteIncidentById

deleteReviewById

deleteWorkspaces

getIncidentById

getReviewById

getWorkspaces

submitEntity

submitOperationsWorkspaces

remoteLinks

Functions

deleteRemoteLinkById

deleteRemoteLinksByProperty

getRemoteLinkById

submitRemoteLinks

securityInformation

Functions

deleteLinkedWorkspaces

deleteVulnerabilitiesByProperty

deleteVulnerabilityById

getLinkedWorkspaceById

getLinkedWorkspaces

getVulnerabilityById

submitVulnerabilities

submitWorkspaces

sprint

Functions

createSprint

deleteProperty

deleteSprint

getIssuesForSprint

getPropertiesKeys

getProperty

getSprint

moveIssuesToSprintAndRank

partiallyUpdateSprint

setProperty

swapSprint

updateSprint

createAgileClient

Type Aliases

AgileClient

Functions

createAgileClient

cloud

api

announcementBanner

Functions

getBanner

setBanner

api

Functions

getWorklogsByIssueIdAndWorklogId

appDataPolicies

Functions

getPolicies

getPolicy

applicationRoles

Functions

getAllApplicationRoles

getApplicationRole

appMigration

Functions

updateEntityPropertiesValue

updateIssueFields

workflowRuleSearch

appProperties

Functions

deleteAddonProperty

deleteForgeAppProperty

getAddonProperties

getAddonProperty

getForgeAppProperty

getForgeAppPropertyKeys

putAddonProperty

putForgeAppProperty

auditRecords

Functions

getAuditRecords

avatars

Functions

deleteAvatar

getAllSystemAvatars

getAvatarImageByID

getAvatarImageByOwner

getAvatarImageByType

getAvatars

storeAvatar

dashboards

Functions

deleteDashboardItemProperty

getAllDashboards

getDashboard

getDashboardItemProperty

getDashboardItemPropertyKeys

getDashboardsPaginated

setDashboardItemProperty

dynamicModules

Functions

getModules

registerModules

removeModules

filters

Functions

createFilter

deleteFavouriteForFilter

deleteFilter

getColumns

getFavouriteFilters

getFilter

getFiltersPaginated

getMyFilters

resetColumns

setColumns

setFavouriteForFilter

updateFilter

filterSharing

Functions

addSharePermission

deleteSharePermission

getDefaultShareScope

getSharePermission

getSharePermissions

setDefaultShareScope

groupAndUserPicker

Functions

findUsersAndGroups

groups

Functions

addUserToGroup

createGroup

findGroups

getUsersFromGroup

removeGroup

removeUserFromGroup

issueAttachments

Functions

addAttachment

getAttachment

getAttachmentContent

getAttachmentMeta

getAttachmentThumbnail

removeAttachment

issueBulkOperations

Functions

getAvailableTransitions

getBulkEditableFields

getBulkOperationProgress

submitBulkDelete

submitBulkEdit

submitBulkMove

submitBulkTransition

submitBulkUnwatch

submitBulkWatch

issueCommentProperties

Functions

deleteCommentProperty

getCommentProperty

getCommentPropertyKeys

setCommentProperty

issueComments

Functions

addComment

deleteComment

getComment

getComments

getCommentsByIds

updateComment

issueCustomFieldAssociations

Functions

createAssociations

removeAssociations

issueCustomFieldConfigurationApps

Functions

getCustomFieldConfiguration

updateCustomFieldConfiguration

issueCustomFieldContexts

Functions

addIssueTypesToContext

assignProjectsToCustomFieldContext

createCustomFieldContext

deleteCustomFieldContext

getContextDefaultValues

getContextsForField

getCustomFieldContextsForProjectsAndIssueTypes

getIssueTypeMappingsForContexts

getProjectContextMapping

removeCustomFieldContextFromProjects

removeIssueTypesFromContext

updateCustomFieldContext

issueCustomFieldOptions

Functions

createCustomFieldOption

deleteCustomFieldOption

getCustomFieldOption

getOptionsForContext

reorderCustomFieldOptions

replaceCustomFieldOption

updateCustomFieldOption

issueCustomFieldOptionsApps

Functions

createIssueFieldOption

deleteIssueFieldOption

getAllIssueFieldOptions

getIssueFieldOption

getSelectableIssueFieldOptions

getVisibleIssueFieldOptions

replaceIssueFieldOption

updateIssueFieldOption

issueCustomFieldValuesApps

Functions

updateCustomFieldValue

updateMultipleCustomFieldValues

issueFields

Functions

createCustomField

deleteCustomField

getFields

getFieldsPaginated

getTrashedFieldsPaginated

restoreCustomField

trashCustomField

updateCustomField

issueLinks

Functions

deleteIssueLink

getIssueLink

linkIssues

issueLinkTypes

Functions

createIssueLinkType

deleteIssueLinkType

getIssueLinkType

getIssueLinkTypes

updateIssueLinkType

issueNavigatorSettings

Functions

getIssueNavigatorDefaultColumns

setIssueNavigatorDefaultColumns

issueNotificationSchemes

Functions

addNotifications

getNotificationScheme

getNotificationSchemes

getNotificationSchemeToProjectMappings

removeNotificationFromNotificationScheme

issuePanels

Functions

bulkPinUnpinProjectsAsync

issuePriorities

Functions

createPriority

deletePriority

getPriority

movePriorities

searchPriorities

setDefaultPriority

updatePriority

issueProperties

Functions

bulkDeleteIssueProperty

bulkSetIssuePropertiesByIssue

bulkSetIssueProperty

bulkSetIssuesPropertiesList

deleteIssueProperty

getIssueProperty

getIssuePropertyKeys

setIssueProperty

issueRedaction

Functions

getRedactionStatus

redact

issueRemoteLinks

Functions

createOrUpdateRemoteIssueLink

deleteRemoteIssueLinkByGlobalId

deleteRemoteIssueLinkById

getRemoteIssueLinkById

getRemoteIssueLinks

updateRemoteIssueLink

issueResolutions

Functions

getResolution

issues

Functions

assignIssue

bulkFetchIssues

createIssue

createIssues

deleteIssue

doTransition

editIssue

getBulkChangelogs

getChangeLogs

getChangeLogsByIds

getCreateIssueMetaIssueTypeId

getCreateIssueMetaIssueTypes

getEditIssueMeta

getIssue

getTransitions

notify

issueSearch

Functions

countIssues

getIssuePickerResource

matchIssues

searchAndReconsileIssuesUsingJql

searchAndReconsileIssuesUsingJqlPost

issueSecurityLevel

Functions

getIssueSecurityLevel

getIssueSecurityLevelMembers

issueSecuritySchemes

Functions

getIssueSecurityScheme

getIssueSecuritySchemes

issueTypeProperties

Functions

deleteIssueTypeProperty

getIssueTypeProperty

getIssueTypePropertyKeys

setIssueTypeProperty

issueTypes

Functions

createIssueType

createIssueTypeAvatar

deleteIssueType

getAlternativeIssueTypes

getIssueAllTypes

getIssueType

updateIssueType

issueTypeSchemes

Functions

addIssueTypesToIssueTypeScheme

assignIssueTypeSchemeToProject

createIssueTypeScheme

deleteIssueTypeScheme

getAllIssueTypeSchemes

getIssueTypeSchemeForProjects

getIssueTypeSchemesMapping

removeIssueTypeFromIssueTypeScheme

reorderIssueTypesInIssueTypeScheme

updateIssueTypeScheme

issueTypeScreenSchemes

Functions

appendMappingsForIssueTypeScreenScheme

assignIssueTypeScreenSchemeToProject

createIssueTypeScreenScheme

deleteIssueTypeScreenScheme

getIssueTypeScreenSchemeMappings

getIssueTypeScreenSchemeProjectAssociations

getIssueTypeScreenSchemes

getProjectsForIssueTypeScreenScheme

removeMappingsFromIssueTypeScreenScheme

updateDefaultScreenScheme

updateIssueTypeScreenScheme

issueVotes

Functions

addVote

getVotes

removeVote

issueWatchers

Functions

addWatcher

getIssueWatchers

getIsWatchingIssueBulk

removeWatcher

issueWorklogProperties

Functions

deleteWorklogProperty

getWorklogProperty

getWorklogPropertyKeys

setWorklogProperty

issueWorklogs

Functions

addWorklog

deleteWorklog

getIdsOfWorklogsDeletedSince

getIdsOfWorklogsModifiedSince

getIssueWorklog

getWorklog

getWorklogsForIds

updateWorklog

jiraExpressions

Functions

analyseExpression

evaluateJSISJiraExpression

jiraSettings

Functions

getAdvancedSettings

getApplicationProperty

getConfiguration

setApplicationProperty

jql

Functions

getAutoComplete

getAutoCompletePost

getFieldAutoCompleteForQueryString

migrateQueries

parseJqlQueries

jqlFunctionsApps

Functions

getPrecomputations

getPrecomputationsByID

updatePrecomputations

labels

Functions

getAllLabels

migrationOfConnectModulesToForge

Functions

fetchMigrationTask

submitTask

myself

Functions

getCurrentUser

getLocale

getPreference

removePreference

setPreference

permissions

Functions

getAllPermissions

getBulkPermissions

getMyPermissions

getPermittedProjects

permissionSchemes

Functions

createPermissionGrant

createPermissionScheme

deletePermissionScheme

deletePermissionSchemeEntity

getAllPermissionSchemes

getPermissionScheme

getPermissionSchemeGrant

getPermissionSchemeGrants

updatePermissionScheme

projectAvatars

Functions

createProjectAvatar

deleteProjectAvatar

getAllProjectAvatars

updateProjectAvatar

projectCategories

Functions

createProjectCategory

getAllProjectCategories

getProjectCategoryById

removeProjectCategory

updateProjectCategory

projectComponents

Functions

createComponent

deleteComponent

findComponentsForProjects

getComponent

getComponentRelatedIssues

getProjectComponents

getProjectComponentsPaginated

updateComponent

projectEmail

Functions

getProjectEmail

updateProjectEmail

projectFeatures

Functions

getFeaturesForProject

toggleFeatureForProject

projectKeyAndNameValidation

Functions

getValidProjectKey

getValidProjectName

validateProjectKey

projectPermissionSchemes

Functions

assignPermissionScheme

getAssignedPermissionScheme

getProjectIssueSecurityScheme

getSecurityLevelsForProject

projectProperties

Functions

deleteProjectProperty

getProjectProperty

getProjectPropertyKeys

setProjectProperty

projectRoleActors

Functions

addActorUsers

addProjectRoleActorsToRole

deleteActor

deleteProjectRoleActorsFromRole

getProjectRoleActorsForRole

setActors

projectRoles

Functions

createProjectRole

deleteProjectRole

fullyUpdateProjectRole

getAllProjectRoles

getProjectRole

getProjectRoleById

getProjectRoleDetails

getProjectRoles

partialUpdateProjectRole

projects

Functions

archiveProject

createProject

deleteProject

getAllStatuses

getHierarchy

getNotificationSchemeForProject

getProject

searchProjects

updateProject

projectTemplates

Functions

createProjectWithCustomTemplate

projectTypes

Functions

getAccessibleProjectTypeByKey

getAllAccessibleProjectTypes

getAllProjectTypes

getProjectTypeByKey

projectVersions

Functions

createRelatedWork

createVersion

deleteAndReplaceVersion

deleteRelatedWork

getProjectVersions

getProjectVersionsPaginated

getRelatedWork

getVersion

getVersionRelatedIssues

getVersionUnresolvedIssues

mergeVersions

moveVersion

updateRelatedWork

updateVersion

screens

Functions

addFieldToDefaultScreen

getAvailableScreenFields

getScreens

getScreensForField

screenSchemes

Functions

createScreenScheme

deleteScreenScheme

getScreenSchemes

updateScreenScheme

screenTabFields

Functions

addScreenTabField

getAllScreenTabFields

moveScreenTabField

removeScreenTabField

screenTabs

Functions

addScreenTab

deleteScreenTab

getAllScreenTabs

moveScreenTab

renameScreenTab

serverInfo

Functions

getServerInfo

status

Functions

createStatuses

deleteStatusesById

getProjectIssueTypeUsagesForStatus

getProjectUsagesForStatus

getStatusesById

getStatusesByName

getWorkflowUsagesForStatus

search

updateStatuses

tasks

Functions

getTask

timeTracking

Functions

getAvailableTimeTrackingImplementations

getSelectedTimeTrackingImplementation

getSharedTimeTrackingConfiguration

selectTimeTrackingImplementation

setSharedTimeTrackingConfiguration

uiModificationsApps

Functions

createUiModification

deleteUiModification

getUiModifications

updateUiModification

userProperties

Functions

deleteUserProperty

getUserProperty

getUserPropertyKeys

setUserProperty

users

Functions

createUser

getAllUsers

getAllUsersDefault

getUser

getUserDefaultColumns

getUserEmail

getUserEmailBulk

getUserGroups

removeUser

resetUserColumns

setUserColumns

userSearch

Functions

findAssignableUsers

findBulkAssignableUsers

findUserKeysByQuery

findUsers

findUsersByQuery

findUsersForPicker

findUsersWithAllPermissions

findUsersWithBrowsePermission

webhooks

Functions

deleteWebhookById

getDynamicWebhooksForApp

refreshWebhooks

registerDynamicWebhooks

workflows

Functions

createWorkflows

deleteInactiveWorkflow

getDefaultEditor

getProjectUsagesForWorkflow

getWorkflowProjectIssueTypeUsages

getWorkflowSchemeUsagesForWorkflow

listWorkflowHistory

readWorkflowFromHistory

readWorkflowPreviews

readWorkflows

searchWorkflows

updateWorkflows

validateCreateWorkflows

validateUpdateWorkflows

workflowCapabilities

workflowSchemeDrafts

Functions

createWorkflowSchemeDraftFromParent

deleteDraftDefaultWorkflow

deleteDraftWorkflowMapping

deleteWorkflowSchemeDraft

deleteWorkflowSchemeDraftIssueType

getDraftDefaultWorkflow

getDraftWorkflow

getWorkflowSchemeDraft

getWorkflowSchemeDraftIssueType

publishDraftWorkflowScheme

setWorkflowSchemeDraftIssueType

updateDraftDefaultWorkflow

updateDraftWorkflowMapping

updateWorkflowSchemeDraft

workflowSchemeProjectAssociations

Functions

assignSchemeToProject

getWorkflowSchemeProjectAssociations

workflowSchemes

Functions

createWorkflowScheme

deleteDefaultWorkflow

deleteWorkflowMapping

deleteWorkflowScheme

deleteWorkflowSchemeIssueType

getAllWorkflowSchemes

getDefaultWorkflow

getProjectUsagesForWorkflowScheme

getRequiredWorkflowSchemeMappings

getWorkflow

getWorkflowScheme

getWorkflowSchemeIssueType

readWorkflowSchemes

setWorkflowSchemeIssueType

updateDefaultWorkflow

updateSchemes

updateWorkflowMapping

updateWorkflowScheme

workflowStatusCategories

Functions

getStatusCategories

getStatusCategory

workflowStatuses

Functions

getStatus

getStatuses

workflowTransitionRules

Functions

deleteWorkflowTransitionRuleConfigurations

getWorkflowTransitionRuleConfigurations

updateWorkflowTransitionRuleConfigurations

createCloudClient

Type Aliases

CloudClient

Functions

createCloudClient

core

apiObject

Functions

apiObject

bodyToFetchBody

Functions

bodyToFetchBody

requiresDuplex

shouldSetJsonContentType

createClient

Functions

createClient

errors

apiError

Classes

ApiError

AuthError

ForbiddenError

NotFoundError

RateLimitError

ScopeError

ServerError

Interfaces

ApiErrorOptions

RateLimitErrorOptions

fromResponse

Variables

TRANSIENT_HTTP_STATUSES

Functions

createApiError

isTransientCode

parseRetryAfter

toNetworkError

kinds

Type Aliases

ErrorKind

Variables

ERROR_KINDS

Functions

hasErrorKind

networkError

Classes

NetworkError

oauthError

Classes

ConfigError

OAuthError

Interfaces

OAuthErrorOptions

predicates

Functions

isApiError

isAuthError

isConfigError

isForbiddenError

isNetworkError

isNotFoundError

isOAuthError

isRateLimitError

isReauthorizationRequired

isSchemaMismatchError

isScopeError

isServerError

schemaMismatchError

Classes

SchemaMismatchError

formData

attachmentInput

Interfaces

AttachmentInput

Type Aliases

AttachmentContent

bufferSchema

Type Aliases

Buffer

Variables

BufferSchema

mimeType

Variables

DEFAULT_MIME_TYPE

Functions

mimeTypeFor

multipartRequest

Interfaces

MultipartRequestBody

Functions

createMultipartRequestBody

toFormDataFile

interfaces

client

Interfaces

Client

oauth

helpers

Functions

exchangeAuthorizationCode

generateAuthorizationUrl

getAccessibleResources

refreshOAuth2Token

oauth2Manager

Interfaces

OAuth2Manager

OAuth2ManagerOptions

Functions

createOAuth2Manager

parseCallbackUrl

Interfaces

CallbackParams

ParseCallbackUrlOptions

Functions

parseCallbackUrl

types

Interfaces

AccessibleResource

OAuth2TokenResponse

TokenRefreshEvent

Type Aliases

OnTokenRefresh

openEnum

Functions

openEnum

productInfo

Interfaces

ProductInfo

Variables

PRODUCT

PRODUCT_SLUG

schemaAudit

Interfaces

UndocumentedKeys

UndocumentedValue

Type Aliases

SchemaDrift

Functions

getCollectedSchemaDrift

isSchemaAuditEnabled

recordSchemaDrift

schemaMismatch

Interfaces

SchemaMismatchIssue

SchemaMismatchReport

Type Aliases

SchemaMismatchBehavior

Functions

describeIssues

reportSchemaMismatch

resetSchemaMismatchReporting

warnOnce

schemas

auth

Type Aliases

Auth

AuthBasic

AuthBearer

AuthBearerProvider

AuthBearerToken

AuthOAuth2

Variables

authBasicSchema

authBearerProviderSchema

authBearerSchema

authBearerTokenSchema

authOAuth2Schema

authSchema

clientConfig

Type Aliases

ClientConfig

CommonClientConfig

ParsedClientConfig

TransientRetryConfig

Variables

clientConfigSchema

transientRetrySchema

httpMethod

Type Aliases

HttpMethod

Variables

httpMethodSchema

sendRequestOptions

Type Aliases

SendRequestOptions

Variables

sendRequestOptionsSchema

serializeSearchParams

Functions

buildUrlWithSearchParams

serializeSearchParamValue

withRetry

Interfaces

RetryOptions

Functions

withRetry

index

serviceDesk

api

assets

Functions

getAssetsWorkspaces

getInsightWorkspaces

customer

Functions

createCustomer

createCustomerSkippingPermissionCheck

revokePortalOnlyAccessForUser

info

Functions

getInfo

knowledgebase

Functions

getArticles

viewArticle

organization

Functions

addOrganization

addUsersToOrganization

createOrganization

deleteOrganization

deleteProperty

getOrganization

getOrganizations

getPropertiesKeys

getProperty

getServiceDeskOrganizations

getUsersInOrganization

removeOrganization

removeUsersFromOrganization

setProperty

request

Functions

addRequestParticipants

answerApproval

createCommentWithAttachment

createCustomerRequest

createRequestComment

getApprovalById

getApprovals

getAttachmentContent

getAttachmentsForRequest

getAttachmentThumbnail

getCustomerRequestByIdOrKey

getCustomerRequests

getCustomerRequestStatus

getCustomerTransitions

getRequestCommentById

getRequestComments

getRequestParticipants

getSlaInformation

getSlaInformationById

getSubscriptionStatus

performCustomerTransition

removeRequestParticipants

subscribe

unsubscribe

servicedesk

Functions

addCustomers

addCustomersSkippingPermissionCheck

attachTemporaryFile

getIssuesInQueue

getQueue

getQueues

getRequestTypeById

getRequestTypeFields

getRequestTypeGroups

getRequestTypes

getServiceDeskArticles

getServiceDeskById

getServiceDesks

createServiceDeskClient

Type Aliases

ServiceDeskClient

Functions

createServiceDeskClient

On this page

cloud/models/customFieldValueUpdate

Type Aliases

CustomFieldValueUpdate

Variables

CustomFieldValueUpdateSchema

Edit this page on GitHub

Pager