Jira
Home
Link
Multiple Menus
Multiple Menus
  • Link1
  • Link2
Home
Link
Multiple Menus
Multiple Menus
  • Link1
  • Link2
  1. Schemas
  • Announcement banner
    • Get announcement banner configuration
    • Update announcement banner configuration
  • Issue custom field configuration (apps)
    • Bulk get custom field configurations
    • Get custom field configurations
    • Update custom field configurations
  • Issue custom field values (apps)
    • Update custom fields
      POST
    • Update custom field value
      PUT
  • Jira settings
    • Get application property
    • Get advanced settings
    • Set application property
    • Get global settings
  • Application roles
    • Get all application roles
    • Get application role
  • Issue attachments
    • Get attachment content
    • Get Jira attachment settings
    • Get attachment thumbnail
    • Delete attachment
    • Get attachment metadata
    • Get all metadata for an expanded attachment
    • Get contents metadata for an expanded attachment
    • Add attachment
  • Audit records
    • Get audit records
  • Avatars
    • Get system avatars by type
    • Get avatars
    • Load avatar
    • Delete avatar
    • Get avatar image by type
    • Get avatar image by ID
    • Get avatar image by owner
  • Issue bulk operations
    • Bulk delete issues
    • Get bulk editable fields
    • Bulk edit issues
    • Bulk move issues
    • Get available transitions
    • Bulk transition issue statuses
    • Bulk unwatch issues
    • Bulk watch issues
    • Get bulk issue operation progress
  • Issues
    • Bulk fetch changelogs
    • Get events
    • Create issue
    • Archive issue(s) by JQL
    • Archive issue(s) by issue ID/key
    • Bulk create issue
    • Bulk fetch issues
    • Get create issue metadata
    • Get create metadata issue types for a project
    • Get create field metadata for a project and issue type id
    • Get issue limit report
    • Unarchive issue(s) by issue keys/ID
    • Delete issue
    • Get issue
    • Edit issue
    • Assign issue
    • Get changelogs
    • Get changelogs by IDs
    • Get edit issue metadata
    • Send notification for issue
    • Get transitions
    • Transition issue
    • Export archived issue(s)
  • Classification levels
    • Get all classification levels
  • Issue comments
    • Get comments by IDs
    • Get comments
    • Add comment
    • Delete comment
    • Get comment
    • Update comment
  • Issue comment properties
    • Get comment property keys
    • Delete comment property
    • Get comment property
    • Set comment property
  • Project components
    • Find components for projects
    • Create component
    • Delete component
    • Get component
    • Update component
    • Get component issues count
    • Get project components paginated
    • Get project components
  • Time tracking
    • Get selected time tracking provider
    • Select time tracking provider
    • Get all time tracking providers
    • Get time tracking settings
    • Set time tracking settings
  • Issue custom field options
    • Get custom field option
    • Get custom field options (context)
    • Create custom field options (context)
    • Update custom field options (context)
    • Reorder custom field options (context)
    • Delete custom field options (context)
    • Replace custom field options
  • Dashboards
    • Get all dashboards
    • Create dashboard
    • Bulk edit dashboards
    • Get available gadgets
    • Search for dashboards
    • Get gadgets
    • Add gadget to dashboard
    • Remove gadget from dashboard
    • Update gadget on dashboard
    • Get dashboard item property keys
    • Delete dashboard item property
    • Get dashboard item property
    • Set dashboard item property
    • Delete dashboard
    • Get dashboard
    • Update dashboard
    • Copy dashboard
  • App data policies
    • Get data policy for the workspace
    • Get data policy for projects
  • Jira expressions
    • Analyse Jira expression
    • Currently being removed. Evaluate Jira expression
    • Evaluate Jira expression using enhanced search API
  • Issue fields
    • Get fields
    • Create custom field
    • Get fields paginated
    • Get fields in trash paginated
    • Update custom field
    • Get contexts for a field
    • Delete custom field
    • Restore custom field from trash
    • Move custom field to trash
  • Issue custom field associations
    • Remove associations
    • Create associations
  • Issue custom field contexts
    • Get custom field contexts
    • Create custom field context
    • Get custom field contexts default values
    • Set custom field contexts default values
    • Get issue types for custom field context
    • Get custom field contexts for projects and issue types
    • Get project mappings for custom field context
    • Delete custom field context
    • Update custom field context
    • Add issue types to context
    • Remove issue types from context
    • Assign custom field context to projects
    • Remove custom field context from projects
  • Screens
    • Get screens for a field
    • Get screens
    • Create screen
    • Add field to default screen
    • Delete screen
    • Update screen
    • Get available screen fields
  • Issue custom field options (apps)
    • Get all issue field options
    • Create issue field option
    • Get selectable issue field options
    • Get visible issue field options
    • Delete issue field option
    • Get issue field option
    • Update issue field option
    • Replace issue field option
  • Issue field configurations
    • Get all field configurations
    • Create field configuration
    • Delete field configuration
    • Update field configuration
    • Get field configuration items
    • Update field configuration items
    • Get all field configuration schemes
    • Create field configuration scheme
    • Get field configuration issue type items
    • Get field configuration schemes for projects
    • Assign field configuration scheme to project
    • Delete field configuration scheme
    • Update field configuration scheme
    • Assign issue types to field configurations
    • Remove issue types from field configuration scheme
  • Filters
    • Create filter
    • Get favorite filters
    • Get my filters
    • Search for filters
    • Delete filter
    • Get filter
    • Update filter
    • Reset columns
    • Get columns
    • Set columns
    • Remove filter as favorite
    • Add filter as favorite
    • Change filter owner
  • Filter sharing
    • Get default share scope
    • Set default share scope
    • Get share permissions
    • Add share permission
    • Delete share permission
    • Get share permission
  • Groups
    • Remove group
    • Get group
    • Create group
    • Bulk get groups
    • Get users from group
    • Remove user from group
    • Add user to group
    • Find groups
  • Group and user picker
    • Find users and groups
  • License metrics
    • Get license
    • Get approximate license count
    • Get approximate application license count
  • Issue search
    • Get issue picker suggestions
    • Check issues against JQL
    • Currently being removed. Search for issues using JQL (GET)
    • Currently being removed. Search for issues using JQL (POST)
    • Count issues using JQL
    • Search for issues using JQL enhanced search (GET)
    • Search for issues using JQL enhanced search (POST)
  • Issue properties
    • Bulk set issues properties by list
    • Bulk set issue properties by issue
    • Bulk delete issue property
    • Bulk set issue property
    • Get issue property keys
    • Delete issue property
    • Get issue property
    • Set issue property
  • Issue watchers
    • Get is watching issue bulk
    • Delete watcher
    • Get issue watchers
    • Add watcher
  • Issue remote links
    • Delete remote issue link by global ID
    • Get remote issue links
    • Create or update remote issue link
    • Delete remote issue link by ID
    • Get remote issue link by ID
    • Update remote issue link by ID
  • Issue votes
    • Delete vote
    • Get votes
    • Add vote
  • Issue worklogs
    • Bulk delete worklogs
    • Get issue worklogs
    • Add worklog
    • Bulk move worklogs
    • Delete worklog
    • Get worklog
    • Update worklog
    • Get IDs of deleted worklogs
    • Get worklogs
    • Get IDs of updated worklogs
  • Issue worklog properties
    • Get worklog property keys
    • Delete worklog property
    • Get worklog property
    • Set worklog property
  • Issue links
    • Create issue link
    • Delete issue link
    • Get issue link
  • Issue link types
    • Get issue link types
    • Create issue link type
    • Delete issue link type
    • Get issue link type
    • Update issue link type
  • Issue security schemes
    • Get issue security schemes
    • Create issue security scheme
    • Get issue security levels
    • Set default issue security levels
    • Get issue security level members
    • Get projects using issue security schemes
    • Associate security scheme to project
    • Search issue security schemes
    • Get issue security scheme
    • Update issue security scheme
    • Delete issue security scheme
    • Add issue security levels
    • Remove issue security level
    • Update issue security level
    • Add issue security level members
    • Remove member from issue security level
  • Issue security level
    • Get issue security level members by issue security scheme
    • Get issue security level
  • Issue types
    • Get all issue types for user
    • Create issue type
    • Get issue types for project
    • Delete issue type
    • Get issue type
    • Update issue type
    • Get alternative issue types
    • Load issue type avatar
  • Issue type properties
    • Get issue type property keys
    • Delete issue type property
    • Get issue type property
    • Set issue type property
  • Issue type schemes
    • Get all issue type schemes
    • Create issue type scheme
    • Get issue type scheme items
    • Get issue type schemes for projects
    • Assign issue type scheme to project
    • Delete issue type scheme
    • Update issue type scheme
    • Add issue types to issue type scheme
    • Change order of issue types
    • Remove issue type from issue type scheme
  • Issue type screen schemes
    • Get issue type screen schemes
    • Create issue type screen scheme
    • Get issue type screen scheme items
    • Get issue type screen schemes for projects
    • Assign issue type screen scheme to project
    • Delete issue type screen scheme
    • Update issue type screen scheme
    • Append mappings to issue type screen scheme
    • Update issue type screen scheme default screen scheme
    • Remove mappings from issue type screen scheme
    • Get issue type screen scheme projects
  • JQL
    • Get field reference data (GET)
    • Get field reference data (POST)
    • Get field auto complete suggestions
    • Parse JQL query
    • Convert user identifiers to account IDs in JQL queries
    • Sanitize JQL queries
  • JQL functions (apps)
    • Get precomputations (apps)
    • Update precomputations (apps)
    • Get precomputations by ID (apps)
  • Labels
    • Get all labels
  • Permissions
    • Get my permissions
    • Get all permissions
    • Get bulk permissions
    • Get permitted projects
  • Myself
    • Delete preference
    • Get preference
    • Set preference
    • Get locale
    • Set locale
    • Get current user
  • Issue notification schemes
    • Get notification schemes paginated
    • Create notification scheme
    • Get projects using notification schemes paginated
    • Get notification scheme
    • Update notification scheme
    • Add notifications to notification scheme
    • Delete notification scheme
    • Remove notification from notification scheme
  • Permission schemes
    • Get all permission schemes
    • Create permission scheme
    • Delete permission scheme
    • Get permission scheme
    • Update permission scheme
    • Get permission scheme grants
    • Create permission grant
    • Delete permission scheme grant
    • Get permission scheme grant
  • Plans
    • Get plans paginated
    • Create plan
    • Get plan
    • Update plan
    • Archive plan
    • Duplicate plan
    • Trash plan
  • Teams in plan
    • Get teams in plan paginated
    • Add Atlassian team to plan
    • Remove Atlassian team from plan
    • Get Atlassian team in plan
    • Update Atlassian team in plan
    • Create plan-only team
    • Delete plan-only team
    • Get plan-only team
    • Update plan-only team
  • Issue priorities
    • Get priorities
    • Create priority
    • Set default priority
    • Move priorities
    • Search priorities
    • Delete priority
    • Get priority
    • Update priority
  • Priority schemes
    • Get priority schemes
    • Create priority scheme
    • Suggested priorities for mappings
    • Get available priorities by priority scheme
    • Delete priority scheme
    • Update priority scheme
    • Get priorities by priority scheme
    • Get projects by priority scheme
  • Projects
    • Get all projects
    • Create project
    • Get recent projects
    • Get projects paginated
    • Delete project
    • Get project
    • Update project
    • Archive project
    • Delete project asynchronously
    • Restore deleted or archived project
    • Get all statuses for project
    • Get project issue type hierarchy
    • Get project notification scheme
  • Project templates
    • Create custom project
  • Project types
    • Get all project types
    • Get licensed project types
    • Get project type by key
    • Get accessible project type by key
  • Project avatars
    • Set project avatar
    • Delete project avatar
    • Load project avatar
    • Get all project avatars
  • Project classification levels
    • Remove the default data classification level from a project
    • Get the default data classification level of a project
    • Update the default data classification level of a project
  • Project features
    • Get project features
    • Set project feature state
  • Project properties
    • Get project property keys
    • Delete project property
    • Get project property
    • Set project property
  • Project roles
    • Get project roles for project
    • Get project role for project
    • Get project role details
    • Get all project roles
    • Create project role
    • Delete project role
    • Get project role by ID
    • Partial update project role
    • Fully update project role
  • Project role actors
    • Delete actors from project role
    • Add actors to project role
    • Set actors for project role
    • Delete default actors from project role
    • Get default actors for project role
    • Add default actors to project role
  • Project versions
    • Get project versions paginated
    • Get project versions
    • Create version
    • Delete version
    • Get version
    • Update version
    • Merge versions
    • Move version
    • Get version's related issues count
    • Get related work
    • Create related work
    • Update related work
    • Delete and replace version
    • Get version's unresolved issues count
    • Delete related work
  • Project email
    • Get project's sender email
    • Set project's sender email
  • Project permission schemes
    • Get project issue security scheme
    • Get assigned permission scheme
    • Assign permission scheme
    • Get project issue security levels
  • Project categories
    • Get all project categories
    • Create project category
    • Delete project category
    • Get project category by ID
    • Update project category
  • Project key and name validation
    • Validate project key
    • Get valid project key
    • Get valid project name
  • Issue redaction
    • Redact
    • Get redaction status
  • Issue resolutions
    • Get resolutions
    • Create resolution
    • Set default resolution
    • Move resolutions
    • Search resolutions
    • Delete resolution
    • Get resolution
    • Update resolution
  • Screen tabs
    • Get bulk screen tabs
    • Get all screen tabs
    • Create screen tab
    • Delete screen tab
    • Update screen tab
    • Move screen tab
  • Screen tab fields
    • Get all screen tab fields
    • Add screen tab field
    • Remove screen tab field
    • Move screen tab field
  • Screen schemes
    • Get screen schemes
    • Create screen scheme
    • Delete screen scheme
    • Update screen scheme
  • Server info
    • Get Jira instance info
  • Issue navigator settings
    • Get issue navigator default columns
    • Set issue navigator default columns
  • Workflow statuses
    • Get all statuses
    • Get status
  • Workflow status categories
    • Get all status categories
    • Get status category
  • Status
    • Bulk delete Statuses
    • Bulk get statuses
    • Bulk create statuses
    • Bulk update statuses
    • Search statuses paginated
    • Get issue type usages by status and project
    • Get project usages by status
    • Get workflow usages by status
  • Tasks
    • Get task
    • Cancel task
  • UI modifications (apps)
    • Get UI modifications
    • Create UI modification
    • Delete UI modification
    • Update UI modification
  • Users
    • Delete user
    • Get user
    • Create user
    • Bulk get users
    • Get account IDs for users
    • Reset user default columns
    • Get user default columns
    • Set user default columns
    • Get user email
    • Get user email bulk
    • Get user groups
    • Get all users default
    • Get all users
  • User search
    • Find users assignable to projects
    • Find users assignable to issues
    • Find users with permissions
    • Find users for picker
    • Find users
    • Find users by query
    • Find user keys by query
    • Find users with browse permission
  • usernavproperties
    • Get user nav property
    • Set user nav property
  • User properties
    • Get user property keys
    • Delete user property
    • Get user property
    • Set user property
  • Webhooks
    • Delete webhooks by ID
    • Get dynamic webhooks for app
    • Register dynamic webhooks
    • Get failed webhooks
    • Extend webhook life
  • Workflows
    • Get all workflows
    • Create workflow
    • Get workflows paginated
    • Delete inactive workflow
    • Get issue types in a project that are using a given workflow
    • Get projects using a given workflow
    • Get workflow schemes which are using a given workflow
    • Bulk get workflows
    • Get available workflow capabilities
    • Bulk create workflows
    • Validate create workflows
    • Get the user's default workflow editor
    • Search workflows
    • Bulk update workflows
    • Validate update workflows
  • Workflow transition rules
    • Get workflow transition rule configurations
    • Update workflow transition rule configurations
    • Delete workflow transition rule configurations
  • Workflow transition properties
    • Delete workflow transition property
    • Get workflow transition properties
    • Create workflow transition property
    • Update workflow transition property
  • Workflow schemes
    • Get all workflow schemes
    • Create workflow scheme
    • Bulk get workflow schemes
    • Update workflow scheme
    • Get required status mappings for workflow scheme update
    • Delete workflow scheme
    • Get workflow scheme
    • Classic update workflow scheme
    • Delete default workflow
    • Get default workflow
    • Update default workflow
    • Delete workflow for issue type in workflow scheme
    • Get workflow for issue type in workflow scheme
    • Set workflow for issue type in workflow scheme
    • Delete issue types for workflow in workflow scheme
    • Get issue types for workflows in workflow scheme
    • Set issue types for workflow in workflow scheme
    • Get projects which are using a given workflow scheme
  • Workflow scheme project associations
    • Get workflow scheme project associations
    • Assign workflow scheme to project
  • Workflow scheme drafts
    • Create draft workflow scheme
    • Delete draft workflow scheme
    • Get draft workflow scheme
    • Update draft workflow scheme
    • Delete draft default workflow
    • Get draft default workflow
    • Update draft default workflow
    • Delete workflow for issue type in draft workflow scheme
    • Get workflow for issue type in draft workflow scheme
    • Set workflow for issue type in draft workflow scheme
    • Publish draft workflow scheme
    • Delete issue types for workflow in draft workflow scheme
    • Get issue types for workflows in draft workflow scheme
    • Set issue types for workflow in workflow scheme
  • App properties
    • Get app properties
    • Delete app property
    • Get app property
    • Set app property
    • Delete app property (Forge)
    • Set app property (Forge)
  • Dynamic modules
    • Remove modules
    • Get modules
    • Register modules
  • App migration
    • Bulk update custom field value
    • Bulk update entity properties
    • Get workflow transition rule configurations
  • Service Registry
    • Retrieve the attributes of service registries
  • Schemas
    • Schemas
      • ActorInputBean
      • ActorsMap
      • AddAtlassianTeamRequest
      • AddFieldBean
      • AddGroupBean
      • AddNotificationsDetails
      • AddSecuritySchemeLevelsRequestBean
      • AnnouncementBannerConfiguration
      • AnnouncementBannerConfigurationUpdate
      • AppWorkflowTransitionRule
      • Application
      • ApplicationProperty
      • ApplicationRole
      • ApprovalConfiguration
      • ArchiveIssueAsyncRequest
      • ArchivedIssuesFilterRequest
      • AssociateFieldConfigurationsWithIssueTypesRequest
      • AssociateSecuritySchemeWithProjectDetails
      • AssociatedItemBean
      • AssociationContextObject
      • Attachment
      • AttachmentArchive
      • AttachmentArchiveEntry
      • AttachmentArchiveImpl
      • AttachmentArchiveItemReadable
      • AttachmentArchiveMetadataReadable
      • AttachmentMetadata
      • AttachmentSettings
      • AuditRecordBean
      • AuditRecords
      • AutoCompleteSuggestion
      • AutoCompleteSuggestions
      • AvailableDashboardGadget
      • AvailableDashboardGadgetsResponse
      • AvailableWorkflowConnectRule
      • AvailableWorkflowForgeRule
      • AvailableWorkflowSystemRule
      • AvailableWorkflowTriggerTypes
      • AvailableWorkflowTriggers
      • Avatar
      • AvatarUrlsBean
      • Avatars
      • BoardColumnPayload
      • BoardFeaturePayload
      • BoardPayload
      • BoardsPayload
      • BulkChangeOwnerDetails
      • BulkChangelogRequestBean
      • BulkChangelogResponseBean
      • BulkContextualConfiguration
      • BulkCustomFieldOptionCreateRequest
      • BulkCustomFieldOptionUpdateRequest
      • BulkEditActionError
      • BulkEditGetFields
      • BulkEditShareableEntityRequest
      • BulkEditShareableEntityResponse
      • BulkFetchIssueRequestBean
      • BulkIssueIsWatching
      • BulkIssuePropertyUpdateRequest
      • BulkIssueResults
      • BulkOperationErrorResponse
      • BulkOperationErrorResult
      • BulkOperationProgress
      • BulkPermissionGrants
      • BulkPermissionsRequestBean
      • BulkProjectPermissionGrants
      • BulkProjectPermissions
      • BulkRedactionRequest
      • BulkRedactionResponse
      • BulkTransitionGetAvailableTransitions
      • BulkTransitionSubmitInput
      • CardLayout
      • CardLayoutField
      • ChangeDetails
      • ChangeFilterOwner
      • ChangedValueBean
      • ChangedWorklog
      • ChangedWorklogs
      • Changelog
      • ColumnItem
      • ColumnRequestBody
      • Comment
      • ComponentIssuesCount
      • ComponentJsonBean
      • ComponentWithIssueCount
      • CompoundClause
      • ConditionGroupConfiguration
      • ConditionGroupPayload
      • ConditionGroupUpdate
      • Configuration
      • ConfigurationsListParameters
      • ConnectCustomFieldValue
      • ConnectCustomFieldValues
      • ConnectModule
      • ConnectModules
      • ConnectWorkflowTransitionRule
      • ContainerForProjectFeatures
      • ContainerForRegisteredWebhooks
      • ContainerForWebhookIDs
      • ContainerOfWorkflowSchemeAssociations
      • ContentItem
      • Context
      • ContextForProjectAndIssueType
      • ContextualConfiguration
      • ConvertedJQLQueries
      • CreateCrossProjectReleaseRequest
      • CreateCustomFieldContext
      • CreateCustomFieldRequest
      • CreateDateFieldRequest
      • CreateExclusionRulesRequest
      • CreateIssueSecuritySchemeDetails
      • CreateIssueSourceRequest
      • CreateNotificationSchemeDetails
      • CreatePermissionHolderRequest
      • CreatePermissionRequest
      • CreatePlanOnlyTeamRequest
      • CreatePlanRequest
      • CreatePriorityDetails
      • CreatePrioritySchemeDetails
      • CreateProjectDetails
      • CreateResolutionDetails
      • CreateSchedulingRequest
      • CreateUiModificationDetails
      • CreateUpdateRoleRequestBean
      • CreateWorkflowCondition
      • CreateWorkflowDetails
      • CreateWorkflowStatusDetails
      • CreateWorkflowTransitionDetails
      • CreateWorkflowTransitionRule
      • CreateWorkflowTransitionRulesDetails
      • CreateWorkflowTransitionScreenDetails
      • CreatedIssue
      • CreatedIssues
      • CustomContextVariable
      • CustomFieldConfigurations
      • CustomFieldContext
      • CustomFieldContextDefaultValue
      • CustomFieldContextDefaultValueCascadingOption
      • CustomFieldContextDefaultValueDate
      • CustomFieldContextDefaultValueDateTime
      • CustomFieldContextDefaultValueFloat
      • CustomFieldContextDefaultValueForgeDateTimeField
      • CustomFieldContextDefaultValueForgeGroupField
      • CustomFieldContextDefaultValueForgeMultiGroupField
      • CustomFieldContextDefaultValueForgeMultiStringField
      • CustomFieldContextDefaultValueForgeMultiUserField
      • CustomFieldContextDefaultValueForgeNumberField
      • CustomFieldContextDefaultValueForgeObjectField
      • CustomFieldContextDefaultValueForgeStringField
      • CustomFieldContextDefaultValueForgeUserField
      • CustomFieldContextDefaultValueLabels
      • CustomFieldContextDefaultValueMultiUserPicker
      • CustomFieldContextDefaultValueMultipleGroupPicker
      • CustomFieldContextDefaultValueMultipleOption
      • CustomFieldContextDefaultValueMultipleVersionPicker
      • CustomFieldContextDefaultValueProject
      • CustomFieldContextDefaultValueReadOnly
      • CustomFieldContextDefaultValueSingleGroupPicker
      • CustomFieldContextDefaultValueSingleOption
      • CustomFieldContextDefaultValueSingleVersionPicker
      • CustomFieldContextDefaultValueTextArea
      • CustomFieldContextDefaultValueTextField
      • CustomFieldContextDefaultValueURL
      • CustomFieldContextDefaultValueUpdate
      • CustomFieldContextOption
      • CustomFieldContextProjectMapping
      • CustomFieldContextSingleUserPickerDefaults
      • CustomFieldContextUpdateDetails
      • CustomFieldCreatedContextOptionsList
      • CustomFieldDefinitionJsonBean
      • CustomFieldOption
      • CustomFieldOptionCreate
      • CustomFieldOptionUpdate
      • CustomFieldPayload
      • CustomFieldReplacement
      • CustomFieldUpdatedContextOptionsList
      • CustomFieldValueUpdate
      • CustomFieldValueUpdateDetails
      • CustomTemplateRequestDTO
      • CustomTemplatesProjectDetails
      • Dashboard
      • DashboardDetails
      • DashboardGadget
      • DashboardGadgetPosition
      • DashboardGadgetResponse
      • DashboardGadgetSettings
      • DashboardGadgetUpdateRequest
      • DataClassificationLevelsBean
      • DataClassificationTagBean
      • DateRangeFilterRequest
      • DefaultLevelValue
      • DefaultShareScope
      • DefaultWorkflow
      • DefaultWorkflowEditorResponse
      • DeleteAndReplaceVersionBean
      • DeprecatedWorkflow
      • DetailedErrorCollection
      • DocumentVersion
      • DuplicatePlanRequest
      • EntityProperty
      • EntityPropertyDetails
      • Error
      • ErrorCollection
      • ErrorCollections
      • ErrorMessage
      • Errors
      • EventNotification
      • ExpandPrioritySchemeBean
      • ExpandPrioritySchemePage
      • ExportArchivedIssuesTaskProgressResponse
      • FailedWebhook
      • FailedWebhooks
      • Field
      • FieldAssociationsRequest
      • FieldCapabilityPayload
      • FieldChangedClause
      • FieldConfiguration
      • FieldConfigurationDetails
      • FieldConfigurationIssueTypeItem
      • FieldConfigurationItem
      • FieldConfigurationItemsDetails
      • FieldConfigurationScheme
      • FieldConfigurationSchemeProjectAssociation
      • FieldConfigurationSchemeProjects
      • FieldConfigurationToIssueTypeMapping
      • FieldCreateMetadata
      • FieldDetails
      • FieldIdIdentifier
      • FieldIdentifierObject
      • FieldLastUsed
      • FieldLayoutConfiguration
      • FieldLayoutPayload
      • FieldLayoutSchemePayload
      • FieldMetadata
      • FieldReferenceData
      • FieldUpdateOperation
      • FieldValueClause
      • FieldWasClause
      • Fields
      • Filter
      • FilterDetails
      • FilterSubscription
      • FilterSubscriptionsList
      • FoundGroup
      • FoundGroups
      • FoundUsers
      • FoundUsersAndGroups
      • FromLayoutPayload
      • FunctionOperand
      • FunctionReferenceData
      • GetAtlassianTeamResponse
      • GetCrossProjectReleaseResponse
      • GetCustomFieldResponse
      • GetDateFieldResponse
      • GetExclusionRulesResponse
      • GetIssueSourceResponse
      • GetPermissionHolderResponse
      • GetPermissionResponse
      • GetPlanOnlyTeamResponse
      • GetPlanResponse
      • GetPlanResponseForPage
      • GetSchedulingResponse
      • GetTeamResponseForPage
      • GlobalScopeBean
      • Group
      • GroupDetails
      • GroupLabel
      • GroupName
      • HealthCheckResult
      • Hierarchy
      • HistoryMetadata
      • HistoryMetadataParticipant
      • Icon
      • IconBean
      • IdBean
      • IdOrKeyBean
      • IncludedFields
      • InputStreamSource
      • IssueArchivalSyncRequest
      • IssueArchivalSyncResponse
      • IssueBean
      • IssueBulkDeletePayload
      • IssueBulkEditField
      • IssueBulkEditPayload
      • IssueBulkMovePayload
      • IssueBulkOperationsFieldOption
      • IssueBulkTransitionForWorkflow
      • IssueBulkTransitionPayload
      • IssueBulkWatchOrUnwatchPayload
      • IssueChangeLog
      • IssueChangelogIds
      • IssueCommentListRequestBean
      • IssueContextVariable
      • IssueCreateMetadata
      • IssueEntityProperties
      • IssueEntityPropertiesForMultiUpdate
      • IssueError
      • IssueEvent
      • IssueFieldOption
      • IssueFieldOptionConfiguration
      • IssueFieldOptionCreateBean
      • IssueFieldOptionScopeBean
      • IssueFilterForBulkPropertyDelete
      • IssueFilterForBulkPropertySet
      • IssueLayouItemtPayload
      • IssueLayoutPayload
      • IssueLimitReportResponseBean
      • IssueLink
      • IssueLinkType
      • IssueLinkTypes
      • IssueList
      • IssueMatches
      • IssueMatchesForJQL
      • IssuePickerSuggestions
      • IssuePickerSuggestionsIssueType
      • IssueSecurityLevelMember
      • IssueSecuritySchemeToProjectMapping
      • IssueTransition
      • IssueTransitionStatus
      • IssueTypeCreateBean
      • IssueTypeDetails
      • IssueTypeHierarchyPayload
      • IssueTypeIds
      • IssueTypeIdsToRemove
      • IssueTypeInfo
      • IssueTypeIssueCreateMetadata
      • IssueTypePayload
      • IssueTypeProjectCreatePayload
      • IssueTypeScheme
      • IssueTypeSchemeDetails
      • IssueTypeSchemeID
      • IssueTypeSchemeMapping
      • IssueTypeSchemePayload
      • IssueTypeSchemeProjectAssociation
      • IssueTypeSchemeProjects
      • IssueTypeSchemeUpdateDetails
      • IssueTypeScreenScheme
      • IssueTypeScreenSchemeDetails
      • IssueTypeScreenSchemeId
      • IssueTypeScreenSchemeItem
      • IssueTypeScreenSchemeMapping
      • IssueTypeScreenSchemeMappingDetails
      • IssueTypeScreenSchemePayload
      • IssueTypeScreenSchemeProjectAssociation
      • IssueTypeScreenSchemeUpdateDetails
      • IssueTypeScreenSchemesProjects
      • IssueTypeToContextMapping
      • IssueTypeUpdateBean
      • IssueTypeWithStatus
      • IssueTypeWorkflowMapping
      • IssueTypesWorkflowMapping
      • IssueUpdateDetails
      • IssueUpdateMetadata
      • IssuesAndJQLQueries
      • IssuesJqlMetaDataBean
      • IssuesMetaBean
      • IssuesUpdateBean
      • JExpEvaluateIssuesJqlMetaDataBean
      • JExpEvaluateIssuesMetaBean
      • JExpEvaluateJiraExpressionResultBean
      • JExpEvaluateMetaDataBean
      • JQLCountRequestBean
      • JQLCountResultsBean
      • JQLPersonalDataMigrationRequest
      • JQLQueryWithUnknownUsers
      • JQLReferenceData
      • JexpEvaluateCtxIssues
      • JexpEvaluateCtxJqlIssues
      • JexpIssues
      • JexpJqlIssues
      • JiraCascadingSelectField
      • JiraColorField
      • JiraColorInput
      • JiraComponentField
      • JiraDateField
      • JiraDateInput
      • JiraDateTimeField
      • JiraDateTimeInput
      • JiraDurationField
      • JiraExpressionAnalysis
      • JiraExpressionComplexity
      • JiraExpressionEvalContextBean
      • JiraExpressionEvalRequestBean
      • JiraExpressionEvaluateContextBean
      • JiraExpressionEvaluateRequestBean
      • JiraExpressionEvaluationMetaDataBean
      • JiraExpressionForAnalysis
      • JiraExpressionResult
      • JiraExpressionValidationError
      • JiraExpressionsAnalysis
      • JiraExpressionsComplexityBean
      • JiraExpressionsComplexityValueBean
      • JiraGroupInput
      • JiraIssueFields
      • JiraIssueTypeField
      • JiraLabelPropertiesInputJackson1
      • JiraLabelsField
      • JiraLabelsInput
      • JiraMultiSelectComponentField
      • JiraMultipleGroupPickerField
      • JiraMultipleSelectField
      • JiraMultipleSelectUserPickerField
      • JiraMultipleVersionPickerField
      • JiraNumberField
      • JiraPriorityField
      • JiraRichTextField
      • JiraRichTextInput
      • JiraSelectedOptionField
      • JiraSingleGroupPickerField
      • JiraSingleLineTextField
      • JiraSingleSelectField
      • JiraSingleSelectUserPickerField
      • JiraSingleVersionPickerField
      • JiraStatus
      • JiraStatusInput
      • JiraTimeTrackingField
      • JiraUrlField
      • JiraUserField
      • JiraVersionField
      • JiraWorkflow
      • JiraWorkflowStatus
      • JqlFunctionPrecomputationBean
      • JqlFunctionPrecomputationGetByIdRequest
      • JqlFunctionPrecomputationGetByIdResponse
      • JqlFunctionPrecomputationUpdateBean
      • JqlFunctionPrecomputationUpdateErrorResponse
      • JqlFunctionPrecomputationUpdateRequestBean
      • JqlFunctionPrecomputationUpdateResponse
      • JqlQueriesToParse
      • JqlQueriesToSanitize
      • JqlQuery
      • JqlQueryClause
      • JqlQueryClauseOperand
      • JqlQueryClauseTimePredicate
      • JqlQueryField
      • JqlQueryFieldEntityProperty
      • JqlQueryOrderByClause
      • JqlQueryOrderByClauseElement
      • JqlQueryToSanitize
      • JqlQueryUnitaryOperand
      • JsonContextVariable
      • JsonNode
      • JsonTypeBean
      • KeywordOperand
      • LegacyJackson1ListAttachment
      • LegacyJackson1ListColumnItem
      • LegacyJackson1ListIssueEvent
      • LegacyJackson1ListIssueTypeWithStatus
      • LegacyJackson1ListProject
      • LegacyJackson1ListProjectComponent
      • LegacyJackson1ListProjectRoleDetails
      • LegacyJackson1ListProjectType
      • LegacyJackson1ListUserMigrationBean
      • LegacyJackson1ListVersion
      • LegacyJackson1ListWorklog
      • License
      • LicenseMetric
      • LicensedApplication
      • LinkGroup
      • LinkIssueRequestJsonBean
      • LinkedIssue
      • ListOperand
      • ListWrapperCallbackApplicationRole
      • ListWrapperCallbackGroupName
      • Locale
      • MandatoryFieldValue
      • MandatoryFieldValueForADF
      • MappingsByIssueTypeOverride
      • MappingsByWorkflow
      • MoveFieldBean
      • MultiIssueEntityProperties
      • MultipartFile
      • MultipleCustomFieldValuesUpdate
      • MultipleCustomFieldValuesUpdateDetails
      • NestedResponse
      • NewUserDetails
      • NonWorkingDay
      • Notification
      • NotificationEvent
      • NotificationRecipients
      • NotificationRecipientsRestrictions
      • NotificationScheme
      • NotificationSchemeAndProjectMappingJsonBean
      • NotificationSchemeEvent
      • NotificationSchemeEventDetails
      • NotificationSchemeEventIDPayload
      • NotificationSchemeEventPayload
      • NotificationSchemeEventTypeId
      • NotificationSchemeId
      • NotificationSchemeNotificationDetails
      • NotificationSchemeNotificationDetailsPayload
      • NotificationSchemePayload
      • OldToNewSecurityLevelMappingsBean
      • OperationMessage
      • Operations
      • OrderOfCustomFieldOptions
      • OrderOfIssueTypes
      • PageBean2ComponentJsonBean
      • PageBean2JqlFunctionPrecomputationBean
      • PageBeanBulkContextualConfiguration
      • PageBeanChangelog
      • PageBeanComment
      • PageBeanComponentWithIssueCount
      • PageBeanContext
      • PageBeanContextForProjectAndIssueType
      • PageBeanContextualConfiguration
      • PageBeanCustomFieldContext
      • PageBeanCustomFieldContextDefaultValue
      • PageBeanCustomFieldContextOption
      • PageBeanCustomFieldContextProjectMapping
      • PageBeanDashboard
      • PageBeanField
      • PageBeanFieldConfigurationDetails
      • PageBeanFieldConfigurationIssueTypeItem
      • PageBeanFieldConfigurationItem
      • PageBeanFieldConfigurationScheme
      • PageBeanFieldConfigurationSchemeProjects
      • PageBeanFilterDetails
      • PageBeanGroupDetails
      • PageBeanIssueFieldOption
      • PageBeanIssueSecurityLevelMember
      • PageBeanIssueSecuritySchemeToProjectMapping
      • PageBeanIssueTypeScheme
      • PageBeanIssueTypeSchemeMapping
      • PageBeanIssueTypeSchemeProjects
      • PageBeanIssueTypeScreenScheme
      • PageBeanIssueTypeScreenSchemeItem
      • PageBeanIssueTypeScreenSchemesProjects
      • PageBeanIssueTypeToContextMapping
      • PageBeanNotificationScheme
      • PageBeanNotificationSchemeAndProjectMappingJsonBean
      • PageBeanPriority
      • PageBeanPrioritySchemeWithPaginatedPrioritiesAndProjects
      • PageBeanPriorityWithSequence
      • PageBeanProject
      • PageBeanProjectDetails
      • PageBeanResolutionJsonBean
      • PageBeanScreen
      • PageBeanScreenScheme
      • PageBeanScreenWithTab
      • PageBeanSecurityLevel
      • PageBeanSecurityLevelMember
      • PageBeanSecuritySchemeWithProjects
      • PageBeanString
      • PageBeanUiModificationDetails
      • PageBeanUser
      • PageBeanUserDetails
      • PageBeanUserKey
      • PageBeanVersion
      • PageBeanWebhook
      • PageBeanWorkflow
      • PageBeanWorkflowScheme
      • PageBeanWorkflowTransitionRules
      • PageOfChangelogs
      • PageOfComments
      • PageOfCreateMetaIssueTypeWithField
      • PageOfCreateMetaIssueTypes
      • PageOfDashboards
      • PageOfStatuses
      • PageOfWorklogs
      • PageWithCursorGetPlanResponseForPage
      • PageWithCursorGetTeamResponseForPage
      • PagedListUserDetailsApplicationUser
      • PaginatedResponseComment
      • PaginatedResponseFieldCreateMetadata
      • PaginatedResponseIssueTypeIssueCreateMetadata
      • ParsedJqlQueries
      • ParsedJqlQuery
      • PermissionDetails
      • PermissionGrant
      • PermissionGrantDTO
      • PermissionGrants
      • PermissionHolder
      • PermissionPayloadDTO
      • PermissionScheme
      • PermissionSchemes
      • Permissions
      • PermissionsKeysBean
      • PermittedProjects
      • Priority
      • PriorityId
      • PriorityMapping
      • PrioritySchemeChangesWithoutMappings
      • PrioritySchemeId
      • PrioritySchemeWithPaginatedPrioritiesAndProjects
      • PriorityWithSequence
      • Project
      • ProjectAndIssueTypePair
      • ProjectAvatars
      • ProjectCategory
      • ProjectComponent
      • ProjectCreateResourceIdentifier
      • ProjectCustomTemplateCreateRequestDTO
      • ProjectDataPolicies
      • ProjectDataPolicy
      • ProjectDetails
      • ProjectEmailAddress
      • ProjectFeature
      • ProjectFeatureState
      • ProjectId
      • ProjectIdAssociationContext
      • ProjectIdentifierBean
      • ProjectIdentifiers
      • ProjectIds
      • ProjectInsight
      • ProjectIssueCreateMetadata
      • ProjectIssueSecurityLevels
      • ProjectIssueTypeHierarchy
      • ProjectIssueTypeMapping
      • ProjectIssueTypeMappings
      • ProjectIssueTypes
      • ProjectIssueTypesHierarchyLevel
      • ProjectLandingPageInfo
      • ProjectPayload
      • ProjectPermissions
      • ProjectRole
      • ProjectRoleActorsUpdateBean
      • ProjectRoleDetails
      • ProjectRoleGroup
      • ProjectRoleUser
      • ProjectScopeBean
      • ProjectType
      • ProjectUsage
      • ProjectUsagePage
      • ProjectWithDataPolicy
      • PropertyKey
      • PropertyKeys
      • PublishDraftWorkflowScheme
      • PublishedWorkflowId
      • QuickFilterPayload
      • RedactionJobStatusResponse
      • RedactionPosition
      • RegisteredWebhook
      • RemoteIssueLink
      • RemoteIssueLinkIdentifies
      • RemoteIssueLinkRequest
      • RemoteObject
      • RemoveOptionFromIssuesResult
      • ReorderIssuePriorities
      • ReorderIssueResolutionsRequest
      • RequiredMappingByIssueType
      • RequiredMappingByWorkflows
      • Resolution
      • ResolutionId
      • ResolutionJsonBean
      • Resource
      • RestrictedPermission
      • RichText
      • RoleActor
      • RolePayload
      • RolesCapabilityPayload
      • RuleConfiguration
      • RulePayload
      • SanitizedJqlQueries
      • SanitizedJqlQuery
      • Scope
      • ScopePayload
      • Screen
      • ScreenDetails
      • ScreenPayload
      • ScreenScheme
      • ScreenSchemeDetails
      • ScreenSchemeId
      • ScreenSchemePayload
      • ScreenTypes
      • ScreenWithTab
      • ScreenableField
      • ScreenableTab
      • SearchAndReconcileRequestBean
      • SearchAndReconcileResults
      • SearchAutoCompleteFilter
      • SearchRequestBean
      • SearchResults
      • SecurityLevel
      • SecurityLevelMember
      • SecurityLevelMemberPayload
      • SecurityLevelPayload
      • SecurityScheme
      • SecuritySchemeId
      • SecuritySchemeLevelBean
      • SecuritySchemeLevelMemberBean
      • SecuritySchemeMembersRequest
      • SecuritySchemePayload
      • SecuritySchemeWithProjects
      • SecuritySchemes
      • ServerInformation
      • ServiceManagementNavigationInfo
      • ServiceRegistry
      • ServiceRegistryTier
      • SetDefaultLevelsRequest
      • SetDefaultPriorityRequest
      • SetDefaultResolutionRequest
      • SharePermission
      • SharePermissionInputBean
      • SimpleApplicationPropertyBean
      • SimpleErrorCollection
      • SimpleLink
      • SimpleListWrapperApplicationRole
      • SimpleListWrapperGroupName
      • SimpleUsage
      • SimplifiedHierarchyLevel
      • SimplifiedIssueTransition
      • SingleRedactionRequest
      • SingleRedactionResponse
      • SoftwareNavigationInfo
      • Status
      • StatusCategory
      • StatusCreate
      • StatusCreateRequest
      • StatusDetails
      • StatusLayoutUpdate
      • StatusMapping
      • StatusMappingDTO
      • StatusMetadata
      • StatusMigration
      • StatusPayload
      • StatusProjectIssueTypeUsage
      • StatusProjectIssueTypeUsageDTO
      • StatusProjectIssueTypeUsagePage
      • StatusProjectUsage
      • StatusProjectUsageDTO
      • StatusProjectUsagePage
      • StatusScope
      • StatusUpdate
      • StatusUpdateRequest
      • StatusWorkflowUsageDTO
      • StatusWorkflowUsagePage
      • StatusWorkflowUsageWorkflow
      • StatusesPerWorkflow
      • StreamingResponseBody
      • StringList
      • SubmittedBulkOperation
      • SuggestedIssue
      • SuggestedMappingsForPrioritiesRequestBean
      • SuggestedMappingsForProjectsRequestBean
      • SuggestedMappingsRequestBean
      • SwimlanePayload
      • SwimlanesPayload
      • SystemAvatars
      • TabPayload
      • TaskProgressBeanJsonNode
      • TaskProgressBeanObject
      • TaskProgressBeanRemoveOptionFromIssuesResult
      • TimeTrackingConfiguration
      • TimeTrackingDetails
      • TimeTrackingProvider
      • ToLayoutPayload
      • Transition
      • TransitionPayload
      • TransitionScreenDetails
      • TransitionUpdateDTO
      • Transitions
      • UiModificationContextDetails
      • UiModificationDetails
      • UiModificationIdentifiers
      • UnrestrictedUserEmail
      • UpdateCustomFieldDetails
      • UpdateDefaultProjectClassificationBean
      • UpdateDefaultScreenScheme
      • UpdateFieldConfigurationSchemeDetails
      • UpdateIssueSecurityLevelDetails
      • UpdateIssueSecuritySchemeRequestBean
      • UpdateNotificationSchemeDetails
      • UpdatePrioritiesInSchemeRequestBean
      • UpdatePriorityDetails
      • UpdatePrioritySchemeRequestBean
      • UpdatePrioritySchemeResponseBean
      • UpdateProjectDetails
      • UpdateProjectsInSchemeRequestBean
      • UpdateResolutionDetails
      • UpdateScreenDetails
      • UpdateScreenSchemeDetails
      • UpdateScreenTypes
      • UpdateUiModificationDetails
      • UpdateUserToGroupBean
      • UpdatedProjectCategory
      • User
      • UserBean
      • UserBeanAvatarUrls
      • UserColumnRequestBody
      • UserContextVariable
      • UserDetails
      • UserFilter
      • UserKey
      • UserList
      • UserMigrationBean
      • UserNavPropertyJsonBean
      • UserPermission
      • UserPickerUser
      • ValidationOptionsForCreate
      • ValidationOptionsForUpdate
      • ValueOperand
      • Version
      • VersionApprover
      • VersionIssueCounts
      • VersionIssuesStatus
      • VersionMoveBean
      • VersionRelatedWork
      • VersionUnresolvedIssuesCount
      • VersionUsageInCustomField
      • Visibility
      • Votes
      • WarningCollection
      • Watchers
      • Webhook
      • WebhookDetails
      • WebhookRegistrationDetails
      • WebhooksExpirationDate
      • WorkManagementNavigationInfo
      • Workflow
      • WorkflowAssociationStatusMapping
      • WorkflowCapabilities
      • WorkflowCapabilityPayload
      • WorkflowCompoundCondition
      • WorkflowCondition
      • WorkflowCreate
      • WorkflowCreateRequest
      • WorkflowCreateResponse
      • WorkflowCreateValidateRequest
      • WorkflowElementReference
      • WorkflowIDs
      • WorkflowId
      • WorkflowLayout
      • WorkflowMetadataAndIssueTypeRestModel
      • WorkflowMetadataRestModel
      • WorkflowOperations
      • WorkflowPayload
      • WorkflowProjectIssueTypeUsage
      • WorkflowProjectIssueTypeUsageDTO
      • WorkflowProjectIssueTypeUsagePage
      • WorkflowProjectUsageDTO
      • WorkflowReadRequest
      • WorkflowReadResponse
      • WorkflowReferenceStatus
      • WorkflowRuleConfiguration
      • WorkflowRules
      • WorkflowRulesSearch
      • WorkflowRulesSearchDetails
      • WorkflowScheme
      • WorkflowSchemeAssociation
      • WorkflowSchemeAssociations
      • WorkflowSchemeIdName
      • WorkflowSchemePayload
      • WorkflowSchemeProjectAssociation
      • WorkflowSchemeProjectUsageDTO
      • WorkflowSchemeReadRequest
      • WorkflowSchemeReadResponse
      • WorkflowSchemeUpdateRequest
      • WorkflowSchemeUpdateRequiredMappingsRequest
      • WorkflowSchemeUpdateRequiredMappingsResponse
      • WorkflowSchemeUsage
      • WorkflowSchemeUsageDTO
      • WorkflowSchemeUsagePage
      • WorkflowScope
      • WorkflowSearchResponse
      • WorkflowSimpleCondition
      • WorkflowStatus
      • WorkflowStatusLayout
      • WorkflowStatusLayoutPayload
      • WorkflowStatusPayload
      • WorkflowStatusUpdate
      • WorkflowTransition
      • WorkflowTransitionLinks
      • WorkflowTransitionProperty
      • WorkflowTransitionRule
      • WorkflowTransitionRules
      • WorkflowTransitionRulesDetails
      • WorkflowTransitionRulesUpdate
      • WorkflowTransitionRulesUpdateErrorDetails
      • WorkflowTransitionRulesUpdateErrors
      • WorkflowTransitions
      • WorkflowTrigger
      • WorkflowUpdate
      • WorkflowUpdateRequest
      • WorkflowUpdateResponse
      • WorkflowUpdateValidateRequestBean
      • WorkflowUsages
      • WorkflowValidationError
      • WorkflowValidationErrorList
      • WorkflowsWithTransitionRulesDetails
      • WorkingDaysConfig
      • Worklog
      • WorklogIdsRequestBean
      • WorklogsMoveRequestBean
      • WorkspaceDataPolicy
      • fields
      • targetClassification
      • targetMandatoryFields
      • targetStatus
      • targetToSourcesMapping
Home
Link
Multiple Menus
Multiple Menus
  • Link1
  • Link2
Home
Link
Multiple Menus
Multiple Menus
  • Link1
  • Link2
  1. Schemas

CustomFieldPayload

Defines the payload for the custom field definitions. See https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-fields/\#api-rest-api-3-field-post

{
    "cfType": "See https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-fields/#api-rest-api-3-field-post `type` for values",
    "description": "This is a custom field",
    "name": "My Custom Field",
    "onConflict": "FAIL",
    "pcri": "pcri:permissionScheme:id:10001",
    "searcherKey": "See https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-fields/#api-rest-api-3-field-post `searcherKey` for values"
}
Built with